@arcgis/charts-components 5.2.0-next.7 → 5.2.0-next.71

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.
Files changed (448) hide show
  1. package/README.md +2 -2
  2. package/dist/cdn/{YJ6TRXMU.js → 24MSASQQ.js} +1 -1
  3. package/dist/cdn/25MA553Z.js +2 -0
  4. package/dist/cdn/{2HUAW34Q.js → 274L47ID.js} +1 -1
  5. package/dist/cdn/27RKQQPS.js +2 -0
  6. package/dist/cdn/{4USHOYLT.js → 2BE3GYK4.js} +1 -1
  7. package/dist/cdn/2K4MIK4T.js +2 -0
  8. package/dist/cdn/2QGFLRRI.js +2 -0
  9. package/dist/cdn/{S5UDCCRH.js → 2SLJKRSD.js} +1 -1
  10. package/dist/cdn/33JR3GH6.js +2 -0
  11. package/dist/cdn/3B6QE7OV.js +2 -0
  12. package/dist/cdn/3FM3YR57.js +2 -0
  13. package/dist/cdn/3PDVKKKZ.js +2 -0
  14. package/dist/cdn/{CLXVAIQX.js → 3QPQ3RE5.js} +1 -1
  15. package/dist/cdn/3U6ESLPG.js +2 -0
  16. package/dist/cdn/3V4ZETXH.js +2 -0
  17. package/dist/cdn/3WOYVXSZ.js +2 -0
  18. package/dist/cdn/3XB2RWHK.js +2 -0
  19. package/dist/cdn/{A5AECJXP.js → 47E3TKSH.js} +1 -1
  20. package/dist/cdn/{JBHGSSHS.js → 4BQ22DKZ.js} +1 -1
  21. package/dist/cdn/4DC4ARHU.js +2 -0
  22. package/dist/cdn/{CHLE2QGU.js → 4DXGXATO.js} +1 -1
  23. package/dist/cdn/4IO3VF3L.js +2 -0
  24. package/dist/cdn/4JUR3VIE.js +2 -0
  25. package/dist/cdn/4JWIBRGO.js +2 -0
  26. package/dist/cdn/4M4SAEH4.js +2 -0
  27. package/dist/cdn/4ODTQZJK.js +2 -0
  28. package/dist/cdn/54VUGIAU.js +2 -0
  29. package/dist/cdn/{H2A5GZ55.js → 5D2QRMC6.js} +1 -1
  30. package/dist/cdn/5GZDXWTQ.js +2 -0
  31. package/dist/cdn/{GDQBQQUP.js → 5NVOWYWZ.js} +1 -1
  32. package/dist/cdn/{LUSFGRHV.js → 5WIR3JWC.js} +1 -1
  33. package/dist/cdn/{VT4WJZN6.js → 64B7ILJI.js} +1 -1
  34. package/dist/cdn/{DEGBVJ76.js → 64F7QNUM.js} +1 -1
  35. package/dist/cdn/{HVO4LIXR.js → 6LACIKDG.js} +1 -1
  36. package/dist/cdn/{7FZC3RZK.js → 6PDO75JM.js} +1 -1
  37. package/dist/cdn/6TJIHHQF.js +2 -0
  38. package/dist/cdn/{SBYD2EKR.js → 6WJKLKEZ.js} +1 -1
  39. package/dist/cdn/{7LYAWWOE.js → 6WKTHJQK.js} +1 -1
  40. package/dist/cdn/{II2ZPEUZ.js → 7C2LVFNV.js} +1 -1
  41. package/dist/cdn/{4Z23HWDH.js → 7COM5REK.js} +1 -1
  42. package/dist/cdn/{7HGVEE7A.js → 7KNUJIOC.js} +1 -1
  43. package/dist/cdn/{TF7TE7K5.js → 7PC3VBMY.js} +1 -1
  44. package/dist/cdn/7REEJ3OW.js +2 -0
  45. package/dist/cdn/{CHQDKVVQ.js → 7SBVBD4E.js} +1 -1
  46. package/dist/cdn/{6XTKJ7DO.js → 7XHAJY6Q.js} +1 -1
  47. package/dist/cdn/7XWR4EVM.js +2 -0
  48. package/dist/cdn/{DKAHZ7IX.js → ACRMB7MU.js} +1 -1
  49. package/dist/cdn/{OJ5X6I3H.js → ADI63OO7.js} +1 -1
  50. package/dist/cdn/{VY3KBD6N.js → ASYRUV4T.js} +1 -1
  51. package/dist/cdn/AVE3KXWQ.js +2 -0
  52. package/dist/cdn/{TXB2I2U5.js → B2SUC7VR.js} +1 -1
  53. package/dist/cdn/{KFONSKQF.js → B4RCAP3J.js} +1 -1
  54. package/dist/cdn/BAFCVCT4.js +2 -0
  55. package/dist/cdn/{TACQVUBU.js → BDEDEGCZ.js} +1 -1
  56. package/dist/cdn/BGOWDCTO.js +2 -0
  57. package/dist/cdn/{LFQGH44F.js → BJC2AIS3.js} +1 -1
  58. package/dist/cdn/{CNFBNAPJ.js → BK7DHYA7.js} +1 -1
  59. package/dist/cdn/BNNBHYRP.js +2 -0
  60. package/dist/cdn/BQORJ3LU.js +2 -0
  61. package/dist/cdn/BYSUABOV.js +2 -0
  62. package/dist/cdn/BZ6FUIQF.js +2 -0
  63. package/dist/cdn/{K3GNHGEW.js → C3A3UXVR.js} +1 -1
  64. package/dist/cdn/{ZFZ5AEUQ.js → CKIF4L44.js} +1 -1
  65. package/dist/cdn/CNI32IL3.js +2 -0
  66. package/dist/cdn/{ADGMA3ST.js → CRNIOME2.js} +2 -2
  67. package/dist/cdn/CRQK4CKK.js +2 -0
  68. package/dist/cdn/CVFKL3S2.js +2 -0
  69. package/dist/cdn/{ZFJFTDJF.js → CYGMXV56.js} +1 -1
  70. package/dist/cdn/D3YWSIAT.js +2 -0
  71. package/dist/cdn/{KDJ5RVHA.js → DAFNQT4C.js} +1 -1
  72. package/dist/cdn/DB2GBCE3.js +2 -0
  73. package/dist/cdn/DGYLORDT.js +2 -0
  74. package/dist/cdn/{KCMZSNBL.js → DT5BOM5F.js} +1 -1
  75. package/dist/cdn/{DCZWZOPF.js → DWYBKGOM.js} +1 -1
  76. package/dist/cdn/E7QFC64H.js +2 -0
  77. package/dist/cdn/EJWHEBKW.js +2 -0
  78. package/dist/cdn/{ZXOO3X5P.js → EQD2B3I6.js} +1 -1
  79. package/dist/cdn/{J5NHXQLA.js → EQZBQP5A.js} +1 -1
  80. package/dist/cdn/F5AR3N3Z.js +2 -0
  81. package/dist/cdn/F7UO7P33.js +2 -0
  82. package/dist/cdn/{XW4PBQNW.js → FBLOPEXC.js} +1 -1
  83. package/dist/cdn/FJGG2VVZ.js +2 -0
  84. package/dist/cdn/{N6AOFBBX.js → GBOCN364.js} +1 -1
  85. package/dist/cdn/GIH3U7YP.js +2 -0
  86. package/dist/cdn/GKEW5JYD.js +2 -0
  87. package/dist/cdn/{L4G6FO7A.js → HDYL2BOC.js} +1 -1
  88. package/dist/cdn/{QMSINFQX.js → HP3GIDT5.js} +1 -1
  89. package/dist/cdn/{AZOBLYAP.js → I2BM5KSH.js} +1 -1
  90. package/dist/cdn/I5DMUUEL.js +2 -0
  91. package/dist/cdn/{JQKRGUBU.js → IDAOLPMA.js} +1 -1
  92. package/dist/cdn/IJWJOXQC.js +2 -0
  93. package/dist/cdn/{JRHMUFED.js → IK4FPUFJ.js} +1 -1
  94. package/dist/cdn/IO6A77U4.js +2 -0
  95. package/dist/cdn/IODRBLGT.js +2 -0
  96. package/dist/cdn/{P4HSSZRL.js → IONJLIQQ.js} +1 -1
  97. package/dist/cdn/IPEJCIHO.js +2 -0
  98. package/dist/cdn/{A4GEWIPY.js → IR2W7UQ3.js} +1 -1
  99. package/dist/cdn/{QOOBNATX.js → J3VAMS5Z.js} +1 -1
  100. package/dist/cdn/{QFEZPP3R.js → JAQYU6KP.js} +1 -1
  101. package/dist/cdn/{IPM2XKST.js → JWEGCP5P.js} +1 -1
  102. package/dist/cdn/{AK7X7SGI.js → JYC77MVD.js} +1 -1
  103. package/dist/cdn/JYLEN3VQ.js +2 -0
  104. package/dist/cdn/{YOT6DVSU.js → K2PVLPOV.js} +1 -1
  105. package/dist/cdn/K4APZJ2O.js +2 -0
  106. package/dist/cdn/{MVHQR4FJ.js → K6F2LRKI.js} +1 -1
  107. package/dist/cdn/KJZTU3DV.js +2 -0
  108. package/dist/cdn/{D3CFPMAR.js → KOY5DWSR.js} +1 -1
  109. package/dist/cdn/L6DFXTSQ.js +104 -0
  110. package/dist/cdn/{AY6IOQ3H.js → LAEUROZM.js} +1 -1
  111. package/dist/cdn/LAPBDR32.js +2 -0
  112. package/dist/cdn/{AJWYIBGC.js → LC4YFJSM.js} +1 -1
  113. package/dist/cdn/LIDWAYQH.js +45 -0
  114. package/dist/cdn/LJTJTGIW.js +2 -0
  115. package/dist/cdn/LPYRKK25.js +2 -0
  116. package/dist/cdn/MAC4MPUA.js +2 -0
  117. package/dist/cdn/{KZ7LPNX3.js → MGAMMXJW.js} +1 -1
  118. package/dist/cdn/MOG5ZVLX.js +2 -0
  119. package/dist/cdn/{ETKPMU7Z.js → MSB6J66X.js} +1 -1
  120. package/dist/cdn/NAGOJPIX.js +3 -0
  121. package/dist/cdn/NF4EBNLN.js +2 -0
  122. package/dist/cdn/{XG2KN6YJ.js → NKPZCF5U.js} +1 -1
  123. package/dist/cdn/NP24UZGI.js +2 -0
  124. package/dist/cdn/{VE3GFNNM.js → NRXCKYYY.js} +1 -1
  125. package/dist/cdn/NUHPR7BM.js +2 -0
  126. package/dist/cdn/{BJDRJUEJ.js → NWHLFMAD.js} +1 -1
  127. package/dist/cdn/{4C6KWLWN.js → NWLNHFHJ.js} +1 -1
  128. package/dist/cdn/O2BQ374Y.js +2 -0
  129. package/dist/cdn/{UT4TYXFO.js → O7LPETXX.js} +1 -1
  130. package/dist/cdn/{THTYR6IL.js → OAXHS4LE.js} +1 -1
  131. package/dist/cdn/{NAXNRCMZ.js → OD2NWPCL.js} +1 -1
  132. package/dist/cdn/OE7FIKPS.js +2 -0
  133. package/dist/cdn/OE7Q4MG5.js +2 -0
  134. package/dist/cdn/{4ZIZEJXS.js → OISERMTF.js} +1 -1
  135. package/dist/cdn/{ETOGNYFU.js → OKAZOAYZ.js} +1 -1
  136. package/dist/cdn/{XUERYUEG.js → OQFM5DBD.js} +1 -1
  137. package/dist/cdn/{4LPXOEML.js → OTFA727N.js} +1 -1
  138. package/dist/cdn/{C5K6XOCR.js → P37JASN4.js} +1 -1
  139. package/dist/cdn/{244ZX2UP.js → P5I5RQTN.js} +1 -1
  140. package/dist/cdn/P6DBPQZO.js +2 -0
  141. package/dist/cdn/{DAB5R2BN.js → PIEX577B.js} +1 -1
  142. package/dist/cdn/{BJ7Q7LCT.js → PIZPF2BH.js} +1 -1
  143. package/dist/cdn/{FF4DUQDZ.js → PMAHEVYY.js} +1 -1
  144. package/dist/cdn/{AM2TOTX6.js → PQVUA4T4.js} +1 -1
  145. package/dist/cdn/PTUMQCFF.js +2 -0
  146. package/dist/cdn/{5XTQQOTT.js → Q2OIHROC.js} +1 -1
  147. package/dist/cdn/{E7OAEGSE.js → Q2WDEGUQ.js} +1 -1
  148. package/dist/cdn/QAXXYD6N.js +2 -0
  149. package/dist/cdn/QC3FMJKL.js +2 -0
  150. package/dist/cdn/{7UQHB6KY.js → QIG5H6WA.js} +1 -1
  151. package/dist/cdn/{XMPLEHTW.js → QKZK6MTN.js} +1 -1
  152. package/dist/cdn/QSGJ3MAT.js +2 -0
  153. package/dist/cdn/QT64PB4L.js +2 -0
  154. package/dist/cdn/QWCNHH6G.js +2 -0
  155. package/dist/cdn/RCLHFY6O.js +2 -0
  156. package/dist/cdn/RCZLTGQI.js +2 -0
  157. package/dist/cdn/ROG3HFDT.js +2 -0
  158. package/dist/cdn/RQ5RKGH5.js +2 -0
  159. package/dist/cdn/SL7NRRSJ.js +2 -0
  160. package/dist/cdn/{MRTKZZTF.js → SN4KBI42.js} +1 -1
  161. package/dist/cdn/{DNTLH5RT.js → SSOL6PCL.js} +1 -1
  162. package/dist/cdn/SSQPRUUN.js +2 -0
  163. package/dist/cdn/{ZYOWZCR7.js → TB7JE5XK.js} +1 -1
  164. package/dist/cdn/TMGMKM5F.js +2 -0
  165. package/dist/cdn/{WMPWOPRZ.js → TRAVRA3M.js} +1 -1
  166. package/dist/cdn/{WASEMNYV.js → TS7M5QXS.js} +1 -1
  167. package/dist/cdn/{P5AO3V3M.js → UD724V36.js} +1 -1
  168. package/dist/cdn/{DSIFL2DF.js → UQSD6YZM.js} +1 -1
  169. package/dist/cdn/USNJZCHH.js +2 -0
  170. package/dist/cdn/{Q7J7EKQW.js → UUVJGPFG.js} +1 -1
  171. package/dist/cdn/V2FHLWYC.js +2 -0
  172. package/dist/cdn/VAF3UIVA.js +2 -0
  173. package/dist/cdn/VHW4OAKG.js +4 -0
  174. package/dist/cdn/{ZQDADGLQ.js → VLCUXTLC.js} +1 -1
  175. package/dist/cdn/VNYRZDY5.js +2 -0
  176. package/dist/cdn/VUHFYOLC.js +2 -0
  177. package/dist/cdn/{Y7HBWU3M.js → WDMYVS4F.js} +1 -1
  178. package/dist/cdn/WDUTZ6EO.js +2 -0
  179. package/dist/cdn/WM6SCZHN.js +2 -0
  180. package/dist/cdn/WPLHZAZ3.js +2 -0
  181. package/dist/cdn/{6B7JCDQC.js → WTF2PFHV.js} +1 -1
  182. package/dist/cdn/{GV3TT7L5.js → XDNGNOOK.js} +1 -1
  183. package/dist/cdn/XH57C72H.js +2 -0
  184. package/dist/cdn/{JJIGLOJA.js → XJVFIGWI.js} +1 -1
  185. package/dist/cdn/{5MEQANMY.js → Y2NESTSK.js} +1 -1
  186. package/dist/cdn/{BXYNEUQY.js → YCQLYXH4.js} +1 -1
  187. package/dist/cdn/{XE3FKQFA.js → YFHCD7R2.js} +1 -1
  188. package/dist/cdn/{AWF4R7WL.js → YW6IZCRW.js} +1 -1
  189. package/dist/cdn/{KUZR6CGB.js → ZK2KMZEI.js} +1 -1
  190. package/dist/cdn/ZK5Z6BOX.js +2 -0
  191. package/dist/cdn/{5ZGALYWZ.js → ZLCRTIQH.js} +1 -1
  192. package/dist/cdn/{TYUVXRBO.js → ZZHKDFTA.js} +1 -1
  193. package/dist/cdn/assets/charts-config-view-charts/t9n/messages.en.json +1 -1
  194. package/dist/cdn/index.js +1 -1
  195. package/dist/cdn/main.css +1 -1
  196. package/dist/cdn/model/shared/setup-utils.js +1 -1
  197. package/dist/chart-rendering/common/data/utils/summarize-data/interfaces.d.ts +5 -1
  198. package/dist/chart-rendering/common/interfaces.d.ts +19 -21
  199. package/dist/chunks/{type-guards3.js → action-bar-utils.js} +27 -35
  200. package/dist/chunks/axis-lines-symbol.js +7 -7
  201. package/dist/chunks/bar-chart-model.js +42 -38
  202. package/dist/chunks/box-plot-data.js +273 -282
  203. package/dist/chunks/box-plot-model.js +137 -122
  204. package/dist/chunks/chart-model.js +177 -145
  205. package/dist/chunks/chart-object-literals.js +2 -1
  206. package/dist/chunks/chart-ui-utils.js +24 -23
  207. package/dist/chunks/class-breaks.js +76 -76
  208. package/dist/chunks/combo-bar-line-chart-model.js +25 -26
  209. package/dist/chunks/data-labels-symbol.js +39 -24
  210. package/dist/chunks/data-labels-visibility.js +24 -24
  211. package/dist/chunks/data.js +69 -69
  212. package/dist/chunks/gauge-model.js +18 -18
  213. package/dist/chunks/generate-x-axis-title.js +12 -12
  214. package/dist/chunks/heat-chart-model.js +93 -64
  215. package/dist/chunks/histogram-data.js +22 -22
  216. package/dist/chunks/histogram-model.js +10 -10
  217. package/dist/chunks/index.js +191 -180
  218. package/dist/chunks/index2.js +6422 -6009
  219. package/dist/chunks/index3.js +97 -86
  220. package/dist/chunks/index4.js +316 -87
  221. package/dist/chunks/index5.js +63 -100
  222. package/dist/chunks/line-chart-model.js +12 -12
  223. package/dist/chunks/model-setter.js +16 -15
  224. package/dist/chunks/model-with-line-marker-styling.js +2 -3
  225. package/dist/chunks/model-with-y-guides.js +59 -74
  226. package/dist/chunks/negative-values-stacked-to-baseline.js +18 -18
  227. package/dist/chunks/pie-chart-data.js +174 -192
  228. package/dist/chunks/pie-chart-model.js +267 -250
  229. package/dist/chunks/radar-chart-model.js +397 -46
  230. package/dist/chunks/resource.js +5 -5
  231. package/dist/chunks/rotated-state.js +1 -1
  232. package/dist/chunks/rounded-corners.js +73 -0
  233. package/dist/chunks/scatterplot-model.js +3 -3
  234. package/dist/chunks/serial-chart-data.js +873 -753
  235. package/dist/chunks/serial-chart-model.js +146 -124
  236. package/dist/chunks/series-length.js +2 -2
  237. package/dist/chunks/series-types.js +22 -18
  238. package/dist/chunks/series.js +1 -1
  239. package/dist/chunks/type-guards.js +17 -13
  240. package/dist/chunks/type-guards2.js +41 -33
  241. package/dist/chunks/utils.js +104 -94
  242. package/dist/chunks/utils2.js +1 -1
  243. package/dist/chunks/web-component-utils.js +592 -541
  244. package/dist/chunks/x-bounds.js +41 -42
  245. package/dist/components/arcgis-chart/customElement.d.ts +547 -224
  246. package/dist/components/arcgis-chart/customElement.js +10300 -10278
  247. package/dist/components/arcgis-charts-action-bar/customElement.js +33 -30
  248. package/dist/components/arcgis-charts-config-axis/customElement.js +70 -64
  249. package/dist/components/arcgis-charts-config-bar-chart/customElement.js +40 -27
  250. package/dist/components/arcgis-charts-config-bar-chart-data/customElement.js +19 -19
  251. package/dist/components/arcgis-charts-config-bar-chart-data/index.js +1 -1
  252. package/dist/components/arcgis-charts-config-bar-chart-popover/customElement.js +35 -37
  253. package/dist/components/arcgis-charts-config-bar-chart-series/customElement.js +44 -43
  254. package/dist/components/arcgis-charts-config-bar-chart-series-popover/customElement.js +13 -15
  255. package/dist/components/arcgis-charts-config-box-plot/customElement.js +10 -11
  256. package/dist/components/arcgis-charts-config-box-plot-data/customElement.js +8 -8
  257. package/dist/components/arcgis-charts-config-box-plot-data/index.js +1 -1
  258. package/dist/components/arcgis-charts-config-box-plot-popover/customElement.js +23 -25
  259. package/dist/components/arcgis-charts-config-box-plot-series/customElement.js +1 -1
  260. package/dist/components/arcgis-charts-config-box-plot-series-popover/customElement.js +15 -18
  261. package/dist/components/arcgis-charts-config-chart-rename-popover/customElement.js +18 -20
  262. package/dist/components/arcgis-charts-config-color-style/customElement.js +1 -1
  263. package/dist/components/arcgis-charts-config-create-flow/customElement.js +243 -229
  264. package/dist/components/arcgis-charts-config-field-picker/customElement.js +30 -0
  265. package/dist/components/arcgis-charts-config-font-style/customElement.js +2 -2
  266. package/dist/components/arcgis-charts-config-format/customElement.js +93 -86
  267. package/dist/components/arcgis-charts-config-format-popover/customElement.js +7 -10
  268. package/dist/components/arcgis-charts-config-guide/customElement.js +17 -18
  269. package/dist/components/arcgis-charts-config-guide-popover/customElement.js +10 -13
  270. package/dist/components/arcgis-charts-config-guides/customElement.js +1 -1
  271. package/dist/components/arcgis-charts-config-heat-chart/customElement.js +12 -13
  272. package/dist/components/arcgis-charts-config-heat-chart-data/customElement.js +64 -76
  273. package/dist/components/arcgis-charts-config-heat-chart-data/index.js +1 -1
  274. package/dist/components/arcgis-charts-config-heat-chart-popover/customElement.js +53 -54
  275. package/dist/components/arcgis-charts-config-histogram/customElement.js +27 -23
  276. package/dist/components/arcgis-charts-config-histogram-data/customElement.js +19 -19
  277. package/dist/components/arcgis-charts-config-histogram-data/index.js +1 -1
  278. package/dist/components/arcgis-charts-config-histogram-popover/customElement.js +33 -34
  279. package/dist/components/arcgis-charts-config-line-chart/customElement.js +5 -6
  280. package/dist/components/arcgis-charts-config-line-chart-data/customElement.js +12 -12
  281. package/dist/components/arcgis-charts-config-line-chart-data/index.js +1 -1
  282. package/dist/components/arcgis-charts-config-line-chart-popover/customElement.js +35 -37
  283. package/dist/components/arcgis-charts-config-line-chart-series/customElement.js +6 -6
  284. package/dist/components/arcgis-charts-config-line-chart-series-popover/customElement.js +6 -7
  285. package/dist/components/arcgis-charts-config-pie-chart/customElement.js +4 -5
  286. package/dist/components/arcgis-charts-config-pie-chart-data/customElement.js +41 -48
  287. package/dist/components/arcgis-charts-config-pie-chart-data/index.js +1 -1
  288. package/dist/components/arcgis-charts-config-pie-chart-popover/customElement.js +55 -56
  289. package/dist/components/arcgis-charts-config-pie-chart-slices/customElement.js +65 -66
  290. package/dist/components/arcgis-charts-config-pie-chart-slices-popover/customElement.js +7 -10
  291. package/dist/components/arcgis-charts-config-scatter-plot/customElement.js +27 -23
  292. package/dist/components/arcgis-charts-config-scatter-plot-data/customElement.js +79 -79
  293. package/dist/components/arcgis-charts-config-scatter-plot-data/index.js +1 -1
  294. package/dist/components/arcgis-charts-config-scatter-plot-popover/customElement.js +16 -17
  295. package/dist/components/arcgis-charts-config-select-chart-type-popover/customElement.js +9 -11
  296. package/dist/components/arcgis-charts-config-view-charts/customElement.js +57 -26
  297. package/dist/components/arcgis-charts-info-modal/customElement.js +6 -6
  298. package/dist/docs/api.json +1 -1
  299. package/dist/docs/docs.json +1 -1
  300. package/dist/docs/vscode.html-custom-data.json +1 -1
  301. package/dist/docs/web-types.json +1 -1
  302. package/dist/index.d.ts +62 -67
  303. package/dist/index.js +470 -458
  304. package/dist/json-schema/index.d.ts +211 -6
  305. package/dist/loader.js +2 -2
  306. package/dist/model/bar-chart-model/bar-chart-model.d.ts +4 -2
  307. package/dist/model/box-plot-model/box-plot-model.d.ts +7 -1
  308. package/dist/model/chart-model/chart-model.d.ts +2 -1
  309. package/dist/model/combo-bar-line-chart-model/combo-bar-line-chart-model.d.ts +8 -5
  310. package/dist/model/heat-chart-model/heat-chart-model.d.ts +44 -2
  311. package/dist/model/interfaces/common.d.ts +0 -2
  312. package/dist/model/mixins/model-with-line-marker-styling.d.ts +6 -5
  313. package/dist/model/mixins/model-with-multi-axes.d.ts +62 -99
  314. package/dist/model/pie-chart-model/pie-chart-model.d.ts +2 -0
  315. package/dist/model/properties/data-labels/data-labels-symbol.d.ts +26 -0
  316. package/dist/model/properties/data-tooltip-font-size.d.ts +20 -0
  317. package/dist/model/properties/rotated-state.d.ts +1 -1
  318. package/dist/model/properties/rounded-corners.d.ts +18 -0
  319. package/dist/model/radar-chart-model/radar-chart-model.d.ts +190 -0
  320. package/dist/model/serial-chart-model/serial-chart-model.d.ts +27 -1
  321. package/dist/model/shared/type-guards.d.ts +16 -2
  322. package/dist/spec/chart-object-literals.d.ts +1 -0
  323. package/dist/spec/data-source.d.ts +17 -3
  324. package/dist/spec/rest-js-object-literals.d.ts +2 -2
  325. package/dist/spec/rest-js-types.d.ts +22 -8
  326. package/dist/spec/web-chart.d.ts +42 -6
  327. package/dist/utils/chart-config/converter/index.js +198 -179
  328. package/dist/utils/chart-config/utils/index.d.ts +56 -6
  329. package/dist/utils/chart-config/validator/index.d.ts +1 -0
  330. package/dist/utils/chart-config/validator/interfaces.d.ts +3 -3
  331. package/dist/utils/cursor/interfaces.d.ts +21 -0
  332. package/dist/utils/data/categorical-data/index.d.ts +1 -1
  333. package/dist/utils/data/index.d.ts +22 -19
  334. package/dist/utils/data/interfaces.d.ts +4 -3
  335. package/dist/utils/defaults/index.d.ts +16 -4
  336. package/dist/utils/defaults/interfaces.d.ts +7 -2
  337. package/dist/utils/errors/index.d.ts +1 -1
  338. package/dist/utils/layer/index.d.ts +5 -3
  339. package/dist/utils/layer/inline-conversion/interfaces.d.ts +0 -2
  340. package/dist/utils/layer/interfaces.d.ts +2 -1
  341. package/dist/utils/layer/query-features/index.d.ts +8 -3
  342. package/dist/utils/layer/query-parser/index.d.ts +9 -5
  343. package/dist/utils/misc/index.d.ts +2 -3
  344. package/dist/utils/type-guards/chart-types.d.ts +10 -0
  345. package/dist/utils/type-guards/series-types.d.ts +9 -2
  346. package/dist/utils/types/index.d.ts +1 -5
  347. package/package.json +6 -7
  348. package/dist/cdn/24RLLXS6.js +0 -2
  349. package/dist/cdn/2N4MK6FQ.js +0 -2
  350. package/dist/cdn/32FR66QO.js +0 -2
  351. package/dist/cdn/3EIVHDDK.js +0 -2
  352. package/dist/cdn/3NUNWPAR.js +0 -2
  353. package/dist/cdn/43ZHPVBB.js +0 -2
  354. package/dist/cdn/547RDEMV.js +0 -2
  355. package/dist/cdn/5YJNENER.js +0 -2
  356. package/dist/cdn/6AF2OTL6.js +0 -2
  357. package/dist/cdn/6CFIKYKR.js +0 -2
  358. package/dist/cdn/6GLTSMOR.js +0 -2
  359. package/dist/cdn/7EMCHGGV.js +0 -2
  360. package/dist/cdn/7OF2IANH.js +0 -2
  361. package/dist/cdn/7VN3A7S2.js +0 -2
  362. package/dist/cdn/7YWZG3ZS.js +0 -2
  363. package/dist/cdn/A5GIBV5W.js +0 -2
  364. package/dist/cdn/ADPDJISV.js +0 -2
  365. package/dist/cdn/B4KAJRUJ.js +0 -2
  366. package/dist/cdn/BBUPTHPL.js +0 -2
  367. package/dist/cdn/BBURKBKE.js +0 -2
  368. package/dist/cdn/BO62KSB5.js +0 -2
  369. package/dist/cdn/C2FOUUEM.js +0 -2
  370. package/dist/cdn/CJPEW4LJ.js +0 -142
  371. package/dist/cdn/CVU3UPPF.js +0 -2
  372. package/dist/cdn/CZ5XRXCE.js +0 -2
  373. package/dist/cdn/D73VV2AZ.js +0 -2
  374. package/dist/cdn/DJACBOFO.js +0 -2
  375. package/dist/cdn/DPNTYHTH.js +0 -2
  376. package/dist/cdn/DZ72EIRH.js +0 -2
  377. package/dist/cdn/EGISZTGB.js +0 -2
  378. package/dist/cdn/EP34TF4L.js +0 -2
  379. package/dist/cdn/EZD3FBJU.js +0 -2
  380. package/dist/cdn/EZV7JSQJ.js +0 -2
  381. package/dist/cdn/G72TNKCS.js +0 -2
  382. package/dist/cdn/GQ5QBLRO.js +0 -2
  383. package/dist/cdn/HWJGWDU3.js +0 -2
  384. package/dist/cdn/HZR4NSZV.js +0 -2
  385. package/dist/cdn/ICFKKJWQ.js +0 -2
  386. package/dist/cdn/IWX5L226.js +0 -2
  387. package/dist/cdn/J6WQX4UD.js +0 -58
  388. package/dist/cdn/JNG6V7XC.js +0 -2
  389. package/dist/cdn/JNNB2DIA.js +0 -2
  390. package/dist/cdn/JS2KOBA2.js +0 -2
  391. package/dist/cdn/JTTJ455Y.js +0 -2
  392. package/dist/cdn/JWO5WVTZ.js +0 -2
  393. package/dist/cdn/K4WI2SGM.js +0 -2
  394. package/dist/cdn/KLHZFPYK.js +0 -2
  395. package/dist/cdn/KO7HQLGV.js +0 -2
  396. package/dist/cdn/L5AQ4I5T.js +0 -2
  397. package/dist/cdn/LC6CY2HW.js +0 -2
  398. package/dist/cdn/MBVTB42G.js +0 -2
  399. package/dist/cdn/MGEW6X3Y.js +0 -102
  400. package/dist/cdn/ML3A3MYV.js +0 -2
  401. package/dist/cdn/NSOZIR5F.js +0 -2
  402. package/dist/cdn/NTSTL3FK.js +0 -2
  403. package/dist/cdn/NZR4L5AA.js +0 -2
  404. package/dist/cdn/O5A25X5K.js +0 -2
  405. package/dist/cdn/OAAJ6CIN.js +0 -2
  406. package/dist/cdn/OGYY2Y22.js +0 -2
  407. package/dist/cdn/OHF3AEWY.js +0 -2
  408. package/dist/cdn/PAIRUVLU.js +0 -2
  409. package/dist/cdn/PRGFNLY7.js +0 -2
  410. package/dist/cdn/PROSIXIF.js +0 -2
  411. package/dist/cdn/Q5JDSPJA.js +0 -2
  412. package/dist/cdn/QJC3FDWG.js +0 -2
  413. package/dist/cdn/QRLILSSI.js +0 -2
  414. package/dist/cdn/QY53LXP2.js +0 -2
  415. package/dist/cdn/R75MHIRF.js +0 -2
  416. package/dist/cdn/RDA5NV6M.js +0 -2
  417. package/dist/cdn/RG3DO2OE.js +0 -2
  418. package/dist/cdn/RPNZL6AC.js +0 -2
  419. package/dist/cdn/S32NLOJ5.js +0 -2
  420. package/dist/cdn/SCAZDS2G.js +0 -2
  421. package/dist/cdn/SJGYHEMZ.js +0 -2
  422. package/dist/cdn/TCTQ4LMU.js +0 -2
  423. package/dist/cdn/TDHHWIIC.js +0 -2
  424. package/dist/cdn/TJMPLGQI.js +0 -2
  425. package/dist/cdn/TJMTF45U.js +0 -3
  426. package/dist/cdn/TW5DX7YP.js +0 -2
  427. package/dist/cdn/U67P6YAZ.js +0 -2
  428. package/dist/cdn/UZEMSOA2.js +0 -2
  429. package/dist/cdn/VBHQFV2H.js +0 -2
  430. package/dist/cdn/VFREVEVA.js +0 -2
  431. package/dist/cdn/VOTZAPI3.js +0 -2
  432. package/dist/cdn/VZTLODMQ.js +0 -2
  433. package/dist/cdn/W7X6L2OB.js +0 -127
  434. package/dist/cdn/WGYJBMRM.js +0 -4
  435. package/dist/cdn/WNKDEOFZ.js +0 -2
  436. package/dist/cdn/WPPMMVD5.js +0 -2
  437. package/dist/cdn/XCUXUZXY.js +0 -2
  438. package/dist/cdn/XG3WW5GG.js +0 -2
  439. package/dist/cdn/XJFVSX2E.js +0 -2
  440. package/dist/cdn/Y3CXVO2M.js +0 -2
  441. package/dist/cdn/YEZL5KRS.js +0 -2
  442. package/dist/cdn/YYK7SPXC.js +0 -2
  443. package/dist/chunks/bar-chart-series.js +0 -15
  444. package/dist/chunks/index6.js +0 -66
  445. package/dist/chunks/time-zone.js +0 -38
  446. package/dist/components/arcgis-charts-config-field-select/customElement.js +0 -30
  447. /package/dist/cdn/{IVLVCLDE.js → 7NWEE7T2.js} +0 -0
  448. /package/dist/components/{arcgis-charts-config-field-select → arcgis-charts-config-field-picker}/index.js +0 -0
@@ -22,125 +22,53 @@ 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 based on the provided model. Get started by reading the [introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/) page.
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
+ * There are different ways to render a chart with the ArcGIS Chart component:
26
27
  *
27
- * Supported chart types include bar charts, box plots, line charts, combo bar-line charts, gauges, heat charts, histograms, pie charts, scatterplots, and radar charts.
28
+ * ##### Load from a layer item
28
29
  *
29
- * @slot [action-bar] - Slot for adding a `charts-action-bar` component or `calcite-action-bar`.
30
- * @see [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/)
31
- * @see
32
- * [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-a-chart/)
30
+ * To load a chart from a layer item, first the chart needs to be [configured in Map Viewer](https://doc.arcgis.com/en/arcgis-online/create-maps/configure-charts-mv.htm) and [saved to the layer item](https://doc.arcgis.com/en/arcgis-online/create-maps/duplicate-save-layers.htm#ESRI_SECTION1_2AE9121DFA5D4E099F0D434EBA7D9365).
31
+ * Then set the [layerItemId](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#layerItemId) property to the item's ID and the [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex) property to the index of the chart within the item.
33
32
  *
34
- * **Note**: When the chart is getting rendered 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.
33
+ * ```html
34
+ * <arcgis-chart layer-item-id="..." chart-index="0"></arcgis-chart>
35
+ * ```
36
+ *
37
+ * ##### Create a new chart with charts model
38
+ *
39
+ * To create a new chart, use the [createModel](https://developers.arcgis.com/javascript/latest/references/charts-components/model/shared/setup-utils/#createModel) method with a layer and a chart type, then configure the chart using the model's properties and methods.
40
+ *
41
+ * ```js
42
+ * import FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";
43
+ * import { createModel } from "@arcgis/charts-components/model/shared/setup-utils.js";
44
+ *
45
+ * const myLayer = new FeatureLayer({ portalItem: { id: "..." } });
46
+ *
47
+ * const chartElement = document.querySelector("arcgis-chart");
48
+ * const barChartModel = await createModel({ layer: myLayer, chartType: "barChart" });
49
+ * barChartModel.xAxisField = "field";
50
+ * ```
51
+ *
52
+ * Each supported [chart type](https://developers.arcgis.com/javascript/latest/charts/chart-types/) has its own configuration properties and methods with their corresponding models.
53
+ *
54
+ * ##### See also:
55
+ * - [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/)
56
+ * - [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-a-chart/)
57
+ * - [Tutorial: Chart and map interactions](https://developers.arcgis.com/javascript/latest/tutorials/chart-and-map-interactions/)
58
+ *
59
+ * > [!WARNING]
60
+ * > 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.
61
+ *
62
+ * @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
63
  * @since 4.32
36
64
  */
37
65
  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
66
  /**
139
67
  * Localized common strings.
140
68
  *
141
69
  * @internal
142
70
  */
143
- protected commonStrings: {
71
+ protected _commonStrings: {
144
72
  utilsStrings: {
145
73
  chartType: {
146
74
  chart: string;
@@ -675,21 +603,158 @@ export abstract class ArcgisChart extends LitElement {
675
603
  "Invalid date": string;
676
604
  };
677
605
  }>;
606
+ /** @internal */
607
+ protected _messages: Partial<{ chartNotFoundWarning: string; }> & T9nMeta<{ chartNotFoundWarning: string; }>;
608
+ /**
609
+ * Specifies how user interactions on the chart are handled.
610
+ *
611
+ * - `monoSelection`: Select one data item at a time. Each new selection replaces the previous selection.
612
+ * - `multiSelection`: Select multiple data items. Each new selection is added to the existing selection.
613
+ * - `multiSelectionWithCtrlKey`: Select multiple data items only while holding Ctrl (or Cmd on macOS). Without the key, selection behaves like `monoSelection`.
614
+ * - `zoom`: Zoom into an area of the chart.
615
+ * - `none`: Disable interaction-driven selection and zoom actions.
616
+ *
617
+ * **Note**: Not applicable to gauges.
618
+ */
619
+ accessor actionMode: ActionModes | undefined;
620
+ /**
621
+ * When `true`, object ID can be used as a numeric field for aggregated charts (for example, `sum` of `objectId`).
622
+ *
623
+ * @default false
624
+ */
625
+ accessor allowUsingObjectIdStat: boolean;
626
+ /**
627
+ * 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.
628
+ *
629
+ * <video
630
+ * src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/animationEnabled.webm"
631
+ * aria-label="animationEnabled"
632
+ * width="720"
633
+ * autoPlay
634
+ * loop
635
+ * muted
636
+ * playsInline
637
+ * />
638
+ *
639
+ * @default false
640
+ * @since 5.1
641
+ */
642
+ accessor animationEnabled: boolean | undefined;
643
+ /**
644
+ * 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).
645
+ *
646
+ * @example
647
+ * ```ts
648
+ * chartElement.aria = {
649
+ * label: "Custom chart label",
650
+ * description: "Custom chart description",
651
+ * };
652
+ * ```
653
+ * @see [ARIA attributes](https://developers.arcgis.com/javascript/latest/accessibility/#aria-attributes)
654
+ * @since 5.0
655
+ */
656
+ accessor aria: DOMContainerAria | undefined;
657
+ /**
658
+ * When `true`, the component is not destroyed automatically when it is disconnected from the document, which is useful when moving or temporarily hiding it.
659
+ *
660
+ * > [!CAUTION]
661
+ * >
662
+ * > 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.
663
+ *
664
+ * @default false
665
+ * @since 5.0
666
+ */
667
+ accessor autoDestroyDisabled: boolean;
668
+ /**
669
+ * Auto disposes the chart when a new one is created in the same container.
670
+ *
671
+ * @deprecated since 5.0. Use [autoDestroyDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#autoDestroyDisabled) instead.
672
+ * @default false
673
+ */
674
+ accessor autoDisposeChart: boolean;
675
+ /**
676
+ * 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.
677
+ *
678
+ * | With `autoInverseDataLabelTextColor` | Without `autoInverseDataLabelTextColor` |
679
+ * | -------- | -------- |
680
+ * | ![autoInverseDataLabelTextColor true](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/autoInverseDataLabelTextColorTrue.avif) | ![autoInverseDataLabelTextColor false](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/autoInverseDataLabelTextColorFalse.avif) |
681
+ *
682
+ * **Note**: Applicable to heat charts only.
683
+ *
684
+ * @default false
685
+ * @since 4.34
686
+ */
687
+ accessor autoInverseDataLabelTextColor: boolean;
688
+ /**
689
+ * Specifies the Calcite CSS variables to use when applying a Calcite theme.
690
+ *
691
+ * By default the following variables are used:
692
+ * - background: `--calcite-color-foreground-1`
693
+ * - text: `--calcite-color-text-1`
694
+ * - line: `--calcite-color-border-1`
695
+ * - secondary line: `--calcite-color-text-3`
696
+ * - spinner: `--calcite-color-brand-hover`
697
+ *
698
+ * The chart colors are overridden by those associated to those CSS variables, but only if they have not been customized beforehand.
699
+ *
700
+ * @see [Charts theming with Calcite CSS variables](https://developers.arcgis.com/javascript/latest/charts/features-and-capabilities/styling-and-theming/#theming-with-css-variables)
701
+ * @see [Components theming with Calcite](https://developers.arcgis.com/javascript/latest/building-your-ui/#styling-and-theming-with-calcite)
702
+ * @since 5.1
703
+ */
704
+ accessor calciteThemingCSSVariables: CalciteThemeCSSVariables;
705
+ /**
706
+ * The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.
707
+ *
708
+ * If a `layer` or `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.
709
+ *
710
+ * If the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.
711
+ *
712
+ * @example
713
+ * ```html
714
+ * <arcgis-chart layer-item-id="8871626e970a4f3e9d6113ec63a92f2f" chart-index="2"></arcgis-chart>
715
+ * ```
716
+ */
717
+ accessor chartIndex: number | undefined;
718
+ /**
719
+ * Customize the maximum number of data items allowed on the chart.
720
+ *
721
+ * The chart's behavior once that limit is reached can be adjusted through the `behaviorAfterLimit` nested property, to either reject the creation
722
+ * or update of the chart, or render the elements up to the given limits.
723
+ *
724
+ * **Note**: Not applicable to gauges.
725
+ *
726
+ * @example
727
+ * ```ts
728
+ * chartElement.chartLimits = {
729
+ * behaviorAfterLimit: LimitBehavior.RenderUpToTheLimit,
730
+ * maxCategoryCountTotal: 15,
731
+ * };
732
+ * ```
733
+ */
734
+ accessor chartLimits: ChartElementLimit | undefined;
735
+ /**
736
+ * Lifecycle function executed after the data has been processed and before the chart renders.
737
+ * Can be used to alter the model from information extracted from the data.
738
+ *
739
+ * **Note**: Applicable to gauges and pie charts only.
740
+ */
741
+ accessor chartWillRender: PreRenderCallback | undefined;
678
742
  /**
679
743
  * Whether to use features uniquely designed for a chart currently being configured by a user via the UI.
680
- * When true, the slotted charts action bar will expose an Edit chart action, surfaces relevant error states,
681
- * and can show a helpful in-container placeholder about the chart’s purpose.
744
+ * 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,
745
+ * 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
746
  *
683
747
  * @default false
748
+ * @since 5.1
684
749
  */
685
750
  accessor configurationEnabled: boolean;
686
751
  /**
687
- * Sets the cursor range when `actionMode` is set to `zoom`, `multiSelection` or `multiSelectionWithCtrlKey`.
752
+ * 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
753
  *
689
- * - `multi-axes`: Allows to draw a free rectangle.
690
- * - `x-axis`: Allows to draw a rectangle bound to the x-axis.
691
- * - `y-axis`: Allows to draw a rectangle bound to the y-axis.
692
- * - `undefined`: Defaults to the preset behavior according to the chart type and action mode.
754
+ * - `multi-axes`: Allows drawing a free rectangle across both axes.
755
+ * - `x-axis`: Constrains the rectangle to the x-axis direction.
756
+ * - `y-axis`: Constrains the rectangle to the y-axis direction.
757
+ * - `undefined`: Uses the default behavior for the current chart type and action mode.
693
758
  *
694
759
  * **Note**: Not applicable to gauges.
695
760
  */
@@ -697,7 +762,25 @@ export abstract class ArcgisChart extends LitElement {
697
762
  /**
698
763
  * Callback function used to format the data labels. If the returned string contains HTML tags they will be interpreted as such.
699
764
  *
700
- * **Note**: Not applicable to gauges.
765
+ * @example
766
+ * ```ts
767
+ * // Render custom data labels with the stat value and percentage formatted to 2 decimal places.
768
+ * chartElement.dataLabelFormatter = (statValue, percent) => {
769
+ * return `
770
+ * <div>
771
+ * Total listings: <strong>${statValue}</strong><br>
772
+ * Percentage: <strong>${Number(percent).toFixed(2)}%</strong>
773
+ * </div>
774
+ * `;
775
+ * };
776
+ * ```
777
+ * <img
778
+ * src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/dataLabelFormatter.avif"
779
+ * alt="dataLabelFormatter true"
780
+ * style="max-width: 700px; width: 100%; height: auto;"
781
+ * />
782
+ *
783
+ * **Note**: Not applicable to gauges and radar charts.
701
784
  */
702
785
  accessor dataLabelFormatter: ChartOptions["dataLabelFormatter"] | undefined;
703
786
  /**
@@ -740,7 +823,8 @@ export abstract class ArcgisChart extends LitElement {
740
823
  */
741
824
  accessor enableResponsiveFeatures: boolean;
742
825
  /**
743
- * Whether to display an error alert and hide the chart when it can't be created or updated.
826
+ * When set to `ignore`, the chart fails silently without displaying an error or hiding the chart.
827
+ * 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
828
  *
745
829
  * @default "throw"
746
830
  */
@@ -748,7 +832,7 @@ export abstract class ArcgisChart extends LitElement {
748
832
  /**
749
833
  * The index of the feature to render when using a feature based gauge.
750
834
  *
751
- * **Note**: Only applicable to gauges.
835
+ * **Note**: Applicable to gauges only.
752
836
  *
753
837
  * @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
838
  */
@@ -761,7 +845,8 @@ export abstract class ArcgisChart extends LitElement {
761
845
  */
762
846
  accessor filterByExtent: boolean;
763
847
  /**
764
- * When `true`, all chart elements are filtered based on the selection.
848
+ * 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.
849
+ * Axis bounds, time binning intervals will be computed based on the selected elements only.
765
850
  *
766
851
  * **Note**: Not applicable to gauges or charts configured with imagery layers.
767
852
  *
@@ -769,7 +854,7 @@ export abstract class ArcgisChart extends LitElement {
769
854
  */
770
855
  accessor filterBySelection: boolean;
771
856
  /**
772
- * When `true`, all chart elements are filtered based on the view extent.
857
+ * 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
858
  *
774
859
  * @default false
775
860
  */
@@ -777,18 +862,49 @@ export abstract class ArcgisChart extends LitElement {
777
862
  /**
778
863
  * Callback function used to format the gauge inner label. If the returned string contains HTML tags they will be interpreted as such.
779
864
  *
865
+ * @example
866
+ * ```ts
867
+ * // Render a centered custom gauge label with the value formatted to 2 decimal places.
868
+ * chartElement.gaugeInnerLabelFormatter = (value) => {
869
+ * return `<div style="text-align: center;"><u>Custom gauge inner label: </u><br /><b>${Number(value).toFixed(2)}</b></div>`;
870
+ * };
871
+ * ```
872
+ *
873
+ * <img
874
+ * src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/gaugeInnerLabelFormatter.avif"
875
+ * alt="gaugeInnerLabelFormatter"
876
+ * style="max-width: 700px; width: 100%; height: auto;"
877
+ * />
878
+ *
780
879
  * **Note**: Applicable to gauges only.
781
880
  */
782
881
  accessor gaugeInnerLabelFormatter: GaugeInnerLabelFormatCallback | undefined;
783
882
  /**
784
883
  * Callback function used to format the axes guides tooltip. If the returned string contains HTML tags they will be interpreted as such.
785
884
  *
885
+ * @example
886
+ * ```ts
887
+ * // Render a custom tooltip with the guide's start and end values.
888
+ * chartElement.guideTooltipFormatter = (props) => {
889
+ * return `
890
+ * <u>Custom guide tooltip</u><br />
891
+ * Range: <b>${props.start} - ${props.end}</b>
892
+ * `;
893
+ * };
894
+ * ```
895
+ *
896
+ * <img
897
+ * src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/guideTooltipFormatter.avif"
898
+ * alt="guideTooltipFormatter"
899
+ * style="max-width: 700px; width: 100%; height: auto;"
900
+ * />
901
+ *
786
902
  * **Note**: Not applicable to pie charts.
787
903
  */
788
904
  accessor guideTooltipFormatter: GuideTooltipFormatCallback | undefined;
789
905
  /**
790
906
  * 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).
907
+ * 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
908
  *
793
909
  * **Note**: Not applicable to gauges.
794
910
  *
@@ -804,27 +920,28 @@ export abstract class ArcgisChart extends LitElement {
804
920
  */
805
921
  accessor hideLicenseWatermark: boolean | undefined;
806
922
  /**
807
- * Hides the loader animation (curtain and spinner), showed by default at every update.
923
+ * 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).
924
+ * | When `hideLoaderAnimation` is `true` | When `hideLoaderAnimation` is `false` |
925
+ * | -------- | -------- |
926
+ * | <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
927
  *
809
928
  * @default false
810
929
  */
811
930
  accessor hideLoaderAnimation: boolean;
812
931
  /**
813
- * Whether to display or hide all UI messages (e.g. no data warnings, or when the logarithmic scale can't be applied to an axis when the data contains values <= 0).
932
+ * When set to `true`, UI messages are hidden. These messages can be no data warnings, any placeholder messages set or invalid chart configuration.
933
+ * By default, its value is `false`, which displays the messages on the chart.
814
934
  *
815
935
  * @default false
816
936
  * @since 5.1
817
937
  */
818
938
  accessor hideUIMessages: boolean;
819
939
  /**
820
- * Whether to keep missing categories from a count aggregation as gaps in the chart's data.
821
- *
822
- * When data is retrieved from the server, the server excludes all features having a count of 0 from the response; hence resulting in missing entries on the charts.
940
+ * When `true`, missing categories from a `Count` aggregation are kept as gaps in the chart's data.
823
941
  *
824
- * When this property is set to `true`, the dataset will keep these gaps instead of filling them with 0s.
942
+ * When data is retrieved from the server, features with a count of 0 are excluded from the response, resulting in missing chart entries.
825
943
  *
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.
944
+ * 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
945
  *
829
946
  * @default false
830
947
  * @since 5.1
@@ -846,18 +963,18 @@ export abstract class ArcgisChart extends LitElement {
846
963
  */
847
964
  accessor ignoreSmoothRenderingLimit: boolean;
848
965
  /**
849
- * This property will be effective when the component's `view` is provided or when the `layer` is set to a FeatureLayerView.
966
+ * When `true`, it signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.
850
967
  *
851
- * By default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any
852
- * geometry passed through the model (`component.model.dataFilters`) or the runtime filters (`component.runtimeDataFilters`).
968
+ * 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
969
  *
854
- * Setting this property to `false` signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.
970
+ * By default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any
971
+ * 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
972
  *
856
973
  * @default false
857
974
  */
858
975
  accessor ignoreViewExtent: boolean;
859
976
  /**
860
- * Disables all interactions on the chart.
977
+ * 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
978
  *
862
979
  * @default false
863
980
  */
@@ -882,9 +999,12 @@ export abstract class ArcgisChart extends LitElement {
882
999
  */
883
1000
  accessor layerFilterChangePolicy: LayerFilterChangePolicy;
884
1001
  /**
885
- * Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property.
1002
+ * Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property. If `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.
886
1003
  *
887
- * If `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.
1004
+ * The layer item ID can be found in the URL of the layer's item page on ArcGIS Online or Enterprise.
1005
+ * For example, in the URL `https://www.arcgis.com/home/item.html?id=8871626e970a4f3e9d6113ec63a92f2f`, the layer item ID is `8871626e970a4f3e9d6113ec63a92f2f`.
1006
+ *
1007
+ * 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
1008
  *
889
1009
  * @example
890
1010
  * ```html
@@ -893,13 +1013,11 @@ export abstract class ArcgisChart extends LitElement {
893
1013
  */
894
1014
  accessor layerItemId: string | undefined;
895
1015
  /**
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.
1016
+ * Allows the chart to update automatically when the layer's renderer changes. Applies when the color match is enabled.
901
1017
  *
902
1018
  * **Note**: If the property is set to `ignore` the chart will still use the layer's renderer information when the data is updated.
1019
+ *
1020
+ * @deprecated since 5.1. Won't be replaced.
903
1021
  * @default "refresh"
904
1022
  */
905
1023
  accessor layerRendererChangePolicy: LayerRendererChangePolicy;
@@ -912,8 +1030,28 @@ export abstract class ArcgisChart extends LitElement {
912
1030
  */
913
1031
  accessor legendPosition: WebChartLegendPositions | undefined;
914
1032
  /**
915
- * A callback function used to format the legend value labels. If the returned string contains HTML tags they will be interpreted as such.
916
- * If provided, the formatter will be used if at least `WebChartPieChartLegend.displayNumericValue` or `WebChartPieChartLegend.displayPercentage` is true.
1033
+ * When the pie chart label contains either a numeric value or a percentage (which can be set through the
1034
+ * [setDisplayNumericValue](https://developers.arcgis.com/javascript/latest/references/charts-components/model/pie-chart-model/pie-chart-model/#setDisplayNumericValue) and
1035
+ * [setDisplayPercentage](https://developers.arcgis.com/javascript/latest/references/charts-components/model/pie-chart-model/pie-chart-model/#setDisplayPercentage) methods from the pie chart model), this property
1036
+ * can be used to format the numeric value and/or percentage. If the returned string contains HTML tags they will be interpreted as such.
1037
+ *
1038
+ * @example
1039
+ * ```ts
1040
+ * // Set the pie chart model to display both numeric value and percentage.
1041
+ * pieChartModel.setDisplayNumericValue(true);
1042
+ * pieChartModel.setDisplayPercentage(true);
1043
+ *
1044
+ * // Render the numeric value and percentage in bold and italic respectively, with 2 decimal places.
1045
+ * chartElement.legendValueLabelFormatter = (value, percentage) => {
1046
+ * return `<strong><u>${Number(value).toFixed(2)}</u></strong> (<em>${Number(percentage).toFixed(2)}%</em>)`;
1047
+ * };
1048
+ * ```
1049
+ *
1050
+ * <img
1051
+ * src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/legendValueLabelFormatter.avif"
1052
+ * alt="legendValueLabelFormatter"
1053
+ * style="max-width: 400px; width: 100%; height: auto;"
1054
+ * />
917
1055
  *
918
1056
  * **Note**: Applicable to pie charts only.
919
1057
  */
@@ -934,12 +1072,34 @@ export abstract class ArcgisChart extends LitElement {
934
1072
  * @example
935
1073
  * ```ts
936
1074
  * // Set a blue curtain and a red spinner for the loader animation
937
- * myChart.loaderColors = { curtainColor: [30, 144, 255, 255], spinnerColor: [255, 0, 0, 255] };
1075
+ * chartComponent.loaderColors = { curtainColor: [30, 144, 255, 255], spinnerColor: [255, 0, 0, 255] };
938
1076
  * ```
939
1077
  */
940
1078
  accessor loaderColors: LoaderColors | undefined;
941
- /** Custom message overrides for the chart's strings. */
942
- accessor messageOverrides: { chartNotFoundWarning?: string | undefined; } & {
1079
+ /**
1080
+ * Custom messages for translated strings on the chart. If the returned string contains HTML tags they will be interpreted as such.
1081
+ *
1082
+ * The customizable messages can be found thru the [`CommonStringsIdentity`](/references/charts-components/utils/localization/interfaces/#CommonStringsIdentity) variable.
1083
+ *
1084
+ * @example
1085
+ * ```ts
1086
+ * // User sets the xAxisField to a field that doesn't exist in the dataset.
1087
+ * barChartModel.xAxisField = "wrong_field_name";
1088
+ *
1089
+ * // Overrides the default message when there's a query error instead of displaying the default "Failure to read input data." message.
1090
+ * chartElement.messageOverrides = {
1091
+ * errorStrings: {
1092
+ * errors: {
1093
+ * queryError:
1094
+ * "<b><u>The input data provided is invalid, please ensure the xAxisField is correctly specified.</u></b>"
1095
+ * },
1096
+ * },
1097
+ * };
1098
+ * ```
1099
+ *
1100
+ * ![messageOverrides](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/messageOverrides.avif)
1101
+ */
1102
+ accessor messageOverrides: {
943
1103
  utilsStrings?: {
944
1104
  chartType?: {
945
1105
  chart?: string | undefined;
@@ -1206,25 +1366,42 @@ export abstract class ArcgisChart extends LitElement {
1206
1366
  "Unable to load file: %1"?: string | undefined;
1207
1367
  "Invalid date"?: string | undefined;
1208
1368
  } | undefined;
1209
- };
1369
+ } & { chartNotFoundWarning?: string | undefined; };
1210
1370
  /**
1211
1371
  * Provides an API to interact with the chart's configuration.
1212
1372
  *
1213
- * **Note**: This property has a union type of `ChartModel | WebChart` meaning a raw chart configuration object can be passed to it instead, however it is recommended to use the `ChartModel` instance whenever possible.
1373
+ * `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.
1374
+ * - `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.
1375
+ * - This is the recommended approach as it ensures the chart configuration is valid and compatible with the component.
1376
+ * - `WebChart`: A plain chart configuration object that follows the [WebChart](https://developers.arcgis.com/javascript/latest/references/charts-components/spec/web-chart/#WebChart) specification.
1377
+ *
1378
+ * @see [Create a new chart with charts model](https://developers.arcgis.com/javascript/latest/charts/#create-a-new-chart-with-charts-model)
1214
1379
  */
1215
1380
  accessor model: ChartModel | WebChart | undefined;
1216
1381
  /**
1217
- * Whether to consider a `null` statistic as valid. If set to `false` and the data has only null values, the chart's dataset will be considered empty:
1218
- * - The corresponding warning event will be sent
1219
- * - The "no data" message will be displayed (unless `hideUIMessages` is set to `true` or `showUIMessages` is set to `false`)
1382
+ * When `true`, null values are considered as valid.
1383
+ *
1384
+ * By default, when the data contains only null values, the chart dataset is considered empty:
1385
+ * - The [@arcgisBadDataWarningRaise](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisBadDataWarningRaise) event will be sent.
1386
+ * - The "No data available to display" warning message will be displayed in the chart container.
1220
1387
  *
1221
1388
  * @default false
1222
1389
  */
1223
1390
  accessor nullAsValid: boolean;
1224
- /** A placeholder string to provides a brief hint to the user indicating needed information for creating a chart. */
1391
+ /**
1392
+ * Placeholder text displayed in the chart container when no chart is configured.
1393
+ * If the string contains HTML tags they will be interpreted as such.
1394
+ *
1395
+ * @example
1396
+ * ```ts
1397
+ * 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.";
1398
+ * ```
1399
+ *
1400
+ * ![placeholder](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/placeholder.avif)
1401
+ */
1225
1402
  accessor placeholder: string | undefined;
1226
1403
  /**
1227
- * Allows the use of the fields alias from the `layer.popupTemplate` when rendering the field names on the chart (e.g. tooltips, axes, legend).
1404
+ * 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
1405
  *
1229
1406
  * @default false
1230
1407
  */
@@ -1238,19 +1415,20 @@ export abstract class ArcgisChart extends LitElement {
1238
1415
  accessor queueChartCreation: boolean | undefined;
1239
1416
  /**
1240
1417
  * When `true`, the chart's `dataItems` associated with empty (no value) categories (from only a `Count` aggregation)
1241
- * will be populated with 0s, via the `completeDataForEmptyCategoriesWithZeros` method.
1418
+ * will be populated with 0s.
1242
1419
  *
1243
1420
  * @deprecated since 5.0. Use [hideZeroCountCategories](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideZeroCountCategories) instead.
1244
1421
  * @default false
1245
1422
  */
1246
1423
  accessor replaceNoValueCategoryWithZero: boolean | undefined;
1247
1424
  /**
1248
- * When `true`, the features extent will be returned through the `arcgisDataProcessComplete` and `arcgisSelectionComplete` events payload.
1425
+ * 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)
1426
+ * and [@arcgisSelectionComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisSelectionComplete) events.
1249
1427
  * Applies only to:
1250
1428
  * - Charts using an aggregation.
1251
- * - Data source using a feature layer compatible with envelope aggregation.
1429
+ * - Data sources using a feature layer compatible with envelope aggregation.
1252
1430
  *
1253
- * The extent (`IExtent`) is returned through a property called `arcgis_charts_features_extent`.
1431
+ * The extent is returned through the [featuresExtentField](https://developers.arcgis.com/javascript/latest/references/charts-components/utils/defaults/index/#featuresExtentField) variable.
1254
1432
  *
1255
1433
  * **Note**: Not applicable to gauges.
1256
1434
  *
@@ -1258,7 +1436,7 @@ export abstract class ArcgisChart extends LitElement {
1258
1436
  */
1259
1437
  accessor returnFeaturesExtent: boolean;
1260
1438
  /**
1261
- * When `true`, the selection indexes will be computed whenever a selection is made on or passed to the chart.
1439
+ * When `true`, selection indexes are computed and returned whenever a selection is made on or passed to the chart.
1262
1440
  *
1263
1441
  * **Note**: Not applicable to gauges.
1264
1442
  *
@@ -1266,10 +1444,10 @@ export abstract class ArcgisChart extends LitElement {
1266
1444
  */
1267
1445
  accessor returnSelectionIndexes: boolean;
1268
1446
  /**
1269
- * When `true`, the object ids will be computed whenever a selection is made on or passed to the chart.
1270
- * Only considered for a data source using a feature layer.
1447
+ * When `true`, object ids are computed and returned whenever a selection is made on or passed to the chart.
1448
+ * Only considered for data sources using a [feature layer](/references/core/layers/FeatureLayer).
1271
1449
  *
1272
- * **Note**: Not applicable to gauges or charts configured with imagery layers. It's always `false` for imagery layers. No object ids will be computed.
1450
+ * **Note**: Not applicable to gauges or charts configured with imagery layers.
1273
1451
  *
1274
1452
  * @default false
1275
1453
  */
@@ -1277,7 +1455,7 @@ export abstract class ArcgisChart extends LitElement {
1277
1455
  /**
1278
1456
  * When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.
1279
1457
  *
1280
- * **Note**: Applicable to bar chart, line chart, combo bar and line chart and box plot.
1458
+ * **Note**: Applicable to bar charts, box plots, combo bar line charts and line charts.
1281
1459
  *
1282
1460
  * @default false
1283
1461
  */
@@ -1285,115 +1463,230 @@ export abstract class ArcgisChart extends LitElement {
1285
1463
  /**
1286
1464
  * When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.
1287
1465
  *
1288
- * **Note**: Applicable to bar chart, line chart, combo bar and line chart and box plot.
1466
+ * **Note**: Applicable to bar chart, line chart, combo bar line chart and box plot.
1289
1467
  *
1290
1468
  * @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
1469
  * @default false
1292
1470
  */
1293
1471
  accessor rotation: boolean;
1294
1472
  /**
1295
- * Applies runtime data filters to the chart.
1473
+ * Applies runtime data filters to the chart, features will be filtered based on the provided key value pairs.
1474
+ *
1475
+ * Supported keys are `where`, `objectIds`, `geometry`, `spatialRelationship`, `distance`, `units`, `timeExtent`, and `gdbVersion`.
1296
1476
  *
1297
1477
  * @example
1298
1478
  * ```ts
1299
- * myChart.runtimeDataFilters = {
1300
- * where: "FieldValue = 9",
1479
+ * // 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.
1480
+ * const start = new Date(2005, 8, 23).getTime();
1481
+ * const end = new Date(2005, 8, 28).getTime();
1482
+ *
1483
+ * chartComponent.runtimeDataFilters = {
1484
+ * where: "Name = 'Katrina'",
1485
+ * objectIds: [12, 19, 27],
1486
+ * geometry: {
1487
+ * xmin: -130,
1488
+ * ymin: 20,
1489
+ * xmax: -60,
1490
+ * ymax: 55,
1491
+ * },
1492
+ * spatialRelationship: "contains",
1493
+ * distance: 10,
1494
+ * units: "miles",
1495
+ * timeExtent: [start, end]
1301
1496
  * };
1302
1497
  * ```
1303
1498
  */
1304
1499
  accessor runtimeDataFilters: WebChartDataFilters | undefined;
1305
1500
  /**
1306
1501
  * 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
1502
  *
1309
- * **Note**: Appliable to bar charts, line charts, combo bar line charts and radar charts.
1503
+ * @example
1504
+ * ```ts
1505
+ * // Render a custom secondary y-axis label with the value formatted as a compact currency.
1506
+ * chartElement.secondaryYAxisLabelFormatter = (value) => {
1507
+ * const formattedValue = new Intl.NumberFormat("en-US", {
1508
+ * style: "currency",
1509
+ * currency: "USD",
1510
+ * notation: "compact",
1511
+ * maximumFractionDigits: 1,
1512
+ * }).format(value);
1513
+ * return `<strong>${formattedValue}</strong>`;
1514
+ * };
1515
+ * ```
1516
+ *
1517
+ * ![secondaryYAxisLabelFormatter](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/secondaryYAxisLabelFormatter.avif)
1518
+ *
1519
+ * **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
1520
  */
1311
1521
  accessor secondaryYAxisLabelFormatter: AxisLabelFormatCallback | undefined;
1312
1522
  /**
1313
- * When this property is set, it will apply a selection on the chart matching the provided selection.
1523
+ * Applies a programmatic selection to the chart. The payload can target chart elements by object IDs (`selectionOIDs`), by indexes (`selectionIndexes`), or by items (`selectionItems`).
1524
+ *
1525
+ * ##### Selection by object IDs
1526
+ * When passing in a `selectionOIDs` array, the chart will match the provided object IDs with the chart's data items and apply the selection.
1527
+ *
1528
+ * @example
1529
+ * ```ts
1530
+ * // This selects the chart data items (`Mid East` and `Great Lakes`) that contains the object IDs "3118" and "6544".
1531
+ * chartElement.selectionData = {
1532
+ * selectionOIDs: [3118, 6544],
1533
+ * };
1534
+ * ```
1535
+ *
1536
+ * <img
1537
+ * src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionData_selectionOIDs.avif"
1538
+ * alt="selectionOIDs"
1539
+ * style="max-width: 600px; width: 100%; height: auto;"
1540
+ * />
1541
+ *
1542
+ * ##### Selection by items
1543
+ * When passing in a `selectionItems` array, the chart will match the provided items with the chart's data items and apply the selection.
1544
+ * @example
1545
+ * ```ts
1546
+ * // This selects the first chart data item with the matching items.
1547
+ * chartElement.selectionData = {
1548
+ * selectionItems: [
1549
+ * {
1550
+ * // The field name and value
1551
+ * neighbourhood_group: "Manhattan",
1552
+ * // The y-series field name and value, 0 indicates the first series.
1553
+ * COUNT_OBJECTID_0: "",
1554
+ * },
1555
+ * ],
1556
+ * };
1557
+ * ```
1558
+ *
1559
+ * <img
1560
+ * src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionData_selectionItems.avif"
1561
+ * alt="selectionItems"
1562
+ * style="max-width: 600px; width: 100%; height: auto;"
1563
+ * />
1314
1564
  *
1315
1565
  * **Note**: Not applicable to gauges.
1316
1566
  */
1317
1567
  accessor selectionData: SelectionData | undefined;
1318
1568
  /**
1319
- * Selection manager object used to synchronize the selections with the chart when `syncViewSelection` is `true`.
1320
- * It has precedence over the layer view's [SelectionManager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/) when both are available.
1569
+ * 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`.
1570
+ * It has precedence over the layer view's [SelectionManager](/references/core/views/SelectionManager/) when both are available.
1321
1571
  *
1322
1572
  * @since 5.1
1323
1573
  */
1324
1574
  accessor selectionManager: SelectionManager | undefined;
1325
1575
  /**
1326
- * Used to provide a customized theme for the selected and non selected elements.
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.
1576
+ * Customizes the visual style applied to selected and non-selected chart data items (bars, slices, markers, boxes etc.).
1329
1577
  *
1330
- * **Note**: Not applicable to gauges.
1578
+ * - The [`selectedElementsTheme`](/references/charts-components/utils/misc/interfaces/#SelectionTheme-selectedElementsTheme) property controls the appearance of selected elements.
1579
+ * - The [`nonSelectedElementsTheme`](/references/charts-components/utils/misc/interfaces/#SelectionTheme-nonSelectedElementsTheme) property controls the appearance of elements that are not selected.
1331
1580
  *
1332
- * * \@example
1581
+ * @example
1333
1582
  * ```ts
1334
- * myChart.selectionTheme = {
1335
- * "selectedElementsTheme": {
1336
- * "transformation": {
1337
- * "scale": 1.2
1338
- * }
1583
+ * chartElement.selectionTheme = {
1584
+ * // The selected elements will have a magenta outline with a width of 3 pixels and will be scaled up by 10%.
1585
+ * selectedElementsTheme: {
1586
+ * elementOutlineColor: [255, 0, 237, 255],
1587
+ * elementOutlineWidth: 3,
1588
+ * transformation: {
1589
+ * scale: 1.1,
1590
+ * },
1591
+ * },
1592
+ * // The non-selected elements will be scaled down by 20% and have their opacity reduced to 50%.
1593
+ * nonSelectedElementsTheme: {
1594
+ * transformation: {
1595
+ * scale: 0.8,
1596
+ * opacity: 0.5,
1597
+ * },
1339
1598
  * },
1340
- * "nonSelectedElementsTheme": {
1341
- * "transformation": {
1342
- * "opacity": 0.5
1343
- * }
1344
- * }
1345
- * }
1599
+ * };
1346
1600
  * ```
1601
+ *
1602
+ * <img
1603
+ * src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/selectionTheme.avif"
1604
+ * alt="selectionTheme"
1605
+ * style="max-width: 700px; width: 100%; height: auto;"
1606
+ * />
1607
+ *
1608
+ * **Note**: Not applicable to gauges.
1347
1609
  */
1348
1610
  accessor selectionTheme: SelectionTheme | undefined;
1349
1611
  /**
1350
- * When `true`, the series properties `unit` and `size` become optional and will be automatically set to values that fit the data set. Used when creating or updating a chart compatible with time binning.
1612
+ * 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.
1613
+ *
1614
+ * 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
1615
  *
1352
- * **Note**: Only applicable to charts using the temporal binning feature (bar chart, line chart, combo bar and line chart, radar chart).
1616
+ * **Note**: Only applicable to charts with temporal binning enabled (bar chart, combo bar line chart, line chart, radar chart).
1353
1617
  *
1354
1618
  * @default false
1355
1619
  */
1356
1620
  accessor setTimeBinningInfoWhenNotProvided: boolean;
1357
1621
  /**
1358
- * Show the series on the chart even if it doesn't have data (i.e. empty)
1622
+ * When `true`, show the series on the chart and legend even if it doesn't contain any data.
1359
1623
  *
1360
- * When `false`, the empty series are completely hidden from the chart and the legend.
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.
1624
+ * By default, the empty series are hidden from the chart and the legend.
1364
1625
  *
1365
1626
  * @default false
1627
+ * @example
1628
+ * ```ts
1629
+ * // In this example, we first set a data filter to only include features with a room type of "Entire home/apt" or "Private room".
1630
+ * // The "Shared room" series will be empty after applying the data filter.
1631
+ * chartElement.runtimeDataFilters = {
1632
+ * where: "room_type = 'Entire home/apt' OR room_type = 'Private room'",
1633
+ * };
1634
+ *
1635
+ * // With the `showEmptySeries` property set to `true`,
1636
+ * // the "Shared room" series will still be displayed on the chart and in the legend, even though it was filtered out.
1637
+ * chartElement.showEmptySeries = true;
1638
+ * ```
1639
+ *
1640
+ * <img
1641
+ * src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/showEmptySeries.avif"
1642
+ * alt="showEmptySeries"
1643
+ * style="max-width: 700px; width: 100%; height: auto;"
1644
+ * />
1645
+ *
1646
+ * **Note**: Not applicable to gauges.
1366
1647
  * @since 5.1
1367
1648
  */
1368
1649
  accessor showEmptySeries: boolean;
1369
1650
  /**
1370
- * Shows the license watermark.
1651
+ * When `true`, the license watermark is displayed on the lower left corner of the chart.
1371
1652
  *
1653
+ * @deprecated since 5.2. Won't be replaced.
1372
1654
  * @default false
1373
1655
  * @since 5.1
1374
1656
  */
1375
1657
  accessor showLicenseWatermark: boolean;
1376
1658
  /**
1377
- * Whether to display or hide all UI messages (e.g. no data warnings, or when the logarithmic scale can't be applied to an axis when the data contains values <= 0).
1659
+ * Whether to display or hide all UI messages (e.g. no data warnings, any placeholder messages set or invalid chart configuration).
1378
1660
  *
1379
1661
  * @deprecated since 5.1. Use [hideUIMessages](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideUIMessages) instead.
1380
1662
  * @default false
1381
1663
  */
1382
1664
  accessor showUIMessages: boolean | undefined;
1383
1665
  /**
1384
- * Whether to skip the chart rendering queue.
1385
- *
1386
1666
  * When `true`, charts will render immediately without waiting for other charts to finish rendering.
1387
- * When `false` (default), charts are queued so that only one chart renders at a time.
1667
+ * By default, charts are queued so that only one chart renders at a time.
1388
1668
  *
1389
1669
  * @default false
1390
1670
  * @since 5.1
1391
1671
  */
1392
1672
  accessor skipChartCreationQueue: boolean;
1393
1673
  /**
1394
- * Whether to synchronize the selection between chart components from the same layer.
1674
+ * When `true`, the selection will be synchronized between charts configured with the same layer.
1395
1675
  *
1396
1676
  * @default false
1677
+ * @example
1678
+ * ```ts
1679
+ * // Both charts are configured with the same layer.
1680
+ * // The "Private room" slice is selected on the pie chart and the selection is reflected on the bar chart.
1681
+ * chartElement1.syncChartsSelection = true;
1682
+ * chartElement2.syncChartsSelection = true;
1683
+ * ```
1684
+ *
1685
+ * <img
1686
+ * src="https://developers.arcgis.com/javascript/latest/assets/references/components/chart/syncChartsSelection.avif"
1687
+ * alt="syncChartsSelection"
1688
+ * style="max-width: 700px; width: 100%; height: auto;"
1689
+ * />
1397
1690
  * @since 5.1
1398
1691
  */
1399
1692
  accessor syncChartsSelection: boolean;
@@ -1405,14 +1698,14 @@ export abstract class ArcgisChart extends LitElement {
1405
1698
  */
1406
1699
  accessor syncSelection: boolean;
1407
1700
  /**
1408
- * Determines whether the chart's selection should be synchronized with either the chart's `selectionManager` or the layer view's.
1701
+ * 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
1702
  *
1410
1703
  * @deprecated since 5.1. Use [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewSelection) prop instead.
1411
1704
  * @default "disabled"
1412
1705
  */
1413
1706
  accessor syncSelectionsBetweenChartAndLayerViewPolicy: SyncSelectionsBetweenChartAndLayerViewPolicy;
1414
1707
  /**
1415
- * Determines whether the chart's selection should be synchronized with either the chart's `selectionManager` or the layer view's.
1708
+ * 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
1709
  *
1417
1710
  * @default false
1418
1711
  * @since 5.1
@@ -1428,7 +1721,8 @@ export abstract class ArcgisChart extends LitElement {
1428
1721
  */
1429
1722
  accessor syncViewTimeExtent: boolean;
1430
1723
  /**
1431
- * Whether the chart's data should be in sync with the view's time zone (`timeZone`).
1724
+ * Whether the chart's data should be in sync with the view's [timeZone](/references/core/views/MapView/#timeZone).
1725
+ *
1432
1726
  * **Note**: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the
1433
1727
  * 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
1728
  *
@@ -1437,7 +1731,8 @@ export abstract class ArcgisChart extends LitElement {
1437
1731
  */
1438
1732
  accessor syncViewTimeZone: boolean;
1439
1733
  /**
1440
- * List of chart types to include from syncing the view's time zone (`timeZone`) with the data. Currently heat charts are included by default.
1734
+ * 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.
1735
+ *
1441
1736
  * **Note**: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the
1442
1737
  * 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
1738
  *
@@ -1451,40 +1746,43 @@ export abstract class ArcgisChart extends LitElement {
1451
1746
  * ```ts
1452
1747
  * chartComponent.timeZone = "America/Los_Angeles";
1453
1748
  * ```
1454
- * @example
1455
- * ```html
1456
- * <arcgis-chart time-zone="America/Los_Angeles"></arcgis-chart>
1457
- * ```
1458
1749
  */
1459
1750
  accessor timeZone: MapView["timeZone"] | undefined;
1460
1751
  /**
1461
- * Disables the toggling of series via the legend items.
1752
+ * 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
1753
  *
1463
- * **Note**: Only applicable to multi-series charts.
1754
+ * **Note**: Only applicable to charts with multiple series and while the legend is displayed.
1464
1755
  *
1465
1756
  * @default false
1466
1757
  */
1467
1758
  accessor togglingLegendItemsDisabled: boolean | undefined;
1468
1759
  /**
1469
- * Callback function used to format the tooltips. If the returned string contains HTML tags they will be interpreted as such.
1760
+ * 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
1761
  *
1471
1762
  * @example
1472
1763
  * ```ts
1473
- * myChart.tooltipFormatter = ({ statValue }) => {
1474
- * return `<b>Custom tooltip</b> for ${statValue}`;
1475
- * };
1764
+ * // Render a custom tooltip with the series name, x-value, and stat value.
1765
+ * chartElement.tooltipFormatter = (props) => `
1766
+ * <div>
1767
+ * <div><strong>${props.seriesName}</strong> in <strong>${props.xValue}</strong></div>
1768
+ * <div>Total listings: <strong>${props.statValue}</strong></div>
1769
+ * </div>
1770
+ * `;
1476
1771
  * ```
1477
1772
  *
1773
+ * ![tooltipFormatter](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/tooltipFormatter.avif)
1774
+ *
1478
1775
  * **Note**: Not applicable to gauges.
1479
1776
  */
1480
1777
  accessor tooltipFormatter: ChartOptions["tooltipFormatter"] | undefined;
1481
1778
  /**
1482
- * Whether to update the series when the data updates while the chart uses a split-by field configuration.
1483
- *
1484
- * If `addMissingSeries` is set to `true` the missing series will be added to cover the split-by values not referenced by the model.
1485
- * The default information from the property `updateSplitBySeries.seriesTemplate` will be applied to the new series.
1779
+ * Whether to automatically add the missing series to cover the split-by values not referenced in the configuration.
1780
+ * - 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.
1781
+ * - When [`addMissingSeries`](/references/charts-components/utils/components/interfaces/#MissingSplitBySeriesProps-addMissingSeries) is set to `true`, the missing series will be added.
1782
+ * - When [`seriesTemplate`](/references/charts-components/utils/components/interfaces/#MissingSplitBySeriesProps-seriesTemplate) is not provided, 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.
1783
+ * - 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.
1486
1784
  *
1487
- * **Note**: Applicable only to bar chart, line chart and box plot when a split-by field is used.
1785
+ * **Note**: Applicable only to bar chart, box plot, line chart and radar chart when a split-by field is used.
1488
1786
  */
1489
1787
  accessor updateSplitBySeries: MissingSplitBySeriesProps | undefined;
1490
1788
  /**
@@ -1516,13 +1814,33 @@ export abstract class ArcgisChart extends LitElement {
1516
1814
  /**
1517
1815
  * Callback function used to format the x-axis labels. If the returned string contains HTML tags they will be interpreted as such.
1518
1816
  *
1519
- * **Note**: Not applicable to pie charts.
1817
+ * @example
1818
+ * ```ts
1819
+ * // Render a custom x-axis label with underlined string and bolded value.
1820
+ * chartElement.xAxisLabelFormatter = (value) => {
1821
+ * return `<u>Neighbourhood Group:</u> <strong>${value}</strong>`;
1822
+ * };
1823
+ * ```
1824
+ *
1825
+ * ![xAxisLabelFormatter](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/xAxisLabelFormatter.avif)
1826
+ *
1827
+ * **Note**: Only applicable to charts with x-axis labels displayed.
1520
1828
  */
1521
1829
  accessor xAxisLabelFormatter: AxisLabelFormatCallback | undefined;
1522
1830
  /**
1523
1831
  * Callback function used to format the y-axis labels. If the returned string contains HTML tags they will be interpreted as such.
1524
1832
  *
1525
- * **Note**: Not applicable to pie charts or gauges.
1833
+ * @example
1834
+ * ```ts
1835
+ * // Render a custom y-axis label with underlined string and bolded value.
1836
+ * chartElement.yAxisLabelFormatter = (value) => {
1837
+ * return `<u>Rental Listings:</u> <strong>${value}</strong>`;
1838
+ * };
1839
+ * ```
1840
+ *
1841
+ * ![yAxisLabelFormatter](https://developers.arcgis.com/javascript/latest/assets/references/components/chart/yAxisLabelFormatter.avif)
1842
+ *
1843
+ * **Note**: Only applicable to charts with y-axis labels displayed.
1526
1844
  */
1527
1845
  accessor yAxisLabelFormatter: AxisLabelFormatCallback | undefined;
1528
1846
  /**
@@ -1564,7 +1882,7 @@ export abstract class ArcgisChart extends LitElement {
1564
1882
  * **Note**: The chart types supported by this method are:
1565
1883
  * - Bar chart
1566
1884
  * - Box plot
1567
- * - Combo bar and line chart
1885
+ * - Combo bar line chart
1568
1886
  * - Heat chart
1569
1887
  * - Histogram
1570
1888
  * - Line chart
@@ -1575,7 +1893,8 @@ export abstract class ArcgisChart extends LitElement {
1575
1893
  exportAsCSV(options?: CSVOptions): Promise<void>;
1576
1894
  /**
1577
1895
  * Exports the current chart as an image. Default format is `png`.
1578
- * - Alternative formats supported are: `jpeg` and `svg`.
1896
+ * - Alternative formats supported are: `jpeg`, `jpg`, `webp`, and `svg`.
1897
+ * - When WebP format is used on Safari, it will fallback to PNG rendering.
1579
1898
  *
1580
1899
  * @param format
1581
1900
  */
@@ -1636,7 +1955,11 @@ export abstract class ArcgisChart extends LitElement {
1636
1955
  readonly arcgisDataProcessComplete: import("@arcgis/lumina").TargetedEvent<this, DataProcessCompletePayload>;
1637
1956
  /** Event triggered when an error occurred while fetching of processing the data for the chart. */
1638
1957
  readonly arcgisDataProcessError: import("@arcgis/lumina").TargetedEvent<this, void>;
1639
- /** Event triggered when an invalid configuration is detected. */
1958
+ /**
1959
+ * Event triggered when an invalid configuration is detected.
1960
+ *
1961
+ * @deprecated since 5.1. Won't be replaced.
1962
+ */
1640
1963
  readonly arcgisInvalidConfigWarningRaise: import("@arcgis/lumina").TargetedEvent<this, DataWarningObject>;
1641
1964
  /** Event triggered once a legend item visibility has been changed. */
1642
1965
  readonly arcgisLegendItemVisibilityChange: import("@arcgis/lumina").TargetedEvent<this, LegendItemVisibilityChangePayload>;