@arcgis/charts-components 5.2.0-next.8 → 5.2.0-next.85
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/{YJ6TRXMU.js → 24MSASQQ.js} +1 -1
- package/dist/cdn/{5MEQANMY.js → 26DDVOQ7.js} +1 -1
- package/dist/cdn/2BA2QD2A.js +3 -0
- package/dist/cdn/{4USHOYLT.js → 2BE3GYK4.js} +1 -1
- package/dist/cdn/2MF442VT.js +2 -0
- package/dist/cdn/{VY3KBD6N.js → 2YDNWOWT.js} +1 -1
- package/dist/cdn/3AYNHY7J.js +2 -0
- package/dist/cdn/{DCZWZOPF.js → 3FFCWEMV.js} +1 -1
- package/dist/cdn/3H3PFQTD.js +2 -0
- package/dist/cdn/3KDTVBIG.js +2 -0
- package/dist/cdn/3SSQPYQA.js +2 -0
- package/dist/cdn/{JRHMUFED.js → 3YPGCLG4.js} +1 -1
- package/dist/cdn/{Y7HBWU3M.js → 3ZKNY2GI.js} +1 -1
- package/dist/cdn/{CHLE2QGU.js → 4DXGXATO.js} +1 -1
- package/dist/cdn/4KF7SUJE.js +2 -0
- package/dist/cdn/{MVHQR4FJ.js → 4U2HIMOR.js} +1 -1
- package/dist/cdn/52NR6B2J.js +2 -0
- package/dist/cdn/{H2A5GZ55.js → 5D2QRMC6.js} +1 -1
- package/dist/cdn/5DHMYPPF.js +2 -0
- package/dist/cdn/5NGIGJYR.js +2 -0
- 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/{CLXVAIQX.js → 6AXYQGBN.js} +1 -1
- package/dist/cdn/6LV3ASGE.js +2 -0
- package/dist/cdn/6SQNRMJG.js +2 -0
- package/dist/cdn/{ETKPMU7Z.js → 6U6VAS2O.js} +1 -1
- package/dist/cdn/{7LYAWWOE.js → 6WKTHJQK.js} +1 -1
- package/dist/cdn/{UT4TYXFO.js → 6WWEQU3O.js} +1 -1
- package/dist/cdn/72KEQM4K.js +2 -0
- package/dist/cdn/72VGCAR5.js +2 -0
- package/dist/cdn/{II2ZPEUZ.js → 7C2LVFNV.js} +1 -1
- package/dist/cdn/{4Z23HWDH.js → 7COM5REK.js} +1 -1
- package/dist/cdn/7CZMR2WF.js +2 -0
- package/dist/cdn/7JA63ENU.js +45 -0
- package/dist/cdn/7P3FHJUU.js +2 -0
- package/dist/cdn/7SIKOCYK.js +4 -0
- package/dist/cdn/7ZAT46VE.js +2 -0
- package/dist/cdn/{A5AECJXP.js → A2KSCV2I.js} +1 -1
- package/dist/cdn/ACMHG3RB.js +2 -0
- package/dist/cdn/{OJ5X6I3H.js → ADI63OO7.js} +1 -1
- package/dist/cdn/{E7OAEGSE.js → AF2GUPVE.js} +1 -1
- package/dist/cdn/{AJWYIBGC.js → AS3QP77N.js} +1 -1
- package/dist/cdn/{TXB2I2U5.js → B2SUC7VR.js} +1 -1
- package/dist/cdn/{LFQGH44F.js → B5Z7FBO7.js} +1 -1
- package/dist/cdn/{2HUAW34Q.js → B7J5YIWF.js} +1 -1
- package/dist/cdn/{TACQVUBU.js → BDEDEGCZ.js} +1 -1
- package/dist/cdn/BGOWDCTO.js +2 -0
- package/dist/cdn/{CNFBNAPJ.js → BK7DHYA7.js} +1 -1
- package/dist/cdn/BV7UUWYI.js +2 -0
- package/dist/cdn/{N6AOFBBX.js → BWR5ONE2.js} +1 -1
- package/dist/cdn/BYSUABOV.js +2 -0
- package/dist/cdn/{AWF4R7WL.js → C2ZX67U4.js} +1 -1
- package/dist/cdn/C5UI5MYS.js +2 -0
- package/dist/cdn/C7F4AVQU.js +104 -0
- package/dist/cdn/{EXXLJVGS.js → CFOB77PI.js} +1 -1
- package/dist/cdn/CSOYZJU5.js +2 -0
- package/dist/cdn/CVWT6DGY.js +2 -0
- package/dist/cdn/CXWBQG5O.js +2 -0
- package/dist/cdn/{ZFJFTDJF.js → CYGMXV56.js} +1 -1
- package/dist/cdn/{L4G6FO7A.js → DDNOUE2T.js} +1 -1
- package/dist/cdn/DE3CJJG3.js +2 -0
- package/dist/cdn/DKC4NIUA.js +2 -0
- package/dist/cdn/DW5NK2B3.js +2 -0
- package/dist/cdn/DZWIVB6V.js +2 -0
- package/dist/cdn/EMOHROY3.js +2 -0
- package/dist/cdn/{HVO4LIXR.js → EQTI5Z4G.js} +1 -1
- package/dist/cdn/{J5NHXQLA.js → EQZBQP5A.js} +1 -1
- package/dist/cdn/EYYTKCXM.js +2 -0
- package/dist/cdn/EZLKMWI5.js +2 -0
- package/dist/cdn/F3LVXDV4.js +2 -0
- package/dist/cdn/FBU4ODQE.js +2 -0
- package/dist/cdn/{A4GEWIPY.js → FFJTVPE4.js} +1 -1
- package/dist/cdn/FQKGQHVK.js +2 -0
- package/dist/cdn/{JCH3RDLR.js → FRTPDJGW.js} +1 -1
- package/dist/cdn/{WASEMNYV.js → G45UKTNI.js} +1 -1
- package/dist/cdn/GDGYKODO.js +2 -0
- package/dist/cdn/GX64OP3A.js +2 -0
- package/dist/cdn/GZEVPH4Y.js +2 -0
- package/dist/cdn/{XE3FKQFA.js → H2DUFQAG.js} +1 -1
- package/dist/cdn/{JJIGLOJA.js → HABS63VB.js} +1 -1
- package/dist/cdn/HDIBDW52.js +2 -0
- package/dist/cdn/HOASAQAB.js +2 -0
- package/dist/cdn/HQ2JPCTQ.js +2 -0
- package/dist/cdn/{AZOBLYAP.js → I2BM5KSH.js} +1 -1
- package/dist/cdn/I3BMYY7N.js +2 -0
- package/dist/cdn/{JQKRGUBU.js → IDAOLPMA.js} +1 -1
- package/dist/cdn/IN2IL6T2.js +2 -0
- package/dist/cdn/IVM37XFX.js +2 -0
- package/dist/cdn/{DKAHZ7IX.js → J3BB5KXD.js} +1 -1
- package/dist/cdn/JMMNRCD4.js +2 -0
- package/dist/cdn/JQM5R6XW.js +2 -0
- package/dist/cdn/{XW4PBQNW.js → JUFBIV44.js} +1 -1
- package/dist/cdn/JUU3BZT7.js +2 -0
- package/dist/cdn/KAQ5XSCQ.js +2 -0
- package/dist/cdn/KG574LAE.js +2 -0
- package/dist/cdn/KHJC5P5T.js +2 -0
- package/dist/cdn/{D3CFPMAR.js → KOY5DWSR.js} +1 -1
- package/dist/cdn/{QOOBNATX.js → KTYFDFMQ.js} +1 -1
- package/dist/cdn/{CHQDKVVQ.js → KWN3N6VE.js} +1 -1
- package/dist/cdn/KYOBS7XL.js +2 -0
- package/dist/cdn/KZSCAJDG.js +2 -0
- package/dist/cdn/L4BZX57U.js +2 -0
- package/dist/cdn/L5JZ5COY.js +2 -0
- package/dist/cdn/{AY6IOQ3H.js → LAEUROZM.js} +1 -1
- package/dist/cdn/LCTDNI27.js +2 -0
- package/dist/cdn/LM6VCILT.js +2 -0
- package/dist/cdn/LMTSW3JM.js +2 -0
- package/dist/cdn/LPS3VU35.js +2 -0
- package/dist/cdn/{6XTKJ7DO.js → LXZXXY7V.js} +1 -1
- package/dist/cdn/M6OCFMDB.js +2 -0
- package/dist/cdn/MITW5XKW.js +2 -0
- package/dist/cdn/MJHVSD5B.js +2 -0
- package/dist/cdn/MNYNXHXE.js +2 -0
- package/dist/cdn/NH2A5QEU.js +2 -0
- package/dist/cdn/NIDXK3GN.js +2 -0
- package/dist/cdn/{XG2KN6YJ.js → NKPZCF5U.js} +1 -1
- package/dist/cdn/{YOT6DVSU.js → NNHJ75EA.js} +1 -1
- package/dist/cdn/{VE3GFNNM.js → NRXCKYYY.js} +1 -1
- package/dist/cdn/{4C6KWLWN.js → NWLNHFHJ.js} +1 -1
- package/dist/cdn/{TF7TE7K5.js → NWQ2L7IJ.js} +1 -1
- package/dist/cdn/{NAXNRCMZ.js → OD2NWPCL.js} +1 -1
- package/dist/cdn/{4ZIZEJXS.js → OISERMTF.js} +1 -1
- package/dist/cdn/{ETOGNYFU.js → OKAZOAYZ.js} +1 -1
- package/dist/cdn/OMORDJT2.js +2 -0
- package/dist/cdn/{DEGBVJ76.js → OMU647X3.js} +1 -1
- package/dist/cdn/{XUERYUEG.js → OQFM5DBD.js} +1 -1
- package/dist/cdn/{AM2TOTX6.js → OXPXA3PS.js} +1 -1
- package/dist/cdn/OYXDCECZ.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/{BJDRJUEJ.js → P7FI5QUW.js} +1 -1
- package/dist/cdn/{KZ7LPNX3.js → PCFEAGXP.js} +1 -1
- package/dist/cdn/PF6QOHZR.js +2 -0
- package/dist/cdn/{BJ7Q7LCT.js → PIZPF2BH.js} +1 -1
- package/dist/cdn/{GDQBQQUP.js → PMTNALXO.js} +1 -1
- package/dist/cdn/PWJBGZPW.js +2 -0
- package/dist/cdn/{ZXOO3X5P.js → PZP57FJ2.js} +1 -1
- package/dist/cdn/{QMSINFQX.js → Q466K37N.js} +1 -1
- package/dist/cdn/{7UQHB6KY.js → QIG5H6WA.js} +1 -1
- package/dist/cdn/QIG7WTJF.js +2 -0
- package/dist/cdn/{XMPLEHTW.js → QKZK6MTN.js} +1 -1
- package/dist/cdn/QXQC4CH5.js +2 -0
- package/dist/cdn/QYRHZJH3.js +2 -0
- package/dist/cdn/{7FZC3RZK.js → R5LIRRMK.js} +1 -1
- package/dist/cdn/R5VDQBUH.js +2 -0
- package/dist/cdn/RCAPTQFV.js +2 -0
- package/dist/cdn/{K3GNHGEW.js → RHUEVXMR.js} +1 -1
- package/dist/cdn/{IPM2XKST.js → RMIIDRGC.js} +1 -1
- package/dist/cdn/RPUEIRTH.js +2 -0
- package/dist/cdn/S2HIF3ZX.js +2 -0
- package/dist/cdn/{KFONSKQF.js → S4NQCINT.js} +1 -1
- package/dist/cdn/SC26LLWP.js +2 -0
- package/dist/cdn/{ML3A3MYV.js → SILDOKXS.js} +1 -1
- package/dist/cdn/{DNTLH5RT.js → SSOL6PCL.js} +1 -1
- package/dist/cdn/{FF4DUQDZ.js → SVLOD3HQ.js} +1 -1
- package/dist/cdn/{ZYOWZCR7.js → TB7JE5XK.js} +1 -1
- package/dist/cdn/TBW6K2TY.js +2 -0
- package/dist/cdn/{AK7X7SGI.js → TENIFMA5.js} +1 -1
- package/dist/cdn/{5XTQQOTT.js → TJ2NRLF6.js} +1 -1
- package/dist/cdn/{KUZR6CGB.js → TOCBEPNS.js} +1 -1
- package/dist/cdn/{WMPWOPRZ.js → TRAVRA3M.js} +1 -1
- package/dist/cdn/TSU6UVTL.js +2 -0
- package/dist/cdn/U3542JBJ.js +2 -0
- package/dist/cdn/U7GQGHZY.js +2 -0
- package/dist/cdn/{P5AO3V3M.js → UD724V36.js} +1 -1
- package/dist/cdn/{DSIFL2DF.js → UQSD6YZM.js} +1 -1
- package/dist/cdn/{Q7J7EKQW.js → UUVJGPFG.js} +1 -1
- package/dist/cdn/UYDDYD3O.js +2 -0
- package/dist/cdn/V3ITNIER.js +2 -0
- package/dist/cdn/{ZQDADGLQ.js → VLCUXTLC.js} +1 -1
- package/dist/cdn/VQU2TVX7.js +3 -0
- package/dist/cdn/VSPKBQS6.js +2 -0
- package/dist/cdn/WC22SRVJ.js +2 -0
- package/dist/cdn/{6B7JCDQC.js → WTF2PFHV.js} +1 -1
- package/dist/cdn/XBRRJQVR.js +2 -0
- package/dist/cdn/XFCDAI5T.js +2 -0
- package/dist/cdn/XHZAAQMF.js +2 -0
- package/dist/cdn/{SBYD2EKR.js → XR4O3AQ6.js} +1 -1
- package/dist/cdn/{7HGVEE7A.js → XU7TGV75.js} +1 -1
- package/dist/cdn/XVCBLLWW.js +2 -0
- package/dist/cdn/YAWW63A5.js +2 -0
- package/dist/cdn/{BXYNEUQY.js → YCQLYXH4.js} +1 -1
- package/dist/cdn/{JBHGSSHS.js → Z5EJIWAY.js} +1 -1
- package/dist/cdn/{GV3TT7L5.js → ZARYZFJ4.js} +1 -1
- package/dist/cdn/ZDUW3TBJ.js +2 -0
- package/dist/cdn/ZGIM53IQ.js +2 -0
- package/dist/cdn/{5ZGALYWZ.js → ZLCRTIQH.js} +1 -1
- package/dist/cdn/{ZFZ5AEUQ.js → ZVOX72AF.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/data/utils/summarize-data/interfaces.d.ts +5 -1
- package/dist/chart-rendering/common/interfaces.d.ts +52 -22
- 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 +42 -38
- package/dist/chunks/box-plot-data.js +270 -279
- package/dist/chunks/box-plot-model.js +159 -144
- package/dist/chunks/chart-model.js +182 -150
- 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 +24 -24
- package/dist/chunks/combo-bar-line-chart-model.js +48 -40
- 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 +9363 -1079
- package/dist/chunks/index2.js +852 -8752
- package/dist/chunks/index3.js +1169 -847
- package/dist/chunks/index4.js +315 -86
- package/dist/chunks/index5.js +63 -100
- package/dist/chunks/interfaces.js +9 -9
- package/dist/chunks/line-chart-model.js +18 -18
- package/dist/chunks/model-setter.js +57 -34
- package/dist/chunks/model-types.js +1 -1
- package/dist/chunks/model-with-line-marker-styling.js +18 -9
- package/dist/chunks/model-with-y-guides.js +52 -67
- package/dist/chunks/negative-values-stacked-to-baseline.js +40 -36
- 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 +397 -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 +73 -0
- package/dist/chunks/scatterplot-model.js +12 -12
- package/dist/chunks/serial-chart-data.js +868 -748
- 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 +16 -12
- 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 +628 -254
- package/dist/components/arcgis-chart/customElement.js +10420 -10099
- 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 +29 -29
- 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 +44 -43
- 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 +16 -16
- 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 +244 -230
- 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 +65 -77
- package/dist/components/arcgis-charts-config-heat-chart-data/index.js +1 -1
- package/dist/components/arcgis-charts-config-heat-chart-popover/customElement.js +58 -59
- 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 +19 -19
- 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 +8 -8
- 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 +41 -48
- 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 +80 -80
- 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 +61 -61
- package/dist/index.js +476 -463
- package/dist/interfaces.d.ts +9 -11
- package/dist/json-schema/index.d.ts +211 -6
- package/dist/loader.js +2 -2
- package/dist/model/bar-chart-model/bar-chart-model.d.ts +4 -2
- package/dist/model/box-plot-model/box-plot-model.d.ts +7 -1
- 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/chart-model/chart-model.d.ts +2 -1
- package/dist/model/combo-bar-line-chart-model/combo-bar-line-chart-model.d.ts +19 -7
- package/dist/model/heat-chart-model/heat-chart-model.d.ts +41 -8
- 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 +16 -7
- 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/data-tooltip-font-size.d.ts +20 -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/type-guards.d.ts +38 -22
- package/dist/spec/chart-object-literals.d.ts +1 -0
- 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 +42 -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 +58 -8
- package/dist/utils/chart-config/validator/index.d.ts +1 -0
- package/dist/utils/chart-config/validator/interfaces.d.ts +4 -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 +1 -1
- 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 +31 -6
- 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 +6 -3
- package/dist/utils/layer/inline-conversion/interfaces.d.ts +0 -2
- package/dist/utils/layer/interfaces.d.ts +2 -1
- 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/localization/interfaces.d.ts +8 -0
- 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 +7 -8
- package/dist/cdn/24RLLXS6.js +0 -2
- package/dist/cdn/32FR66QO.js +0 -2
- package/dist/cdn/3EIVHDDK.js +0 -2
- package/dist/cdn/3NUNWPAR.js +0 -2
- package/dist/cdn/4ACX3XOE.js +0 -2
- package/dist/cdn/547RDEMV.js +0 -2
- package/dist/cdn/5YJNENER.js +0 -2
- package/dist/cdn/6AF2OTL6.js +0 -2
- package/dist/cdn/6C6AH4LL.js +0 -2
- package/dist/cdn/6CFIKYKR.js +0 -2
- package/dist/cdn/6GLTSMOR.js +0 -2
- package/dist/cdn/7OF2IANH.js +0 -2
- package/dist/cdn/7VN3A7S2.js +0 -2
- package/dist/cdn/7YWZG3ZS.js +0 -2
- package/dist/cdn/A5GIBV5W.js +0 -2
- package/dist/cdn/ADGMA3ST.js +0 -3
- package/dist/cdn/ADPDJISV.js +0 -2
- package/dist/cdn/AWKELFV6.js +0 -2
- package/dist/cdn/B4KAJRUJ.js +0 -2
- package/dist/cdn/BBUPTHPL.js +0 -2
- package/dist/cdn/BBURKBKE.js +0 -2
- package/dist/cdn/C2FOUUEM.js +0 -2
- package/dist/cdn/CBNT3DO7.js +0 -2
- package/dist/cdn/CJPEW4LJ.js +0 -142
- package/dist/cdn/CVU3UPPF.js +0 -2
- package/dist/cdn/CZ5XRXCE.js +0 -2
- package/dist/cdn/D73VV2AZ.js +0 -2
- package/dist/cdn/DF5P34HK.js +0 -2
- package/dist/cdn/DJACBOFO.js +0 -2
- package/dist/cdn/DPNTYHTH.js +0 -2
- package/dist/cdn/EGISZTGB.js +0 -2
- package/dist/cdn/EP34TF4L.js +0 -2
- package/dist/cdn/EZD3FBJU.js +0 -2
- package/dist/cdn/EZV7JSQJ.js +0 -2
- package/dist/cdn/FDFYTCDO.js +0 -2
- package/dist/cdn/G72TNKCS.js +0 -2
- package/dist/cdn/GQ5QBLRO.js +0 -2
- package/dist/cdn/HWJGWDU3.js +0 -2
- package/dist/cdn/HZR4NSZV.js +0 -2
- package/dist/cdn/IXRBZPQL.js +0 -2
- package/dist/cdn/JNNB2DIA.js +0 -2
- package/dist/cdn/JPPGHHIA.js +0 -2
- package/dist/cdn/JS2KOBA2.js +0 -2
- package/dist/cdn/JTTJ455Y.js +0 -2
- package/dist/cdn/JWO5WVTZ.js +0 -2
- package/dist/cdn/JWPAMNU4.js +0 -2
- package/dist/cdn/K4WI2SGM.js +0 -2
- package/dist/cdn/KCMZSNBL.js +0 -2
- package/dist/cdn/KLHZFPYK.js +0 -2
- package/dist/cdn/KVUFR34S.js +0 -2
- package/dist/cdn/LTQRSPSC.js +0 -2
- package/dist/cdn/MBVTB42G.js +0 -2
- package/dist/cdn/MRTKZZTF.js +0 -2
- package/dist/cdn/NNEDF6G4.js +0 -2
- package/dist/cdn/NSOZIR5F.js +0 -2
- package/dist/cdn/NTSTL3FK.js +0 -2
- package/dist/cdn/NZR4L5AA.js +0 -2
- package/dist/cdn/O5A25X5K.js +0 -2
- package/dist/cdn/OAAJ6CIN.js +0 -2
- package/dist/cdn/OGYY2Y22.js +0 -2
- package/dist/cdn/OJIUI56Z.js +0 -2
- package/dist/cdn/OSNA56IW.js +0 -4
- package/dist/cdn/P3YHDWG2.js +0 -2
- package/dist/cdn/P4HSSZRL.js +0 -2
- package/dist/cdn/PAIRUVLU.js +0 -2
- package/dist/cdn/PBWZYX5M.js +0 -58
- package/dist/cdn/PPGRM3VJ.js +0 -2
- package/dist/cdn/PRGFNLY7.js +0 -2
- package/dist/cdn/PRMN6W5R.js +0 -2
- package/dist/cdn/PROSIXIF.js +0 -2
- package/dist/cdn/Q5JDSPJA.js +0 -2
- package/dist/cdn/QJC3FDWG.js +0 -2
- package/dist/cdn/R75MHIRF.js +0 -2
- package/dist/cdn/RDA5NV6M.js +0 -2
- package/dist/cdn/RG3DO2OE.js +0 -2
- package/dist/cdn/RPNZL6AC.js +0 -2
- package/dist/cdn/S5UDCCRH.js +0 -2
- package/dist/cdn/SCAZDS2G.js +0 -2
- package/dist/cdn/SRPOC65M.js +0 -2
- package/dist/cdn/TCTQ4LMU.js +0 -2
- package/dist/cdn/TDHHWIIC.js +0 -2
- package/dist/cdn/THTYR6IL.js +0 -2
- package/dist/cdn/TJMPLGQI.js +0 -2
- package/dist/cdn/TJMTF45U.js +0 -3
- package/dist/cdn/U2CYVAIC.js +0 -102
- package/dist/cdn/U67P6YAZ.js +0 -2
- package/dist/cdn/UZEMSOA2.js +0 -2
- package/dist/cdn/VBHQFV2H.js +0 -2
- package/dist/cdn/VOTZAPI3.js +0 -2
- package/dist/cdn/VQU6N5HX.js +0 -2
- package/dist/cdn/VZTLODMQ.js +0 -2
- package/dist/cdn/W7X6L2OB.js +0 -127
- package/dist/cdn/WNKDEOFZ.js +0 -2
- package/dist/cdn/WPPMMVD5.js +0 -2
- package/dist/cdn/XCUXUZXY.js +0 -2
- package/dist/cdn/XG3WW5GG.js +0 -2
- package/dist/cdn/XJFVSX2E.js +0 -2
- package/dist/cdn/Y3CXVO2M.js +0 -2
- package/dist/cdn/YEZL5KRS.js +0 -2
- package/dist/cdn/YYK7SPXC.js +0 -2
- package/dist/cdn/ZS6EP5BD.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
|
@@ -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,7 +752,25 @@ 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
775
|
accessor dataLabelFormatter: ChartOptions["dataLabelFormatter"] | undefined;
|
|
703
776
|
/**
|
|
@@ -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
|
*/
|
|
@@ -748,7 +822,7 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
748
822
|
/**
|
|
749
823
|
* The index of the feature to render when using a feature based gauge.
|
|
750
824
|
*
|
|
751
|
-
* **Note**:
|
|
825
|
+
* **Note**: Applicable to gauges only.
|
|
752
826
|
*
|
|
753
827
|
* @deprecated since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/model/gauge-model/gauge-model/#featureIndex) prop instead.
|
|
754
828
|
*/
|
|
@@ -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,18 +852,49 @@ 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;
|
|
789
895
|
/**
|
|
790
896
|
* When `true`, the empty series are completely hidden from the chart and the legend.
|
|
791
|
-
* For example, a series may become empty after applying a data filter, filter by attribute or geometry (as when using the filter by extent).
|
|
897
|
+
* For example, a series may become empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).
|
|
792
898
|
*
|
|
793
899
|
* **Note**: Not applicable to gauges.
|
|
794
900
|
*
|
|
@@ -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, via the`completeDataForEmptyCategoriesWithZeros` method.
|
|
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
|
*/
|
|
@@ -882,9 +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.
|
|
993
|
+
*
|
|
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`.
|
|
886
996
|
*
|
|
887
|
-
*
|
|
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).
|
|
888
998
|
*
|
|
889
999
|
* @example
|
|
890
1000
|
* ```html
|
|
@@ -893,13 +1003,11 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
893
1003
|
*/
|
|
894
1004
|
accessor layerItemId: string | undefined;
|
|
895
1005
|
/**
|
|
896
|
-
* Allows the chart to update automatically when the layer's renderer changes.
|
|
897
|
-
* Applies when the color match is enabled.
|
|
898
|
-
*
|
|
899
|
-
* @deprecated
|
|
900
|
-
* since 5.1. Won't be replaced.
|
|
1006
|
+
* Allows the chart to update automatically when the layer's renderer changes. Applies when the color match is enabled.
|
|
901
1007
|
*
|
|
902
1008
|
* **Note**: If the property is set to `ignore` the chart will still use the layer's renderer information when the data is updated.
|
|
1009
|
+
*
|
|
1010
|
+
* @deprecated since 5.1. Won't be replaced.
|
|
903
1011
|
* @default "refresh"
|
|
904
1012
|
*/
|
|
905
1013
|
accessor layerRendererChangePolicy: LayerRendererChangePolicy;
|
|
@@ -912,8 +1020,28 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
912
1020
|
*/
|
|
913
1021
|
accessor legendPosition: WebChartLegendPositions | undefined;
|
|
914
1022
|
/**
|
|
915
|
-
*
|
|
916
|
-
*
|
|
1023
|
+
* When the pie chart label contains either a numeric value or a percentage (which can be set through the
|
|
1024
|
+
* [displayNumericValueOnLegendItems](https://developers.arcgis.com/javascript/latest/references/charts-components/model/pie-chart-model/pie-chart-model/#displayNumericValueOnLegendItems) and
|
|
1025
|
+
* [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
|
|
1026
|
+
* can be used to format the numeric value and/or percentage. If the returned string contains HTML tags they will be interpreted as such.
|
|
1027
|
+
*
|
|
1028
|
+
* @example
|
|
1029
|
+
* ```ts
|
|
1030
|
+
* // Set the pie chart model to display both numeric value and percentage.
|
|
1031
|
+
* pieChartModel.displayNumericValueOnLegendItems = true;
|
|
1032
|
+
* pieChartModel.displayPercentageOnLegendItems = true;
|
|
1033
|
+
*
|
|
1034
|
+
* // Render the numeric value and percentage in bold and italic respectively, with 2 decimal places.
|
|
1035
|
+
* chartElement.legendValueLabelFormatter = (value, percentage) => {
|
|
1036
|
+
* return `<strong><u>${Number(value).toFixed(2)}</u></strong> (<em>${Number(percentage).toFixed(2)}%</em>)`;
|
|
1037
|
+
* };
|
|
1038
|
+
* ```
|
|
1039
|
+
*
|
|
1040
|
+
* <img
|
|
1041
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/legendValueLabelFormatter.avif"
|
|
1042
|
+
* alt="legendValueLabelFormatter"
|
|
1043
|
+
* style="max-width: 400px; width: 100%; height: auto;"
|
|
1044
|
+
* />
|
|
917
1045
|
*
|
|
918
1046
|
* **Note**: Applicable to pie charts only.
|
|
919
1047
|
*/
|
|
@@ -934,12 +1062,34 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
934
1062
|
* @example
|
|
935
1063
|
* ```ts
|
|
936
1064
|
* // Set a blue curtain and a red spinner for the loader animation
|
|
937
|
-
*
|
|
1065
|
+
* chartComponent.loaderColors = { curtainColor: [30, 144, 255, 255], spinnerColor: [255, 0, 0, 255] };
|
|
938
1066
|
* ```
|
|
939
1067
|
*/
|
|
940
1068
|
accessor loaderColors: LoaderColors | undefined;
|
|
941
|
-
/**
|
|
942
|
-
|
|
1069
|
+
/**
|
|
1070
|
+
* Custom messages for translated strings on the chart. If the returned string contains HTML tags they will be interpreted as such.
|
|
1071
|
+
*
|
|
1072
|
+
* The customizable messages can be found thru the [`CommonStringsIdentity`](/references/charts-components/utils/localization/interfaces/#CommonStringsIdentity) variable.
|
|
1073
|
+
*
|
|
1074
|
+
* @example
|
|
1075
|
+
* ```ts
|
|
1076
|
+
* // User sets the xAxisField to a field that doesn't exist in the dataset.
|
|
1077
|
+
* barChartModel.xAxisField = "wrong_field_name";
|
|
1078
|
+
*
|
|
1079
|
+
* // Overrides the default message when there's a query error instead of displaying the default "Failure to read input data." message.
|
|
1080
|
+
* chartElement.messageOverrides = {
|
|
1081
|
+
* errorStrings: {
|
|
1082
|
+
* errors: {
|
|
1083
|
+
* queryError:
|
|
1084
|
+
* "<b><u>The input data provided is invalid, please ensure the xAxisField is correctly specified.</u></b>"
|
|
1085
|
+
* },
|
|
1086
|
+
* },
|
|
1087
|
+
* };
|
|
1088
|
+
* ```
|
|
1089
|
+
*
|
|
1090
|
+
* 
|
|
1091
|
+
*/
|
|
1092
|
+
accessor messageOverrides: {
|
|
943
1093
|
utilsStrings?: {
|
|
944
1094
|
chartType?: {
|
|
945
1095
|
chart?: string | undefined;
|
|
@@ -1077,6 +1227,10 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1077
1227
|
twoTemporalSeriesLineCountCannotExceedLimit?: string | undefined;
|
|
1078
1228
|
threePlusTemporalSeriesLineCountCannotExceedLimit?: string | undefined;
|
|
1079
1229
|
lineSeriesCountCannotExceedLimit?: string | undefined;
|
|
1230
|
+
uniqueSeriesRadarCountCannotExceedLimit?: string | undefined;
|
|
1231
|
+
twoSeriesRadarCountCannotExceedLimit?: string | undefined;
|
|
1232
|
+
threePlusSeriesRadarCountCannotExceedLimit?: string | undefined;
|
|
1233
|
+
radarSeriesCountCannotExceedLimit?: string | undefined;
|
|
1080
1234
|
uniqueSeriesBoxCountCannotExceedLimit?: string | undefined;
|
|
1081
1235
|
twoSeriesBoxCountCannotExceedLimit?: string | undefined;
|
|
1082
1236
|
threePlusBoxLineCountCannotExceedLimit?: string | undefined;
|
|
@@ -1206,25 +1360,42 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1206
1360
|
"Unable to load file: %1"?: string | undefined;
|
|
1207
1361
|
"Invalid date"?: string | undefined;
|
|
1208
1362
|
} | undefined;
|
|
1209
|
-
};
|
|
1363
|
+
} & { chartNotFoundWarning?: string | undefined; };
|
|
1210
1364
|
/**
|
|
1211
1365
|
* Provides an API to interact with the chart's configuration.
|
|
1212
1366
|
*
|
|
1213
|
-
*
|
|
1367
|
+
* `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.
|
|
1368
|
+
* - `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.
|
|
1369
|
+
* - This is the recommended approach as it ensures the chart configuration is valid and compatible with the component.
|
|
1370
|
+
* - `WebChart`: A plain chart configuration object that follows the [WebChart](https://developers.arcgis.com/javascript/latest/references/charts-components/spec/web-chart/#WebChart) specification.
|
|
1371
|
+
*
|
|
1372
|
+
* @see [Create a new chart with charts model](https://developers.arcgis.com/javascript/latest/charts/#create-a-new-chart-with-charts-model)
|
|
1214
1373
|
*/
|
|
1215
1374
|
accessor model: ChartModel | WebChart | undefined;
|
|
1216
1375
|
/**
|
|
1217
|
-
*
|
|
1218
|
-
*
|
|
1219
|
-
*
|
|
1376
|
+
* When `true`, null values are considered as valid.
|
|
1377
|
+
*
|
|
1378
|
+
* By default, when the data contains only null values, the chart dataset is considered empty:
|
|
1379
|
+
* - The [@arcgisBadDataWarningRaise](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisBadDataWarningRaise) event will be sent.
|
|
1380
|
+
* - The "No data available to display" warning message will be displayed in the chart container.
|
|
1220
1381
|
*
|
|
1221
1382
|
* @default false
|
|
1222
1383
|
*/
|
|
1223
1384
|
accessor nullAsValid: boolean;
|
|
1224
|
-
/**
|
|
1385
|
+
/**
|
|
1386
|
+
* Placeholder text displayed in the chart container when no chart is configured.
|
|
1387
|
+
* If the string contains HTML tags they will be interpreted as such.
|
|
1388
|
+
*
|
|
1389
|
+
* @example
|
|
1390
|
+
* ```ts
|
|
1391
|
+
* 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.";
|
|
1392
|
+
* ```
|
|
1393
|
+
*
|
|
1394
|
+
* 
|
|
1395
|
+
*/
|
|
1225
1396
|
accessor placeholder: string | undefined;
|
|
1226
1397
|
/**
|
|
1227
|
-
*
|
|
1398
|
+
* 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
1399
|
*
|
|
1229
1400
|
* @default false
|
|
1230
1401
|
*/
|
|
@@ -1238,19 +1409,20 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1238
1409
|
accessor queueChartCreation: boolean | undefined;
|
|
1239
1410
|
/**
|
|
1240
1411
|
* When `true`, the chart's `dataItems` associated with empty (no value) categories (from only a `Count` aggregation)
|
|
1241
|
-
* will be populated with 0s
|
|
1412
|
+
* will be populated with 0s.
|
|
1242
1413
|
*
|
|
1243
1414
|
* @deprecated since 5.0. Use [hideZeroCountCategories](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideZeroCountCategories) instead.
|
|
1244
1415
|
* @default false
|
|
1245
1416
|
*/
|
|
1246
1417
|
accessor replaceNoValueCategoryWithZero: boolean | undefined;
|
|
1247
1418
|
/**
|
|
1248
|
-
* When `true`, the
|
|
1419
|
+
* 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)
|
|
1420
|
+
* and [@arcgisSelectionComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisSelectionComplete) events.
|
|
1249
1421
|
* Applies only to:
|
|
1250
1422
|
* - Charts using an aggregation.
|
|
1251
|
-
* - Data
|
|
1423
|
+
* - Data sources using a feature layer compatible with envelope aggregation.
|
|
1252
1424
|
*
|
|
1253
|
-
* The extent
|
|
1425
|
+
* The extent is returned through the [featuresExtentField](https://developers.arcgis.com/javascript/latest/references/charts-components/utils/defaults/index/#featuresExtentField) variable.
|
|
1254
1426
|
*
|
|
1255
1427
|
* **Note**: Not applicable to gauges.
|
|
1256
1428
|
*
|
|
@@ -1258,7 +1430,7 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1258
1430
|
*/
|
|
1259
1431
|
accessor returnFeaturesExtent: boolean;
|
|
1260
1432
|
/**
|
|
1261
|
-
* When `true`,
|
|
1433
|
+
* When `true`, selection indexes are computed and returned whenever a selection is made on or passed to the chart.
|
|
1262
1434
|
*
|
|
1263
1435
|
* **Note**: Not applicable to gauges.
|
|
1264
1436
|
*
|
|
@@ -1266,10 +1438,10 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1266
1438
|
*/
|
|
1267
1439
|
accessor returnSelectionIndexes: boolean;
|
|
1268
1440
|
/**
|
|
1269
|
-
* When `true`,
|
|
1270
|
-
* Only considered for
|
|
1441
|
+
* When `true`, object ids are computed and returned whenever a selection is made on or passed to the chart.
|
|
1442
|
+
* Only considered for data sources using a [feature layer](/references/core/layers/FeatureLayer).
|
|
1271
1443
|
*
|
|
1272
|
-
* **Note**: Not applicable to gauges or charts configured with imagery layers.
|
|
1444
|
+
* **Note**: Not applicable to gauges or charts configured with imagery layers.
|
|
1273
1445
|
*
|
|
1274
1446
|
* @default false
|
|
1275
1447
|
*/
|
|
@@ -1277,7 +1449,7 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1277
1449
|
/**
|
|
1278
1450
|
* When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.
|
|
1279
1451
|
*
|
|
1280
|
-
* **Note**: Applicable to bar
|
|
1452
|
+
* **Note**: Applicable to bar charts, box plots, combo bar line charts and line charts.
|
|
1281
1453
|
*
|
|
1282
1454
|
* @default false
|
|
1283
1455
|
*/
|
|
@@ -1285,115 +1457,230 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1285
1457
|
/**
|
|
1286
1458
|
* When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.
|
|
1287
1459
|
*
|
|
1288
|
-
* **Note**: Applicable to bar chart, line chart, combo bar
|
|
1460
|
+
* **Note**: Applicable to bar chart, line chart, combo bar line chart and box plot.
|
|
1289
1461
|
*
|
|
1290
1462
|
* @deprecated since 5.0. Use either [rotated](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#rotated) or the charts model's [rotated](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#rotated) prop instead.
|
|
1291
1463
|
* @default false
|
|
1292
1464
|
*/
|
|
1293
1465
|
accessor rotation: boolean;
|
|
1294
1466
|
/**
|
|
1295
|
-
* Applies runtime data filters to the chart.
|
|
1467
|
+
* Applies runtime data filters to the chart, features will be filtered based on the provided key value pairs.
|
|
1468
|
+
*
|
|
1469
|
+
* Supported keys are `where`, `objectIds`, `geometry`, `spatialRelationship`, `distance`, `units`, `timeExtent`, and `gdbVersion`.
|
|
1296
1470
|
*
|
|
1297
1471
|
* @example
|
|
1298
1472
|
* ```ts
|
|
1299
|
-
*
|
|
1300
|
-
*
|
|
1473
|
+
* // 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.
|
|
1474
|
+
* const start = new Date(2005, 8, 23).getTime();
|
|
1475
|
+
* const end = new Date(2005, 8, 28).getTime();
|
|
1476
|
+
*
|
|
1477
|
+
* chartComponent.runtimeDataFilters = {
|
|
1478
|
+
* where: "Name = 'Katrina'",
|
|
1479
|
+
* objectIds: [12, 19, 27],
|
|
1480
|
+
* geometry: {
|
|
1481
|
+
* xmin: -130,
|
|
1482
|
+
* ymin: 20,
|
|
1483
|
+
* xmax: -60,
|
|
1484
|
+
* ymax: 55,
|
|
1485
|
+
* },
|
|
1486
|
+
* spatialRelationship: "contains",
|
|
1487
|
+
* distance: 10,
|
|
1488
|
+
* units: "miles",
|
|
1489
|
+
* timeExtent: [start, end]
|
|
1301
1490
|
* };
|
|
1302
1491
|
* ```
|
|
1303
1492
|
*/
|
|
1304
1493
|
accessor runtimeDataFilters: WebChartDataFilters | undefined;
|
|
1305
1494
|
/**
|
|
1306
1495
|
* Callback function used to format the secondary y-axis labels. If the returned string contains HTML tags they will be interpreted as such.
|
|
1307
|
-
* The property will be effective only if 3 axes are defined (dual axis chart).
|
|
1308
1496
|
*
|
|
1309
|
-
*
|
|
1497
|
+
* @example
|
|
1498
|
+
* ```ts
|
|
1499
|
+
* // Render a custom secondary y-axis label with the value formatted as a compact currency.
|
|
1500
|
+
* chartElement.secondaryYAxisLabelFormatter = (value) => {
|
|
1501
|
+
* const formattedValue = new Intl.NumberFormat("en-US", {
|
|
1502
|
+
* style: "currency",
|
|
1503
|
+
* currency: "USD",
|
|
1504
|
+
* notation: "compact",
|
|
1505
|
+
* maximumFractionDigits: 1,
|
|
1506
|
+
* }).format(value);
|
|
1507
|
+
* return `<strong>${formattedValue}</strong>`;
|
|
1508
|
+
* };
|
|
1509
|
+
* ```
|
|
1510
|
+
*
|
|
1511
|
+
* 
|
|
1512
|
+
*
|
|
1513
|
+
* **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.
|
|
1310
1514
|
*/
|
|
1311
1515
|
accessor secondaryYAxisLabelFormatter: AxisLabelFormatCallback | undefined;
|
|
1312
1516
|
/**
|
|
1313
|
-
*
|
|
1517
|
+
* Applies a programmatic selection to the chart. The payload can target chart elements by object IDs (`selectionOIDs`), by indexes (`selectionIndexes`), or by items (`selectionItems`).
|
|
1518
|
+
*
|
|
1519
|
+
* ##### Selection by object IDs
|
|
1520
|
+
* When passing in a `selectionOIDs` array, the chart will match the provided object IDs with the chart's data items and apply the selection.
|
|
1521
|
+
*
|
|
1522
|
+
* @example
|
|
1523
|
+
* ```ts
|
|
1524
|
+
* // This selects the chart data items (`Mid East` and `Great Lakes`) that contains the object IDs "3118" and "6544".
|
|
1525
|
+
* chartElement.selectionData = {
|
|
1526
|
+
* selectionOIDs: [3118, 6544],
|
|
1527
|
+
* };
|
|
1528
|
+
* ```
|
|
1529
|
+
*
|
|
1530
|
+
* <img
|
|
1531
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionData_selectionOIDs.avif"
|
|
1532
|
+
* alt="selectionOIDs"
|
|
1533
|
+
* style="max-width: 600px; width: 100%; height: auto;"
|
|
1534
|
+
* />
|
|
1535
|
+
*
|
|
1536
|
+
* ##### Selection by items
|
|
1537
|
+
* When passing in a `selectionItems` array, the chart will match the provided items with the chart's data items and apply the selection.
|
|
1538
|
+
* @example
|
|
1539
|
+
* ```ts
|
|
1540
|
+
* // This selects the first chart data item with the matching items.
|
|
1541
|
+
* chartElement.selectionData = {
|
|
1542
|
+
* selectionItems: [
|
|
1543
|
+
* {
|
|
1544
|
+
* // The field name and value
|
|
1545
|
+
* neighbourhood_group: "Manhattan",
|
|
1546
|
+
* // The y-series field name and value, 0 indicates the first series.
|
|
1547
|
+
* COUNT_OBJECTID_0: "",
|
|
1548
|
+
* },
|
|
1549
|
+
* ],
|
|
1550
|
+
* };
|
|
1551
|
+
* ```
|
|
1552
|
+
*
|
|
1553
|
+
* <img
|
|
1554
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionData_selectionItems.avif"
|
|
1555
|
+
* alt="selectionItems"
|
|
1556
|
+
* style="max-width: 600px; width: 100%; height: auto;"
|
|
1557
|
+
* />
|
|
1314
1558
|
*
|
|
1315
1559
|
* **Note**: Not applicable to gauges.
|
|
1316
1560
|
*/
|
|
1317
1561
|
accessor selectionData: SelectionData | undefined;
|
|
1318
1562
|
/**
|
|
1319
|
-
* Selection manager object used to synchronize the selections with the chart when
|
|
1320
|
-
* It has precedence over the layer view's [SelectionManager](
|
|
1563
|
+
* Selection manager object used to synchronize the selections with the chart when [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewSelection) is `true`.
|
|
1564
|
+
* It has precedence over the layer view's [SelectionManager](/references/core/views/SelectionManager/) when both are available.
|
|
1321
1565
|
*
|
|
1322
1566
|
* @since 5.1
|
|
1323
1567
|
*/
|
|
1324
1568
|
accessor selectionManager: SelectionManager | undefined;
|
|
1325
1569
|
/**
|
|
1326
|
-
*
|
|
1327
|
-
* - If no style is provided for the selected elements, a default selection is applied.
|
|
1328
|
-
* - If no style is provided for the non selected elements, the chart's style is applied.
|
|
1570
|
+
* Customizes the visual style applied to selected and non-selected chart data items (bars, slices, markers, boxes etc.).
|
|
1329
1571
|
*
|
|
1330
|
-
*
|
|
1572
|
+
* - The [`selectedElementsTheme`](/references/charts-components/utils/misc/interfaces/#SelectionTheme-selectedElementsTheme) property controls the appearance of selected elements.
|
|
1573
|
+
* - The [`nonSelectedElementsTheme`](/references/charts-components/utils/misc/interfaces/#SelectionTheme-nonSelectedElementsTheme) property controls the appearance of elements that are not selected.
|
|
1331
1574
|
*
|
|
1332
|
-
*
|
|
1575
|
+
* @example
|
|
1333
1576
|
* ```ts
|
|
1334
|
-
*
|
|
1335
|
-
*
|
|
1336
|
-
*
|
|
1337
|
-
*
|
|
1338
|
-
*
|
|
1577
|
+
* chartElement.selectionTheme = {
|
|
1578
|
+
* // The selected elements will have a magenta outline with a width of 3 pixels and will be scaled up by 10%.
|
|
1579
|
+
* selectedElementsTheme: {
|
|
1580
|
+
* elementOutlineColor: [255, 0, 237, 255],
|
|
1581
|
+
* elementOutlineWidth: 3,
|
|
1582
|
+
* transformation: {
|
|
1583
|
+
* scale: 1.1,
|
|
1584
|
+
* },
|
|
1585
|
+
* },
|
|
1586
|
+
* // The non-selected elements will be scaled down by 20% and have their opacity reduced to 50%.
|
|
1587
|
+
* nonSelectedElementsTheme: {
|
|
1588
|
+
* transformation: {
|
|
1589
|
+
* scale: 0.8,
|
|
1590
|
+
* opacity: 0.5,
|
|
1591
|
+
* },
|
|
1339
1592
|
* },
|
|
1340
|
-
*
|
|
1341
|
-
* "transformation": {
|
|
1342
|
-
* "opacity": 0.5
|
|
1343
|
-
* }
|
|
1344
|
-
* }
|
|
1345
|
-
* }
|
|
1593
|
+
* };
|
|
1346
1594
|
* ```
|
|
1595
|
+
*
|
|
1596
|
+
* <img
|
|
1597
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionTheme.avif"
|
|
1598
|
+
* alt="selectionTheme"
|
|
1599
|
+
* style="max-width: 700px; width: 100%; height: auto;"
|
|
1600
|
+
* />
|
|
1601
|
+
*
|
|
1602
|
+
* **Note**: Not applicable to gauges.
|
|
1347
1603
|
*/
|
|
1348
1604
|
accessor selectionTheme: SelectionTheme | undefined;
|
|
1349
1605
|
/**
|
|
1350
|
-
* When `true`, the
|
|
1606
|
+
* 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.
|
|
1607
|
+
*
|
|
1608
|
+
* 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.
|
|
1351
1609
|
*
|
|
1352
|
-
* **Note**: Only applicable to charts
|
|
1610
|
+
* **Note**: Only applicable to charts with temporal binning enabled (bar chart, combo bar line chart, line chart, radar chart).
|
|
1353
1611
|
*
|
|
1354
1612
|
* @default false
|
|
1355
1613
|
*/
|
|
1356
1614
|
accessor setTimeBinningInfoWhenNotProvided: boolean;
|
|
1357
1615
|
/**
|
|
1358
|
-
*
|
|
1616
|
+
* When `true`, show the series on the chart and legend even if it doesn't contain any data.
|
|
1359
1617
|
*
|
|
1360
|
-
*
|
|
1361
|
-
* For example a series can be empty after applying a data filter, filter by attribute or geometry (as when using the filter by extent).
|
|
1362
|
-
*
|
|
1363
|
-
* **Note**: Not applicable to gauges.
|
|
1618
|
+
* By default, the empty series are hidden from the chart and the legend.
|
|
1364
1619
|
*
|
|
1365
1620
|
* @default false
|
|
1621
|
+
* @example
|
|
1622
|
+
* ```ts
|
|
1623
|
+
* // In this example, we first set a data filter to only include features with a room type of "Entire home/apt" or "Private room".
|
|
1624
|
+
* // The "Shared room" series will be empty after applying the data filter.
|
|
1625
|
+
* chartElement.runtimeDataFilters = {
|
|
1626
|
+
* where: "room_type = 'Entire home/apt' OR room_type = 'Private room'",
|
|
1627
|
+
* };
|
|
1628
|
+
*
|
|
1629
|
+
* // With the `showEmptySeries` property set to `true`,
|
|
1630
|
+
* // the "Shared room" series will still be displayed on the chart and in the legend, even though it was filtered out.
|
|
1631
|
+
* chartElement.showEmptySeries = true;
|
|
1632
|
+
* ```
|
|
1633
|
+
*
|
|
1634
|
+
* <img
|
|
1635
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/showEmptySeries.avif"
|
|
1636
|
+
* alt="showEmptySeries"
|
|
1637
|
+
* style="max-width: 700px; width: 100%; height: auto;"
|
|
1638
|
+
* />
|
|
1639
|
+
*
|
|
1640
|
+
* **Note**: Not applicable to gauges.
|
|
1366
1641
|
* @since 5.1
|
|
1367
1642
|
*/
|
|
1368
1643
|
accessor showEmptySeries: boolean;
|
|
1369
1644
|
/**
|
|
1370
|
-
*
|
|
1645
|
+
* When `true`, the license watermark is displayed on the lower left corner of the chart.
|
|
1371
1646
|
*
|
|
1647
|
+
* @deprecated since 5.2. Won't be replaced.
|
|
1372
1648
|
* @default false
|
|
1373
1649
|
* @since 5.1
|
|
1374
1650
|
*/
|
|
1375
1651
|
accessor showLicenseWatermark: boolean;
|
|
1376
1652
|
/**
|
|
1377
|
-
* Whether to display or hide all UI messages (e.g. no data warnings,
|
|
1653
|
+
* Whether to display or hide all UI messages (e.g. no data warnings, any placeholder messages set or invalid chart configuration).
|
|
1378
1654
|
*
|
|
1379
1655
|
* @deprecated since 5.1. Use [hideUIMessages](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideUIMessages) instead.
|
|
1380
1656
|
* @default false
|
|
1381
1657
|
*/
|
|
1382
1658
|
accessor showUIMessages: boolean | undefined;
|
|
1383
1659
|
/**
|
|
1384
|
-
* Whether to skip the chart rendering queue.
|
|
1385
|
-
*
|
|
1386
1660
|
* When `true`, charts will render immediately without waiting for other charts to finish rendering.
|
|
1387
|
-
*
|
|
1661
|
+
* By default, charts are queued so that only one chart renders at a time.
|
|
1388
1662
|
*
|
|
1389
1663
|
* @default false
|
|
1390
1664
|
* @since 5.1
|
|
1391
1665
|
*/
|
|
1392
1666
|
accessor skipChartCreationQueue: boolean;
|
|
1393
1667
|
/**
|
|
1394
|
-
*
|
|
1668
|
+
* When `true`, the selection will be synchronized between charts configured with the same layer.
|
|
1395
1669
|
*
|
|
1396
1670
|
* @default false
|
|
1671
|
+
* @example
|
|
1672
|
+
* ```ts
|
|
1673
|
+
* // Both charts are configured with the same layer.
|
|
1674
|
+
* // The "Private room" slice is selected on the pie chart and the selection is reflected on the bar chart.
|
|
1675
|
+
* chartElement1.syncChartsSelection = true;
|
|
1676
|
+
* chartElement2.syncChartsSelection = true;
|
|
1677
|
+
* ```
|
|
1678
|
+
*
|
|
1679
|
+
* <img
|
|
1680
|
+
* src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/syncChartsSelection.avif"
|
|
1681
|
+
* alt="syncChartsSelection"
|
|
1682
|
+
* style="max-width: 700px; width: 100%; height: auto;"
|
|
1683
|
+
* />
|
|
1397
1684
|
* @since 5.1
|
|
1398
1685
|
*/
|
|
1399
1686
|
accessor syncChartsSelection: boolean;
|
|
@@ -1405,14 +1692,14 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1405
1692
|
*/
|
|
1406
1693
|
accessor syncSelection: boolean;
|
|
1407
1694
|
/**
|
|
1408
|
-
* Determines whether the chart's selection should be synchronized with either the chart's
|
|
1695
|
+
* Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.
|
|
1409
1696
|
*
|
|
1410
1697
|
* @deprecated since 5.1. Use [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewSelection) prop instead.
|
|
1411
1698
|
* @default "disabled"
|
|
1412
1699
|
*/
|
|
1413
1700
|
accessor syncSelectionsBetweenChartAndLayerViewPolicy: SyncSelectionsBetweenChartAndLayerViewPolicy;
|
|
1414
1701
|
/**
|
|
1415
|
-
* Determines whether the chart's selection should be synchronized with either the chart's
|
|
1702
|
+
* Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.
|
|
1416
1703
|
*
|
|
1417
1704
|
* @default false
|
|
1418
1705
|
* @since 5.1
|
|
@@ -1428,7 +1715,8 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1428
1715
|
*/
|
|
1429
1716
|
accessor syncViewTimeExtent: boolean;
|
|
1430
1717
|
/**
|
|
1431
|
-
* Whether the chart's data should be in sync with the view's
|
|
1718
|
+
* Whether the chart's data should be in sync with the view's [timeZone](/references/core/views/MapView/#timeZone).
|
|
1719
|
+
*
|
|
1432
1720
|
* **Note**: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the
|
|
1433
1721
|
* capacity to handle the `/queryBins` operation. For any other case the chart will ignore the view's time zone regardless of the value of this property.
|
|
1434
1722
|
*
|
|
@@ -1437,7 +1725,8 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1437
1725
|
*/
|
|
1438
1726
|
accessor syncViewTimeZone: boolean;
|
|
1439
1727
|
/**
|
|
1440
|
-
* List of chart types to include from syncing the view's
|
|
1728
|
+
* List of chart types to include from syncing the view's [`timeZone`](/references/core/views/MapView/#timeZone) with the data. Currently heat charts are included by default.
|
|
1729
|
+
*
|
|
1441
1730
|
* **Note**: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the
|
|
1442
1731
|
* capacity to handle the `/queryBins` operation. For any other case the chart will ignore the view's time zone regardless of the content of this list.
|
|
1443
1732
|
*
|
|
@@ -1451,40 +1740,43 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1451
1740
|
* ```ts
|
|
1452
1741
|
* chartComponent.timeZone = "America/Los_Angeles";
|
|
1453
1742
|
* ```
|
|
1454
|
-
* @example
|
|
1455
|
-
* ```html
|
|
1456
|
-
* <arcgis-chart time-zone="America/Los_Angeles"></arcgis-chart>
|
|
1457
|
-
* ```
|
|
1458
1743
|
*/
|
|
1459
1744
|
accessor timeZone: MapView["timeZone"] | undefined;
|
|
1460
1745
|
/**
|
|
1461
|
-
*
|
|
1746
|
+
* 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.
|
|
1462
1747
|
*
|
|
1463
|
-
* **Note**: Only applicable to
|
|
1748
|
+
* **Note**: Only applicable to charts with multiple series and while the legend is displayed.
|
|
1464
1749
|
*
|
|
1465
1750
|
* @default false
|
|
1466
1751
|
*/
|
|
1467
1752
|
accessor togglingLegendItemsDisabled: boolean | undefined;
|
|
1468
1753
|
/**
|
|
1469
|
-
* Callback function used to format the tooltips. If the returned string contains HTML tags they will be interpreted as such.
|
|
1754
|
+
* 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.
|
|
1470
1755
|
*
|
|
1471
1756
|
* @example
|
|
1472
1757
|
* ```ts
|
|
1473
|
-
*
|
|
1474
|
-
*
|
|
1475
|
-
*
|
|
1758
|
+
* // Render a custom tooltip with the series name, x-value, and stat value.
|
|
1759
|
+
* chartElement.tooltipFormatter = (props) => `
|
|
1760
|
+
* <div>
|
|
1761
|
+
* <div><strong>${props.seriesName}</strong> in <strong>${props.xValue}</strong></div>
|
|
1762
|
+
* <div>Total listings: <strong>${props.statValue}</strong></div>
|
|
1763
|
+
* </div>
|
|
1764
|
+
* `;
|
|
1476
1765
|
* ```
|
|
1477
1766
|
*
|
|
1767
|
+
* 
|
|
1768
|
+
*
|
|
1478
1769
|
* **Note**: Not applicable to gauges.
|
|
1479
1770
|
*/
|
|
1480
1771
|
accessor tooltipFormatter: ChartOptions["tooltipFormatter"] | undefined;
|
|
1481
1772
|
/**
|
|
1482
|
-
* Whether to
|
|
1773
|
+
* Whether to automatically add the missing series to cover the split-by values not referenced in the configuration.
|
|
1774
|
+
* - 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.
|
|
1775
|
+
* - When [`addMissingSeries`](/references/charts-components/utils/components/interfaces/#MissingSplitBySeriesProps-addMissingSeries) is set to `true`, the missing series will be added.
|
|
1776
|
+
* - 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.
|
|
1777
|
+
* - 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
1778
|
*
|
|
1484
|
-
*
|
|
1485
|
-
* The default information from the property `updateSplitBySeries.seriesTemplate` will be applied to the new series.
|
|
1486
|
-
*
|
|
1487
|
-
* **Note**: Applicable only to bar chart, line chart and box plot when a split-by field is used.
|
|
1779
|
+
* **Note**: Applicable only to bar chart, box plot, line chart and radar chart when a split-by field is used.
|
|
1488
1780
|
*/
|
|
1489
1781
|
accessor updateSplitBySeries: MissingSplitBySeriesProps | undefined;
|
|
1490
1782
|
/**
|
|
@@ -1516,15 +1808,46 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1516
1808
|
/**
|
|
1517
1809
|
* Callback function used to format the x-axis labels. If the returned string contains HTML tags they will be interpreted as such.
|
|
1518
1810
|
*
|
|
1519
|
-
*
|
|
1811
|
+
* @example
|
|
1812
|
+
* ```ts
|
|
1813
|
+
* // Render a custom x-axis label with underlined string and bolded value.
|
|
1814
|
+
* chartElement.xAxisLabelFormatter = (value) => {
|
|
1815
|
+
* return `<u>Neighbourhood Group:</u> <strong>${value}</strong>`;
|
|
1816
|
+
* };
|
|
1817
|
+
* ```
|
|
1818
|
+
*
|
|
1819
|
+
* 
|
|
1820
|
+
*
|
|
1821
|
+
* **Note**: Only applicable to charts with x-axis labels displayed.
|
|
1520
1822
|
*/
|
|
1521
1823
|
accessor xAxisLabelFormatter: AxisLabelFormatCallback | undefined;
|
|
1522
1824
|
/**
|
|
1523
1825
|
* Callback function used to format the y-axis labels. If the returned string contains HTML tags they will be interpreted as such.
|
|
1524
1826
|
*
|
|
1525
|
-
*
|
|
1827
|
+
* @example
|
|
1828
|
+
* ```ts
|
|
1829
|
+
* // Render a custom y-axis label with underlined string and bolded value.
|
|
1830
|
+
* chartElement.yAxisLabelFormatter = (value) => {
|
|
1831
|
+
* return `<u>Rental Listings:</u> <strong>${value}</strong>`;
|
|
1832
|
+
* };
|
|
1833
|
+
* ```
|
|
1834
|
+
*
|
|
1835
|
+
* 
|
|
1836
|
+
*
|
|
1837
|
+
* **Note**: Only applicable to charts with y-axis labels displayed.
|
|
1526
1838
|
*/
|
|
1527
1839
|
accessor yAxisLabelFormatter: AxisLabelFormatCallback | undefined;
|
|
1840
|
+
/**
|
|
1841
|
+
* When `true`, count=0 is considered a valid statistic.
|
|
1842
|
+
*
|
|
1843
|
+
* By default, when the aggregation type is "count" and the data contains only values equal to 0, the chart dataset
|
|
1844
|
+
* is considered empty:
|
|
1845
|
+
* - The [@arcgisBadDataWarningRaise](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisBadDataWarningRaise) event will be sent.
|
|
1846
|
+
* - The "No data available to display" warning message will be displayed in the chart container.
|
|
1847
|
+
*
|
|
1848
|
+
* @default false
|
|
1849
|
+
*/
|
|
1850
|
+
accessor zeroCountAsValid: boolean;
|
|
1528
1851
|
/**
|
|
1529
1852
|
* Apply the selection from the selection manager to the chart.
|
|
1530
1853
|
*
|
|
@@ -1538,7 +1861,7 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1538
1861
|
*/
|
|
1539
1862
|
clearSelection(): Promise<void>;
|
|
1540
1863
|
/**
|
|
1541
|
-
* Destroys the chart instance
|
|
1864
|
+
* Destroys the chart instance.
|
|
1542
1865
|
*
|
|
1543
1866
|
* @since 5.1
|
|
1544
1867
|
*/
|
|
@@ -1553,63 +1876,110 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1553
1876
|
/**
|
|
1554
1877
|
* Export the current chart's data as a CSV file.
|
|
1555
1878
|
*
|
|
1556
|
-
* The
|
|
1557
|
-
*
|
|
1558
|
-
*
|
|
1559
|
-
*
|
|
1560
|
-
*
|
|
1561
|
-
*
|
|
1562
|
-
*
|
|
1563
|
-
*
|
|
1564
|
-
*
|
|
1565
|
-
*
|
|
1566
|
-
*
|
|
1567
|
-
*
|
|
1568
|
-
*
|
|
1569
|
-
*
|
|
1570
|
-
*
|
|
1571
|
-
*
|
|
1572
|
-
*
|
|
1573
|
-
*
|
|
1879
|
+
* @param options - The options to customize the exported CSV file.
|
|
1880
|
+
* @example
|
|
1881
|
+
* ```ts
|
|
1882
|
+
* // Export the chart's data as a CSV file with custom options.
|
|
1883
|
+
* await chartElement.exportAsCSV({
|
|
1884
|
+
* columns: ["neighbourhood_group", "room_type", "Count"],
|
|
1885
|
+
* delimiter: "|",
|
|
1886
|
+
* includeHeader: false,
|
|
1887
|
+
* quoteAll: true,
|
|
1888
|
+
* locale: "fr"
|
|
1889
|
+
* });
|
|
1890
|
+
* ```
|
|
1891
|
+
*
|
|
1892
|
+
* ```csv
|
|
1893
|
+
* // The exported CSV file will contain the following data:
|
|
1894
|
+
* sep=|
|
|
1895
|
+
* "Bronx"|"Entire home/apt"|"379"
|
|
1896
|
+
* "Bronx"|"Private room"|"652"
|
|
1897
|
+
* "Bronx"|"Shared room"|"60"
|
|
1898
|
+
* "Brooklyn"|"Entire home/apt"|"9 559"
|
|
1899
|
+
* ...
|
|
1900
|
+
* ```
|
|
1901
|
+
*
|
|
1902
|
+
* **Note**: Not supported for gauges, scatterplots and radar charts.
|
|
1574
1903
|
*/
|
|
1575
1904
|
exportAsCSV(options?: CSVOptions): Promise<void>;
|
|
1576
1905
|
/**
|
|
1577
|
-
* Exports the current chart as an image.
|
|
1578
|
-
* -
|
|
1906
|
+
* Exports and downloads the current chart as an image.
|
|
1907
|
+
* - Supported formats: `png` (default), `jpeg`, `jpg`, `webp`, and `svg`.
|
|
1908
|
+
* - When `webp` format is used on Safari, it will fallback to `png`.
|
|
1579
1909
|
*
|
|
1580
|
-
* @param format
|
|
1910
|
+
* @param format - The image format to export the chart as. Default: `png`.
|
|
1581
1911
|
*/
|
|
1582
1912
|
exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>;
|
|
1583
|
-
/**
|
|
1913
|
+
/**
|
|
1914
|
+
* Returns a promise that resolves when the chart model is fully loaded.
|
|
1915
|
+
*
|
|
1916
|
+
* 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.
|
|
1917
|
+
*
|
|
1918
|
+
* @example
|
|
1919
|
+
* ```html
|
|
1920
|
+
* // Load a chart from a layer item
|
|
1921
|
+
* <arcgis-chart layer-item-id="8871626e970a4f3e9d6113ec63a92f2f" chart-index="2" />
|
|
1922
|
+
* ```
|
|
1923
|
+
* ```ts
|
|
1924
|
+
* // Get a reference to the chart element in the DOM
|
|
1925
|
+
* const chartElement = document.querySelector("arcgis-chart");
|
|
1926
|
+
*
|
|
1927
|
+
* // Call the method to ensure the model is fully loaded before making changes
|
|
1928
|
+
* await chartElement.loadModel();
|
|
1929
|
+
*
|
|
1930
|
+
* // Once the model is loaded, use the model's properties/methods to customize
|
|
1931
|
+
* chartElement.model.titleText = "New Title";
|
|
1932
|
+
* ```
|
|
1933
|
+
* @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)
|
|
1934
|
+
*/
|
|
1584
1935
|
loadModel(): Promise<void>;
|
|
1585
1936
|
/**
|
|
1586
|
-
*
|
|
1587
|
-
*
|
|
1588
|
-
*
|
|
1937
|
+
* Passes external messages to the chart component and displays them in the chart's container.
|
|
1938
|
+
* 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.
|
|
1939
|
+
*
|
|
1940
|
+
* @param message - The message to display in the chart's container.
|
|
1941
|
+
* @param heading - The heading to display in the chart's container.
|
|
1942
|
+
* @example
|
|
1943
|
+
* ```html
|
|
1944
|
+
* <button id="show-notification" type="button">Show notification</button>
|
|
1945
|
+
* <button id="clear-notification" type="button">Clear notification</button>
|
|
1946
|
+
* ```
|
|
1589
1947
|
*
|
|
1590
|
-
*
|
|
1591
|
-
*
|
|
1948
|
+
* ```ts
|
|
1949
|
+
* // When the "Show notification" button is clicked, the chart's container will display a custom message and heading.
|
|
1950
|
+
* document.querySelector("#show-notification").addEventListener("click", () => {
|
|
1951
|
+
* chartElement.notify(
|
|
1952
|
+
* "This is a notification message.",
|
|
1953
|
+
* "Notification heading",
|
|
1954
|
+
* );
|
|
1955
|
+
* });
|
|
1956
|
+
*
|
|
1957
|
+
* // When the "Clear notification" button is clicked, the chart's container will be cleared and hidden.
|
|
1958
|
+
* document.querySelector("#clear-notification").addEventListener("click", () => {
|
|
1959
|
+
* chartElement.notify();
|
|
1960
|
+
* });
|
|
1961
|
+
* ```
|
|
1592
1962
|
*/
|
|
1593
1963
|
notify(message?: string, heading?: string): Promise<void>;
|
|
1594
1964
|
/**
|
|
1595
1965
|
* Re-render the chart.
|
|
1596
1966
|
*
|
|
1597
|
-
* @param props -
|
|
1967
|
+
* @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`).
|
|
1598
1968
|
*/
|
|
1599
1969
|
refresh(props?: {
|
|
1600
1970
|
updateData?: boolean;
|
|
1601
1971
|
resetAxesBounds?: boolean;
|
|
1602
1972
|
}): Promise<void>;
|
|
1603
1973
|
/**
|
|
1604
|
-
* Resets the chart zoom
|
|
1974
|
+
* Resets the chart's zoom and brings it back to full zoom extent.
|
|
1605
1975
|
*
|
|
1606
|
-
* **Note**:
|
|
1976
|
+
* **Note**: Not applicable to gauges, heat charts, pie charts and radar charts.
|
|
1607
1977
|
*/
|
|
1608
1978
|
resetZoom(): Promise<void>;
|
|
1609
1979
|
/**
|
|
1610
1980
|
* Switches the selection on the chart.
|
|
1611
1981
|
*
|
|
1612
|
-
* **Note**: Not applicable to
|
|
1982
|
+
* **Note**: Not applicable to gauges.
|
|
1613
1983
|
*/
|
|
1614
1984
|
switchSelection(): Promise<void>;
|
|
1615
1985
|
/** Event triggered once the chart axes min/max values are computed. */
|
|
@@ -1636,7 +2006,11 @@ export abstract class ArcgisChart extends LitElement {
|
|
|
1636
2006
|
readonly arcgisDataProcessComplete: import("@arcgis/lumina").TargetedEvent<this, DataProcessCompletePayload>;
|
|
1637
2007
|
/** Event triggered when an error occurred while fetching of processing the data for the chart. */
|
|
1638
2008
|
readonly arcgisDataProcessError: import("@arcgis/lumina").TargetedEvent<this, void>;
|
|
1639
|
-
/**
|
|
2009
|
+
/**
|
|
2010
|
+
* Event triggered when an invalid configuration is detected.
|
|
2011
|
+
*
|
|
2012
|
+
* @deprecated since 5.1. Won't be replaced.
|
|
2013
|
+
*/
|
|
1640
2014
|
readonly arcgisInvalidConfigWarningRaise: import("@arcgis/lumina").TargetedEvent<this, DataWarningObject>;
|
|
1641
2015
|
/** Event triggered once a legend item visibility has been changed. */
|
|
1642
2016
|
readonly arcgisLegendItemVisibilityChange: import("@arcgis/lumina").TargetedEvent<this, LegendItemVisibilityChangePayload>;
|