@arcgis/charts-components 5.2.0-next.10 → 5.2.0-next.100
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/LICENSE.md +4 -2
- package/README.md +2 -2
- package/dist/cdn/225VUGML.js +4 -0
- package/dist/cdn/22V4YZLT.js +2 -0
- package/dist/cdn/{YJ6TRXMU.js → 24MSASQQ.js} +1 -1
- package/dist/cdn/{4USHOYLT.js → 2BE3GYK4.js} +1 -1
- package/dist/cdn/{VMS7DT3M.js → 2INZEFXR.js} +1 -1
- package/dist/cdn/{L47EGLUH.js → 2OAB6VMZ.js} +1 -1
- package/dist/cdn/2RSKVWTZ.js +2 -0
- package/dist/cdn/{YKDW7ZW3.js → 2TNZTI5Q.js} +1 -1
- package/dist/cdn/{VY3KBD6N.js → 2YDNWOWT.js} +1 -1
- package/dist/cdn/{2XXW3WF3.js → 3DGX6WFJ.js} +1 -1
- package/dist/cdn/3NLKE6ZN.js +2 -0
- package/dist/cdn/{S3ZSZXYG.js → 3W64DBHG.js} +1 -1
- package/dist/cdn/3XSL5VPN.js +2 -0
- package/dist/cdn/{Y7HBWU3M.js → 3ZKNY2GI.js} +1 -1
- package/dist/cdn/42FKRE56.js +2 -0
- package/dist/cdn/42PLGMOG.js +2 -0
- package/dist/cdn/455LSMAU.js +2 -0
- package/dist/cdn/4A4EW5Z5.js +2 -0
- package/dist/cdn/4DR6JUR7.js +104 -0
- package/dist/cdn/{CHLE2QGU.js → 4DXGXATO.js} +1 -1
- package/dist/cdn/4U63XRSZ.js +2 -0
- package/dist/cdn/{QR2OOC4D.js → 4YKB2PME.js} +1 -1
- package/dist/cdn/{TFPQDMER.js → 5BZCHVPD.js} +1 -1
- package/dist/cdn/{H2A5GZ55.js → 5D2QRMC6.js} +1 -1
- package/dist/cdn/5GDVKAX5.js +2 -0
- package/dist/cdn/5SYHQWPP.js +2 -0
- package/dist/cdn/{ULWJ57VT.js → 5V2YHARQ.js} +1 -1
- package/dist/cdn/{XY4TRZCG.js → 5VHWJWWP.js} +1 -1
- package/dist/cdn/{LUSFGRHV.js → 5WIR3JWC.js} +1 -1
- package/dist/cdn/62GSQDTE.js +2 -0
- package/dist/cdn/{VT4WJZN6.js → 64B7ILJI.js} +1 -1
- package/dist/cdn/{MK5ZYSOD.js → 65WMT7WD.js} +1 -1
- package/dist/cdn/6DYDDJKB.js +2 -0
- package/dist/cdn/6H6SZO4Y.js +2 -0
- package/dist/cdn/{H3EXGCE7.js → 6MALKAJY.js} +1 -1
- package/dist/cdn/6VIPQGM6.js +2 -0
- package/dist/cdn/{7LYAWWOE.js → 6WKTHJQK.js} +1 -1
- package/dist/cdn/{II2ZPEUZ.js → 7C2LVFNV.js} +1 -1
- package/dist/cdn/{4Z23HWDH.js → 7COM5REK.js} +1 -1
- package/dist/cdn/7FPQDD3C.js +2 -0
- package/dist/cdn/7GTZX5NP.js +2 -0
- package/dist/cdn/7NGEMDYM.js +2 -0
- package/dist/cdn/7TM4LYGN.js +2 -0
- package/dist/cdn/{3TZEMBXR.js → 7TTQNVC5.js} +1 -1
- package/dist/cdn/AA456L7Q.js +2 -0
- package/dist/cdn/{VDKFC44J.js → AAHQPRYK.js} +1 -1
- package/dist/cdn/{OJ5X6I3H.js → ADI63OO7.js} +1 -1
- package/dist/cdn/AIQU35U3.js +2 -0
- package/dist/cdn/AMIDKZA2.js +2 -0
- package/dist/cdn/AOVXHBJK.js +2 -0
- package/dist/cdn/{ZBIVDGNH.js → ATWR3DSK.js} +1 -1
- package/dist/cdn/AYCQHDDV.js +2 -0
- package/dist/cdn/AZYYQMCD.js +2 -0
- package/dist/cdn/{TXB2I2U5.js → B2SUC7VR.js} +1 -1
- package/dist/cdn/{VW4GW2JT.js → B46RQ2MZ.js} +1 -1
- package/dist/cdn/{TACQVUBU.js → BDEDEGCZ.js} +1 -1
- package/dist/cdn/{N5ZUO6F3.js → BK2QOEX2.js} +1 -1
- package/dist/cdn/{CNFBNAPJ.js → BK7DHYA7.js} +1 -1
- package/dist/cdn/BWLRC2U5.js +2 -0
- package/dist/cdn/BYSUABOV.js +2 -0
- package/dist/cdn/{CSAUXIK2.js → CHBL4DXX.js} +1 -1
- package/dist/cdn/{SERX6V5M.js → CTMOMBBM.js} +1 -1
- package/dist/cdn/{ZFJFTDJF.js → CYGMXV56.js} +1 -1
- package/dist/cdn/D5DOFLCS.js +2 -0
- package/dist/cdn/{N7NZHIGS.js → DLMRATCW.js} +1 -1
- package/dist/cdn/{XDMGH7YU.js → DWO7GMVE.js} +1 -1
- package/dist/cdn/E6E2KLJ2.js +2 -0
- package/dist/cdn/E6JK3JRJ.js +2 -0
- package/dist/cdn/EB4CM3YK.js +2 -0
- package/dist/cdn/EJW2UHAB.js +2 -0
- package/dist/cdn/{J5NHXQLA.js → EQZBQP5A.js} +1 -1
- package/dist/cdn/EWIMT2AS.js +2 -0
- package/dist/cdn/FBS4RBSA.js +2 -0
- package/dist/cdn/{7QXRWMUN.js → FLUZSJXH.js} +1 -1
- package/dist/cdn/{4OH4NSIW.js → FSEQQXRO.js} +1 -1
- package/dist/cdn/G3KO465U.js +4 -0
- package/dist/cdn/GVJ5WCQD.js +2 -0
- package/dist/cdn/H2ECCBL7.js +2 -0
- package/dist/cdn/H2R62NYZ.js +2 -0
- package/dist/cdn/{XYKXBWIT.js → H7Z3QWIW.js} +1 -1
- package/dist/cdn/{2OHFSVV5.js → HJSR7M2A.js} +1 -1
- package/dist/cdn/{YDJPGFXU.js → HUMEIOOQ.js} +1 -1
- package/dist/cdn/{BDGHBTPU.js → HZUBDLNR.js} +1 -1
- package/dist/cdn/{AZOBLYAP.js → I2BM5KSH.js} +1 -1
- package/dist/cdn/IBMPLHXH.js +2 -0
- package/dist/cdn/{JQKRGUBU.js → IDAOLPMA.js} +1 -1
- package/dist/cdn/{FTOYQNHN.js → IGOJGDYE.js} +1 -1
- package/dist/cdn/{AASL4RKT.js → IRIGTY65.js} +1 -1
- package/dist/cdn/JCCCT72R.js +2 -0
- package/dist/cdn/{SSQ3VCZ2.js → JMR2NH33.js} +1 -1
- package/dist/cdn/JSVAA6N4.js +2 -0
- package/dist/cdn/JVHMHWIM.js +2 -0
- package/dist/cdn/JZMYBU7B.js +2 -0
- package/dist/cdn/KKE5EKYC.js +2 -0
- package/dist/cdn/KODMEY56.js +2 -0
- package/dist/cdn/{D3CFPMAR.js → KOY5DWSR.js} +1 -1
- package/dist/cdn/KYESCAI2.js +2 -0
- package/dist/cdn/KYOCE6FA.js +2 -0
- package/dist/cdn/KZSCAJDG.js +2 -0
- package/dist/cdn/L5JZ5COY.js +2 -0
- package/dist/cdn/{AY6IOQ3H.js → LAEUROZM.js} +1 -1
- package/dist/cdn/LZ7SW2R3.js +2 -0
- package/dist/cdn/M4G6TGMS.js +2 -0
- package/dist/cdn/{UYXCGSXU.js → MJVTTSEV.js} +1 -1
- package/dist/cdn/MMUAG4IX.js +2 -0
- package/dist/cdn/MQI4ZLAS.js +2 -0
- package/dist/cdn/{X2LW7GTR.js → N7VRRNQD.js} +1 -1
- package/dist/cdn/{HD4FP3ZK.js → NJF5UIYM.js} +1 -1
- package/dist/cdn/{XG2KN6YJ.js → NKPZCF5U.js} +1 -1
- package/dist/cdn/{VE3GFNNM.js → NRXCKYYY.js} +1 -1
- package/dist/cdn/{4C6KWLWN.js → NWLNHFHJ.js} +1 -1
- package/dist/cdn/{RSNZMJ6I.js → NWYSPTLF.js} +1 -1
- package/dist/cdn/O4DFT4N4.js +2 -0
- package/dist/cdn/{NAXNRCMZ.js → OD2NWPCL.js} +1 -1
- package/dist/cdn/OGH6DSQR.js +2 -0
- package/dist/cdn/{FWAXKDYV.js → OH3X6QIK.js} +1 -1
- package/dist/cdn/{4ZIZEJXS.js → OISERMTF.js} +1 -1
- package/dist/cdn/OIWZXO7H.js +2 -0
- package/dist/cdn/{ETOGNYFU.js → OKAZOAYZ.js} +1 -1
- package/dist/cdn/OKKEWHMB.js +2 -0
- package/dist/cdn/{VRZ2SY6M.js → OQFM5DBD.js} +1 -1
- package/dist/cdn/OURE3TA5.js +2 -0
- package/dist/cdn/{C5K6XOCR.js → P37JASN4.js} +1 -1
- package/dist/cdn/{KDJ5RVHA.js → P3AYFJRV.js} +1 -1
- package/dist/cdn/{244ZX2UP.js → P5I5RQTN.js} +1 -1
- package/dist/cdn/{N4L5KE23.js → PAPE3NIS.js} +1 -1
- package/dist/cdn/{BJ7Q7LCT.js → PIZPF2BH.js} +1 -1
- package/dist/cdn/{3JYZJUOM.js → PMFGLOZL.js} +1 -1
- package/dist/cdn/PT2OG4W2.js +2 -0
- package/dist/cdn/PWJBGZPW.js +2 -0
- package/dist/cdn/Q366CY3F.js +45 -0
- package/dist/cdn/{LROW4Y6O.js → QHJSE3P3.js} +1 -1
- package/dist/cdn/{7UQHB6KY.js → QIG5H6WA.js} +1 -1
- package/dist/cdn/QKUFLZC3.js +2 -0
- package/dist/cdn/{XMPLEHTW.js → QKZK6MTN.js} +1 -1
- package/dist/cdn/QO2RH3XB.js +3 -0
- package/dist/cdn/QPX4FNCB.js +2 -0
- package/dist/cdn/{5SIAOUPO.js → QTAETIIH.js} +1 -1
- package/dist/cdn/QYRHZJH3.js +2 -0
- package/dist/cdn/{I6UPUSLQ.js → QZIF3GED.js} +1 -1
- package/dist/cdn/RD7TKIQS.js +2 -0
- package/dist/cdn/RGIL6ZEZ.js +2 -0
- package/dist/cdn/RNGQEQRO.js +2 -0
- package/dist/cdn/RPUEIRTH.js +2 -0
- package/dist/cdn/{WAINRCCJ.js → S6CNTZIE.js} +1 -1
- package/dist/cdn/S6RBDFHP.js +2 -0
- package/dist/cdn/SIHW3QVG.js +2 -0
- package/dist/cdn/SS7GYFUD.js +2 -0
- package/dist/cdn/{DNTLH5RT.js → SSOL6PCL.js} +1 -1
- package/dist/cdn/SXT66JGI.js +2 -0
- package/dist/cdn/SZSTCHLY.js +2 -0
- package/dist/cdn/SZYIWW3C.js +2 -0
- package/dist/cdn/T75QDGXB.js +2 -0
- package/dist/cdn/{ZYOWZCR7.js → TB7JE5XK.js} +1 -1
- package/dist/cdn/{AK7X7SGI.js → TENIFMA5.js} +1 -1
- package/dist/cdn/{OXYJKZEP.js → TNUZFQGZ.js} +1 -1
- package/dist/cdn/{WMPWOPRZ.js → TRAVRA3M.js} +1 -1
- package/dist/cdn/{Y6ZCTPJW.js → U25H6VUE.js} +1 -1
- package/dist/cdn/UCHQXTEC.js +2 -0
- package/dist/cdn/{P5AO3V3M.js → UD724V36.js} +1 -1
- package/dist/cdn/ULQSD4KK.js +2 -0
- package/dist/cdn/{DSIFL2DF.js → UQSD6YZM.js} +1 -1
- package/dist/cdn/{Q7J7EKQW.js → UUVJGPFG.js} +1 -1
- package/dist/cdn/UVESG7TY.js +2 -0
- package/dist/cdn/{ANN3O54W.js → V4NEFGS3.js} +1 -1
- package/dist/cdn/{IYA7HQMS.js → V54RTUAV.js} +1 -1
- package/dist/cdn/{ZQDADGLQ.js → VLCUXTLC.js} +1 -1
- package/dist/cdn/VMHDTE3U.js +2 -0
- package/dist/cdn/VQMG3F5Z.js +2 -0
- package/dist/cdn/VQU2TVX7.js +3 -0
- package/dist/cdn/{GNC62GNV.js → VWUW3HFU.js} +1 -1
- package/dist/cdn/W66Q5TB6.js +2 -0
- package/dist/cdn/{FOYOG3G7.js → WKRD4TIL.js} +1 -1
- package/dist/cdn/WMYNPECY.js +2 -0
- package/dist/cdn/WOGALV3T.js +2 -0
- package/dist/cdn/{6B7JCDQC.js → WTF2PFHV.js} +1 -1
- package/dist/cdn/WTMEWLUJ.js +2 -0
- package/dist/cdn/WTOK3YQI.js +2 -0
- package/dist/cdn/WVOXFKFO.js +2 -0
- package/dist/cdn/X2FMGJRP.js +2 -0
- package/dist/cdn/X733UM32.js +2 -0
- package/dist/cdn/XGWHDERD.js +2 -0
- package/dist/cdn/{OFWEHJDH.js → XOB6RSOR.js} +1 -1
- package/dist/cdn/{BXYNEUQY.js → YCQLYXH4.js} +1 -1
- package/dist/cdn/YFMHKHFE.js +2 -0
- package/dist/cdn/YHC6WRNQ.js +2 -0
- package/dist/cdn/ZDKUHFRX.js +2 -0
- package/dist/cdn/ZK72BJCQ.js +2 -0
- package/dist/cdn/{3376CR53.js → ZLARROJV.js} +1 -1
- package/dist/cdn/{5ZGALYWZ.js → ZLCRTIQH.js} +1 -1
- package/dist/cdn/{TYUVXRBO.js → ZZHKDFTA.js} +1 -1
- package/dist/cdn/assets/charts-config-view-charts/t9n/messages.en.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.en.json +1 -1
- package/dist/cdn/index.js +1 -1
- package/dist/cdn/main.css +1 -1
- package/dist/cdn/model/shared/setup-utils.js +1 -1
- package/dist/chart-rendering/common/interfaces.d.ts +104 -66
- package/dist/chunks/{type-guards3.js → action-bar-utils.js} +37 -45
- package/dist/chunks/axis-lines-symbol.js +7 -7
- package/dist/chunks/bar-chart-model.js +46 -38
- package/dist/chunks/box-plot-data.js +291 -274
- package/dist/chunks/box-plot-model.js +143 -130
- package/dist/chunks/chart-model.js +64 -55
- package/dist/chunks/chart-object-literals.js +26 -25
- package/dist/chunks/chart-ui-utils.js +148 -66
- package/dist/chunks/chart-ui-utils2.js +68 -149
- package/dist/chunks/class-breaks.js +270 -238
- package/dist/chunks/combo-bar-line-chart-model.js +122 -101
- package/dist/chunks/data-labels-symbol.js +39 -24
- package/dist/chunks/data-labels-visibility.js +8 -8
- package/dist/chunks/data.js +68 -68
- package/dist/chunks/default.js +6 -6
- package/dist/chunks/gauge-model.js +61 -61
- package/dist/chunks/generate-x-axis-title.js +15 -15
- package/dist/chunks/heat-chart-model.js +95 -66
- package/dist/chunks/histogram-data.js +23 -23
- package/dist/chunks/histogram-model.js +9 -9
- package/dist/chunks/index.js +9353 -1079
- package/dist/chunks/index2.js +851 -8751
- package/dist/chunks/index3.js +1169 -848
- package/dist/chunks/index4.js +420 -253
- package/dist/chunks/index5.js +63 -100
- package/dist/chunks/interfaces.js +9 -9
- package/dist/chunks/line-chart-model.js +40 -24
- package/dist/chunks/model-setter.js +59 -64
- package/dist/chunks/model-types.js +1 -1
- package/dist/chunks/model-with-line-marker-styling.js +72 -47
- package/dist/chunks/model-with-y-guides.js +52 -67
- package/dist/chunks/negative-values-stacked-to-baseline.js +122 -71
- package/dist/chunks/pie-chart-data.js +175 -193
- package/dist/chunks/pie-chart-model.js +388 -320
- package/dist/chunks/radar-chart-model.js +413 -46
- package/dist/chunks/resource.js +1 -1
- package/dist/chunks/rest-js-object-literals.js +10 -10
- package/dist/chunks/rotated-state.js +1 -1
- package/dist/chunks/rounded-corners.js +90 -0
- package/dist/chunks/scatterplot-model.js +12 -12
- package/dist/chunks/serial-chart-data.js +884 -749
- package/dist/chunks/serial-chart-model.js +145 -123
- package/dist/chunks/series-length.js +17 -17
- package/dist/chunks/series-types.js +22 -18
- package/dist/chunks/series.js +1 -1
- package/dist/chunks/type-guards.js +49 -23
- package/dist/chunks/type-guards2.js +61 -52
- package/dist/chunks/utils.js +101 -91
- package/dist/chunks/utils2.js +9 -9
- package/dist/chunks/web-component-utils.js +591 -540
- package/dist/chunks/x-bounds.js +98 -97
- package/dist/components/arcgis-chart/customElement.d.ts +762 -255
- package/dist/components/arcgis-chart/customElement.js +10646 -10368
- package/dist/components/arcgis-charts-action-bar/customElement.d.ts +8 -0
- package/dist/components/arcgis-charts-action-bar/customElement.js +34 -31
- package/dist/components/arcgis-charts-config-axis/customElement.js +70 -64
- package/dist/components/arcgis-charts-config-bar-chart/customElement.js +39 -33
- package/dist/components/arcgis-charts-config-bar-chart-data/customElement.js +27 -27
- package/dist/components/arcgis-charts-config-bar-chart-data/index.js +1 -1
- package/dist/components/arcgis-charts-config-bar-chart-popover/customElement.js +35 -37
- package/dist/components/arcgis-charts-config-bar-chart-series/customElement.js +43 -42
- package/dist/components/arcgis-charts-config-bar-chart-series-popover/customElement.js +13 -15
- package/dist/components/arcgis-charts-config-box-plot/customElement.js +31 -39
- package/dist/components/arcgis-charts-config-box-plot-data/customElement.js +15 -15
- package/dist/components/arcgis-charts-config-box-plot-data/index.js +1 -1
- package/dist/components/arcgis-charts-config-box-plot-popover/customElement.js +26 -28
- package/dist/components/arcgis-charts-config-box-plot-series/customElement.js +4 -4
- package/dist/components/arcgis-charts-config-box-plot-series-popover/customElement.js +14 -17
- package/dist/components/arcgis-charts-config-category-format/customElement.js +1 -1
- package/dist/components/arcgis-charts-config-chart-rename-popover/customElement.js +18 -20
- package/dist/components/arcgis-charts-config-color-style/customElement.js +1 -1
- package/dist/components/arcgis-charts-config-colors/customElement.js +1 -1
- package/dist/components/arcgis-charts-config-create-flow/customElement.js +243 -229
- package/dist/components/arcgis-charts-config-field-picker/customElement.js +30 -0
- package/dist/components/arcgis-charts-config-font-style/customElement.js +4 -4
- package/dist/components/arcgis-charts-config-format/customElement.js +94 -87
- package/dist/components/arcgis-charts-config-format-popover/customElement.js +8 -11
- package/dist/components/arcgis-charts-config-general/customElement.js +3 -3
- package/dist/components/arcgis-charts-config-guide/customElement.js +21 -22
- package/dist/components/arcgis-charts-config-guide-popover/customElement.js +10 -13
- package/dist/components/arcgis-charts-config-guides/customElement.js +1 -1
- package/dist/components/arcgis-charts-config-heat-chart/customElement.js +12 -13
- package/dist/components/arcgis-charts-config-heat-chart-data/customElement.js +64 -76
- package/dist/components/arcgis-charts-config-heat-chart-data/index.js +1 -1
- package/dist/components/arcgis-charts-config-heat-chart-popover/customElement.js +57 -58
- package/dist/components/arcgis-charts-config-histogram/customElement.js +27 -23
- package/dist/components/arcgis-charts-config-histogram-data/customElement.js +28 -28
- package/dist/components/arcgis-charts-config-histogram-data/index.js +1 -1
- package/dist/components/arcgis-charts-config-histogram-popover/customElement.js +35 -36
- package/dist/components/arcgis-charts-config-invalid-input-message/customElement.js +1 -1
- package/dist/components/arcgis-charts-config-line-chart/customElement.js +5 -6
- package/dist/components/arcgis-charts-config-line-chart-data/customElement.js +18 -18
- package/dist/components/arcgis-charts-config-line-chart-data/index.js +1 -1
- package/dist/components/arcgis-charts-config-line-chart-popover/customElement.js +42 -44
- package/dist/components/arcgis-charts-config-line-chart-series/customElement.js +2 -2
- package/dist/components/arcgis-charts-config-line-chart-series-popover/customElement.js +7 -8
- package/dist/components/arcgis-charts-config-line-style/customElement.js +2 -2
- package/dist/components/arcgis-charts-config-number-format/customElement.js +1 -1
- package/dist/components/arcgis-charts-config-pie-chart/customElement.js +5 -6
- package/dist/components/arcgis-charts-config-pie-chart-data/customElement.js +57 -64
- package/dist/components/arcgis-charts-config-pie-chart-data/index.js +1 -1
- package/dist/components/arcgis-charts-config-pie-chart-popover/customElement.js +56 -57
- package/dist/components/arcgis-charts-config-pie-chart-slices/customElement.js +66 -67
- package/dist/components/arcgis-charts-config-pie-chart-slices-popover/customElement.js +7 -10
- package/dist/components/arcgis-charts-config-scatter-plot/customElement.js +27 -23
- package/dist/components/arcgis-charts-config-scatter-plot-data/customElement.js +15 -15
- package/dist/components/arcgis-charts-config-scatter-plot-data/index.js +1 -1
- package/dist/components/arcgis-charts-config-scatter-plot-popover/customElement.js +18 -19
- package/dist/components/arcgis-charts-config-select-chart-type-popover/customElement.js +9 -11
- package/dist/components/arcgis-charts-config-view-charts/customElement.js +57 -26
- package/dist/components/arcgis-charts-info-modal/customElement.js +7 -7
- package/dist/docs/api.json +1 -1
- package/dist/docs/docs.json +1 -1
- package/dist/docs/vscode.html-custom-data.json +1 -1
- package/dist/docs/web-types.json +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +488 -464
- package/dist/interfaces.d.ts +57 -14
- package/dist/json-schema/index.d.ts +161 -6
- package/dist/loader.js +2 -2
- package/dist/model/bar-chart-model/bar-chart-model.d.ts +6 -4
- package/dist/model/box-plot-model/box-plot-model.d.ts +11 -5
- package/dist/model/chart-model/chart-model-base.d.ts +10 -0
- package/dist/model/chart-model/chart-model-wrapper.d.ts +24 -0
- package/dist/model/combo-bar-line-chart-model/combo-bar-line-chart-model.d.ts +33 -21
- package/dist/model/heat-chart-model/heat-chart-model.d.ts +41 -8
- package/dist/model/interfaces/chart-interfaces.d.ts +2 -2
- package/dist/model/interfaces/common.d.ts +0 -2
- package/dist/model/mixins/model-with-guides.d.ts +1 -1
- package/dist/model/mixins/model-with-line-marker-styling.d.ts +28 -19
- package/dist/model/mixins/model-with-multi-axes.d.ts +62 -99
- package/dist/model/pie-chart-model/pie-chart-legend-model.d.ts +7 -55
- package/dist/model/pie-chart-model/pie-chart-model.d.ts +61 -2
- package/dist/model/properties/data-labels/data-labels-symbol.d.ts +26 -0
- package/dist/model/properties/rounded-corners.d.ts +18 -0
- package/dist/model/radar-chart-model/radar-chart-model.d.ts +190 -0
- package/dist/model/serial-chart-model/serial-chart-model.d.ts +27 -1
- package/dist/model/shared/setup-utils.d.ts +3 -3
- package/dist/model/shared/type-guards.d.ts +38 -22
- package/dist/spec/chart-object-literals.d.ts +4 -3
- package/dist/spec/data-source.d.ts +17 -3
- package/dist/spec/rest-js-types.d.ts +22 -8
- package/dist/spec/web-chart.d.ts +36 -6
- package/dist/types/lumina.d.ts +1 -1
- package/dist/types/preact.d.ts +1 -1
- package/dist/types/react.d.ts +1 -1
- package/dist/types/stencil.d.ts +3 -3
- package/dist/utils/chart-config/converter/index.js +210 -191
- package/dist/utils/chart-config/utils/index.d.ts +29 -10
- package/dist/utils/chart-config/validator/index.d.ts +1 -0
- package/dist/utils/chart-config/validator/interfaces.d.ts +2 -3
- package/dist/utils/components/interfaces.d.ts +2 -0
- package/dist/utils/cursor/interfaces.d.ts +21 -0
- package/dist/utils/data/categorical-data/index.d.ts +18 -2
- package/dist/utils/data/index.d.ts +28 -22
- package/dist/utils/data/interfaces.d.ts +4 -3
- package/dist/utils/defaults/index.d.ts +30 -4
- package/dist/utils/defaults/interfaces.d.ts +73 -4
- package/dist/utils/errors/index.d.ts +1 -1
- package/dist/utils/layer/index.d.ts +23 -5
- package/dist/utils/layer/inline-conversion/index.d.ts +0 -3
- package/dist/utils/layer/inline-conversion/interfaces.d.ts +0 -2
- package/dist/utils/layer/interfaces.d.ts +0 -12
- package/dist/utils/layer/query-features/index.d.ts +8 -3
- package/dist/utils/layer/query-parser/index.d.ts +10 -6
- package/dist/utils/layer/utils/index.d.ts +22 -5
- package/dist/utils/localization/interfaces.d.ts +9 -1
- package/dist/utils/misc/index.d.ts +2 -3
- package/dist/utils/misc/interfaces.d.ts +1 -0
- package/dist/utils/type-guards/chart-types.d.ts +10 -0
- package/dist/utils/type-guards/series-types.d.ts +9 -2
- package/dist/utils/types/index.d.ts +1 -5
- package/package.json +8 -9
- package/dist/cdn/255TSQSE.js +0 -102
- package/dist/cdn/25YAWDIB.js +0 -2
- package/dist/cdn/2A7JZQX5.js +0 -2
- package/dist/cdn/2HTYRBIX.js +0 -2
- package/dist/cdn/2PAVNZEM.js +0 -2
- package/dist/cdn/2XYTPC2V.js +0 -2
- package/dist/cdn/3CFZUVMF.js +0 -2
- package/dist/cdn/3S3PN7AK.js +0 -2
- package/dist/cdn/3W2A4SAP.js +0 -2
- package/dist/cdn/4ETF22K6.js +0 -2
- package/dist/cdn/4J6UFQ2Q.js +0 -2
- package/dist/cdn/4YJSRB7R.js +0 -2
- package/dist/cdn/547RDEMV.js +0 -2
- package/dist/cdn/5JNEJJU3.js +0 -2
- package/dist/cdn/5OKNLDIJ.js +0 -2
- package/dist/cdn/5V3ADOWS.js +0 -2
- package/dist/cdn/6MF2R6DJ.js +0 -2
- package/dist/cdn/6SRJ2VKV.js +0 -2
- package/dist/cdn/7EEYYP6X.js +0 -2
- package/dist/cdn/BBURKBKE.js +0 -2
- package/dist/cdn/BER7FMK3.js +0 -2
- package/dist/cdn/BJRHNVLR.js +0 -2
- package/dist/cdn/CBHWMUGA.js +0 -58
- package/dist/cdn/CDHUW42P.js +0 -2
- package/dist/cdn/CEE2QRZ5.js +0 -2
- package/dist/cdn/CGYB5KPV.js +0 -2
- package/dist/cdn/CHQDKVVQ.js +0 -4
- package/dist/cdn/DJ5OHPYW.js +0 -2
- package/dist/cdn/EDSF5KGV.js +0 -233
- package/dist/cdn/EK33HUAH.js +0 -2
- package/dist/cdn/EZV7JSQJ.js +0 -2
- package/dist/cdn/F7Q3XDZH.js +0 -2
- package/dist/cdn/FFS73X36.js +0 -142
- package/dist/cdn/GBDEYCR6.js +0 -2
- package/dist/cdn/GKPMAFU3.js +0 -2
- package/dist/cdn/GXC7VLYM.js +0 -2
- package/dist/cdn/H4B3ERFL.js +0 -2
- package/dist/cdn/HFJ4EPET.js +0 -2
- package/dist/cdn/I5AALJRN.js +0 -2
- package/dist/cdn/ICVAXCHZ.js +0 -2
- package/dist/cdn/IHTJSWKK.js +0 -2
- package/dist/cdn/IKCVYV5L.js +0 -2
- package/dist/cdn/JEH22SPH.js +0 -2
- package/dist/cdn/JMAVBKEZ.js +0 -2
- package/dist/cdn/JNNB2DIA.js +0 -2
- package/dist/cdn/JQYB4ZDY.js +0 -2
- package/dist/cdn/KB76VF4V.js +0 -2
- package/dist/cdn/KHNP4LWB.js +0 -2
- package/dist/cdn/KKKCWW6G.js +0 -2
- package/dist/cdn/L6ZALCLC.js +0 -2
- package/dist/cdn/LIPUN4CH.js +0 -2
- package/dist/cdn/LO6KKSE4.js +0 -2
- package/dist/cdn/LOZOENFC.js +0 -3
- package/dist/cdn/M6JCOZIE.js +0 -2
- package/dist/cdn/NFANBMTU.js +0 -2
- package/dist/cdn/NKJC4MT7.js +0 -2
- package/dist/cdn/OYCT7CFU.js +0 -2
- package/dist/cdn/P4HSSZRL.js +0 -2
- package/dist/cdn/PAIRUVLU.js +0 -2
- package/dist/cdn/PJZVDHIF.js +0 -2
- package/dist/cdn/PM6FCUUV.js +0 -2
- package/dist/cdn/PNDFAGEB.js +0 -2
- package/dist/cdn/PRPNJEPZ.js +0 -2
- package/dist/cdn/PZKRRAXW.js +0 -2
- package/dist/cdn/QAIY4AMN.js +0 -2
- package/dist/cdn/QF4UBQYT.js +0 -2
- package/dist/cdn/QF6LHQTR.js +0 -2
- package/dist/cdn/QM27URJR.js +0 -2
- package/dist/cdn/RA3CZHC7.js +0 -2
- package/dist/cdn/RH4AC577.js +0 -2
- package/dist/cdn/SHTFWNG3.js +0 -2
- package/dist/cdn/SPVZ5BND.js +0 -2
- package/dist/cdn/SXT5DNXJ.js +0 -4
- package/dist/cdn/SYIW6YJN.js +0 -2
- package/dist/cdn/SZEYHOGG.js +0 -2
- package/dist/cdn/TH4OHGTQ.js +0 -2
- package/dist/cdn/THTYR6IL.js +0 -2
- package/dist/cdn/U4COKMGA.js +0 -2
- package/dist/cdn/U67P6YAZ.js +0 -2
- package/dist/cdn/U6USPTQ5.js +0 -2
- package/dist/cdn/UHPAFBYO.js +0 -2
- package/dist/cdn/VL2G5M57.js +0 -2
- package/dist/cdn/VOTZAPI3.js +0 -2
- package/dist/cdn/VSPTNIIU.js +0 -2
- package/dist/cdn/W7X6L2OB.js +0 -127
- package/dist/cdn/WBJ6NWHX.js +0 -2
- package/dist/cdn/WNKDEOFZ.js +0 -2
- package/dist/cdn/WPPMMVD5.js +0 -2
- package/dist/cdn/X4BYDZDR.js +0 -2
- package/dist/cdn/XACXJMSF.js +0 -3
- package/dist/cdn/XJ2L7VN4.js +0 -2
- package/dist/cdn/XJFVSX2E.js +0 -2
- package/dist/cdn/XP5GZU4O.js +0 -2
- package/dist/cdn/XUERYUEG.js +0 -2
- package/dist/cdn/XUT56VH6.js +0 -2
- package/dist/cdn/XWZYTOHY.js +0 -2
- package/dist/cdn/XXXXO6OB.js +0 -2
- package/dist/cdn/Y3CXVO2M.js +0 -2
- package/dist/cdn/YSWV4FZE.js +0 -2
- package/dist/cdn/YXWIKYN4.js +0 -2
- package/dist/cdn/Z4HCNLCD.js +0 -2
- package/dist/cdn/Z5VVIVR3.js +0 -2
- package/dist/cdn/ZIVPZF6E.js +0 -2
- package/dist/chunks/bar-chart-series.js +0 -15
- package/dist/chunks/index6.js +0 -66
- package/dist/chunks/time-zone.js +0 -38
- package/dist/components/arcgis-charts-config-field-select/customElement.js +0 -30
- /package/dist/cdn/{IVLVCLDE.js → 7NWEE7T2.js} +0 -0
- /package/dist/components/{arcgis-charts-config-field-select → arcgis-charts-config-field-picker}/index.js +0 -0
|
@@ -5,8 +5,8 @@ import type SelectionManager from "@arcgis/core/views/SelectionManager.js";
|
|
|
5
5
|
import type FeatureLayerView from "@arcgis/core/views/layers/FeatureLayerView.js";
|
|
6
6
|
import type { DOMContainerAria } from "@arcgis/core/views/DOMContainer.js";
|
|
7
7
|
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
|
|
8
|
-
import type { AxisLabelFormatCallback,
|
|
9
|
-
import type {
|
|
8
|
+
import type { AxisLabelFormatCallback, BarAndLineDataLabelFormatCallback, GaugeInnerLabelFormatCallback, GuideTooltipFormatCallback, HistogramLabelFormatCallback, PieChartLabelFormatCallback, PieChartLegendValueLabelFormatCallback, PreRenderCallback, ScatterplotLabelFormatCallback, TooltipFormatters } from "../../chart-rendering/common/interfaces.js";
|
|
9
|
+
import type { ChartLayerInput, CSVOptions } from "../../interfaces.js";
|
|
10
10
|
import type { ChartModel } from "../../model/chart-model/chart-model.js";
|
|
11
11
|
import type { WebChartTypes, WebChartLegendPositions } from "../../spec/chart-object-literals.js";
|
|
12
12
|
import type { WebChartDataTypes } from "../../spec/data-source.js";
|
|
@@ -22,125 +22,35 @@ import type { ErrorPolicy, LayerFieldsChangePolicy, LayerFilterChangePolicy, Lay
|
|
|
22
22
|
import type { T9nMeta } from "@arcgis/lumina/controllers";
|
|
23
23
|
|
|
24
24
|
/**
|
|
25
|
-
* The Chart component renders a chart
|
|
25
|
+
* The ArcGIS Chart component renders a chart by setting a [model](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#model) object that defines the chart's configuration and data.
|
|
26
26
|
*
|
|
27
|
-
*
|
|
27
|
+
* You can render a chart either by:
|
|
28
|
+
* - Setting [layerItemId](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#layerItemId) and [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex) to load a saved chart from a layer item.
|
|
29
|
+
* - Create a new chart by using the [`createModel()`](/references/charts-components/model/shared/setup-utils/#createModel) function to create a chart model and set it to the [model](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#model) property.
|
|
28
30
|
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
32
|
-
* [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-a-chart/)
|
|
31
|
+
* > [!IMPORTANT]
|
|
32
|
+
* >
|
|
33
|
+
* > See the [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/) guide for detailed examples on how to render a chart using the above patterns.
|
|
33
34
|
*
|
|
34
|
-
*
|
|
35
|
+
* There are 10 supported chart types, each with its own model properties and methods. Refer to the [chart types documentation](https://developers.arcgis.com/javascript/latest/charts/chart-types/) for more information on each chart type.
|
|
36
|
+
*
|
|
37
|
+
* ##### See also:
|
|
38
|
+
* - [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-a-chart/)
|
|
39
|
+
* - [Tutorial: Chart and map interactions](https://developers.arcgis.com/javascript/latest/tutorials/chart-and-map-interactions/)
|
|
40
|
+
*
|
|
41
|
+
* > [!WARNING]
|
|
42
|
+
* > When the chart is rendering while its container is not yet fully sized, a console error about the chart's attribute height may appear. This is a known issue and should not affect the functionality of the chart.
|
|
43
|
+
*
|
|
44
|
+
* @slot [action-bar] - Slot for the [arcgis-charts-action-bar](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-charts-action-bar/) component or [calcite-action-bar](https://developers.arcgis.com/calcite-design-system/components/action-bar/) component.
|
|
35
45
|
* @since 4.32
|
|
36
46
|
*/
|
|
37
47
|
export abstract class ArcgisChart extends LitElement {
|
|
38
|
-
/** @internal */
|
|
39
|
-
protected _messages: Partial<{ chartNotFoundWarning: string; }> & T9nMeta<{ chartNotFoundWarning: string; }>;
|
|
40
|
-
/**
|
|
41
|
-
* Specifies the user action behavior for the chart.
|
|
42
|
-
*
|
|
43
|
-
* - `monoSelection`: Select a single data point or series, new selection replaces the previous one.
|
|
44
|
-
* - `multiSelection`: Select multiple data points or series, new selection adds to the previous one.
|
|
45
|
-
* - `multiSelectionWithCtrlKey`: Select multiple data points or series while holding the Ctrl key (Cmd on Mac). When the key is held, each new selection is added; otherwise, the selection is replaced.
|
|
46
|
-
* - `none`: No action is performed on user interaction.
|
|
47
|
-
* - `zoom`: Zoom into a specific area of the chart.
|
|
48
|
-
*
|
|
49
|
-
* **Note**: Not applicable to gauges.
|
|
50
|
-
*/
|
|
51
|
-
accessor actionMode: ActionModes | undefined;
|
|
52
|
-
/**
|
|
53
|
-
* Whether to allow the object id to be used as a statistic other than `Count`.
|
|
54
|
-
*
|
|
55
|
-
* @default false
|
|
56
|
-
*/
|
|
57
|
-
accessor allowUsingObjectIdStat: boolean;
|
|
58
|
-
/**
|
|
59
|
-
* Enable animation on the chart.
|
|
60
|
-
*
|
|
61
|
-
* @default false
|
|
62
|
-
*/
|
|
63
|
-
accessor animationEnabled: boolean | undefined;
|
|
64
|
-
/**
|
|
65
|
-
* The ARIA attributes for the chart. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [`label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [`description`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [`describedByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaDescribedByElements), and [`labelledByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaLabelledByElements).
|
|
66
|
-
*
|
|
67
|
-
* @since 5.0
|
|
68
|
-
*/
|
|
69
|
-
accessor aria: DOMContainerAria | undefined;
|
|
70
|
-
/**
|
|
71
|
-
* If `true`, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#destroy) method when you are done to prevent memory leaks.
|
|
72
|
-
*
|
|
73
|
-
* @default false
|
|
74
|
-
* @since 5.0
|
|
75
|
-
*/
|
|
76
|
-
accessor autoDestroyDisabled: boolean;
|
|
77
|
-
/**
|
|
78
|
-
* Auto disposes the chart when a new one is created in the same container.
|
|
79
|
-
*
|
|
80
|
-
* @deprecated since 5.0. Use [autoDestroyDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#autoDestroyDisabled) instead.
|
|
81
|
-
* @default false
|
|
82
|
-
*/
|
|
83
|
-
accessor autoDisposeChart: boolean;
|
|
84
|
-
/**
|
|
85
|
-
* When `true`, the data label text color is automatically adjusted for readability based on its background.
|
|
86
|
-
* If the label is dark and appears over a dark series area, the text color is switched to either the chart background color or white.
|
|
87
|
-
*
|
|
88
|
-
* **Note**: Applicable to heat charts only.
|
|
89
|
-
*
|
|
90
|
-
* @default false
|
|
91
|
-
*/
|
|
92
|
-
accessor autoInverseDataLabelTextColor: boolean;
|
|
93
|
-
/**
|
|
94
|
-
* Allows picking the Calcite CSS variables to use when applying a Calcite theme.
|
|
95
|
-
*
|
|
96
|
-
* By default the following variables are used:
|
|
97
|
-
* - background: `--calcite-color-foreground-1`
|
|
98
|
-
* - text: `--calcite-color-text-1`
|
|
99
|
-
* - line: `--calcite-color-border-1`
|
|
100
|
-
* - secondary line: `--calcite-color-text-3`
|
|
101
|
-
* - spinner: `--calcite-color-brand-hover`
|
|
102
|
-
*
|
|
103
|
-
* The charts colors are overridden by those associated to those CSS variables, but only if they have not been
|
|
104
|
-
* customized beforehand.
|
|
105
|
-
*
|
|
106
|
-
* @since 5.1
|
|
107
|
-
*/
|
|
108
|
-
accessor calciteThemingCSSVariables: CalciteThemeCSSVariables;
|
|
109
|
-
/**
|
|
110
|
-
* The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.
|
|
111
|
-
*
|
|
112
|
-
* If a `layer` or `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.
|
|
113
|
-
*
|
|
114
|
-
* If the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.
|
|
115
|
-
*
|
|
116
|
-
* @example
|
|
117
|
-
* ```html
|
|
118
|
-
* <arcgis-chart layer-item-id="8871626e970a4f3e9d6113ec63a92f2f" chart-index="2"></arcgis-chart>
|
|
119
|
-
* ```
|
|
120
|
-
*/
|
|
121
|
-
accessor chartIndex: number | undefined;
|
|
122
|
-
/**
|
|
123
|
-
* Customize the maximum number of series allowed on the chart.
|
|
124
|
-
*
|
|
125
|
-
* The chart's behavior once that limit is reached can be adjusted through the `behaviorAfterLimit` nested property, to either reject the creation
|
|
126
|
-
* or update of the chart, or render the elements up to the given limits.
|
|
127
|
-
*
|
|
128
|
-
* **Note**: Not applicable to gauges.
|
|
129
|
-
*/
|
|
130
|
-
accessor chartLimits: ChartElementLimit | undefined;
|
|
131
|
-
/**
|
|
132
|
-
* Lifecycle function executed after the data has been processed and before the chart renders.
|
|
133
|
-
* Can be used to alter the model from information extracted from the data.
|
|
134
|
-
*
|
|
135
|
-
* **Note**: Applicable to gauges and pie charts only.
|
|
136
|
-
*/
|
|
137
|
-
accessor chartWillRender: PreRenderCallback | undefined;
|
|
138
48
|
/**
|
|
139
49
|
* Localized common strings.
|
|
140
50
|
*
|
|
141
51
|
* @internal
|
|
142
52
|
*/
|
|
143
|
-
protected
|
|
53
|
+
protected _commonStrings: {
|
|
144
54
|
utilsStrings: {
|
|
145
55
|
chartType: {
|
|
146
56
|
chart: string;
|
|
@@ -278,6 +188,10 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
278
188
|
twoTemporalSeriesLineCountCannotExceedLimit: string;
|
|
279
189
|
threePlusTemporalSeriesLineCountCannotExceedLimit: string;
|
|
280
190
|
lineSeriesCountCannotExceedLimit: string;
|
|
191
|
+
uniqueSeriesRadarCountCannotExceedLimit: string;
|
|
192
|
+
twoSeriesRadarCountCannotExceedLimit: string;
|
|
193
|
+
threePlusSeriesRadarCountCannotExceedLimit: string;
|
|
194
|
+
radarSeriesCountCannotExceedLimit: string;
|
|
281
195
|
uniqueSeriesBoxCountCannotExceedLimit: string;
|
|
282
196
|
twoSeriesBoxCountCannotExceedLimit: string;
|
|
283
197
|
threePlusBoxLineCountCannotExceedLimit: string;
|
|
@@ -545,6 +459,10 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
545
459
|
twoTemporalSeriesLineCountCannotExceedLimit: string;
|
|
546
460
|
threePlusTemporalSeriesLineCountCannotExceedLimit: string;
|
|
547
461
|
lineSeriesCountCannotExceedLimit: string;
|
|
462
|
+
uniqueSeriesRadarCountCannotExceedLimit: string;
|
|
463
|
+
twoSeriesRadarCountCannotExceedLimit: string;
|
|
464
|
+
threePlusSeriesRadarCountCannotExceedLimit: string;
|
|
465
|
+
radarSeriesCountCannotExceedLimit: string;
|
|
548
466
|
uniqueSeriesBoxCountCannotExceedLimit: string;
|
|
549
467
|
twoSeriesBoxCountCannotExceedLimit: string;
|
|
550
468
|
threePlusBoxLineCountCannotExceedLimit: string;
|
|
@@ -675,21 +593,158 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
675
593
|
"Invalid date": string;
|
|
676
594
|
};
|
|
677
595
|
}>;
|
|
596
|
+
/** @internal */
|
|
597
|
+
protected _messages: Partial<{ chartNotFoundWarning: string; }> & T9nMeta<{ chartNotFoundWarning: string; }>;
|
|
598
|
+
/**
|
|
599
|
+
* Specifies how user interactions on the chart are handled.
|
|
600
|
+
*
|
|
601
|
+
* - `monoSelection`: Select one data item at a time. Each new selection replaces the previous selection.
|
|
602
|
+
* - `multiSelection`: Select multiple data items. Each new selection is added to the existing selection.
|
|
603
|
+
* - `multiSelectionWithCtrlKey`: Select multiple data items only while holding Ctrl (or Cmd on macOS). Without the key, selection behaves like `monoSelection`.
|
|
604
|
+
* - `zoom`: Zoom into an area of the chart.
|
|
605
|
+
* - `none`: Disable interaction-driven selection and zoom actions.
|
|
606
|
+
*
|
|
607
|
+
* **Note**: Not applicable to gauges.
|
|
608
|
+
*/
|
|
609
|
+
accessor actionMode: ActionModes | undefined;
|
|
610
|
+
/**
|
|
611
|
+
* When `true`, object ID can be used as a numeric field for aggregated charts (for example, `sum` of `objectId`).
|
|
612
|
+
*
|
|
613
|
+
* @default false
|
|
614
|
+
*/
|
|
615
|
+
accessor allowUsingObjectIdStat: boolean;
|
|
616
|
+
/**
|
|
617
|
+
* When `true`, elements such as data items, axes, and legends will animate when the chart is first rendered or when the chart's configuration is updated.
|
|
618
|
+
*
|
|
619
|
+
* <video
|
|
620
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/animationEnabled.webm"
|
|
621
|
+
* aria-label="animationEnabled"
|
|
622
|
+
* width="720"
|
|
623
|
+
* autoPlay
|
|
624
|
+
* loop
|
|
625
|
+
* muted
|
|
626
|
+
* playsInline
|
|
627
|
+
* />
|
|
628
|
+
*
|
|
629
|
+
* @default false
|
|
630
|
+
* @since 5.1
|
|
631
|
+
*/
|
|
632
|
+
accessor animationEnabled: boolean | undefined;
|
|
633
|
+
/**
|
|
634
|
+
* The ARIA attributes for the chart component. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [\`label\`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [\`description\`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [\`describedByElements\`](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements), and [\`labelledByElements\`](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements).
|
|
635
|
+
*
|
|
636
|
+
* @example
|
|
637
|
+
* ```ts
|
|
638
|
+
* chartElement.aria = {
|
|
639
|
+
* label: "Custom chart label",
|
|
640
|
+
* description: "Custom chart description",
|
|
641
|
+
* };
|
|
642
|
+
* ```
|
|
643
|
+
* @see [ARIA attributes](https://developers.arcgis.com/javascript/latest/accessibility/#aria-attributes)
|
|
644
|
+
* @since 5.0
|
|
645
|
+
*/
|
|
646
|
+
accessor aria: DOMContainerAria | undefined;
|
|
647
|
+
/**
|
|
648
|
+
* When `true`, the component is not destroyed automatically when it is disconnected from the document, which is useful when moving or temporarily hiding it.
|
|
649
|
+
*
|
|
650
|
+
* > [!CAUTION]
|
|
651
|
+
* >
|
|
652
|
+
* > Call the [destroy()](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#destroy) method when you are done to prevent memory leaks.
|
|
653
|
+
*
|
|
654
|
+
* @default false
|
|
655
|
+
* @since 5.0
|
|
656
|
+
*/
|
|
657
|
+
accessor autoDestroyDisabled: boolean;
|
|
658
|
+
/**
|
|
659
|
+
* Auto disposes the chart when a new one is created in the same container.
|
|
660
|
+
*
|
|
661
|
+
* @deprecated since 5.0. Use [autoDestroyDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#autoDestroyDisabled) instead.
|
|
662
|
+
* @default false
|
|
663
|
+
*/
|
|
664
|
+
accessor autoDisposeChart: boolean;
|
|
665
|
+
/**
|
|
666
|
+
* When `true`, the data label text color is automatically adjusted for readability based on its background, switching to either the chart background color or white when the contrast is too low.
|
|
667
|
+
*
|
|
668
|
+
* | With `autoInverseDataLabelTextColor` | Without `autoInverseDataLabelTextColor` |
|
|
669
|
+
* | -------- | -------- |
|
|
670
|
+
* |  |  |
|
|
671
|
+
*
|
|
672
|
+
* **Note**: Applicable to heat charts only.
|
|
673
|
+
*
|
|
674
|
+
* @default false
|
|
675
|
+
* @since 4.34
|
|
676
|
+
*/
|
|
677
|
+
accessor autoInverseDataLabelTextColor: boolean;
|
|
678
|
+
/**
|
|
679
|
+
* Specifies the Calcite CSS variables to use when applying a Calcite theme.
|
|
680
|
+
*
|
|
681
|
+
* By default the following variables are used:
|
|
682
|
+
* - background: `--calcite-color-foreground-1`
|
|
683
|
+
* - text: `--calcite-color-text-1`
|
|
684
|
+
* - line: `--calcite-color-border-1`
|
|
685
|
+
* - secondary line: `--calcite-color-text-3`
|
|
686
|
+
* - spinner: `--calcite-color-brand-hover`
|
|
687
|
+
*
|
|
688
|
+
* The chart colors are overridden by those associated to those CSS variables, but only if they have not been customized beforehand.
|
|
689
|
+
*
|
|
690
|
+
* @see [Charts theming with Calcite CSS variables](https://developers.arcgis.com/javascript/latest/charts/features-and-capabilities/styling-and-theming/#theming-with-css-variables)
|
|
691
|
+
* @see [Components theming with Calcite](https://developers.arcgis.com/javascript/latest/building-your-ui/#styling-and-theming-with-calcite)
|
|
692
|
+
* @since 5.1
|
|
693
|
+
*/
|
|
694
|
+
accessor calciteThemingCSSVariables: CalciteThemeCSSVariables;
|
|
695
|
+
/**
|
|
696
|
+
* The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.
|
|
697
|
+
*
|
|
698
|
+
* If a `layer` or `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.
|
|
699
|
+
*
|
|
700
|
+
* If the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.
|
|
701
|
+
*
|
|
702
|
+
* @example
|
|
703
|
+
* ```html
|
|
704
|
+
* <arcgis-chart layer-item-id="8871626e970a4f3e9d6113ec63a92f2f" chart-index="2"></arcgis-chart>
|
|
705
|
+
* ```
|
|
706
|
+
*/
|
|
707
|
+
accessor chartIndex: number | undefined;
|
|
708
|
+
/**
|
|
709
|
+
* Customize the maximum number of data items allowed on the chart.
|
|
710
|
+
*
|
|
711
|
+
* The chart's behavior once that limit is reached can be adjusted through the `behaviorAfterLimit` nested property, to either reject the creation
|
|
712
|
+
* or update of the chart, or render the elements up to the given limits.
|
|
713
|
+
*
|
|
714
|
+
* **Note**: Not applicable to gauges.
|
|
715
|
+
*
|
|
716
|
+
* @example
|
|
717
|
+
* ```ts
|
|
718
|
+
* chartElement.chartLimits = {
|
|
719
|
+
* behaviorAfterLimit: LimitBehavior.RenderUpToTheLimit,
|
|
720
|
+
* serialChart: { categories: 15 }
|
|
721
|
+
* };
|
|
722
|
+
* ```
|
|
723
|
+
*/
|
|
724
|
+
accessor chartLimits: ChartElementLimit | undefined;
|
|
725
|
+
/**
|
|
726
|
+
* Lifecycle function executed after the data has been processed and before the chart renders.
|
|
727
|
+
* Can be used to alter the model from information extracted from the data.
|
|
728
|
+
*
|
|
729
|
+
* **Note**: Applicable to gauges and pie charts only.
|
|
730
|
+
*/
|
|
731
|
+
accessor chartWillRender: PreRenderCallback | undefined;
|
|
678
732
|
/**
|
|
679
733
|
* Whether to use features uniquely designed for a chart currently being configured by a user via the UI.
|
|
680
|
-
* When true
|
|
681
|
-
* and
|
|
734
|
+
* When `true` and if the [arcgis-charts-action-bar](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-charts-action-bar/) is slotted in the chart component,
|
|
735
|
+
* the action bar will expose an "Edit chart" action, surface relevant error states, and show a helpful in-container placeholder about the chart’s purpose.
|
|
682
736
|
*
|
|
683
737
|
* @default false
|
|
738
|
+
* @since 5.1
|
|
684
739
|
*/
|
|
685
740
|
accessor configurationEnabled: boolean;
|
|
686
741
|
/**
|
|
687
|
-
*
|
|
742
|
+
* Defines how the cursor selection rectangle is constrained when [actionMode](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#actionMode) is `zoom`, `multiSelection`, or `multiSelectionWithCtrlKey`.
|
|
688
743
|
*
|
|
689
|
-
* - `multi-axes`: Allows
|
|
690
|
-
* - `x-axis`:
|
|
691
|
-
* - `y-axis`:
|
|
692
|
-
* - `undefined`:
|
|
744
|
+
* - `multi-axes`: Allows drawing a free rectangle across both axes.
|
|
745
|
+
* - `x-axis`: Constrains the rectangle to the x-axis direction.
|
|
746
|
+
* - `y-axis`: Constrains the rectangle to the y-axis direction.
|
|
747
|
+
* - `undefined`: Uses the default behavior for the current chart type and action mode.
|
|
693
748
|
*
|
|
694
749
|
* **Note**: Not applicable to gauges.
|
|
695
750
|
*/
|
|
@@ -697,9 +752,27 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
697
752
|
/**
|
|
698
753
|
* Callback function used to format the data labels. If the returned string contains HTML tags they will be interpreted as such.
|
|
699
754
|
*
|
|
700
|
-
*
|
|
755
|
+
* @example
|
|
756
|
+
* ```ts
|
|
757
|
+
* // Render custom data labels with the stat value and percentage formatted to 2 decimal places.
|
|
758
|
+
* chartElement.dataLabelFormatter = (statValue, percent) => {
|
|
759
|
+
* return `
|
|
760
|
+
* <div>
|
|
761
|
+
* Total listings: <strong>${statValue}</strong><br>
|
|
762
|
+
* Percentage: <strong>${Number(percent).toFixed(2)}%</strong>
|
|
763
|
+
* </div>
|
|
764
|
+
* `;
|
|
765
|
+
* };
|
|
766
|
+
* ```
|
|
767
|
+
* <img
|
|
768
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/dataLabelFormatter.avif"
|
|
769
|
+
* alt="dataLabelFormatter true"
|
|
770
|
+
* style="max-width: 700px; width: 100%; height: auto;"
|
|
771
|
+
* />
|
|
772
|
+
*
|
|
773
|
+
* **Note**: Not applicable to gauges and radar charts.
|
|
701
774
|
*/
|
|
702
|
-
accessor dataLabelFormatter:
|
|
775
|
+
accessor dataLabelFormatter: BarAndLineDataLabelFormatCallback | HistogramLabelFormatCallback | PieChartLabelFormatCallback | ScatterplotLabelFormatCallback | undefined;
|
|
703
776
|
/**
|
|
704
777
|
* Disables all interactions on the chart.
|
|
705
778
|
*
|
|
@@ -712,7 +785,7 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
712
785
|
*
|
|
713
786
|
* **Note**: Only applicable to multi-series charts.
|
|
714
787
|
*
|
|
715
|
-
* @deprecated since 5.1. Use [
|
|
788
|
+
* @deprecated since 5.1. Use [legendInteractionsDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#legendInteractionsDisabled) instead.
|
|
716
789
|
* @default false
|
|
717
790
|
*/
|
|
718
791
|
accessor disableTogglingLegendItems: boolean;
|
|
@@ -740,7 +813,8 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
740
813
|
*/
|
|
741
814
|
accessor enableResponsiveFeatures: boolean;
|
|
742
815
|
/**
|
|
743
|
-
*
|
|
816
|
+
* When set to `ignore`, the chart fails silently without displaying an error or hiding the chart.
|
|
817
|
+
* By default, it is set to `throw`, which displays an error alert and hides the chart when it can't be created or updated.
|
|
744
818
|
*
|
|
745
819
|
* @default "throw"
|
|
746
820
|
*/
|
|
@@ -761,7 +835,8 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
761
835
|
*/
|
|
762
836
|
accessor filterByExtent: boolean;
|
|
763
837
|
/**
|
|
764
|
-
* When `true`,
|
|
838
|
+
* When `true`, the chart uses the current selection as a data filter and renders only selected elements instead of rendering the full dataset with selection styling.
|
|
839
|
+
* Axis bounds, time binning intervals will be computed based on the selected elements only.
|
|
765
840
|
*
|
|
766
841
|
* **Note**: Not applicable to gauges or charts configured with imagery layers.
|
|
767
842
|
*
|
|
@@ -769,7 +844,7 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
769
844
|
*/
|
|
770
845
|
accessor filterBySelection: boolean;
|
|
771
846
|
/**
|
|
772
|
-
* When `true`,
|
|
847
|
+
* When `true`, chart queries are constrained to the current map view extent. The chart refreshes as the view extent changes, and the axis bounds or other derived values are recalculated from the view extent data.
|
|
773
848
|
*
|
|
774
849
|
* @default false
|
|
775
850
|
*/
|
|
@@ -777,12 +852,43 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
777
852
|
/**
|
|
778
853
|
* Callback function used to format the gauge inner label. If the returned string contains HTML tags they will be interpreted as such.
|
|
779
854
|
*
|
|
855
|
+
* @example
|
|
856
|
+
* ```ts
|
|
857
|
+
* // Render a centered custom gauge label with the value formatted to 2 decimal places.
|
|
858
|
+
* chartElement.gaugeInnerLabelFormatter = (value) => {
|
|
859
|
+
* return `<div style="text-align: center;"><u>Custom gauge inner label: </u><br /><b>${Number(value).toFixed(2)}</b></div>`;
|
|
860
|
+
* };
|
|
861
|
+
* ```
|
|
862
|
+
*
|
|
863
|
+
* <img
|
|
864
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/gaugeInnerLabelFormatter.avif"
|
|
865
|
+
* alt="gaugeInnerLabelFormatter"
|
|
866
|
+
* style="max-width: 700px; width: 100%; height: auto;"
|
|
867
|
+
* />
|
|
868
|
+
*
|
|
780
869
|
* **Note**: Applicable to gauges only.
|
|
781
870
|
*/
|
|
782
871
|
accessor gaugeInnerLabelFormatter: GaugeInnerLabelFormatCallback | undefined;
|
|
783
872
|
/**
|
|
784
873
|
* Callback function used to format the axes guides tooltip. If the returned string contains HTML tags they will be interpreted as such.
|
|
785
874
|
*
|
|
875
|
+
* @example
|
|
876
|
+
* ```ts
|
|
877
|
+
* // Render a custom tooltip with the guide's start and end values.
|
|
878
|
+
* chartElement.guideTooltipFormatter = (props) => {
|
|
879
|
+
* return `
|
|
880
|
+
* <u>Custom guide tooltip</u><br />
|
|
881
|
+
* Range: <b>${props.start} - ${props.end}</b>
|
|
882
|
+
* `;
|
|
883
|
+
* };
|
|
884
|
+
* ```
|
|
885
|
+
*
|
|
886
|
+
* <img
|
|
887
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/guideTooltipFormatter.avif"
|
|
888
|
+
* alt="guideTooltipFormatter"
|
|
889
|
+
* style="max-width: 700px; width: 100%; height: auto;"
|
|
890
|
+
* />
|
|
891
|
+
*
|
|
786
892
|
* **Note**: Not applicable to pie charts.
|
|
787
893
|
*/
|
|
788
894
|
accessor guideTooltipFormatter: GuideTooltipFormatCallback | undefined;
|
|
@@ -804,27 +910,28 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
804
910
|
*/
|
|
805
911
|
accessor hideLicenseWatermark: boolean | undefined;
|
|
806
912
|
/**
|
|
807
|
-
*
|
|
913
|
+
* When `true`, the loader animation is hidden when the chart is being created or updated. By default, it is shown at chart creation and each update (if it takes more than 300ms).
|
|
914
|
+
* | When `hideLoaderAnimation` is `true` | When `hideLoaderAnimation` is `false` |
|
|
915
|
+
* | -------- | -------- |
|
|
916
|
+
* | <video src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/hideLoaderAnimationTrue.webm" aria-label="animationEnabled" width="720" autoPlay loop muted playsInline/> | <video src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/hideLoaderAnimationFalse.webm" aria-label="animationEnabled" width="720" autoPlay loop muted playsInline/>
|
|
808
917
|
*
|
|
809
918
|
* @default false
|
|
810
919
|
*/
|
|
811
920
|
accessor hideLoaderAnimation: boolean;
|
|
812
921
|
/**
|
|
813
|
-
*
|
|
922
|
+
* When set to `true`, UI messages are hidden. These messages can be no data warnings, any placeholder messages set or invalid chart configuration.
|
|
923
|
+
* By default, its value is `false`, which displays the messages on the chart.
|
|
814
924
|
*
|
|
815
925
|
* @default false
|
|
816
926
|
* @since 5.1
|
|
817
927
|
*/
|
|
818
928
|
accessor hideUIMessages: boolean;
|
|
819
929
|
/**
|
|
820
|
-
*
|
|
930
|
+
* When `true`, missing categories from a `Count` aggregation are kept as gaps in the chart's data.
|
|
821
931
|
*
|
|
822
|
-
* When data is retrieved from the server,
|
|
932
|
+
* When data is retrieved from the server, features with a count of 0 are excluded from the response, resulting in missing chart entries.
|
|
823
933
|
*
|
|
824
|
-
*
|
|
825
|
-
*
|
|
826
|
-
* When left to `false`, the chart's dataItems associated with empty (no value) categories (from only a `Count` aggregation)
|
|
827
|
-
* will be populated with 0s.
|
|
934
|
+
* By default, the chart's [WebChartGenericDataItem](https://developers.arcgis.com/javascript/latest/references/charts-components/spec/data-source/#WebChartGenericDataItem-dataItems) associated with empty categories (from only a `Count` aggregation) are populated with 0s.
|
|
828
935
|
*
|
|
829
936
|
* @default false
|
|
830
937
|
* @since 5.1
|
|
@@ -846,18 +953,18 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
846
953
|
*/
|
|
847
954
|
accessor ignoreSmoothRenderingLimit: boolean;
|
|
848
955
|
/**
|
|
849
|
-
*
|
|
956
|
+
* When `true`, it signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.
|
|
850
957
|
*
|
|
851
|
-
*
|
|
852
|
-
* geometry passed through the model (`component.model.dataFilters`) or the runtime filters (`component.runtimeDataFilters`).
|
|
958
|
+
* This property will be effective when the component's [view](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#view) property is provided or when the [layer](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#layer) property is set to [`FeatureLayerView`](/references/core/views/layers/FeatureLayerView/).
|
|
853
959
|
*
|
|
854
|
-
*
|
|
960
|
+
* By default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any
|
|
961
|
+
* geometry filters passed through the [model](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#model) or the [runtimeDataFilters](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#runtimeDataFilters) properties.
|
|
855
962
|
*
|
|
856
963
|
* @default false
|
|
857
964
|
*/
|
|
858
965
|
accessor ignoreViewExtent: boolean;
|
|
859
966
|
/**
|
|
860
|
-
*
|
|
967
|
+
* When `true`, all interactions such as zooming and selection are disabled on the chart. The chart will be rendered in a read-only state.
|
|
861
968
|
*
|
|
862
969
|
* @default false
|
|
863
970
|
*/
|
|
@@ -866,7 +973,7 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
866
973
|
* Used to perform queries.
|
|
867
974
|
* If the layer is a `FeatureLayerView` or if the layer and the `view` property are both provided, the queries will be executed client-side.
|
|
868
975
|
*/
|
|
869
|
-
accessor layer:
|
|
976
|
+
accessor layer: ChartLayerInput | FeatureLayerView | undefined;
|
|
870
977
|
/**
|
|
871
978
|
* Allows the chart to update automatically when the layer's `fields` property changes.
|
|
872
979
|
*
|
|
@@ -882,11 +989,12 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
882
989
|
*/
|
|
883
990
|
accessor layerFilterChangePolicy: LayerFilterChangePolicy;
|
|
884
991
|
/**
|
|
885
|
-
* Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property.
|
|
992
|
+
* Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property. If `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.
|
|
886
993
|
*
|
|
887
|
-
*
|
|
994
|
+
* The layer item ID can be found in the URL of the layer's item page on ArcGIS Online or Enterprise.
|
|
995
|
+
* For example, in the URL `https://www.arcgis.com/home/item.html?id=8871626e970a4f3e9d6113ec63a92f2f`, the layer item ID is `8871626e970a4f3e9d6113ec63a92f2f`.
|
|
888
996
|
*
|
|
889
|
-
* Supported
|
|
997
|
+
* Supported layer types include: [`FeatureLayer`](/references/core/layers/FeatureLayer), [`SubtypeSublayer`](/references/core/layers/support/SubtypeSublayer), [`ImageryLayer`](/references/core/layers/ImageryLayer), [`ImageryTileLayer`](/references/core/layers/ImageryTileLayer) and [`WCSLayer`](/references/core/layers/WCSLayer).
|
|
890
998
|
*
|
|
891
999
|
* @example
|
|
892
1000
|
* ```html
|
|
@@ -903,6 +1011,15 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
903
1011
|
* @default "refresh"
|
|
904
1012
|
*/
|
|
905
1013
|
accessor layerRendererChangePolicy: LayerRendererChangePolicy;
|
|
1014
|
+
/**
|
|
1015
|
+
* When `true`, disables the toggling of series or slices from the legend items. Clicking on the legend items will not hide or show the corresponding elements on the chart.
|
|
1016
|
+
*
|
|
1017
|
+
* **Note**: Only applicable to charts with multiple series and while the legend is displayed.
|
|
1018
|
+
*
|
|
1019
|
+
* @default false
|
|
1020
|
+
* @since 5.2
|
|
1021
|
+
*/
|
|
1022
|
+
accessor legendInteractionsDisabled: boolean | undefined;
|
|
906
1023
|
/**
|
|
907
1024
|
* Sets the legend's position on the chart.
|
|
908
1025
|
*
|
|
@@ -912,8 +1029,28 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
912
1029
|
*/
|
|
913
1030
|
accessor legendPosition: WebChartLegendPositions | undefined;
|
|
914
1031
|
/**
|
|
915
|
-
*
|
|
916
|
-
*
|
|
1032
|
+
* When the pie chart label contains either a numeric value or a percentage (which can be set through the
|
|
1033
|
+
* [displayNumericValueOnLegendItems](https://developers.arcgis.com/javascript/latest/references/charts-components/model/pie-chart-model/pie-chart-model/#displayNumericValueOnLegendItems) and
|
|
1034
|
+
* [displayPercentageOnLegendItems](https://developers.arcgis.com/javascript/latest/references/charts-components/model/pie-chart-model/pie-chart-model/#displayPercentageOnLegendItems) properties from the pie chart model), this property
|
|
1035
|
+
* can be used to format the numeric value and/or percentage. If the returned string contains HTML tags they will be interpreted as such.
|
|
1036
|
+
*
|
|
1037
|
+
* @example
|
|
1038
|
+
* ```ts
|
|
1039
|
+
* // Set the pie chart model to display both numeric value and percentage.
|
|
1040
|
+
* pieChartModel.displayNumericValueOnLegendItems = true;
|
|
1041
|
+
* pieChartModel.displayPercentageOnLegendItems = true;
|
|
1042
|
+
*
|
|
1043
|
+
* // Render the numeric value and percentage in bold and italic respectively, with 2 decimal places.
|
|
1044
|
+
* chartElement.legendValueLabelFormatter = (value, percentage) => {
|
|
1045
|
+
* return `<strong><u>${Number(value).toFixed(2)}</u></strong> (<em>${Number(percentage).toFixed(2)}%</em>)`;
|
|
1046
|
+
* };
|
|
1047
|
+
* ```
|
|
1048
|
+
*
|
|
1049
|
+
* <img
|
|
1050
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/legendValueLabelFormatter.avif"
|
|
1051
|
+
* alt="legendValueLabelFormatter"
|
|
1052
|
+
* style="max-width: 400px; width: 100%; height: auto;"
|
|
1053
|
+
* />
|
|
917
1054
|
*
|
|
918
1055
|
* **Note**: Applicable to pie charts only.
|
|
919
1056
|
*/
|
|
@@ -938,8 +1075,30 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
938
1075
|
* ```
|
|
939
1076
|
*/
|
|
940
1077
|
accessor loaderColors: LoaderColors | undefined;
|
|
941
|
-
/**
|
|
942
|
-
|
|
1078
|
+
/**
|
|
1079
|
+
* Custom messages for translated strings on the chart. If the returned string contains HTML tags they will be interpreted as such.
|
|
1080
|
+
*
|
|
1081
|
+
* The customizable messages can be found thru the [`CommonStringsIdentity`](/references/charts-components/utils/localization/interfaces/#CommonStringsIdentity) variable.
|
|
1082
|
+
*
|
|
1083
|
+
* @example
|
|
1084
|
+
* ```ts
|
|
1085
|
+
* // User sets the xAxisField to a field that doesn't exist in the dataset.
|
|
1086
|
+
* barChartModel.xAxisField = "wrong_field_name";
|
|
1087
|
+
*
|
|
1088
|
+
* // Overrides the default message when there's a query error instead of displaying the default "Failure to read input data." message.
|
|
1089
|
+
* chartElement.messageOverrides = {
|
|
1090
|
+
* errorStrings: {
|
|
1091
|
+
* errors: {
|
|
1092
|
+
* queryError:
|
|
1093
|
+
* "<b><u>The input data provided is invalid, please ensure the xAxisField is correctly specified.</u></b>"
|
|
1094
|
+
* },
|
|
1095
|
+
* },
|
|
1096
|
+
* };
|
|
1097
|
+
* ```
|
|
1098
|
+
*
|
|
1099
|
+
* 
|
|
1100
|
+
*/
|
|
1101
|
+
accessor messageOverrides: {
|
|
943
1102
|
utilsStrings?: {
|
|
944
1103
|
chartType?: {
|
|
945
1104
|
chart?: string | undefined;
|
|
@@ -1077,6 +1236,10 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1077
1236
|
twoTemporalSeriesLineCountCannotExceedLimit?: string | undefined;
|
|
1078
1237
|
threePlusTemporalSeriesLineCountCannotExceedLimit?: string | undefined;
|
|
1079
1238
|
lineSeriesCountCannotExceedLimit?: string | undefined;
|
|
1239
|
+
uniqueSeriesRadarCountCannotExceedLimit?: string | undefined;
|
|
1240
|
+
twoSeriesRadarCountCannotExceedLimit?: string | undefined;
|
|
1241
|
+
threePlusSeriesRadarCountCannotExceedLimit?: string | undefined;
|
|
1242
|
+
radarSeriesCountCannotExceedLimit?: string | undefined;
|
|
1080
1243
|
uniqueSeriesBoxCountCannotExceedLimit?: string | undefined;
|
|
1081
1244
|
twoSeriesBoxCountCannotExceedLimit?: string | undefined;
|
|
1082
1245
|
threePlusBoxLineCountCannotExceedLimit?: string | undefined;
|
|
@@ -1206,25 +1369,42 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1206
1369
|
"Unable to load file: %1"?: string | undefined;
|
|
1207
1370
|
"Invalid date"?: string | undefined;
|
|
1208
1371
|
} | undefined;
|
|
1209
|
-
};
|
|
1372
|
+
} & { chartNotFoundWarning?: string | undefined; };
|
|
1210
1373
|
/**
|
|
1211
1374
|
* Provides an API to interact with the chart's configuration.
|
|
1212
1375
|
*
|
|
1213
|
-
*
|
|
1376
|
+
* `model` accepts either a [ChartModel](https://developers.arcgis.com/javascript/latest/references/charts-components/model/chart-model/chart-model/) instance or a [WebChart](https://developers.arcgis.com/javascript/latest/references/charts-components/spec/web-chart/#WebChart) object.
|
|
1377
|
+
* - `ChartModel`: A chart model class instance, which can be created using the [createModel](https://developers.arcgis.com/javascript/latest/references/charts-components/model/shared/setup-utils/#createModel) function.
|
|
1378
|
+
* - This is the recommended approach as it ensures the chart configuration is valid and compatible with the component.
|
|
1379
|
+
* - `WebChart`: A plain chart configuration object that follows the [WebChart](https://developers.arcgis.com/javascript/latest/references/charts-components/spec/web-chart/#WebChart) specification.
|
|
1380
|
+
*
|
|
1381
|
+
* @see [Create a new chart with charts model](https://developers.arcgis.com/javascript/latest/charts/#create-a-new-chart-with-charts-model)
|
|
1214
1382
|
*/
|
|
1215
1383
|
accessor model: ChartModel | WebChart | undefined;
|
|
1216
1384
|
/**
|
|
1217
|
-
*
|
|
1218
|
-
*
|
|
1219
|
-
*
|
|
1385
|
+
* When `true`, null values are considered as valid.
|
|
1386
|
+
*
|
|
1387
|
+
* By default, when the data contains only null values, the chart dataset is considered empty:
|
|
1388
|
+
* - The [@arcgisBadDataWarningRaise](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisBadDataWarningRaise) event will be sent.
|
|
1389
|
+
* - The "No data available to display" warning message will be displayed in the chart container.
|
|
1220
1390
|
*
|
|
1221
1391
|
* @default false
|
|
1222
1392
|
*/
|
|
1223
1393
|
accessor nullAsValid: boolean;
|
|
1224
|
-
/**
|
|
1394
|
+
/**
|
|
1395
|
+
* Placeholder text displayed in the chart container when no chart is configured.
|
|
1396
|
+
* If the string contains HTML tags they will be interpreted as such.
|
|
1397
|
+
*
|
|
1398
|
+
* @example
|
|
1399
|
+
* ```ts
|
|
1400
|
+
* chartElement.placeholder = "<strong>Welcome!</strong><br/>Read the <a href=\"https://developers.arcgis.com/javascript/latest/charts/charts-intro/\">charts introduction page</a> to get started.";
|
|
1401
|
+
* ```
|
|
1402
|
+
*
|
|
1403
|
+
* 
|
|
1404
|
+
*/
|
|
1225
1405
|
accessor placeholder: string | undefined;
|
|
1226
1406
|
/**
|
|
1227
|
-
*
|
|
1407
|
+
* When `true`, field aliases from layer's [popupTemplate](/references/core/layers/FeatureLayer/#popupTemplate) are used to render field names in tooltips, axes and legend on the chart.
|
|
1228
1408
|
*
|
|
1229
1409
|
* @default false
|
|
1230
1410
|
*/
|
|
@@ -1245,12 +1425,13 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1245
1425
|
*/
|
|
1246
1426
|
accessor replaceNoValueCategoryWithZero: boolean | undefined;
|
|
1247
1427
|
/**
|
|
1248
|
-
* When `true`, the
|
|
1428
|
+
* When `true`, the feature extent is returned in the payload of [@arcgisDataProcessComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisDataProcessComplete)
|
|
1429
|
+
* and [@arcgisSelectionComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisSelectionComplete) events.
|
|
1249
1430
|
* Applies only to:
|
|
1250
1431
|
* - Charts using an aggregation.
|
|
1251
|
-
* - Data
|
|
1432
|
+
* - Data sources using a feature layer compatible with envelope aggregation.
|
|
1252
1433
|
*
|
|
1253
|
-
* The extent
|
|
1434
|
+
* The extent is returned through the [featuresExtentField](https://developers.arcgis.com/javascript/latest/references/charts-components/utils/defaults/index/#featuresExtentField) variable.
|
|
1254
1435
|
*
|
|
1255
1436
|
* **Note**: Not applicable to gauges.
|
|
1256
1437
|
*
|
|
@@ -1258,7 +1439,7 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1258
1439
|
*/
|
|
1259
1440
|
accessor returnFeaturesExtent: boolean;
|
|
1260
1441
|
/**
|
|
1261
|
-
* When `true`,
|
|
1442
|
+
* When `true`, selection indexes are computed and returned whenever a selection is made on or passed to the chart.
|
|
1262
1443
|
*
|
|
1263
1444
|
* **Note**: Not applicable to gauges.
|
|
1264
1445
|
*
|
|
@@ -1266,10 +1447,10 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1266
1447
|
*/
|
|
1267
1448
|
accessor returnSelectionIndexes: boolean;
|
|
1268
1449
|
/**
|
|
1269
|
-
* When `true`,
|
|
1270
|
-
* Only considered for
|
|
1450
|
+
* When `true`, object ids are computed and returned whenever a selection is made on or passed to the chart.
|
|
1451
|
+
* Only considered for data sources using a [feature layer](/references/core/layers/FeatureLayer).
|
|
1271
1452
|
*
|
|
1272
|
-
* **Note**: Not applicable to gauges or charts configured with imagery layers.
|
|
1453
|
+
* **Note**: Not applicable to gauges or charts configured with imagery layers.
|
|
1273
1454
|
*
|
|
1274
1455
|
* @default false
|
|
1275
1456
|
*/
|
|
@@ -1277,7 +1458,7 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1277
1458
|
/**
|
|
1278
1459
|
* When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.
|
|
1279
1460
|
*
|
|
1280
|
-
* **Note**: Applicable to bar
|
|
1461
|
+
* **Note**: Applicable to bar charts, box plots, combo bar line charts and line charts.
|
|
1281
1462
|
*
|
|
1282
1463
|
* @default false
|
|
1283
1464
|
*/
|
|
@@ -1292,12 +1473,29 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1292
1473
|
*/
|
|
1293
1474
|
accessor rotation: boolean;
|
|
1294
1475
|
/**
|
|
1295
|
-
* Applies runtime data filters to the chart.
|
|
1476
|
+
* Applies runtime data filters to the chart, features will be filtered based on the provided key value pairs.
|
|
1477
|
+
*
|
|
1478
|
+
* Supported keys are `where`, `objectIds`, `geometry`, `spatialRelationship`, `distance`, `units`, `timeExtent`, and `gdbVersion`.
|
|
1296
1479
|
*
|
|
1297
1480
|
* @example
|
|
1298
1481
|
* ```ts
|
|
1482
|
+
* // This example filters the chart to show only features with the name "Katrina", object IDs 12, 19, and 27, within a specified geometry, within 10 miles and a specific time extent.
|
|
1483
|
+
* const start = new Date(2005, 8, 23).getTime();
|
|
1484
|
+
* const end = new Date(2005, 8, 28).getTime();
|
|
1485
|
+
*
|
|
1299
1486
|
* chartComponent.runtimeDataFilters = {
|
|
1300
|
-
* where: "
|
|
1487
|
+
* where: "Name = 'Katrina'",
|
|
1488
|
+
* objectIds: [12, 19, 27],
|
|
1489
|
+
* geometry: {
|
|
1490
|
+
* xmin: -130,
|
|
1491
|
+
* ymin: 20,
|
|
1492
|
+
* xmax: -60,
|
|
1493
|
+
* ymax: 55,
|
|
1494
|
+
* },
|
|
1495
|
+
* spatialRelationship: "contains",
|
|
1496
|
+
* distance: 10,
|
|
1497
|
+
* units: "miles",
|
|
1498
|
+
* timeExtent: [start, end]
|
|
1301
1499
|
* };
|
|
1302
1500
|
* ```
|
|
1303
1501
|
*/
|
|
@@ -1305,11 +1503,67 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1305
1503
|
/**
|
|
1306
1504
|
* Callback function used to format the secondary y-axis labels. If the returned string contains HTML tags they will be interpreted as such.
|
|
1307
1505
|
*
|
|
1308
|
-
*
|
|
1506
|
+
* @example
|
|
1507
|
+
* ```ts
|
|
1508
|
+
* // Render a custom secondary y-axis label with the value formatted as a compact currency.
|
|
1509
|
+
* chartElement.secondaryYAxisLabelFormatter = (value) => {
|
|
1510
|
+
* const formattedValue = new Intl.NumberFormat("en-US", {
|
|
1511
|
+
* style: "currency",
|
|
1512
|
+
* currency: "USD",
|
|
1513
|
+
* notation: "compact",
|
|
1514
|
+
* maximumFractionDigits: 1,
|
|
1515
|
+
* }).format(value);
|
|
1516
|
+
* return `<strong>${formattedValue}</strong>`;
|
|
1517
|
+
* };
|
|
1518
|
+
* ```
|
|
1519
|
+
*
|
|
1520
|
+
* 
|
|
1521
|
+
*
|
|
1522
|
+
* **Note**: Applicable to bar, line, and combo bar line charts configured with dual axes through the [setSeriesToSecondaryYAxis](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#setSeriesToSecondaryYAxis) method.
|
|
1309
1523
|
*/
|
|
1310
1524
|
accessor secondaryYAxisLabelFormatter: AxisLabelFormatCallback | undefined;
|
|
1311
1525
|
/**
|
|
1312
|
-
*
|
|
1526
|
+
* Applies a programmatic selection to the chart. The payload can target chart elements by object IDs (`selectionOIDs`), by indexes (`selectionIndexes`), or by items (`selectionItems`).
|
|
1527
|
+
*
|
|
1528
|
+
* ##### Selection by object IDs
|
|
1529
|
+
* When passing in a `selectionOIDs` array, the chart will match the provided object IDs with the chart's data items and apply the selection.
|
|
1530
|
+
*
|
|
1531
|
+
* @example
|
|
1532
|
+
* ```ts
|
|
1533
|
+
* // This selects the chart data items (`Mid East` and `Great Lakes`) that contains the object IDs "3118" and "6544".
|
|
1534
|
+
* chartElement.selectionData = {
|
|
1535
|
+
* selectionOIDs: [3118, 6544],
|
|
1536
|
+
* };
|
|
1537
|
+
* ```
|
|
1538
|
+
*
|
|
1539
|
+
* <img
|
|
1540
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionData_selectionOIDs.avif"
|
|
1541
|
+
* alt="selectionOIDs"
|
|
1542
|
+
* style="max-width: 600px; width: 100%; height: auto;"
|
|
1543
|
+
* />
|
|
1544
|
+
*
|
|
1545
|
+
* ##### Selection by items
|
|
1546
|
+
* When passing in a `selectionItems` array, the chart will match the provided items with the chart's data items and apply the selection.
|
|
1547
|
+
* @example
|
|
1548
|
+
* ```ts
|
|
1549
|
+
* // This selects the first chart data item with the matching items.
|
|
1550
|
+
* chartElement.selectionData = {
|
|
1551
|
+
* selectionItems: [
|
|
1552
|
+
* {
|
|
1553
|
+
* // The field name and value
|
|
1554
|
+
* neighbourhood_group: "Manhattan",
|
|
1555
|
+
* // The y-series field name and value, 0 indicates the first series.
|
|
1556
|
+
* COUNT_OBJECTID_0: "",
|
|
1557
|
+
* },
|
|
1558
|
+
* ],
|
|
1559
|
+
* };
|
|
1560
|
+
* ```
|
|
1561
|
+
*
|
|
1562
|
+
* <img
|
|
1563
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionData_selectionItems.avif"
|
|
1564
|
+
* alt="selectionItems"
|
|
1565
|
+
* style="max-width: 600px; width: 100%; height: auto;"
|
|
1566
|
+
* />
|
|
1313
1567
|
*
|
|
1314
1568
|
* **Note**: Not applicable to gauges.
|
|
1315
1569
|
*/
|
|
@@ -1322,77 +1576,120 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1322
1576
|
*/
|
|
1323
1577
|
accessor selectionManager: SelectionManager | undefined;
|
|
1324
1578
|
/**
|
|
1325
|
-
*
|
|
1326
|
-
* - If no style is provided for the selected elements, a default selection is applied.
|
|
1327
|
-
* - If no style is provided for the non selected elements, the chart's style is applied.
|
|
1579
|
+
* Customizes the visual style applied to selected and non-selected chart data items (bars, slices, markers, boxes etc.).
|
|
1328
1580
|
*
|
|
1329
|
-
*
|
|
1581
|
+
* - The [`selectedElementsTheme`](/references/charts-components/utils/misc/interfaces/#SelectionTheme-selectedElementsTheme) property controls the appearance of selected elements.
|
|
1582
|
+
* - The [`nonSelectedElementsTheme`](/references/charts-components/utils/misc/interfaces/#SelectionTheme-nonSelectedElementsTheme) property controls the appearance of elements that are not selected.
|
|
1330
1583
|
*
|
|
1331
1584
|
* @example
|
|
1332
1585
|
* ```ts
|
|
1333
|
-
*
|
|
1334
|
-
*
|
|
1335
|
-
*
|
|
1336
|
-
*
|
|
1337
|
-
*
|
|
1586
|
+
* chartElement.selectionTheme = {
|
|
1587
|
+
* // The selected elements will have a magenta outline with a width of 3 pixels and will be scaled up by 10%.
|
|
1588
|
+
* selectedElementsTheme: {
|
|
1589
|
+
* elementOutlineColor: [255, 0, 237, 255],
|
|
1590
|
+
* elementOutlineWidth: 3,
|
|
1591
|
+
* transformation: {
|
|
1592
|
+
* scale: 1.1,
|
|
1593
|
+
* },
|
|
1594
|
+
* },
|
|
1595
|
+
* // The non-selected elements will be scaled down by 20% and have their opacity reduced to 50%.
|
|
1596
|
+
* nonSelectedElementsTheme: {
|
|
1597
|
+
* transformation: {
|
|
1598
|
+
* scale: 0.8,
|
|
1599
|
+
* opacity: 0.5,
|
|
1600
|
+
* },
|
|
1338
1601
|
* },
|
|
1339
|
-
*
|
|
1340
|
-
* "transformation": {
|
|
1341
|
-
* "opacity": 0.5
|
|
1342
|
-
* }
|
|
1343
|
-
* }
|
|
1344
|
-
* }
|
|
1602
|
+
* };
|
|
1345
1603
|
* ```
|
|
1604
|
+
*
|
|
1605
|
+
* <img
|
|
1606
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionTheme.avif"
|
|
1607
|
+
* alt="selectionTheme"
|
|
1608
|
+
* style="max-width: 700px; width: 100%; height: auto;"
|
|
1609
|
+
* />
|
|
1610
|
+
*
|
|
1611
|
+
* **Note**: Not applicable to gauges.
|
|
1346
1612
|
*/
|
|
1347
1613
|
accessor selectionTheme: SelectionTheme | undefined;
|
|
1348
1614
|
/**
|
|
1349
|
-
* When `true`, the
|
|
1615
|
+
* When `true`, the time binning unit and size is automatically set when not provided via the [`temporalBinningSize`](/references/charts-components/model/bar-chart-model/bar-chart-model/#temporalBinningSize) or [`temporalBinningUnit`](/references/charts-components/model/line-chart-model/line-chart-model/#temporalBinningUnit) properties of the chart model.
|
|
1350
1616
|
*
|
|
1351
|
-
*
|
|
1617
|
+
* The time binning unit and size information for the chart will be derived from the dataset's date minimum and maximum values to compute an interval that best fits the date range.
|
|
1618
|
+
*
|
|
1619
|
+
* **Note**: Only applicable to charts with temporal binning enabled (bar chart, combo bar line chart, line chart, radar chart).
|
|
1352
1620
|
*
|
|
1353
1621
|
* @default false
|
|
1354
1622
|
*/
|
|
1355
1623
|
accessor setTimeBinningInfoWhenNotProvided: boolean;
|
|
1356
1624
|
/**
|
|
1357
|
-
*
|
|
1358
|
-
*
|
|
1359
|
-
* When `false`, the empty series are completely hidden from the chart and the legend.
|
|
1360
|
-
* For example a series can be empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).
|
|
1625
|
+
* When `true`, show the series on the chart and legend even if it doesn't contain any data.
|
|
1361
1626
|
*
|
|
1362
|
-
*
|
|
1627
|
+
* By default, the empty series are hidden from the chart and the legend.
|
|
1363
1628
|
*
|
|
1364
1629
|
* @default false
|
|
1630
|
+
* @example
|
|
1631
|
+
* ```ts
|
|
1632
|
+
* // In this example, we first set a data filter to only include features with a room type of "Entire home/apt" or "Private room".
|
|
1633
|
+
* // The "Shared room" series will be empty after applying the data filter.
|
|
1634
|
+
* chartElement.runtimeDataFilters = {
|
|
1635
|
+
* where: "room_type = 'Entire home/apt' OR room_type = 'Private room'",
|
|
1636
|
+
* };
|
|
1637
|
+
*
|
|
1638
|
+
* // With the `showEmptySeries` property set to `true`,
|
|
1639
|
+
* // the "Shared room" series will still be displayed on the chart and in the legend, even though it was filtered out.
|
|
1640
|
+
* chartElement.showEmptySeries = true;
|
|
1641
|
+
* ```
|
|
1642
|
+
*
|
|
1643
|
+
* <img
|
|
1644
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/showEmptySeries.avif"
|
|
1645
|
+
* alt="showEmptySeries"
|
|
1646
|
+
* style="max-width: 700px; width: 100%; height: auto;"
|
|
1647
|
+
* />
|
|
1648
|
+
*
|
|
1649
|
+
* **Note**: Not applicable to gauges.
|
|
1365
1650
|
* @since 5.1
|
|
1366
1651
|
*/
|
|
1367
1652
|
accessor showEmptySeries: boolean;
|
|
1368
1653
|
/**
|
|
1369
|
-
*
|
|
1654
|
+
* When `true`, the license watermark is displayed on the lower left corner of the chart.
|
|
1370
1655
|
*
|
|
1656
|
+
* @deprecated since 5.2. Won't be replaced.
|
|
1371
1657
|
* @default false
|
|
1372
1658
|
* @since 5.1
|
|
1373
1659
|
*/
|
|
1374
1660
|
accessor showLicenseWatermark: boolean;
|
|
1375
1661
|
/**
|
|
1376
|
-
* Whether to display or hide all UI messages (e.g. no data warnings,
|
|
1662
|
+
* Whether to display or hide all UI messages (e.g. no data warnings, any placeholder messages set or invalid chart configuration).
|
|
1377
1663
|
*
|
|
1378
1664
|
* @deprecated since 5.1. Use [hideUIMessages](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideUIMessages) instead.
|
|
1379
1665
|
* @default false
|
|
1380
1666
|
*/
|
|
1381
1667
|
accessor showUIMessages: boolean | undefined;
|
|
1382
1668
|
/**
|
|
1383
|
-
* Whether to skip the chart rendering queue.
|
|
1384
|
-
*
|
|
1385
1669
|
* When `true`, charts will render immediately without waiting for other charts to finish rendering.
|
|
1386
|
-
*
|
|
1670
|
+
* By default, charts are queued so that only one chart renders at a time.
|
|
1387
1671
|
*
|
|
1388
1672
|
* @default false
|
|
1389
1673
|
* @since 5.1
|
|
1390
1674
|
*/
|
|
1391
1675
|
accessor skipChartCreationQueue: boolean;
|
|
1392
1676
|
/**
|
|
1393
|
-
*
|
|
1677
|
+
* When `true`, the selection will be synchronized between charts configured with the same layer.
|
|
1394
1678
|
*
|
|
1395
1679
|
* @default false
|
|
1680
|
+
* @example
|
|
1681
|
+
* ```ts
|
|
1682
|
+
* // Both charts are configured with the same layer.
|
|
1683
|
+
* // The "Private room" slice is selected on the pie chart and the selection is reflected on the bar chart.
|
|
1684
|
+
* chartElement1.syncChartsSelection = true;
|
|
1685
|
+
* chartElement2.syncChartsSelection = true;
|
|
1686
|
+
* ```
|
|
1687
|
+
*
|
|
1688
|
+
* <img
|
|
1689
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/syncChartsSelection.avif"
|
|
1690
|
+
* alt="syncChartsSelection"
|
|
1691
|
+
* style="max-width: 700px; width: 100%; height: auto;"
|
|
1692
|
+
* />
|
|
1396
1693
|
* @since 5.1
|
|
1397
1694
|
*/
|
|
1398
1695
|
accessor syncChartsSelection: boolean;
|
|
@@ -1455,33 +1752,41 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1455
1752
|
*/
|
|
1456
1753
|
accessor timeZone: MapView["timeZone"] | undefined;
|
|
1457
1754
|
/**
|
|
1458
|
-
*
|
|
1755
|
+
* When `true`, disables the toggling of series or slices from the legend items. Clicking on the legend items will not hide or show the corresponding elements on the chart.
|
|
1459
1756
|
*
|
|
1460
|
-
* **Note**: Only applicable to
|
|
1757
|
+
* **Note**: Only applicable to charts with multiple series and while the legend is displayed.
|
|
1461
1758
|
*
|
|
1759
|
+
* @deprecated since 5.2. Use [legendInteractionsDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#legendInteractionsDisabled) instead.
|
|
1462
1760
|
* @default false
|
|
1463
1761
|
*/
|
|
1464
1762
|
accessor togglingLegendItemsDisabled: boolean | undefined;
|
|
1465
1763
|
/**
|
|
1466
|
-
* Callback function used to format the tooltips. If the returned string contains HTML tags they will be interpreted as such.
|
|
1764
|
+
* Callback function used to format the tooltips when hovering over a chart element. If the returned string contains HTML tags they will be interpreted as such.
|
|
1467
1765
|
*
|
|
1468
1766
|
* @example
|
|
1469
1767
|
* ```ts
|
|
1470
|
-
*
|
|
1471
|
-
*
|
|
1472
|
-
*
|
|
1768
|
+
* // Render a custom tooltip with the series name, x-value, and stat value.
|
|
1769
|
+
* chartElement.tooltipFormatter = (props) => `
|
|
1770
|
+
* <div>
|
|
1771
|
+
* <div><strong>${props.seriesName}</strong> in <strong>${props.xValue}</strong></div>
|
|
1772
|
+
* <div>Total listings: <strong>${props.statValue}</strong></div>
|
|
1773
|
+
* </div>
|
|
1774
|
+
* `;
|
|
1473
1775
|
* ```
|
|
1474
1776
|
*
|
|
1777
|
+
* 
|
|
1778
|
+
*
|
|
1475
1779
|
* **Note**: Not applicable to gauges.
|
|
1476
1780
|
*/
|
|
1477
|
-
accessor tooltipFormatter:
|
|
1781
|
+
accessor tooltipFormatter: TooltipFormatters | undefined;
|
|
1478
1782
|
/**
|
|
1479
|
-
* Whether to
|
|
1480
|
-
*
|
|
1481
|
-
*
|
|
1482
|
-
*
|
|
1783
|
+
* Whether to automatically add the missing series to cover the split-by values not referenced in the configuration.
|
|
1784
|
+
* - This property only applies to plain chart configuration object that's constructed following the [WebChart](https://developers.arcgis.com/javascript/latest/references/charts-components/spec/web-chart/#WebChart) specification.
|
|
1785
|
+
* - When [`addMissingSeries`](/references/charts-components/utils/components/interfaces/#MissingSplitBySeriesProps-addMissingSeries) is set to `true`, the missing series will be added.
|
|
1786
|
+
* - When [`seriesTemplate`](/references/charts-components/utils/components/interfaces/#MissingSplitBySeriesProps-seriesTemplate) is omitted, the first existing series from the configuration will be copied to be used as a model for the missing ones. The chart won't render if the series template is not set and there's no series in the configuration.
|
|
1787
|
+
* - If a chart is configured using a chart model, this property is not necessary as the split-by series will be updated automatically when the model's properties are changed.
|
|
1483
1788
|
*
|
|
1484
|
-
* **Note**: Applicable only to bar chart, line chart and
|
|
1789
|
+
* **Note**: Applicable only to bar chart, box plot, line chart and radar chart when a split-by field is used.
|
|
1485
1790
|
*/
|
|
1486
1791
|
accessor updateSplitBySeries: MissingSplitBySeriesProps | undefined;
|
|
1487
1792
|
/**
|
|
@@ -1513,15 +1818,47 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1513
1818
|
/**
|
|
1514
1819
|
* Callback function used to format the x-axis labels. If the returned string contains HTML tags they will be interpreted as such.
|
|
1515
1820
|
*
|
|
1516
|
-
*
|
|
1821
|
+
* @example
|
|
1822
|
+
* ```ts
|
|
1823
|
+
* // Render a custom x-axis label with underlined string and bolded value.
|
|
1824
|
+
* chartElement.xAxisLabelFormatter = (value) => {
|
|
1825
|
+
* return `<u>Neighbourhood Group:</u> <strong>${value}</strong>`;
|
|
1826
|
+
* };
|
|
1827
|
+
* ```
|
|
1828
|
+
*
|
|
1829
|
+
* 
|
|
1830
|
+
*
|
|
1831
|
+
* **Note**: Only applicable to charts with x-axis labels displayed.
|
|
1517
1832
|
*/
|
|
1518
1833
|
accessor xAxisLabelFormatter: AxisLabelFormatCallback | undefined;
|
|
1519
1834
|
/**
|
|
1520
1835
|
* Callback function used to format the y-axis labels. If the returned string contains HTML tags they will be interpreted as such.
|
|
1521
1836
|
*
|
|
1522
|
-
*
|
|
1837
|
+
* @example
|
|
1838
|
+
* ```ts
|
|
1839
|
+
* // Render a custom y-axis label with underlined string and bolded value.
|
|
1840
|
+
* chartElement.yAxisLabelFormatter = (value) => {
|
|
1841
|
+
* return `<u>Rental Listings:</u> <strong>${value}</strong>`;
|
|
1842
|
+
* };
|
|
1843
|
+
* ```
|
|
1844
|
+
*
|
|
1845
|
+
* 
|
|
1846
|
+
*
|
|
1847
|
+
* **Note**: Only applicable to charts with y-axis labels displayed.
|
|
1523
1848
|
*/
|
|
1524
1849
|
accessor yAxisLabelFormatter: AxisLabelFormatCallback | undefined;
|
|
1850
|
+
/**
|
|
1851
|
+
* When `true`, count=0 is considered a valid statistic.
|
|
1852
|
+
*
|
|
1853
|
+
* By default, when the aggregation type is "count" and the data contains only values equal to 0, the chart dataset
|
|
1854
|
+
* is considered empty:
|
|
1855
|
+
* - The [@arcgisBadDataWarningRaise](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisBadDataWarningRaise) event will be sent.
|
|
1856
|
+
* - The "No data available to display" warning message will be displayed in the chart container.
|
|
1857
|
+
*
|
|
1858
|
+
* @default false
|
|
1859
|
+
* @since 5.2
|
|
1860
|
+
*/
|
|
1861
|
+
accessor zeroCountAsValid: boolean;
|
|
1525
1862
|
/**
|
|
1526
1863
|
* Apply the selection from the selection manager to the chart.
|
|
1527
1864
|
*
|
|
@@ -1535,7 +1872,7 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1535
1872
|
*/
|
|
1536
1873
|
clearSelection(): Promise<void>;
|
|
1537
1874
|
/**
|
|
1538
|
-
* Destroys the chart instance
|
|
1875
|
+
* Destroys the chart instance.
|
|
1539
1876
|
*
|
|
1540
1877
|
* @since 5.1
|
|
1541
1878
|
*/
|
|
@@ -1550,110 +1887,280 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1550
1887
|
/**
|
|
1551
1888
|
* Export the current chart's data as a CSV file.
|
|
1552
1889
|
*
|
|
1553
|
-
* The
|
|
1554
|
-
*
|
|
1555
|
-
*
|
|
1556
|
-
*
|
|
1557
|
-
*
|
|
1558
|
-
*
|
|
1559
|
-
*
|
|
1560
|
-
*
|
|
1561
|
-
*
|
|
1562
|
-
*
|
|
1563
|
-
*
|
|
1564
|
-
*
|
|
1565
|
-
*
|
|
1566
|
-
*
|
|
1567
|
-
*
|
|
1568
|
-
*
|
|
1569
|
-
*
|
|
1570
|
-
*
|
|
1890
|
+
* @param options - The options to customize the exported CSV file.
|
|
1891
|
+
* @example
|
|
1892
|
+
* ```ts
|
|
1893
|
+
* // Export the chart's data as a CSV file with custom options.
|
|
1894
|
+
* await chartElement.exportAsCSV({
|
|
1895
|
+
* columns: ["neighbourhood_group", "room_type", "Count"],
|
|
1896
|
+
* delimiter: "|",
|
|
1897
|
+
* includeHeader: false,
|
|
1898
|
+
* quoteAll: true,
|
|
1899
|
+
* locale: "fr"
|
|
1900
|
+
* });
|
|
1901
|
+
* ```
|
|
1902
|
+
*
|
|
1903
|
+
* ```csv
|
|
1904
|
+
* // The exported CSV file will contain the following data:
|
|
1905
|
+
* sep=|
|
|
1906
|
+
* "Bronx"|"Entire home/apt"|"379"
|
|
1907
|
+
* "Bronx"|"Private room"|"652"
|
|
1908
|
+
* "Bronx"|"Shared room"|"60"
|
|
1909
|
+
* "Brooklyn"|"Entire home/apt"|"9 559"
|
|
1910
|
+
* ...
|
|
1911
|
+
* ```
|
|
1912
|
+
*
|
|
1913
|
+
* **Note**: Not supported for gauges, scatterplots and radar charts.
|
|
1571
1914
|
*/
|
|
1572
1915
|
exportAsCSV(options?: CSVOptions): Promise<void>;
|
|
1573
1916
|
/**
|
|
1574
|
-
* Exports the current chart as an image.
|
|
1575
|
-
* -
|
|
1917
|
+
* Exports and downloads the current chart as an image.
|
|
1918
|
+
* - Supported formats: `png` (default), `jpeg`, `jpg`, `webp`, and `svg`.
|
|
1919
|
+
* - When `webp` format is used on Safari, it will fallback to `png`.
|
|
1576
1920
|
*
|
|
1577
|
-
* @param format
|
|
1921
|
+
* @param format - The image format to export the chart as. Default: `png`.
|
|
1578
1922
|
*/
|
|
1579
1923
|
exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>;
|
|
1580
|
-
/**
|
|
1924
|
+
/**
|
|
1925
|
+
* Returns a promise that resolves when the chart model is fully loaded.
|
|
1926
|
+
*
|
|
1927
|
+
* This method should be used when loading a chart with [layerItemId](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#layerItemId) and [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex), and further customization of the chart model is needed.
|
|
1928
|
+
*
|
|
1929
|
+
* @example
|
|
1930
|
+
* ```html
|
|
1931
|
+
* // Load a chart from a layer item
|
|
1932
|
+
* <arcgis-chart layer-item-id="8871626e970a4f3e9d6113ec63a92f2f" chart-index="2" />
|
|
1933
|
+
* ```
|
|
1934
|
+
* ```ts
|
|
1935
|
+
* // Get a reference to the chart element in the DOM
|
|
1936
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
1937
|
+
*
|
|
1938
|
+
* // Call the method to ensure the model is fully loaded before making changes
|
|
1939
|
+
* await chartElement.loadModel();
|
|
1940
|
+
*
|
|
1941
|
+
* // Once the model is loaded, use the model's properties/methods to customize
|
|
1942
|
+
* chartElement.model.titleText = "New Title";
|
|
1943
|
+
* ```
|
|
1944
|
+
* @see [Load from layer item and customize with charts model](https://developers.arcgis.com/javascript/latest/charts/#load-from-layer-item-and-customize-with-charts-model)
|
|
1945
|
+
*/
|
|
1581
1946
|
loadModel(): Promise<void>;
|
|
1582
1947
|
/**
|
|
1583
|
-
*
|
|
1584
|
-
*
|
|
1585
|
-
* In a situation where a model update is overriding the notification modal, consider waiting for the [@arcgisUpdateComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisUpdateComplete) event.
|
|
1948
|
+
* Passes external messages to the chart component and displays them in the chart's container.
|
|
1949
|
+
* When a model update is overriding the notification modal, consider waiting for the [@arcgisUpdateComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisUpdateComplete) event.
|
|
1586
1950
|
*
|
|
1587
|
-
* @param message - The message to display in the chart's
|
|
1588
|
-
* @param heading - The heading to display in the chart's
|
|
1951
|
+
* @param message - The message to display in the chart's container.
|
|
1952
|
+
* @param heading - The heading to display in the chart's container.
|
|
1953
|
+
* @example
|
|
1954
|
+
* ```html
|
|
1955
|
+
* <button id="show-notification" type="button">Show notification</button>
|
|
1956
|
+
* <button id="clear-notification" type="button">Clear notification</button>
|
|
1957
|
+
* ```
|
|
1958
|
+
*
|
|
1959
|
+
* ```ts
|
|
1960
|
+
* // When the "Show notification" button is clicked, the chart's container will display a custom message and heading.
|
|
1961
|
+
* document.querySelector("#show-notification").addEventListener("click", () => {
|
|
1962
|
+
* chartElement.notify(
|
|
1963
|
+
* "This is a notification message.",
|
|
1964
|
+
* "Notification heading",
|
|
1965
|
+
* );
|
|
1966
|
+
* });
|
|
1967
|
+
*
|
|
1968
|
+
* // When the "Clear notification" button is clicked, the chart's container will be cleared and hidden.
|
|
1969
|
+
* document.querySelector("#clear-notification").addEventListener("click", () => {
|
|
1970
|
+
* chartElement.notify();
|
|
1971
|
+
* });
|
|
1972
|
+
* ```
|
|
1589
1973
|
*/
|
|
1590
1974
|
notify(message?: string, heading?: string): Promise<void>;
|
|
1591
1975
|
/**
|
|
1592
1976
|
* Re-render the chart.
|
|
1593
1977
|
*
|
|
1594
|
-
* @param props -
|
|
1978
|
+
* @param props - Properties to control the refresh behavior: `updateData` indicates whether to fetch new data (default: `true`), and `resetAxesBounds` indicates whether to reset the axes bounds along with the refresh (default: `false`).
|
|
1595
1979
|
*/
|
|
1596
1980
|
refresh(props?: {
|
|
1597
1981
|
updateData?: boolean;
|
|
1598
1982
|
resetAxesBounds?: boolean;
|
|
1599
1983
|
}): Promise<void>;
|
|
1600
1984
|
/**
|
|
1601
|
-
* Resets the chart zoom
|
|
1985
|
+
* Resets the chart's zoom and brings it back to full zoom extent.
|
|
1602
1986
|
*
|
|
1603
|
-
* **Note**:
|
|
1987
|
+
* **Note**: Not applicable to gauges, heat charts, pie charts and radar charts.
|
|
1604
1988
|
*/
|
|
1605
1989
|
resetZoom(): Promise<void>;
|
|
1606
1990
|
/**
|
|
1607
1991
|
* Switches the selection on the chart.
|
|
1608
1992
|
*
|
|
1609
|
-
* **Note**: Not applicable to
|
|
1993
|
+
* **Note**: Not applicable to gauges.
|
|
1610
1994
|
*/
|
|
1611
1995
|
switchSelection(): Promise<void>;
|
|
1612
|
-
/**
|
|
1996
|
+
/**
|
|
1997
|
+
* Emitted when the chart's axes minimum or maximum values are computed.
|
|
1998
|
+
*
|
|
1999
|
+
* @example
|
|
2000
|
+
* ```ts
|
|
2001
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
2002
|
+
* chartElement.addEventListener("arcgisAxesMinMaxChange", (event) => {
|
|
2003
|
+
* const { bounds, model } = event.detail;
|
|
2004
|
+
* // Handle the new bounds and model
|
|
2005
|
+
* });
|
|
2006
|
+
* ```
|
|
2007
|
+
*/
|
|
1613
2008
|
readonly arcgisAxesMinMaxChange: import("@arcgis/lumina").TargetedEvent<this, AxesMinMaxChangePayload>;
|
|
1614
|
-
/**
|
|
2009
|
+
/**
|
|
2010
|
+
* Emitted when the chart's data is incompatible with its model. Bad data such as empty dataset, axis logarithmic scale being incompatible with the data will trigger this event.
|
|
2011
|
+
* The event details contain information about the error.
|
|
2012
|
+
*
|
|
2013
|
+
* @example
|
|
2014
|
+
* ```ts
|
|
2015
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
2016
|
+
* chartElement.addEventListener("arcgisBadDataWarningRaise", (event) => {
|
|
2017
|
+
* const { keyword, header, message, params } = event.detail;
|
|
2018
|
+
* // Handle the bad data warning
|
|
2019
|
+
* });
|
|
2020
|
+
* ```
|
|
2021
|
+
*/
|
|
1615
2022
|
readonly arcgisBadDataWarningRaise: import("@arcgis/lumina").TargetedEvent<this, DataWarningObject>;
|
|
1616
|
-
/**
|
|
2023
|
+
/**
|
|
2024
|
+
* Emitted when the chart is not found for the given [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex) property with a valid [layerItemId](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#layerItemId).
|
|
2025
|
+
*
|
|
2026
|
+
* @example
|
|
2027
|
+
* ```ts
|
|
2028
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
2029
|
+
* chartElement.addEventListener("arcgisChartNotFoundWarning", (event) => {
|
|
2030
|
+
* const warningMessage = event.detail;
|
|
2031
|
+
* // Handle the warning message
|
|
2032
|
+
* });
|
|
2033
|
+
* ```
|
|
2034
|
+
*/
|
|
1617
2035
|
readonly arcgisChartNotFoundWarning: import("@arcgis/lumina").TargetedEvent<this, string>;
|
|
1618
|
-
/**
|
|
2036
|
+
/**
|
|
2037
|
+
* Emitted when the chart configuration is changed.
|
|
2038
|
+
*
|
|
2039
|
+
* @example
|
|
2040
|
+
* ```ts
|
|
2041
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
2042
|
+
* chartElement.addEventListener("arcgisConfigChange", (event) => {
|
|
2043
|
+
* const { newConfig, oldConfig, functionCalled } = event.detail;
|
|
2044
|
+
* // Handle the configuration change
|
|
2045
|
+
* });
|
|
2046
|
+
* ```
|
|
2047
|
+
*/
|
|
1619
2048
|
readonly arcgisConfigChange: import("@arcgis/lumina").TargetedEvent<this, {
|
|
1620
2049
|
newConfig: WebChart | undefined;
|
|
1621
2050
|
oldConfig: WebChart | undefined;
|
|
1622
2051
|
functionCalled: string | undefined;
|
|
1623
2052
|
}>;
|
|
1624
2053
|
/**
|
|
1625
|
-
*
|
|
1626
|
-
*
|
|
1627
|
-
* For instance it can be useful to see all the slices before they get grouped into an 'other' slice during the post-processing step.
|
|
2054
|
+
* Emitted once the chart data has been fetched but not yet fully processed. This event can be used to see all the slices before they get grouped into the 'other' slice during the post-processing step for pie charts.
|
|
2055
|
+
* The event details contain the pie chart's data with its ungrouped slices.
|
|
1628
2056
|
*
|
|
1629
2057
|
* **Note**: Applicable to pie charts only.
|
|
1630
2058
|
*/
|
|
1631
2059
|
readonly arcgisDataFetchComplete: import("@arcgis/lumina").TargetedEvent<this, WebChartDataTypes>;
|
|
1632
|
-
/**
|
|
2060
|
+
/**
|
|
2061
|
+
* Emitted once the chart data is updated and any subsequent updates to the chart's data.
|
|
2062
|
+
* The event details contain the chart's data.
|
|
2063
|
+
*
|
|
2064
|
+
* @example
|
|
2065
|
+
* ```ts
|
|
2066
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
2067
|
+
* chartElement.addEventListener("arcgisDataProcessComplete", (event) => {
|
|
2068
|
+
* const { chartData, model } = event.detail;
|
|
2069
|
+
* // Handle the processed chart data
|
|
2070
|
+
* });
|
|
2071
|
+
* ```
|
|
2072
|
+
*/
|
|
1633
2073
|
readonly arcgisDataProcessComplete: import("@arcgis/lumina").TargetedEvent<this, DataProcessCompletePayload>;
|
|
1634
|
-
/**
|
|
2074
|
+
/**
|
|
2075
|
+
* Emitted when an error occurred while fetching or processing the data for the chart.
|
|
2076
|
+
*
|
|
2077
|
+
* @example
|
|
2078
|
+
* ```ts
|
|
2079
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
2080
|
+
* chartElement.addEventListener("arcgisDataProcessError", () => {
|
|
2081
|
+
* // Handle the data process error
|
|
2082
|
+
* });
|
|
2083
|
+
* ```
|
|
2084
|
+
*/
|
|
1635
2085
|
readonly arcgisDataProcessError: import("@arcgis/lumina").TargetedEvent<this, void>;
|
|
1636
2086
|
/**
|
|
1637
|
-
*
|
|
2087
|
+
* Emitted when an invalid configuration is detected.
|
|
1638
2088
|
*
|
|
1639
2089
|
* @deprecated since 5.1. Won't be replaced.
|
|
1640
2090
|
*/
|
|
1641
2091
|
readonly arcgisInvalidConfigWarningRaise: import("@arcgis/lumina").TargetedEvent<this, DataWarningObject>;
|
|
1642
|
-
/**
|
|
2092
|
+
/**
|
|
2093
|
+
* Emitted once a legend item visibility has been changed.
|
|
2094
|
+
* The event details contain the toggled item's visibility and related information (series or slice id).
|
|
2095
|
+
*
|
|
2096
|
+
* @example
|
|
2097
|
+
* ```ts
|
|
2098
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
2099
|
+
* chartElement.addEventListener("arcgisLegendItemVisibilityChange", (event) => {
|
|
2100
|
+
* const { legendItemVisibility, model } = event.detail;
|
|
2101
|
+
* // Handle the legend item visibility change
|
|
2102
|
+
* });
|
|
2103
|
+
* ```
|
|
2104
|
+
*/
|
|
1643
2105
|
readonly arcgisLegendItemVisibilityChange: import("@arcgis/lumina").TargetedEvent<this, LegendItemVisibilityChangePayload>;
|
|
1644
|
-
/**
|
|
2106
|
+
/** Emitted when a no-render property ([rotated](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#rotated), [legendPosition](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#legendPosition), [legendVisibility](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#legendVisibility), [view](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#view) and [featureIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#featureIndex)) is changed. */
|
|
1645
2107
|
readonly arcgisNoRenderPropChange: import("@arcgis/lumina").TargetedEvent<this, NoRenderPropChangePayload>;
|
|
1646
|
-
/**
|
|
2108
|
+
/**
|
|
2109
|
+
* Emitted once the chart is created and the rendering is complete. This event also emits with any subsequent chart updates, including when the chart is refreshed or when the configuration is changed.
|
|
2110
|
+
*
|
|
2111
|
+
* @example
|
|
2112
|
+
* ```ts
|
|
2113
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
2114
|
+
* chartElement.addEventListener("arcgisRenderingComplete", () => {
|
|
2115
|
+
* // Handle the rendering complete event
|
|
2116
|
+
* });
|
|
2117
|
+
*/
|
|
1647
2118
|
readonly arcgisRenderingComplete: import("@arcgis/lumina").TargetedEvent<this, void>;
|
|
1648
|
-
/**
|
|
2119
|
+
/**
|
|
2120
|
+
* Emitted when an error occurred that prevents the chart from being created or updated.
|
|
2121
|
+
*
|
|
2122
|
+
* @example
|
|
2123
|
+
* ```ts
|
|
2124
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
2125
|
+
* chartElement.addEventListener("arcgisRuntimeError", () => {
|
|
2126
|
+
* // Handle the runtime error
|
|
2127
|
+
* });
|
|
2128
|
+
*/
|
|
1649
2129
|
readonly arcgisRuntimeError: import("@arcgis/lumina").TargetedEvent<this, void>;
|
|
1650
|
-
/**
|
|
2130
|
+
/**
|
|
2131
|
+
* Emitted when a selection is applied to the chart.
|
|
2132
|
+
* The [`selectionData`](/references/charts-components/utils/misc/interfaces/#SelectionData) event detail contains various information about the selection, including the selected OIDs.
|
|
2133
|
+
*
|
|
2134
|
+
* @example
|
|
2135
|
+
* ```ts
|
|
2136
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
2137
|
+
* chartElement.addEventListener("arcgisSelectionComplete", (event) => {
|
|
2138
|
+
* const { selectionData, model } = event.detail;
|
|
2139
|
+
* // Handle the selection complete event
|
|
2140
|
+
* });
|
|
2141
|
+
* ```
|
|
2142
|
+
*/
|
|
1651
2143
|
readonly arcgisSelectionComplete: import("@arcgis/lumina").TargetedEvent<this, SelectionCompletePayload>;
|
|
1652
|
-
/**
|
|
2144
|
+
/** Emitted once one of the chart's series color has been assigned or changed. */
|
|
1653
2145
|
readonly arcgisSeriesColorChange: import("@arcgis/lumina").TargetedEvent<this, SeriesColorChangePayload>;
|
|
1654
|
-
/**
|
|
2146
|
+
/**
|
|
2147
|
+
* Emitted when the chart is created and at every update to confirm the order of the series on the chart.
|
|
2148
|
+
* The event details contain the modified series' indexes and names.
|
|
2149
|
+
*
|
|
2150
|
+
* @example
|
|
2151
|
+
* ```ts
|
|
2152
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
2153
|
+
* chartElement.addEventListener("arcgisSeriesOrder", (event) => {
|
|
2154
|
+
* // Handle the series order change
|
|
2155
|
+
* });
|
|
2156
|
+
* ```
|
|
2157
|
+
*/
|
|
1655
2158
|
readonly arcgisSeriesOrder: import("@arcgis/lumina").TargetedEvent<this, string[]>;
|
|
1656
|
-
/**
|
|
2159
|
+
/**
|
|
2160
|
+
* Emitted once the chart is updated.
|
|
2161
|
+
*
|
|
2162
|
+
* @deprecated since 5.2. Use [@arcgisRenderingComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisRenderingComplete) instead.
|
|
2163
|
+
*/
|
|
1657
2164
|
readonly arcgisUpdateComplete: import("@arcgis/lumina").TargetedEvent<this, ValidationStatus>;
|
|
1658
2165
|
readonly "@eventTypes": {
|
|
1659
2166
|
arcgisAxesMinMaxChange: ArcgisChart["arcgisAxesMinMaxChange"]["detail"];
|