@arcgis/map-components 4.34.0-next.3 → 4.34.0-next.31

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 (550) hide show
  1. package/dist/cdn/26DLYMMR.js +4 -0
  2. package/dist/cdn/2LA4GLAI.js +4 -0
  3. package/dist/cdn/2YQKPNDT.js +4 -0
  4. package/dist/cdn/36IPUTQX.js +4 -0
  5. package/dist/cdn/3ADIDWVI.js +4 -0
  6. package/dist/cdn/{F3DQMWJ6.js → 3BAWA3LT.js} +2 -2
  7. package/dist/cdn/3CKMW2Q7.js +4 -0
  8. package/dist/cdn/3PBS3Q4N.js +4 -0
  9. package/dist/cdn/4B5PPETT.js +4 -0
  10. package/dist/cdn/4BDSIGFP.js +4 -0
  11. package/dist/cdn/4JVOBYXB.js +4 -0
  12. package/dist/cdn/4LFWEY26.js +4 -0
  13. package/dist/cdn/4M2LSAHJ.js +4 -0
  14. package/dist/cdn/4VPIQFJG.js +4 -0
  15. package/dist/cdn/{T3BMQYR2.js → 53CKEVNM.js} +2 -2
  16. package/dist/cdn/{46FOHP5W.js → 5HM4DXXC.js} +1 -1
  17. package/dist/cdn/5O4AEJTW.js +4 -0
  18. package/dist/cdn/622LTAWJ.js +4 -0
  19. package/dist/cdn/6DLZGELR.js +4 -0
  20. package/dist/cdn/6HCHHWVQ.js +4 -0
  21. package/dist/cdn/6IIYZGAO.js +4 -0
  22. package/dist/cdn/6JBTZTC4.js +4 -0
  23. package/dist/cdn/6KYTRBQ6.js +4 -0
  24. package/dist/cdn/6YITMAED.js +4 -0
  25. package/dist/cdn/73NMUS6P.js +4 -0
  26. package/dist/cdn/763422CW.js +4 -0
  27. package/dist/cdn/7CIEE227.js +4 -0
  28. package/dist/cdn/7FDT4OMI.js +4 -0
  29. package/dist/cdn/7ICHTEBA.js +4 -0
  30. package/dist/cdn/7OKH4ASK.js +4 -0
  31. package/dist/cdn/A7K23NW5.js +4 -0
  32. package/dist/cdn/{VXVE4ZXP.js → AA3IOEUJ.js} +2 -2
  33. package/dist/cdn/ALJRY2FC.js +4 -0
  34. package/dist/cdn/AXKKDFUQ.js +4 -0
  35. package/dist/cdn/BDLQBPYG.js +5 -0
  36. package/dist/cdn/BFKMSLZI.js +4 -0
  37. package/dist/cdn/BJM2DCRK.js +4 -0
  38. package/dist/cdn/BLULWZYD.js +4 -0
  39. package/dist/cdn/BTRN7VJ4.js +4 -0
  40. package/dist/cdn/BXK5XOEO.js +4 -0
  41. package/dist/cdn/{72K6PTPA.js → C76Q4VBO.js} +1 -1
  42. package/dist/cdn/CAFKXOOL.js +4 -0
  43. package/dist/cdn/CGRDJ5UJ.js +4 -0
  44. package/dist/cdn/CP5OPXZE.js +4 -0
  45. package/dist/cdn/CPM4VQI4.js +4 -0
  46. package/dist/cdn/D7NYAGRB.js +4 -0
  47. package/dist/cdn/DC6NDRG7.js +4 -0
  48. package/dist/cdn/DCWCSQRU.js +4 -0
  49. package/dist/cdn/DDEQLPG7.js +4 -0
  50. package/dist/cdn/DGNKHT6U.js +4 -0
  51. package/dist/cdn/DNKO5WD4.js +4 -0
  52. package/dist/cdn/DPDKZHBS.js +4 -0
  53. package/dist/cdn/DZSLNGVD.js +4 -0
  54. package/dist/cdn/EAVO2WOK.js +4 -0
  55. package/dist/cdn/{OYIZFWCL.js → EBOZA7ZG.js} +2 -2
  56. package/dist/cdn/{MFJLKVY3.js → EHLBYAW6.js} +2 -2
  57. package/dist/cdn/EJ5ZDARC.js +4 -0
  58. package/dist/cdn/EMVUGP3L.js +4 -0
  59. package/dist/cdn/EUN5OD2J.js +4 -0
  60. package/dist/cdn/FLGTTJBB.js +4 -0
  61. package/dist/cdn/FPBPE422.js +4 -0
  62. package/dist/cdn/FQV4SUAY.js +4 -0
  63. package/dist/cdn/FYPTTC7V.js +4 -0
  64. package/dist/cdn/{3W2WGUDP.js → G3YO6G3G.js} +1 -1
  65. package/dist/cdn/G5TA3KVQ.js +4 -0
  66. package/dist/cdn/GAOEXMR7.js +4 -0
  67. package/dist/cdn/GIYTXCBM.js +4 -0
  68. package/dist/cdn/GJJOP3HC.js +4 -0
  69. package/dist/cdn/GQTHMU4S.js +4 -0
  70. package/dist/cdn/GQYM23VB.js +4 -0
  71. package/dist/cdn/HHSFLGQJ.js +4 -0
  72. package/dist/cdn/HIOV6S45.js +4 -0
  73. package/dist/cdn/HUEFDYUQ.js +4 -0
  74. package/dist/cdn/HY6VFKBI.js +4 -0
  75. package/dist/cdn/I2BOYOB6.js +4 -0
  76. package/dist/cdn/I7ZOGENV.js +4 -0
  77. package/dist/cdn/IBCDVZKK.js +4 -0
  78. package/dist/cdn/{4IQYTQIS.js → IBLIJAUY.js} +2 -2
  79. package/dist/cdn/IHNSXSRB.js +4 -0
  80. package/dist/cdn/JCGEWIZJ.js +4 -0
  81. package/dist/cdn/JPP4VR4A.js +4 -0
  82. package/dist/cdn/K4AVZIZY.js +4 -0
  83. package/dist/cdn/K6D6OMQR.js +4 -0
  84. package/dist/cdn/KHUZW65E.js +4 -0
  85. package/dist/cdn/{WUICCK44.js → KKG33AH4.js} +2 -2
  86. package/dist/cdn/KP24HLQQ.js +4 -0
  87. package/dist/cdn/KWFYJ3PH.js +4 -0
  88. package/dist/cdn/KY7UB4SK.js +4 -0
  89. package/dist/cdn/LBKPOWHT.js +4 -0
  90. package/dist/cdn/LEJJWBPC.js +4 -0
  91. package/dist/cdn/LF6WKLSP.js +4 -0
  92. package/dist/cdn/{PQBBBIQU.js → LIWDJPSV.js} +2 -2
  93. package/dist/cdn/LQMXJQBO.js +4 -0
  94. package/dist/cdn/LTQN4UYJ.js +4 -0
  95. package/dist/cdn/LUGQJB5O.js +4 -0
  96. package/dist/cdn/M3ED5O6F.js +4 -0
  97. package/dist/cdn/M6FUVO53.js +4 -0
  98. package/dist/cdn/M7QHUCKP.js +4 -0
  99. package/dist/cdn/MI4KV3CX.js +4 -0
  100. package/dist/cdn/MN3XLBQS.js +4 -0
  101. package/dist/cdn/MSP4TFNY.js +4 -0
  102. package/dist/cdn/MZU5L2JD.js +4 -0
  103. package/dist/cdn/NATL267K.js +4 -0
  104. package/dist/cdn/NBEZ3HD2.js +4 -0
  105. package/dist/cdn/NEFKVILA.js +4 -0
  106. package/dist/cdn/NLEHYGIW.js +4 -0
  107. package/dist/cdn/NS3FMAYW.js +4 -0
  108. package/dist/cdn/NTF525KK.js +4 -0
  109. package/dist/cdn/{EGAU2GAK.js → O5UBAPDN.js} +2 -2
  110. package/dist/cdn/OATNAOVF.js +4 -0
  111. package/dist/cdn/OFAQC3GS.js +4 -0
  112. package/dist/cdn/OMVHEDLC.js +4 -0
  113. package/dist/cdn/OY36GFUB.js +4 -0
  114. package/dist/cdn/PAWTXHBY.js +4 -0
  115. package/dist/cdn/PEXNMK5Q.js +4 -0
  116. package/dist/cdn/PS62UU6E.js +4 -0
  117. package/dist/cdn/PUJ23HZE.js +4 -0
  118. package/dist/cdn/Q7LO7KLU.js +4 -0
  119. package/dist/cdn/Q7WVYIOB.js +4 -0
  120. package/dist/cdn/{5R5OWXAQ.js → QGT5ESJQ.js} +2 -2
  121. package/dist/cdn/QR7K3RUL.js +4 -0
  122. package/dist/cdn/QROWDO6U.js +4 -0
  123. package/dist/cdn/QXPJFR6H.js +4 -0
  124. package/dist/cdn/QZ53U2T6.js +4 -0
  125. package/dist/cdn/R2URNESZ.js +4 -0
  126. package/dist/cdn/{LP4I37RY.js → R4CT2F7F.js} +1 -1
  127. package/dist/cdn/R5LSLUTP.js +4 -0
  128. package/dist/cdn/R5OKIQET.js +4 -0
  129. package/dist/cdn/RDRAZMZM.js +4 -0
  130. package/dist/cdn/RIZJRT6Y.js +4 -0
  131. package/dist/cdn/RKBMMJM2.js +4 -0
  132. package/dist/cdn/{N4BQ2M5C.js → RNPVFMQ7.js} +2 -2
  133. package/dist/cdn/RNSKJ3XA.js +4 -0
  134. package/dist/cdn/RT46PA45.js +4 -0
  135. package/dist/cdn/RUSYF6NM.js +4 -0
  136. package/dist/cdn/SD3UUDRY.js +4 -0
  137. package/dist/cdn/SMCJKPQM.js +4 -0
  138. package/dist/cdn/SS2ZFJPC.js +4 -0
  139. package/dist/cdn/T7L24I5I.js +4 -0
  140. package/dist/cdn/{5YG75FR4.js → TAOTWWKU.js} +4 -4
  141. package/dist/cdn/TDYYD2N6.js +4 -0
  142. package/dist/cdn/TLVAT3AY.js +4 -0
  143. package/dist/cdn/TOLZJFGD.js +4 -0
  144. package/dist/cdn/TT3YIOPW.js +4 -0
  145. package/dist/cdn/U3PE5XKO.js +4 -0
  146. package/dist/cdn/U6I77C3G.js +4 -0
  147. package/dist/cdn/{TG4WOIVN.js → U75MZFTX.js} +2 -2
  148. package/dist/cdn/UARKWXHU.js +4 -0
  149. package/dist/cdn/UJUODCMJ.js +4 -0
  150. package/dist/cdn/UMI4O723.js +4 -0
  151. package/dist/cdn/UPSUYH4Y.js +4 -0
  152. package/dist/cdn/UT7UMC7K.js +4 -0
  153. package/dist/cdn/UVSB6JMI.js +4 -0
  154. package/dist/cdn/VHTHRPHC.js +4 -0
  155. package/dist/cdn/VUJ4WOH2.js +4 -0
  156. package/dist/cdn/VY4W7K6V.js +4 -0
  157. package/dist/cdn/WEAXSAF7.js +4 -0
  158. package/dist/cdn/{Y3HMAR44.js → WFZBPWEW.js} +1 -1
  159. package/dist/cdn/WL4DZY4L.js +4 -0
  160. package/dist/cdn/WLZHIEET.js +4 -0
  161. package/dist/cdn/WP7TCQS6.js +4 -0
  162. package/dist/cdn/WY2V34L5.js +4 -0
  163. package/dist/cdn/XBK7M2JX.js +4 -0
  164. package/dist/cdn/XCPXCNRD.js +4 -0
  165. package/dist/cdn/{ZDO5M5ZH.js → XQ5YJ6DC.js} +2 -2
  166. package/dist/cdn/XRYJX5GI.js +4 -0
  167. package/dist/cdn/XXMM7VGN.js +4 -0
  168. package/dist/cdn/XZ64KGLO.js +4 -0
  169. package/dist/cdn/YCXS4EZW.js +4 -0
  170. package/dist/cdn/{363OWKVL.js → YOHULSJK.js} +2 -2
  171. package/dist/cdn/YTCIMUZ4.js +4 -0
  172. package/dist/cdn/YXERGQ66.js +4 -0
  173. package/dist/cdn/YXWPO6AK.js +4 -0
  174. package/dist/cdn/Z2A3RVER.js +4 -0
  175. package/dist/cdn/ZB3SR2RL.js +4 -0
  176. package/dist/cdn/ZBCV3H2S.js +4 -0
  177. package/dist/cdn/ZBVID3H2.js +4 -0
  178. package/dist/cdn/ZE6RGNFJ.js +4 -0
  179. package/dist/cdn/ZFOERVH2.js +4 -0
  180. package/dist/cdn/{D4UC6YNK.js → ZKBCJP4L.js} +2 -2
  181. package/dist/cdn/ZNVU7M2F.js +4 -0
  182. package/dist/cdn/{BRHFFFB6.js → ZR3PDZ5Q.js} +1 -1
  183. package/dist/cdn/assets/feature/t9n/messages.ar.json +1 -0
  184. package/dist/cdn/assets/feature/t9n/messages.bg.json +1 -0
  185. package/dist/cdn/assets/feature/t9n/messages.bs.json +1 -0
  186. package/dist/cdn/assets/feature/t9n/messages.ca.json +1 -0
  187. package/dist/cdn/assets/feature/t9n/messages.cs.json +1 -0
  188. package/dist/cdn/assets/feature/t9n/messages.da.json +1 -0
  189. package/dist/cdn/assets/feature/t9n/messages.de.json +1 -0
  190. package/dist/cdn/assets/feature/t9n/messages.el.json +1 -0
  191. package/dist/cdn/assets/feature/t9n/messages.en.json +1 -0
  192. package/dist/cdn/assets/feature/t9n/messages.es.json +1 -0
  193. package/dist/cdn/assets/feature/t9n/messages.et.json +1 -0
  194. package/dist/cdn/assets/feature/t9n/messages.fi.json +1 -0
  195. package/dist/cdn/assets/feature/t9n/messages.fr.json +1 -0
  196. package/dist/cdn/assets/feature/t9n/messages.he.json +1 -0
  197. package/dist/cdn/assets/feature/t9n/messages.hr.json +1 -0
  198. package/dist/cdn/assets/feature/t9n/messages.hu.json +1 -0
  199. package/dist/cdn/assets/feature/t9n/messages.id.json +1 -0
  200. package/dist/cdn/assets/feature/t9n/messages.it.json +1 -0
  201. package/dist/cdn/assets/feature/t9n/messages.ja.json +1 -0
  202. package/dist/cdn/assets/feature/t9n/messages.ko.json +1 -0
  203. package/dist/cdn/assets/feature/t9n/messages.lt.json +1 -0
  204. package/dist/cdn/assets/feature/t9n/messages.lv.json +1 -0
  205. package/dist/cdn/assets/feature/t9n/messages.nl.json +1 -0
  206. package/dist/cdn/assets/feature/t9n/messages.no.json +1 -0
  207. package/dist/cdn/assets/feature/t9n/messages.pl.json +1 -0
  208. package/dist/cdn/assets/feature/t9n/messages.pt-BR.json +1 -0
  209. package/dist/cdn/assets/feature/t9n/messages.pt-PT.json +1 -0
  210. package/dist/cdn/assets/feature/t9n/messages.ro.json +1 -0
  211. package/dist/cdn/assets/feature/t9n/messages.ru.json +1 -0
  212. package/dist/cdn/assets/feature/t9n/messages.sk.json +1 -0
  213. package/dist/cdn/assets/feature/t9n/messages.sl.json +1 -0
  214. package/dist/cdn/assets/feature/t9n/messages.sr.json +1 -0
  215. package/dist/cdn/assets/feature/t9n/messages.sv.json +1 -0
  216. package/dist/cdn/assets/feature/t9n/messages.th.json +1 -0
  217. package/dist/cdn/assets/feature/t9n/messages.tr.json +1 -0
  218. package/dist/cdn/assets/feature/t9n/messages.uk.json +1 -0
  219. package/dist/cdn/assets/feature/t9n/messages.vi.json +1 -0
  220. package/dist/cdn/assets/feature/t9n/messages.zh-CN.json +1 -0
  221. package/dist/cdn/assets/feature/t9n/messages.zh-HK.json +1 -0
  222. package/dist/cdn/assets/feature/t9n/messages.zh-TW.json +1 -0
  223. package/dist/cdn/index.js +2 -2
  224. package/dist/chunks/AnalysisViewModel.js +1 -1
  225. package/dist/chunks/async-utils.js +1 -1
  226. package/dist/chunks/basemap-gallery-resources.js +1 -1
  227. package/dist/chunks/chart-utils.js +66 -0
  228. package/dist/chunks/chartCommon.js +19 -0
  229. package/dist/chunks/component-utils.js +1 -1
  230. package/dist/chunks/createCloseEvent.js +1 -1
  231. package/dist/chunks/feature-utils.js +145 -0
  232. package/dist/chunks/globalCss.js +2 -1
  233. package/dist/chunks/heading.js +1 -1
  234. package/dist/chunks/layer-list.js +1 -1
  235. package/dist/chunks/legacyIcon.js +1 -1
  236. package/dist/chunks/maybe.js +1 -1
  237. package/dist/chunks/measurementUtils.js +1 -1
  238. package/dist/chunks/runtime.js +1 -1
  239. package/dist/chunks/useHandles.js +4 -4
  240. package/dist/chunks/useT9n.js +1 -1
  241. package/dist/chunks/useView.js +1 -1
  242. package/dist/chunks/useViewModel.js +1 -1
  243. package/dist/chunks/useWidget.js +1 -1
  244. package/dist/chunks/utils.js +1 -1
  245. package/dist/components/arcgis-area-measurement-2d/customElement.d.ts +5 -0
  246. package/dist/components/arcgis-area-measurement-2d/customElement.js +1 -1
  247. package/dist/components/arcgis-area-measurement-3d/customElement.d.ts +111 -9
  248. package/dist/components/arcgis-area-measurement-3d/customElement.js +3 -6
  249. package/dist/components/arcgis-attachments/customElement.d.ts +6 -1
  250. package/dist/components/arcgis-attachments/customElement.js +1 -1
  251. package/dist/components/arcgis-basemap-gallery/customElement.d.ts +10 -1
  252. package/dist/components/arcgis-basemap-gallery/customElement.js +1 -1
  253. package/dist/components/arcgis-basemap-gallery-item/customElement.js +1 -1
  254. package/dist/components/arcgis-basemap-layer-list/customElement.d.ts +5 -0
  255. package/dist/components/arcgis-basemap-layer-list/customElement.js +1 -1
  256. package/dist/components/arcgis-basemap-toggle/customElement.d.ts +11 -2
  257. package/dist/components/arcgis-basemap-toggle/customElement.js +5 -5
  258. package/dist/components/arcgis-bookmarks/customElement.d.ts +6 -3
  259. package/dist/components/arcgis-bookmarks/customElement.js +1 -1
  260. package/dist/components/arcgis-building-explorer/customElement.d.ts +26 -14
  261. package/dist/components/arcgis-building-explorer/customElement.js +1 -1
  262. package/dist/components/arcgis-catalog-layer-list/customElement.d.ts +5 -0
  263. package/dist/components/arcgis-catalog-layer-list/customElement.js +1 -1
  264. package/dist/components/arcgis-compass/customElement.d.ts +10 -1
  265. package/dist/components/arcgis-compass/customElement.js +1 -1
  266. package/dist/components/arcgis-coordinate-conversion/customElement.d.ts +6 -1
  267. package/dist/components/arcgis-coordinate-conversion/customElement.js +3 -3
  268. package/dist/components/arcgis-daylight/customElement.d.ts +27 -13
  269. package/dist/components/arcgis-daylight/customElement.js +1 -1
  270. package/dist/components/arcgis-direct-line-measurement-3d/customElement.d.ts +112 -9
  271. package/dist/components/arcgis-direct-line-measurement-3d/customElement.js +3 -6
  272. package/dist/components/arcgis-directional-pad/customElement.d.ts +10 -1
  273. package/dist/components/arcgis-directional-pad/customElement.js +1 -1
  274. package/dist/components/arcgis-directions/customElement.d.ts +6 -1
  275. package/dist/components/arcgis-directions/customElement.js +1 -1
  276. package/dist/components/arcgis-distance-measurement-2d/customElement.d.ts +5 -0
  277. package/dist/components/arcgis-distance-measurement-2d/customElement.js +1 -1
  278. package/dist/components/arcgis-editor/customElement.d.ts +5 -0
  279. package/dist/components/arcgis-editor/customElement.js +1 -1
  280. package/dist/components/arcgis-elevation-profile/customElement.d.ts +28 -20
  281. package/dist/components/arcgis-elevation-profile/customElement.js +1 -1
  282. package/dist/components/arcgis-expand/customElement.d.ts +8 -2
  283. package/dist/components/arcgis-expand/customElement.js +1 -1
  284. package/dist/components/arcgis-feature/customElement.d.ts +6 -1
  285. package/dist/components/arcgis-feature/customElement.js +10 -9
  286. package/dist/components/arcgis-feature-attachments/customElement.d.ts +15 -0
  287. package/dist/components/arcgis-feature-attachments/customElement.js +24 -0
  288. package/dist/components/arcgis-feature-attachments/index.d.ts +3 -0
  289. package/dist/components/arcgis-feature-attachments/index.js +3 -0
  290. package/dist/components/arcgis-feature-content/customElement.d.ts +11 -0
  291. package/dist/components/arcgis-feature-content/customElement.js +66 -0
  292. package/dist/components/arcgis-feature-content/index.d.ts +2 -0
  293. package/dist/components/arcgis-feature-content/index.js +2 -0
  294. package/dist/components/arcgis-feature-element-info/customElement.d.ts +11 -0
  295. package/dist/components/arcgis-feature-element-info/customElement.js +39 -0
  296. package/dist/components/arcgis-feature-element-info/index.d.ts +1 -0
  297. package/dist/components/arcgis-feature-element-info/index.js +1 -0
  298. package/dist/components/arcgis-feature-fields/customElement.d.ts +16 -0
  299. package/dist/components/arcgis-feature-fields/customElement.js +141 -0
  300. package/dist/components/arcgis-feature-fields/index.d.ts +2 -0
  301. package/dist/components/arcgis-feature-fields/index.js +2 -0
  302. package/dist/components/arcgis-feature-form/customElement.d.ts +6 -1
  303. package/dist/components/arcgis-feature-form/customElement.js +1 -1
  304. package/dist/components/arcgis-feature-media/chartCommon.d.ts +1 -0
  305. package/dist/components/arcgis-feature-media/customElement.d.ts +37 -0
  306. package/dist/components/arcgis-feature-media/customElement.js +575 -0
  307. package/dist/components/arcgis-feature-media/index.d.ts +3 -0
  308. package/dist/components/arcgis-feature-media/index.js +3 -0
  309. package/dist/components/arcgis-feature-table/customElement.d.ts +7 -1
  310. package/dist/components/arcgis-feature-table/customElement.js +1 -1
  311. package/dist/components/arcgis-feature-templates/customElement.d.ts +5 -0
  312. package/dist/components/arcgis-feature-templates/customElement.js +1 -1
  313. package/dist/components/arcgis-features/customElement.d.ts +5 -0
  314. package/dist/components/arcgis-features/customElement.js +1 -1
  315. package/dist/components/arcgis-floor-filter/customElement.d.ts +5 -0
  316. package/dist/components/arcgis-floor-filter/customElement.js +1 -1
  317. package/dist/components/arcgis-fullscreen/customElement.d.ts +16 -1
  318. package/dist/components/arcgis-fullscreen/customElement.js +1 -1
  319. package/dist/components/arcgis-grid-controls/customElement.d.ts +10 -1
  320. package/dist/components/arcgis-grid-controls/customElement.js +1 -1
  321. package/dist/components/arcgis-histogram-range-slider/customElement.d.ts +5 -0
  322. package/dist/components/arcgis-histogram-range-slider/customElement.js +1 -1
  323. package/dist/components/arcgis-home/customElement.d.ts +23 -12
  324. package/dist/components/arcgis-home/customElement.js +1 -1
  325. package/dist/components/arcgis-labeled-switch/customElement.js +1 -1
  326. package/dist/components/arcgis-layer-list/customElement.d.ts +5 -0
  327. package/dist/components/arcgis-layer-list/customElement.js +1 -1
  328. package/dist/components/arcgis-layer-list-item/customElement.js +1 -1
  329. package/dist/components/arcgis-legend/customElement.d.ts +5 -0
  330. package/dist/components/arcgis-legend/customElement.js +1 -1
  331. package/dist/components/arcgis-line-of-sight/customElement.d.ts +75 -19
  332. package/dist/components/arcgis-line-of-sight/customElement.js +10 -13
  333. package/dist/components/arcgis-link-chart/customElement.d.ts +19 -9
  334. package/dist/components/arcgis-link-chart/customElement.js +14 -5
  335. package/dist/components/arcgis-link-chart-layout-switcher/customElement.d.ts +13 -2
  336. package/dist/components/arcgis-link-chart-layout-switcher/customElement.js +25 -26
  337. package/dist/components/arcgis-link-chart-layout-switcher/index.d.ts +1 -2
  338. package/dist/components/arcgis-link-chart-layout-switcher/index.js +1 -2
  339. package/dist/components/arcgis-locate/customElement.d.ts +17 -5
  340. package/dist/components/arcgis-locate/customElement.js +29 -29
  341. package/dist/components/arcgis-map/customElement.d.ts +27 -14
  342. package/dist/components/arcgis-map/customElement.js +25 -14
  343. package/dist/components/arcgis-measurement/customElement.d.ts +5 -0
  344. package/dist/components/arcgis-measurement/customElement.js +1 -1
  345. package/dist/components/arcgis-measurement-content/customElement.js +1 -1
  346. package/dist/components/arcgis-navigation-toggle/customElement.d.ts +17 -13
  347. package/dist/components/arcgis-navigation-toggle/customElement.js +14 -11
  348. package/dist/components/arcgis-oriented-imagery-viewer/customElement.d.ts +5 -0
  349. package/dist/components/arcgis-oriented-imagery-viewer/customElement.js +1 -1
  350. package/dist/components/arcgis-placement/customElement.d.ts +5 -0
  351. package/dist/components/arcgis-placement/customElement.js +1 -1
  352. package/dist/components/arcgis-print/customElement.d.ts +54 -40
  353. package/dist/components/arcgis-print/customElement.js +39 -33
  354. package/dist/components/arcgis-print-custom-text-elements/customElement.js +1 -1
  355. package/dist/components/arcgis-print-dpi-input/customElement.js +18 -23
  356. package/dist/components/arcgis-print-export-button/customElement.d.ts +1 -7
  357. package/dist/components/arcgis-print-export-button/customElement.js +3 -4
  358. package/dist/components/arcgis-print-exported-link/customElement.js +1 -1
  359. package/dist/components/arcgis-print-exports-panel/customElement.js +1 -1
  360. package/dist/components/arcgis-print-format-select/customElement.js +1 -1
  361. package/dist/components/arcgis-print-layout-advanced-options/customElement.js +1 -1
  362. package/dist/components/arcgis-print-layout-panel/customElement.d.ts +1 -7
  363. package/dist/components/arcgis-print-layout-panel/customElement.js +8 -8
  364. package/dist/components/arcgis-print-main-panel/customElement.d.ts +1 -7
  365. package/dist/components/arcgis-print-main-panel/customElement.js +8 -8
  366. package/dist/components/arcgis-print-map-only-advanced-options/customElement.js +1 -1
  367. package/dist/components/arcgis-print-map-only-panel/customElement.d.ts +1 -7
  368. package/dist/components/arcgis-print-map-only-panel/customElement.js +28 -22
  369. package/dist/components/arcgis-print-out-spatial-reference-input/customElement.js +23 -18
  370. package/dist/components/arcgis-print-preview-input/customElement.js +1 -1
  371. package/dist/components/arcgis-print-scale-section/customElement.js +26 -19
  372. package/dist/components/arcgis-print-template-select/customElement.js +1 -1
  373. package/dist/components/arcgis-print-template-selector/customElement.js +1 -1
  374. package/dist/components/arcgis-scale-bar/customElement.d.ts +11 -2
  375. package/dist/components/arcgis-scale-bar/customElement.js +1 -1
  376. package/dist/components/arcgis-scale-range-slider/customElement.d.ts +5 -0
  377. package/dist/components/arcgis-scale-range-slider/customElement.js +1 -1
  378. package/dist/components/arcgis-scene/customElement.d.ts +143 -80
  379. package/dist/components/arcgis-scene/customElement.js +27 -16
  380. package/dist/components/arcgis-search/customElement.d.ts +46 -16
  381. package/dist/components/arcgis-search/customElement.js +39 -36
  382. package/dist/components/arcgis-search-result-renderer/customElement.js +1 -1
  383. package/dist/components/arcgis-shadow-cast/customElement.d.ts +92 -30
  384. package/dist/components/arcgis-shadow-cast/customElement.js +1 -1
  385. package/dist/components/arcgis-sketch/customElement.d.ts +5 -0
  386. package/dist/components/arcgis-sketch/customElement.js +27 -19
  387. package/dist/components/arcgis-slice/customElement.d.ts +77 -18
  388. package/dist/components/arcgis-slice/customElement.js +2 -2
  389. package/dist/components/arcgis-slider/customElement.d.ts +5 -0
  390. package/dist/components/arcgis-slider/customElement.js +1 -1
  391. package/dist/components/arcgis-swipe/customElement.d.ts +11 -2
  392. package/dist/components/arcgis-swipe/customElement.js +1 -1
  393. package/dist/components/arcgis-table-list/customElement.d.ts +5 -0
  394. package/dist/components/arcgis-table-list/customElement.js +1 -1
  395. package/dist/components/arcgis-time-slider/customElement.d.ts +5 -0
  396. package/dist/components/arcgis-time-slider/customElement.js +1 -1
  397. package/dist/components/arcgis-time-zone-label/customElement.d.ts +3 -1
  398. package/dist/components/arcgis-time-zone-label/customElement.js +1 -1
  399. package/dist/components/arcgis-track/customElement.d.ts +26 -9
  400. package/dist/components/arcgis-track/customElement.js +1 -1
  401. package/dist/components/arcgis-unit-select/customElement.d.ts +5 -1
  402. package/dist/components/arcgis-unit-select/customElement.js +1 -1
  403. package/dist/components/arcgis-utility-network-associations/customElement.d.ts +16 -13
  404. package/dist/components/arcgis-utility-network-associations/customElement.js +1 -1
  405. package/dist/components/arcgis-utility-network-trace/customElement.d.ts +6 -1
  406. package/dist/components/arcgis-utility-network-trace/customElement.js +1 -1
  407. package/dist/components/arcgis-utility-network-validate-topology/customElement.d.ts +5 -0
  408. package/dist/components/arcgis-utility-network-validate-topology/customElement.js +1 -1
  409. package/dist/components/arcgis-value-picker/customElement.d.ts +5 -0
  410. package/dist/components/arcgis-value-picker/customElement.js +1 -1
  411. package/dist/components/arcgis-version-management/customElement.d.ts +14 -5
  412. package/dist/components/arcgis-version-management/customElement.js +48 -50
  413. package/dist/components/arcgis-version-management-service-item/customElement.d.ts +0 -1
  414. package/dist/components/arcgis-version-management-service-item/customElement.js +19 -20
  415. package/dist/components/arcgis-version-management-version-item/customElement.d.ts +0 -1
  416. package/dist/components/arcgis-version-management-version-item/customElement.js +11 -11
  417. package/dist/components/arcgis-version-management-version-list/customElement.d.ts +0 -1
  418. package/dist/components/arcgis-version-management-version-list/customElement.js +19 -22
  419. package/dist/components/arcgis-version-management-version-properties/customElement.d.ts +0 -1
  420. package/dist/components/arcgis-version-management-version-properties/customElement.js +45 -45
  421. package/dist/components/arcgis-video/customElement.d.ts +20 -9
  422. package/dist/components/arcgis-video/customElement.js +10 -19
  423. package/dist/components/arcgis-video-player/customElement.d.ts +23 -5
  424. package/dist/components/arcgis-video-player/customElement.js +32 -26
  425. package/dist/components/arcgis-video-player-action-bar/customElement.js +1 -1
  426. package/dist/components/arcgis-video-player-actions-group/customElement.js +1 -1
  427. package/dist/components/arcgis-video-player-controls-group/customElement.js +12 -12
  428. package/dist/components/arcgis-video-player-metadata/customElement.js +2 -2
  429. package/dist/components/arcgis-video-player-settings/customElement.js +2 -2
  430. package/dist/components/arcgis-video-player-slider/customElement.js +1 -1
  431. package/dist/components/arcgis-weather/customElement.d.ts +52 -3
  432. package/dist/components/arcgis-weather/customElement.js +2 -2
  433. package/dist/components/arcgis-zoom/customElement.d.ts +10 -1
  434. package/dist/components/arcgis-zoom/customElement.js +1 -1
  435. package/dist/controllers/Handles.d.ts +2 -2
  436. package/dist/controllers/useHandles.d.ts +4 -4
  437. package/dist/docs/api.json +1381 -495
  438. package/dist/docs/docs.json +1119 -509
  439. package/dist/docs/vscode.html-custom-data.json +195 -102
  440. package/dist/docs/web-types.json +421 -230
  441. package/dist/geolocation/GeolocationPositioning.d.ts +5 -6
  442. package/dist/index.d.ts +3 -0
  443. package/dist/index.js +1 -1
  444. package/dist/loader.js +20 -15
  445. package/dist/types/lumina.d.ts +15 -12
  446. package/dist/types/preact.d.ts +15 -12
  447. package/dist/types/react.d.ts +15 -12
  448. package/dist/types/stencil.d.ts +15 -12
  449. package/dist/utils/chart-utils.d.ts +6 -0
  450. package/dist/utils/feature-utils.d.ts +30 -0
  451. package/dist/utils/related-feature-utils.d.ts +17 -0
  452. package/dist/utils/uri-utils.d.ts +4 -0
  453. package/package.json +5 -4
  454. package/dist/cdn/2DEASVZD.js +0 -4
  455. package/dist/cdn/2ESEAIA5.js +0 -4
  456. package/dist/cdn/46DOZMHG.js +0 -4
  457. package/dist/cdn/46NE5CD2.js +0 -4
  458. package/dist/cdn/4H2W5GYD.js +0 -4
  459. package/dist/cdn/4QRBF4FC.js +0 -4
  460. package/dist/cdn/4USUAQ3M.js +0 -4
  461. package/dist/cdn/4XMBZYKO.js +0 -4
  462. package/dist/cdn/56EGKCO3.js +0 -4
  463. package/dist/cdn/5VXQTBEA.js +0 -4
  464. package/dist/cdn/67UXLU2S.js +0 -4
  465. package/dist/cdn/6EE4JJ2I.js +0 -4
  466. package/dist/cdn/6K7QBAMI.js +0 -4
  467. package/dist/cdn/6X6BDLCA.js +0 -4
  468. package/dist/cdn/6Z56X76F.js +0 -4
  469. package/dist/cdn/7AXRMMLJ.js +0 -4
  470. package/dist/cdn/7L5XBWYD.js +0 -4
  471. package/dist/cdn/ALUNHIFF.js +0 -4
  472. package/dist/cdn/BKWCCZ53.js +0 -4
  473. package/dist/cdn/BOZBPEOQ.js +0 -4
  474. package/dist/cdn/C2GRKYPA.js +0 -4
  475. package/dist/cdn/C5VB62EV.js +0 -4
  476. package/dist/cdn/CQMPO2FO.js +0 -4
  477. package/dist/cdn/CV25FGWS.js +0 -4
  478. package/dist/cdn/CWRD56OW.js +0 -4
  479. package/dist/cdn/DPC4BXUO.js +0 -4
  480. package/dist/cdn/DVRWN2X3.js +0 -4
  481. package/dist/cdn/DWMAF3AB.js +0 -4
  482. package/dist/cdn/FGMM6TLQ.js +0 -4
  483. package/dist/cdn/GKQV3GV7.js +0 -4
  484. package/dist/cdn/GOEEX3IG.js +0 -4
  485. package/dist/cdn/H34JBL4Z.js +0 -4
  486. package/dist/cdn/HAFNNW3D.js +0 -4
  487. package/dist/cdn/HJBXOC2I.js +0 -4
  488. package/dist/cdn/HLKSYNBA.js +0 -4
  489. package/dist/cdn/HQEQV3QC.js +0 -4
  490. package/dist/cdn/JCQD3YNR.js +0 -4
  491. package/dist/cdn/JDTYQCZK.js +0 -4
  492. package/dist/cdn/JI6FC2KZ.js +0 -4
  493. package/dist/cdn/JLCRXIKZ.js +0 -4
  494. package/dist/cdn/JP5O6B5F.js +0 -4
  495. package/dist/cdn/JV24GCAP.js +0 -4
  496. package/dist/cdn/K7UZ42V3.js +0 -4
  497. package/dist/cdn/KXYEAIS4.js +0 -4
  498. package/dist/cdn/L3OI72NI.js +0 -4
  499. package/dist/cdn/LEGQAMIG.js +0 -4
  500. package/dist/cdn/LUJBBH5J.js +0 -4
  501. package/dist/cdn/LXPDH2BL.js +0 -4
  502. package/dist/cdn/M3YHSP3I.js +0 -4
  503. package/dist/cdn/MSKYKJCN.js +0 -4
  504. package/dist/cdn/MT5RQBAH.js +0 -4
  505. package/dist/cdn/MZ4A2RS4.js +0 -4
  506. package/dist/cdn/N2AWMIHG.js +0 -4
  507. package/dist/cdn/NFP7KMGH.js +0 -4
  508. package/dist/cdn/NNWDJSAH.js +0 -4
  509. package/dist/cdn/O7ZKXOTB.js +0 -4
  510. package/dist/cdn/OYUETUJJ.js +0 -4
  511. package/dist/cdn/PPUKTTQ3.js +0 -4
  512. package/dist/cdn/PYZLIY6P.js +0 -4
  513. package/dist/cdn/QPFJHO6Q.js +0 -4
  514. package/dist/cdn/QSM7LMGZ.js +0 -4
  515. package/dist/cdn/REMEYP6N.js +0 -4
  516. package/dist/cdn/RFMOKDOF.js +0 -4
  517. package/dist/cdn/RNXSFATM.js +0 -4
  518. package/dist/cdn/RURKZO7X.js +0 -4
  519. package/dist/cdn/S2O5QLCT.js +0 -4
  520. package/dist/cdn/SHCBXBY3.js +0 -4
  521. package/dist/cdn/SLDQ2YZY.js +0 -4
  522. package/dist/cdn/SWDKYZ6Z.js +0 -4
  523. package/dist/cdn/TJN54QWM.js +0 -4
  524. package/dist/cdn/TNVEJWIO.js +0 -4
  525. package/dist/cdn/TRPGUDFV.js +0 -4
  526. package/dist/cdn/TXZALV35.js +0 -4
  527. package/dist/cdn/U2HHRTN2.js +0 -4
  528. package/dist/cdn/V2RJSRTT.js +0 -4
  529. package/dist/cdn/V45UQX3A.js +0 -4
  530. package/dist/cdn/V4COQWPL.js +0 -4
  531. package/dist/cdn/V5ZNHCME.js +0 -4
  532. package/dist/cdn/VIDQXKDI.js +0 -4
  533. package/dist/cdn/VQD7JRM4.js +0 -4
  534. package/dist/cdn/W3XQBJXS.js +0 -4
  535. package/dist/cdn/WG47QYRW.js +0 -4
  536. package/dist/cdn/WQJO5G7X.js +0 -4
  537. package/dist/cdn/WY2EGIGS.js +0 -4
  538. package/dist/cdn/XFRS3WPC.js +0 -4
  539. package/dist/cdn/XRRL7PHW.js +0 -4
  540. package/dist/cdn/XUU76GOK.js +0 -4
  541. package/dist/cdn/Y5DTQNYQ.js +0 -4
  542. package/dist/cdn/Y5TCYX4Y.js +0 -4
  543. package/dist/cdn/YPOT4P5O.js +0 -4
  544. package/dist/cdn/Z5HH6M3E.js +0 -4
  545. package/dist/cdn/Z5JQ33M4.js +0 -4
  546. package/dist/cdn/ZAORUVUH.js +0 -4
  547. package/dist/cdn/ZEVG6CNZ.js +0 -4
  548. package/dist/cdn/ZHMO3DWS.js +0 -4
  549. package/dist/cdn/ZS3C5VPV.js +0 -4
  550. package/dist/cdn/ZUXJIOON.js +0 -4
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
3
3
  "name": "@arcgis/map-components",
4
- "version": "4.34.0-next.3",
4
+ "version": "4.34.0-next.31",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
@@ -53,6 +53,7 @@
53
53
  },
54
54
  {
55
55
  "name": "reference-element",
56
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
56
57
  "value": {
57
58
  "type": "string"
58
59
  }
@@ -130,6 +131,7 @@
130
131
  },
131
132
  {
132
133
  "name": "referenceElement",
134
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
133
135
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
134
136
  },
135
137
  {
@@ -169,7 +171,7 @@
169
171
  },
170
172
  {
171
173
  "name": "arcgis-area-measurement-3d",
172
- "description": "The Area Measurement 3D component calculates and displays the area and perimeter of a polygon.\nThis component can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nto measure the area and perimeter of a polygon.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`",
174
+ "description": "The Area Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent to calculate and display area and perimeter of polygons.\n\n[![measurement-area-3d](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/3D_AreaMeasurement_widget.png)](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow the area and perimeter are computed depends on the scene's spatial reference and the length of the measured perimeter.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- If the measurement's perimeter is below 100 km, they are computed in a Euclidean manner,\n in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets).\n- If the perimeter is above 100 km, they are computed geodetically, and the visualization takes\n the curvature of the planet into consideration.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, the area and perimeter\nare always calculated in a Euclidean manner (in their respective PCS).\n\nThe area may be visualized and calculated in two ways:\n1. If all the vertices are mostly coplanar (lying on the same plane),\n the measurement polygon is formed on that plane, and area and perimeter are calculated from its geometry.\n2. If the vertices don't form a planar surface, the measurement polygon\n is projected to a horizontal plane, and area and perimeter are calculated from its geometry.\n\n![area-measurement-3d-types](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/area-measurement-3d-types.png)\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\n\n**Things to consider**\n\n* Area Measurement 3D is designed to work in the Scene component. For measurements in the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Area Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/).\n* Snapping is enabled by default. Holding the `CTRL` key disables it.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
173
175
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/",
174
176
  "attributes": [
175
177
  {
@@ -214,13 +216,14 @@
214
216
  },
215
217
  {
216
218
  "name": "reference-element",
219
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
217
220
  "value": {
218
221
  "type": "string"
219
222
  }
220
223
  },
221
224
  {
222
225
  "name": "state",
223
- "description": "The current state of the component.",
226
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
224
227
  "value": {
225
228
  "type": [
226
229
  "\"disabled\"",
@@ -232,7 +235,7 @@
232
235
  },
233
236
  {
234
237
  "name": "unit",
235
- "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
238
+ "description": "Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](#unitOptions).",
236
239
  "value": {
237
240
  "type": [
238
241
  "\"acres\"",
@@ -271,6 +274,7 @@
271
274
  "properties": [
272
275
  {
273
276
  "name": "analysis",
277
+ "description": "The [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Area Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst areaMeasurementAnalysis = new AreaMeasurementAnalysis({\n geometry: new Polygon({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n rings: [\n [\n [-13624861.22274897, 4550346.5519295, 63.378210234455764],\n [-13624935.305160372, 4550273.144585712, 63.37829629518092],\n [-13624995.61798748, 4550334.030096778, 63.37819860037416],\n [-13624921.53589075, 4550407.42357004, 63.3783810287714],\n [-13624861.22274897, 4550346.5519295, 63.378210234455764]\n ]\n ]\n })\n});\n// Get the Scene and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst areaMeasurement3d = document.querySelector(\"arcgis-area-measurement-3d\");\nawait areaMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(areaMeasurementAnalysis);\n// Connect the analysis to the measurement component:\nareaMeasurement3d.analysis = areaMeasurementAnalysis;\n```",
274
278
  "type": "AreaMeasurementAnalysis"
275
279
  },
276
280
  {
@@ -294,21 +298,22 @@
294
298
  },
295
299
  {
296
300
  "name": "referenceElement",
301
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
297
302
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
298
303
  },
299
304
  {
300
305
  "name": "state",
301
- "description": "The current state of the component.",
306
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
302
307
  "type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
303
308
  },
304
309
  {
305
310
  "name": "unit",
306
- "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
311
+ "description": "Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](#unitOptions).",
307
312
  "type": "\"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\" | \"square-centimeters\" | \"square-decimeters\" | \"square-feet\" | \"square-inches\" | \"square-kilometers\" | \"square-meters\" | \"square-miles\" | \"square-millimeters\" | \"square-nautical-miles\" | \"square-us-feet\" | \"square-yards\""
308
313
  },
309
314
  {
310
315
  "name": "unitOptions",
311
- "description": "List of unit systems (imperial, metric) and specific units for displaying the distance values.",
316
+ "description": "List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [unit](#unit) values can only be a subset of this list.",
312
317
  "type": "Array<\"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\">"
313
318
  }
314
319
  ],
@@ -441,6 +446,7 @@
441
446
  },
442
447
  {
443
448
  "name": "reference-element",
449
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
444
450
  "value": {
445
451
  "type": "string"
446
452
  }
@@ -540,6 +546,7 @@
540
546
  },
541
547
  {
542
548
  "name": "referenceElement",
549
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
543
550
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
544
551
  },
545
552
  {
@@ -645,6 +652,7 @@
645
652
  },
646
653
  {
647
654
  "name": "reference-element",
655
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
648
656
  "value": {
649
657
  "type": "string"
650
658
  }
@@ -709,7 +717,7 @@
709
717
  },
710
718
  {
711
719
  "name": "messageOverrides",
712
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
720
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
713
721
  "type": "Record<string, unknown>"
714
722
  },
715
723
  {
@@ -718,6 +726,7 @@
718
726
  },
719
727
  {
720
728
  "name": "referenceElement",
729
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
721
730
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
722
731
  },
723
732
  {
@@ -898,6 +907,7 @@
898
907
  },
899
908
  {
900
909
  "name": "reference-element",
910
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
901
911
  "value": {
902
912
  "type": "string"
903
913
  }
@@ -1124,6 +1134,7 @@
1124
1134
  },
1125
1135
  {
1126
1136
  "name": "referenceElement",
1137
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
1127
1138
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
1128
1139
  },
1129
1140
  {
@@ -1269,6 +1280,7 @@
1269
1280
  },
1270
1281
  {
1271
1282
  "name": "reference-element",
1283
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
1272
1284
  "value": {
1273
1285
  "type": "string"
1274
1286
  }
@@ -1298,7 +1310,7 @@
1298
1310
  "events": [
1299
1311
  {
1300
1312
  "name": "arcgisPropertyChange",
1301
- "type": "{ name: \"state\" | \"nextBasemap\"; }",
1313
+ "type": "{ name: \"state\" | \"activeBasemap\" | \"nextBasemap\"; }",
1302
1314
  "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
1303
1315
  },
1304
1316
  {
@@ -1331,7 +1343,7 @@
1331
1343
  },
1332
1344
  {
1333
1345
  "name": "messageOverrides",
1334
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
1346
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
1335
1347
  "type": "Record<string, unknown>"
1336
1348
  },
1337
1349
  {
@@ -1345,6 +1357,7 @@
1345
1357
  },
1346
1358
  {
1347
1359
  "name": "referenceElement",
1360
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
1348
1361
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
1349
1362
  },
1350
1363
  {
@@ -1361,7 +1374,7 @@
1361
1374
  "events": [
1362
1375
  {
1363
1376
  "name": "arcgisPropertyChange",
1364
- "type": "{ name: \"state\" | \"nextBasemap\"; }",
1377
+ "type": "{ name: \"state\" | \"activeBasemap\" | \"nextBasemap\"; }",
1365
1378
  "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
1366
1379
  },
1367
1380
  {
@@ -1478,6 +1491,7 @@
1478
1491
  },
1479
1492
  {
1480
1493
  "name": "reference-element",
1494
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
1481
1495
  "value": {
1482
1496
  "type": "string"
1483
1497
  }
@@ -1641,6 +1655,7 @@
1641
1655
  },
1642
1656
  {
1643
1657
  "name": "referenceElement",
1658
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
1644
1659
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
1645
1660
  },
1646
1661
  {
@@ -1702,7 +1717,7 @@
1702
1717
  },
1703
1718
  {
1704
1719
  "name": "arcgis-building-explorer",
1705
- "description": "The Building Explorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
1720
+ "description": "The Building Explorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.\n\n**Known limitations**\n\nBuilding Explorer is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
1706
1721
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/",
1707
1722
  "attributes": [
1708
1723
  {
@@ -1715,7 +1730,7 @@
1715
1730
  },
1716
1731
  {
1717
1732
  "name": "heading-level",
1718
- "description": "Indicates the heading level to use for the headings in the widget.",
1733
+ "description": "Indicates the heading level to use for the component title.",
1719
1734
  "default": "3",
1720
1735
  "value": {
1721
1736
  "type": "number"
@@ -1744,7 +1759,7 @@
1744
1759
  },
1745
1760
  {
1746
1761
  "name": "icon",
1747
- "description": "Icon which represents the widget.",
1762
+ "description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
1748
1763
  "default": "\"organization\"",
1749
1764
  "value": {
1750
1765
  "type": "string"
@@ -1752,7 +1767,7 @@
1752
1767
  },
1753
1768
  {
1754
1769
  "name": "label",
1755
- "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#label)",
1770
+ "description": "The component's default label.",
1756
1771
  "value": {
1757
1772
  "type": "string"
1758
1773
  }
@@ -1776,13 +1791,14 @@
1776
1791
  },
1777
1792
  {
1778
1793
  "name": "reference-element",
1794
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
1779
1795
  "value": {
1780
1796
  "type": "string"
1781
1797
  }
1782
1798
  },
1783
1799
  {
1784
1800
  "name": "state",
1785
- "description": "The current state of the view model that can be used for rendering the UI of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#state)",
1801
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - \tcomponent is being created\n* `loading` - layers and statistics are loading\n* `ready` - component is ready\n* `failed` - component failed to load data",
1786
1802
  "default": "\"disabled\"",
1787
1803
  "value": {
1788
1804
  "type": [
@@ -1815,7 +1831,7 @@
1815
1831
  },
1816
1832
  {
1817
1833
  "name": "headingLevel",
1818
- "description": "Indicates the heading level to use for the headings in the widget.",
1834
+ "description": "Indicates the heading level to use for the component title.",
1819
1835
  "type": "number"
1820
1836
  },
1821
1837
  {
@@ -1832,17 +1848,17 @@
1832
1848
  },
1833
1849
  {
1834
1850
  "name": "icon",
1835
- "description": "Icon which represents the widget.",
1851
+ "description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
1836
1852
  "type": "string"
1837
1853
  },
1838
1854
  {
1839
1855
  "name": "label",
1840
- "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#label)",
1856
+ "description": "The component's default label.",
1841
1857
  "type": "string"
1842
1858
  },
1843
1859
  {
1844
1860
  "name": "layers",
1845
- "description": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of layers of type [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html)\nthat are added to the widget for exploration.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#layers)",
1861
+ "description": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)\nof layers of type [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html)\nthat are added to the componen for exploration.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#layers)",
1846
1862
  "type": "Collection<BuildingSceneLayer>"
1847
1863
  },
1848
1864
  {
@@ -1861,11 +1877,12 @@
1861
1877
  },
1862
1878
  {
1863
1879
  "name": "referenceElement",
1880
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
1864
1881
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
1865
1882
  },
1866
1883
  {
1867
1884
  "name": "state",
1868
- "description": "The current state of the view model that can be used for rendering the UI of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#state)",
1885
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - \tcomponent is being created\n* `loading` - layers and statistics are loading\n* `ready` - component is ready\n* `failed` - component failed to load data",
1869
1886
  "type": "\"disabled\" | \"failed\" | \"loading\" | \"ready\""
1870
1887
  }
1871
1888
  ],
@@ -1992,6 +2009,7 @@
1992
2009
  },
1993
2010
  {
1994
2011
  "name": "reference-element",
2012
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
1995
2013
  "value": {
1996
2014
  "type": "string"
1997
2015
  }
@@ -2178,6 +2196,7 @@
2178
2196
  },
2179
2197
  {
2180
2198
  "name": "referenceElement",
2199
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
2181
2200
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
2182
2201
  },
2183
2202
  {
@@ -2295,6 +2314,7 @@
2295
2314
  },
2296
2315
  {
2297
2316
  "name": "reference-element",
2317
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
2298
2318
  "value": {
2299
2319
  "type": "string"
2300
2320
  }
@@ -2348,7 +2368,7 @@
2348
2368
  },
2349
2369
  {
2350
2370
  "name": "messageOverrides",
2351
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
2371
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
2352
2372
  "type": "Record<string, unknown>"
2353
2373
  },
2354
2374
  {
@@ -2362,6 +2382,7 @@
2362
2382
  },
2363
2383
  {
2364
2384
  "name": "referenceElement",
2385
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
2365
2386
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
2366
2387
  },
2367
2388
  {
@@ -2413,14 +2434,14 @@
2413
2434
  }
2414
2435
  },
2415
2436
  {
2416
- "name": "hide-edit-button",
2437
+ "name": "hide-expand-button",
2417
2438
  "default": "false",
2418
2439
  "value": {
2419
2440
  "type": "boolean"
2420
2441
  }
2421
2442
  },
2422
2443
  {
2423
- "name": "hide-expand-button",
2444
+ "name": "hide-input-button",
2424
2445
  "default": "false",
2425
2446
  "value": {
2426
2447
  "type": "boolean"
@@ -2498,6 +2519,7 @@
2498
2519
  },
2499
2520
  {
2500
2521
  "name": "reference-element",
2522
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
2501
2523
  "value": {
2502
2524
  "type": "string"
2503
2525
  }
@@ -2583,11 +2605,11 @@
2583
2605
  "type": "boolean"
2584
2606
  },
2585
2607
  {
2586
- "name": "hideEditButton",
2608
+ "name": "hideExpandButton",
2587
2609
  "type": "boolean"
2588
2610
  },
2589
2611
  {
2590
- "name": "hideExpandButton",
2612
+ "name": "hideInputButton",
2591
2613
  "type": "boolean"
2592
2614
  },
2593
2615
  {
@@ -2630,6 +2652,7 @@
2630
2652
  },
2631
2653
  {
2632
2654
  "name": "referenceElement",
2655
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
2633
2656
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
2634
2657
  },
2635
2658
  {
@@ -2664,7 +2687,7 @@
2664
2687
  },
2665
2688
  {
2666
2689
  "name": "arcgis-daylight",
2667
- "description": "The Daylight component can be used to manipulate the lighting conditions of a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisUserDateTimeChange** - Fires when the user changes the date or time in the widget by interacting with the slider, the date picker, the\nseason selector or the play buttons.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
2690
+ "description": "The Daylight component can be used to manipulate the lighting conditions of a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\n**Known limitations**\n\nDaylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [Environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)\n- [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisUserDateTimeChange** - Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
2668
2691
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/",
2669
2692
  "attributes": [
2670
2693
  {
@@ -2689,7 +2712,7 @@
2689
2712
  },
2690
2713
  {
2691
2714
  "name": "date-or-season",
2692
- "description": "Controls whether the widget displays a date or a season picker.",
2715
+ "description": "Controls whether the component displays a date or a season picker.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason)",
2693
2716
  "default": "\"date\"",
2694
2717
  "value": {
2695
2718
  "type": [
@@ -2708,7 +2731,7 @@
2708
2731
  },
2709
2732
  {
2710
2733
  "name": "heading-level",
2711
- "description": "Indicates the heading level to use for the widget title.",
2734
+ "description": "Indicates the heading level to use for the component title.",
2712
2735
  "default": "3",
2713
2736
  "value": {
2714
2737
  "type": "number"
@@ -2758,7 +2781,7 @@
2758
2781
  },
2759
2782
  {
2760
2783
  "name": "icon",
2761
- "description": "Icon which represents the widget.",
2784
+ "description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
2762
2785
  "default": "\"brightness\"",
2763
2786
  "value": {
2764
2787
  "type": "string"
@@ -2766,7 +2789,7 @@
2766
2789
  },
2767
2790
  {
2768
2791
  "name": "label",
2769
- "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#label)",
2792
+ "description": "The component's default label.",
2770
2793
  "value": {
2771
2794
  "type": "string"
2772
2795
  }
@@ -2798,13 +2821,14 @@
2798
2821
  },
2799
2822
  {
2800
2823
  "name": "reference-element",
2824
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
2801
2825
  "value": {
2802
2826
  "type": "string"
2803
2827
  }
2804
2828
  },
2805
2829
  {
2806
2830
  "name": "time-slider-steps",
2807
- "description": "Sets steps, or intervals, on the time slider to restrict the times\nof the day that can be selected when dragging the thumb.",
2831
+ "description": "Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#timeSliderSteps)",
2808
2832
  "default": "5",
2809
2833
  "value": {
2810
2834
  "type": "number"
@@ -2828,7 +2852,7 @@
2828
2852
  {
2829
2853
  "name": "arcgisUserDateTimeChange",
2830
2854
  "type": "void",
2831
- "description": "Fires when the user changes the date or time in the widget by interacting with the slider, the date picker, the\nseason selector or the play buttons."
2855
+ "description": "Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons."
2832
2856
  }
2833
2857
  ],
2834
2858
  "js": {
@@ -2845,7 +2869,7 @@
2845
2869
  },
2846
2870
  {
2847
2871
  "name": "dateOrSeason",
2848
- "description": "Controls whether the widget displays a date or a season picker.",
2872
+ "description": "Controls whether the component displays a date or a season picker.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason)",
2849
2873
  "type": "\"date\" | \"season\""
2850
2874
  },
2851
2875
  {
@@ -2855,7 +2879,7 @@
2855
2879
  },
2856
2880
  {
2857
2881
  "name": "headingLevel",
2858
- "description": "Indicates the heading level to use for the widget title.",
2882
+ "description": "Indicates the heading level to use for the component title.",
2859
2883
  "type": "number"
2860
2884
  },
2861
2885
  {
@@ -2884,12 +2908,12 @@
2884
2908
  },
2885
2909
  {
2886
2910
  "name": "icon",
2887
- "description": "Icon which represents the widget.",
2911
+ "description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
2888
2912
  "type": "string"
2889
2913
  },
2890
2914
  {
2891
2915
  "name": "label",
2892
- "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#label)",
2916
+ "description": "The component's default label.",
2893
2917
  "type": "string"
2894
2918
  },
2895
2919
  {
@@ -2903,11 +2927,12 @@
2903
2927
  },
2904
2928
  {
2905
2929
  "name": "referenceElement",
2930
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
2906
2931
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
2907
2932
  },
2908
2933
  {
2909
2934
  "name": "timeSliderSteps",
2910
- "description": "Sets steps, or intervals, on the time slider to restrict the times\nof the day that can be selected when dragging the thumb.",
2935
+ "description": "Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#timeSliderSteps)",
2911
2936
  "type": "Array<number> | number"
2912
2937
  },
2913
2938
  {
@@ -2925,7 +2950,7 @@
2925
2950
  {
2926
2951
  "name": "arcgisUserDateTimeChange",
2927
2952
  "type": "void",
2928
- "description": "Fires when the user changes the date or time in the widget by interacting with the slider, the date picker, the\nseason selector or the play buttons."
2953
+ "description": "Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons."
2929
2954
  }
2930
2955
  ]
2931
2956
  }
@@ -2993,6 +3018,7 @@
2993
3018
  },
2994
3019
  {
2995
3020
  "name": "reference-element",
3021
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
2996
3022
  "value": {
2997
3023
  "type": "string"
2998
3024
  }
@@ -3078,7 +3104,7 @@
3078
3104
  },
3079
3105
  {
3080
3106
  "name": "messageOverrides",
3081
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
3107
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
3082
3108
  "type": "Record<string, unknown>"
3083
3109
  },
3084
3110
  {
@@ -3087,6 +3113,7 @@
3087
3113
  },
3088
3114
  {
3089
3115
  "name": "referenceElement",
3116
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
3090
3117
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
3091
3118
  },
3092
3119
  {
@@ -3215,6 +3242,7 @@
3215
3242
  },
3216
3243
  {
3217
3244
  "name": "reference-element",
3245
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
3218
3246
  "value": {
3219
3247
  "type": "string"
3220
3248
  }
@@ -3346,6 +3374,7 @@
3346
3374
  },
3347
3375
  {
3348
3376
  "name": "referenceElement",
3377
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
3349
3378
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
3350
3379
  },
3351
3380
  {
@@ -3354,7 +3383,7 @@
3354
3383
  },
3355
3384
  {
3356
3385
  "name": "searchProperties",
3357
- "description": "Controls the default properties used when [searching](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search.html).",
3386
+ "description": "Controls the default properties used when searching.",
3358
3387
  "type": "DirectionsSearchProperties"
3359
3388
  },
3360
3389
  {
@@ -3388,7 +3417,7 @@
3388
3417
  },
3389
3418
  {
3390
3419
  "name": "arcgis-direct-line-measurement-3d",
3391
- "description": "The Direct Line Measurement 3D component calculates and displays the 3D distance between two points. This component\ncan be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nto measure the vertical, horizontal, and direct distance between two points.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`",
3420
+ "description": "The Direct Line Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent to calculate and display vertical, horizontal, and direct distances between two points.\n\n[![measurement-line-3d](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/3D_DirectLineMeasurement_widget.png)](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow distances are computed depends on the scene's spatial reference.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- Direct distance is computed in a Euclidean manner, in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets);\n- Horizontal distance is computed geodetically, taking into consideration the curvature of the planet;\n- Vertical distance is computed as an elevation difference.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, all three distances (direct, horizontal, and vertical)\n are computed in a Euclidean manner (in their respective PCS).\n\nDirect Line Measurement 3D component visualizes and labels the direct, horizontal, and vertical distances and displays the same values\nin the UI panel. When the distance between the points is greater than 100 kilometers,\nthe measurement visualization is simplified, and only the horizontal and vertical distances are calculated.\nThe direct distance option becomes unavailable.\n\n![measurement-line-3d](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/direct-line-measurement-3d.png)\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\nA second laser line shows the intersection of the scene with the vertical plane that passes through the checkered line.\n\n**Things to consider**\n\n* Direct Line Measurement 3D is designed to work in the Scene component. For measurements in the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Distance Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/).\n* Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n- [Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
3392
3421
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/",
3393
3422
  "attributes": [
3394
3423
  {
@@ -3433,12 +3462,14 @@
3433
3462
  },
3434
3463
  {
3435
3464
  "name": "reference-element",
3465
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
3436
3466
  "value": {
3437
3467
  "type": "string"
3438
3468
  }
3439
3469
  },
3440
3470
  {
3441
3471
  "name": "state",
3472
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
3442
3473
  "value": {
3443
3474
  "type": [
3444
3475
  "\"disabled\"",
@@ -3450,7 +3481,7 @@
3450
3481
  },
3451
3482
  {
3452
3483
  "name": "unit",
3453
- "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
3484
+ "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
3454
3485
  "value": {
3455
3486
  "type": [
3456
3487
  "\"centimeters\"",
@@ -3486,6 +3517,7 @@
3486
3517
  "properties": [
3487
3518
  {
3488
3519
  "name": "analysis",
3520
+ "description": "The [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Direct Line Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst directLineAnalysis = new DirectLineMeasurementAnalysis({\n startPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624995.61798748,\n y: 4550334.030096778,\n z: 63.378210234455764\n }),\n endPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624921.53589075,\n y: 4550407.42357004,\n z: 63.3783810287714\n }),\n});\n// Get the Scene and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst directLineMeasurement3d = document.querySelector(\"arcgis-direct-line-measurement-3d\");\nawait directLineMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(directLineAnalysis);\n// Connect the analysis to the measurement component:\ndirectLineMeasurement3d.analysis = directLineAnalysis;\n```",
3489
3521
  "type": "DirectLineMeasurementAnalysis"
3490
3522
  },
3491
3523
  {
@@ -3509,20 +3541,22 @@
3509
3541
  },
3510
3542
  {
3511
3543
  "name": "referenceElement",
3544
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
3512
3545
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
3513
3546
  },
3514
3547
  {
3515
3548
  "name": "state",
3549
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
3516
3550
  "type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
3517
3551
  },
3518
3552
  {
3519
3553
  "name": "unit",
3520
- "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
3554
+ "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
3521
3555
  "type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
3522
3556
  },
3523
3557
  {
3524
3558
  "name": "unitOptions",
3525
- "description": "List of unit systems (imperial, metric) and specific units for displaying the distance values.",
3559
+ "description": "List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `inches`, `feet`, `us-feet`, `yards`, `miles`, `nautical-miles`, `meters`, `kilometers`.\nPossible [unit](#unit) values can only be a subset of this list.",
3526
3560
  "type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
3527
3561
  }
3528
3562
  ],
@@ -3542,7 +3576,7 @@
3542
3576
  },
3543
3577
  {
3544
3578
  "name": "arcgis-directline-measurement-3d",
3545
- "description": "**Deprecated**. The Direct Line Measurement 3D component calculates and displays the 3D distance between two points. This component can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to measure the vertical, horizontal, and direct distance between two points.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`",
3579
+ "description": "**Deprecated**. The Directline Measurement 3D component calculates and displays the 3D distance between two points. It can be used in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component to measure the vertical, horizontal, and direct distance between two points.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
3546
3580
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directline-measurement-3d/",
3547
3581
  "attributes": [
3548
3582
  {
@@ -3587,12 +3621,14 @@
3587
3621
  },
3588
3622
  {
3589
3623
  "name": "reference-element",
3624
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
3590
3625
  "value": {
3591
3626
  "type": "string"
3592
3627
  }
3593
3628
  },
3594
3629
  {
3595
3630
  "name": "state",
3631
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
3596
3632
  "value": {
3597
3633
  "type": [
3598
3634
  "\"disabled\"",
@@ -3604,7 +3640,7 @@
3604
3640
  },
3605
3641
  {
3606
3642
  "name": "unit",
3607
- "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
3643
+ "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
3608
3644
  "value": {
3609
3645
  "type": [
3610
3646
  "\"centimeters\"",
@@ -3640,6 +3676,7 @@
3640
3676
  "properties": [
3641
3677
  {
3642
3678
  "name": "analysis",
3679
+ "description": "The [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Direct Line Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst directLineAnalysis = new DirectLineMeasurementAnalysis({\n startPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624995.61798748,\n y: 4550334.030096778,\n z: 63.378210234455764\n }),\n endPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624921.53589075,\n y: 4550407.42357004,\n z: 63.3783810287714\n }),\n});\n// Get the Scene and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst directLineMeasurement3d = document.querySelector(\"arcgis-direct-line-measurement-3d\");\nawait directLineMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(directLineAnalysis);\n// Connect the analysis to the measurement component:\ndirectLineMeasurement3d.analysis = directLineAnalysis;\n```",
3643
3680
  "type": "DirectLineMeasurementAnalysis"
3644
3681
  },
3645
3682
  {
@@ -3663,20 +3700,22 @@
3663
3700
  },
3664
3701
  {
3665
3702
  "name": "referenceElement",
3703
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
3666
3704
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
3667
3705
  },
3668
3706
  {
3669
3707
  "name": "state",
3708
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
3670
3709
  "type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
3671
3710
  },
3672
3711
  {
3673
3712
  "name": "unit",
3674
- "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
3713
+ "description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
3675
3714
  "type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
3676
3715
  },
3677
3716
  {
3678
3717
  "name": "unitOptions",
3679
- "description": "List of unit systems (imperial, metric) and specific units for displaying the distance values.",
3718
+ "description": "List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `inches`, `feet`, `us-feet`, `yards`, `miles`, `nautical-miles`, `meters`, `kilometers`.\nPossible [unit](#unit) values can only be a subset of this list.",
3680
3719
  "type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
3681
3720
  }
3682
3721
  ],
@@ -3741,6 +3780,7 @@
3741
3780
  },
3742
3781
  {
3743
3782
  "name": "reference-element",
3783
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
3744
3784
  "value": {
3745
3785
  "type": "string"
3746
3786
  }
@@ -3815,6 +3855,7 @@
3815
3855
  },
3816
3856
  {
3817
3857
  "name": "referenceElement",
3858
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
3818
3859
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
3819
3860
  },
3820
3861
  {
@@ -3963,6 +4004,7 @@
3963
4004
  },
3964
4005
  {
3965
4006
  "name": "reference-element",
4007
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
3966
4008
  "value": {
3967
4009
  "type": "string"
3968
4010
  }
@@ -4087,6 +4129,7 @@
4087
4129
  },
4088
4130
  {
4089
4131
  "name": "referenceElement",
4132
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
4090
4133
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
4091
4134
  },
4092
4135
  {
@@ -4130,7 +4173,7 @@
4130
4173
  },
4131
4174
  {
4132
4175
  "name": "arcgis-elevation-profile",
4133
- "description": "The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`\n- `stop(): Promise<void>`",
4176
+ "description": "The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).\n\n**See also**\n\n- [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Switches to the \"creating\" state in which the user can draw a new line.\n- `stop(): Promise<void>` - Stops the creation operation.",
4134
4177
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/",
4135
4178
  "attributes": [
4136
4179
  {
@@ -4214,7 +4257,7 @@
4214
4257
  },
4215
4258
  {
4216
4259
  "name": "icon",
4217
- "description": "Icon which represents the widget.",
4260
+ "description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
4218
4261
  "default": "\"altitude\"",
4219
4262
  "value": {
4220
4263
  "type": "string"
@@ -4222,7 +4265,7 @@
4222
4265
  },
4223
4266
  {
4224
4267
  "name": "label",
4225
- "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#label)",
4268
+ "description": "The component's default label.",
4226
4269
  "value": {
4227
4270
  "type": "string"
4228
4271
  }
@@ -4246,13 +4289,14 @@
4246
4289
  },
4247
4290
  {
4248
4291
  "name": "reference-element",
4292
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
4249
4293
  "value": {
4250
4294
  "type": "string"
4251
4295
  }
4252
4296
  },
4253
4297
  {
4254
4298
  "name": "state",
4255
- "description": "The current state of the view model that can be used for rendering the UI\nof the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#state)",
4299
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready; no path configured and no interactive operation ongoing\n* `creating` - user is creating a new input path\n* `created` - input path is configured but no interactive operation is ongoing\n* `selecting` - user is selecting an existing input path\n* `selected` - user selected an existing input path",
4256
4300
  "default": "\"disabled\"",
4257
4301
  "value": {
4258
4302
  "type": [
@@ -4316,7 +4360,7 @@
4316
4360
  },
4317
4361
  {
4318
4362
  "name": "effectiveUnits",
4319
- "description": "Units which have been selected according to the magnitude of the elevations and distances\nthat are to be displayed in the widget, according to the selected unit or unit system.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#effectiveUnits)",
4363
+ "description": "Units which have been selected according to the magnitude of the elevations and distances that are to be displayed in the component, according to the selected unit or unit system.",
4320
4364
  "type": "EffectiveUnits"
4321
4365
  },
4322
4366
  {
@@ -4363,17 +4407,17 @@
4363
4407
  },
4364
4408
  {
4365
4409
  "name": "icon",
4366
- "description": "Icon which represents the widget.",
4410
+ "description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
4367
4411
  "type": "string"
4368
4412
  },
4369
4413
  {
4370
4414
  "name": "input",
4371
- "description": "The input line graphic along which elevation will be queried in order to generate an elevation profile.",
4415
+ "description": "The input path along which elevation will be queried in order to generate an elevation profile.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input)",
4372
4416
  "type": "Graphic"
4373
4417
  },
4374
4418
  {
4375
4419
  "name": "label",
4376
- "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#label)",
4420
+ "description": "The component's default label.",
4377
4421
  "type": "string"
4378
4422
  },
4379
4423
  {
@@ -4382,7 +4426,7 @@
4382
4426
  },
4383
4427
  {
4384
4428
  "name": "profiles",
4385
- "description": "Collection of elevation profile lines which are to be generated and displayed in the widget's\nchart.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#profiles)",
4429
+ "description": "Collection of elevation profile lines which are to be generated and displayed in the component's chart.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#profiles)",
4386
4430
  "type": "Collection<ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineView>"
4387
4431
  },
4388
4432
  {
@@ -4392,11 +4436,12 @@
4392
4436
  },
4393
4437
  {
4394
4438
  "name": "referenceElement",
4439
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
4395
4440
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
4396
4441
  },
4397
4442
  {
4398
4443
  "name": "state",
4399
- "description": "The current state of the view model that can be used for rendering the UI\nof the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#state)",
4444
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready; no path configured and no interactive operation ongoing\n* `creating` - user is creating a new input path\n* `created` - input path is configured but no interactive operation is ongoing\n* `selecting` - user is selecting an existing input path\n* `selected` - user selected an existing input path",
4400
4445
  "type": "\"created\" | \"creating\" | \"disabled\" | \"ready\" | \"selected\" | \"selecting\""
4401
4446
  },
4402
4447
  {
@@ -4431,7 +4476,7 @@
4431
4476
  },
4432
4477
  {
4433
4478
  "name": "arcgis-expand",
4434
- "description": "The Expand component acts as a clickable button for opening content.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `collapse(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `expand(): Promise<void>`\n- `toggle(): Promise<void>`",
4479
+ "description": "The Expand component acts as a clickable button for displaying interactive content, most commonly other components.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `collapse(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `expand(): Promise<void>`\n- `toggle(): Promise<void>`",
4435
4480
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/",
4436
4481
  "attributes": [
4437
4482
  {
@@ -4508,7 +4553,7 @@
4508
4553
  },
4509
4554
  {
4510
4555
  "name": "focus-trap-enabled",
4511
- "description": "**Deprecated**: since 4.33. Use [`focusTrapDisabled`](#focusTrapDisabled) instead.. Disables focus trapping within the expand widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#focusTrapDisabled)",
4556
+ "description": "**Deprecated**: since 4.33, use [`focusTrapDisabled`](#focusTrapDisabled) instead.. Disables focus trapping within the expand widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#focusTrapDisabled)",
4512
4557
  "default": "false",
4513
4558
  "value": {
4514
4559
  "type": "boolean"
@@ -4596,6 +4641,7 @@
4596
4641
  },
4597
4642
  {
4598
4643
  "name": "reference-element",
4644
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
4599
4645
  "value": {
4600
4646
  "type": "string"
4601
4647
  }
@@ -4691,6 +4737,7 @@
4691
4737
  },
4692
4738
  {
4693
4739
  "name": "referenceElement",
4740
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
4694
4741
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
4695
4742
  }
4696
4743
  ],
@@ -4774,7 +4821,7 @@
4774
4821
  },
4775
4822
  {
4776
4823
  "name": "hide-last-edit-info",
4777
- "description": "**Deprecated**: since 4.33. Use [hideLastEditedInfo](#hideLastEditedInfo) instead.. ",
4824
+ "description": "**Deprecated**: since 4.33, use [hideLastEditedInfo](#hideLastEditedInfo) instead.. ",
4778
4825
  "default": "false",
4779
4826
  "value": {
4780
4827
  "type": "boolean"
@@ -4830,6 +4877,7 @@
4830
4877
  },
4831
4878
  {
4832
4879
  "name": "reference-element",
4880
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
4833
4881
  "value": {
4834
4882
  "type": "string"
4835
4883
  }
@@ -4954,6 +5002,7 @@
4954
5002
  },
4955
5003
  {
4956
5004
  "name": "referenceElement",
5005
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
4957
5006
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
4958
5007
  },
4959
5008
  {
@@ -5052,6 +5101,7 @@
5052
5101
  },
5053
5102
  {
5054
5103
  "name": "reference-element",
5104
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
5055
5105
  "value": {
5056
5106
  "type": "string"
5057
5107
  }
@@ -5136,7 +5186,7 @@
5136
5186
  {
5137
5187
  "name": "layer",
5138
5188
  "description": "Layer containing the editable feature attributes.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#layer)",
5139
- "type": "FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer"
5189
+ "type": "FeatureLayer | GeoJSONLayer | KnowledgeGraphSublayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer"
5140
5190
  },
5141
5191
  {
5142
5192
  "name": "position",
@@ -5144,6 +5194,7 @@
5144
5194
  },
5145
5195
  {
5146
5196
  "name": "referenceElement",
5197
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
5147
5198
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
5148
5199
  },
5149
5200
  {
@@ -5537,6 +5588,7 @@
5537
5588
  },
5538
5589
  {
5539
5590
  "name": "reference-element",
5591
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
5540
5592
  "value": {
5541
5593
  "type": "string"
5542
5594
  }
@@ -5998,6 +6050,7 @@
5998
6050
  },
5999
6051
  {
6000
6052
  "name": "referenceElement",
6053
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
6001
6054
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
6002
6055
  },
6003
6056
  {
@@ -6072,7 +6125,7 @@
6072
6125
  },
6073
6126
  {
6074
6127
  "name": "supportsResizeAttachments",
6075
- "description": "Indicates whether the table and associated layer support resizing attachments with the current configuration.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#supportsResizeAttachments)",
6128
+ "description": "Defines whether or not the feature supports resizing\nattachments.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#supportsResizeAttachments)",
6076
6129
  "type": "boolean"
6077
6130
  },
6078
6131
  {
@@ -6244,6 +6297,7 @@
6244
6297
  },
6245
6298
  {
6246
6299
  "name": "reference-element",
6300
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
6247
6301
  "value": {
6248
6302
  "type": "string"
6249
6303
  }
@@ -6344,6 +6398,7 @@
6344
6398
  },
6345
6399
  {
6346
6400
  "name": "referenceElement",
6401
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
6347
6402
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
6348
6403
  },
6349
6404
  {
@@ -6558,6 +6613,7 @@
6558
6613
  },
6559
6614
  {
6560
6615
  "name": "reference-element",
6616
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
6561
6617
  "value": {
6562
6618
  "type": "string"
6563
6619
  }
@@ -6760,6 +6816,7 @@
6760
6816
  },
6761
6817
  {
6762
6818
  "name": "referenceElement",
6819
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
6763
6820
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
6764
6821
  },
6765
6822
  {
@@ -6893,6 +6950,7 @@
6893
6950
  },
6894
6951
  {
6895
6952
  "name": "reference-element",
6953
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
6896
6954
  "value": {
6897
6955
  "type": "string"
6898
6956
  }
@@ -6955,6 +7013,7 @@
6955
7013
  },
6956
7014
  {
6957
7015
  "name": "referenceElement",
7016
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
6958
7017
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
6959
7018
  },
6960
7019
  {
@@ -6974,7 +7033,7 @@
6974
7033
  },
6975
7034
  {
6976
7035
  "name": "arcgis-fullscreen",
6977
- "description": "The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
7036
+ "description": "The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\nUse the escape key (`esc`) to exit fullscreen mode.\n\n**Known limitations**\n\n* The Fullscreen widget only works with browsers that implement the [Fullscreen](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API) API.\n Thus, iOS Safari is not supported.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
6978
7037
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-fullscreen/",
6979
7038
  "attributes": [
6980
7039
  {
@@ -7003,6 +7062,7 @@
7003
7062
  },
7004
7063
  {
7005
7064
  "name": "reference-element",
7065
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
7006
7066
  "value": {
7007
7067
  "type": "string"
7008
7068
  }
@@ -7045,7 +7105,7 @@
7045
7105
  },
7046
7106
  {
7047
7107
  "name": "messageOverrides",
7048
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
7108
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
7049
7109
  "type": "Record<string, unknown>"
7050
7110
  },
7051
7111
  {
@@ -7054,6 +7114,7 @@
7054
7114
  },
7055
7115
  {
7056
7116
  "name": "referenceElement",
7117
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
7057
7118
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
7058
7119
  },
7059
7120
  {
@@ -7255,6 +7316,7 @@
7255
7316
  },
7256
7317
  {
7257
7318
  "name": "reference-element",
7319
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
7258
7320
  "value": {
7259
7321
  "type": "string"
7260
7322
  }
@@ -7443,7 +7505,7 @@
7443
7505
  },
7444
7506
  {
7445
7507
  "name": "messageOverrides",
7446
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
7508
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
7447
7509
  "type": "Record<string, unknown>"
7448
7510
  },
7449
7511
  {
@@ -7457,6 +7519,7 @@
7457
7519
  },
7458
7520
  {
7459
7521
  "name": "referenceElement",
7522
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
7460
7523
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
7461
7524
  },
7462
7525
  {
@@ -7617,6 +7680,7 @@
7617
7680
  },
7618
7681
  {
7619
7682
  "name": "reference-element",
7683
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
7620
7684
  "value": {
7621
7685
  "type": "string"
7622
7686
  }
@@ -7742,6 +7806,7 @@
7742
7806
  },
7743
7807
  {
7744
7808
  "name": "referenceElement",
7809
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
7745
7810
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
7746
7811
  },
7747
7812
  {
@@ -7826,6 +7891,7 @@
7826
7891
  },
7827
7892
  {
7828
7893
  "name": "reference-element",
7894
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
7829
7895
  "value": {
7830
7896
  "type": "string"
7831
7897
  }
@@ -7884,7 +7950,7 @@
7884
7950
  },
7885
7951
  {
7886
7952
  "name": "messageOverrides",
7887
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
7953
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
7888
7954
  "type": "Record<string, unknown>"
7889
7955
  },
7890
7956
  {
@@ -7893,6 +7959,7 @@
7893
7959
  },
7894
7960
  {
7895
7961
  "name": "referenceElement",
7962
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
7896
7963
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
7897
7964
  },
7898
7965
  {
@@ -7902,7 +7969,7 @@
7902
7969
  },
7903
7970
  {
7904
7971
  "name": "viewpoint",
7905
- "description": "The esri/Viewpoint, or point of view, to zoom to when\ngoing home. The initial value is determined a few different ways:\n\nIf no esri/views/View is provided, the value is `null`.\nIf the esri/views/View is ready, but the esri/Viewpoint is not defined, the initial\nvalue of the esri/Viewpoint is determined when the esri/views/View became ready.\nIf the esri/views/View is ready and the esri/Viewpoint is defined by the user, the initial viewpoint value is the user-defined esri/Viewpoint.",
7972
+ "description": "The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nto go to when going \"home\".\nThe initial value is determined in a few different ways:\n\nIf no referenceElement is provided, the value is `null`.\nOnce the referenceElement is ready, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html).",
7906
7973
  "type": "Viewpoint"
7907
7974
  }
7908
7975
  ],
@@ -8057,6 +8124,7 @@
8057
8124
  },
8058
8125
  {
8059
8126
  "name": "reference-element",
8127
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
8060
8128
  "value": {
8061
8129
  "type": "string"
8062
8130
  }
@@ -8272,6 +8340,7 @@
8272
8340
  },
8273
8341
  {
8274
8342
  "name": "referenceElement",
8343
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
8275
8344
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
8276
8345
  },
8277
8346
  {
@@ -8427,6 +8496,7 @@
8427
8496
  },
8428
8497
  {
8429
8498
  "name": "reference-element",
8499
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
8430
8500
  "value": {
8431
8501
  "type": "string"
8432
8502
  }
@@ -8524,6 +8594,7 @@
8524
8594
  },
8525
8595
  {
8526
8596
  "name": "referenceElement",
8597
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
8527
8598
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
8528
8599
  },
8529
8600
  {
@@ -8558,7 +8629,7 @@
8558
8629
  },
8559
8630
  {
8560
8631
  "name": "arcgis-line-of-sight",
8561
- "description": "The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a 3D view. Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including ground, integrated meshes, and 3D objects such as buildings or trees.\n\nThe results from the analysis are displayed as lines, where the visible part, indicating what the observer can see,\nis colored green. Visible targets are displayed with a green sphere and a fully green line of sight.\nThe spheres marking occluded targets are displayed red, as are the occluded parts of the lines of sight.\nWhen the line of sight cannot be calculated, it will be displayed with a gray color. This may happen if either\nthe target or the observer is not in the view.\n\nWhen creating a new line of sight analysis with the component, the first click in the scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html)\nand any further clicks place the [targets](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html).\nBoth, observer and target points, can be moved by dragging them. Additionally, the target points can be removed with a right click.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current analysis results. After calling this method, the user can set a new observer and targets.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `continue(): Promise<void>` - After [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-line-of-sight/#stop)\nwas called, this method allows to continue the line of sight analysis and add more targets.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start a new line of sight analysis.\n- `stop(): Promise<void>` - Stop the current line of sight analysis, keeping the results in the view.\nUsers can still interact with existing targets and the observer but they cannot place new target points.",
8632
+ "description": "The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including the ground, integrated meshes, and 3D objects such as buildings or trees.\n\n![line-of-sight](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/line-of-sight.png)\n\nThe analysis results are displayed as colored lines, where areas visible to the observer are\nshown green and occluded parts are marked in red. Also, the color of the target points indicates their visibility.\nWhen the line of sight cannot be calculated, it will be displayed with a gray color. This may happen if either\nthe target or the observer is not in the view.\n\nWhen creating a new line of sight analysis, the first click in the Scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html)\nand subsequent clicks place the [targets](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html).\nBoth the observer and target points can be moved by dragging. Additionally, the target points can be removed with a right click.\n\n**Known limitation**\n\nLine Of Sight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\n- [Sample - Line of sight component](https://developers.arcgis.com/javascript/latest/sample-code/line-of-sight/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current analysis results. After calling this method, the user can set a new observer and targets.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `continue(): Promise<void>` - After [stop()](#stop) was called, this method allows to continue the line of sight analysis and add more targets.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start a new line of sight analysis.\n- `stop(): Promise<void>` - Stop the current placing of line of sight analysis. Any lines added this far are kept in the view.\nUsers can still interact with existing targets and the observer, but they cannot place new target points.",
8562
8633
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-line-of-sight/",
8563
8634
  "attributes": [
8564
8635
  {
@@ -8603,9 +8674,22 @@
8603
8674
  },
8604
8675
  {
8605
8676
  "name": "reference-element",
8677
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
8606
8678
  "value": {
8607
8679
  "type": "string"
8608
8680
  }
8681
+ },
8682
+ {
8683
+ "name": "state",
8684
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for analysis\n* `creating` - observer/target points are being placed\n* `created` - finished analysis",
8685
+ "value": {
8686
+ "type": [
8687
+ "\"created\"",
8688
+ "\"creating\"",
8689
+ "\"disabled\"",
8690
+ "\"ready\""
8691
+ ]
8692
+ }
8609
8693
  }
8610
8694
  ],
8611
8695
  "events": [
@@ -8624,7 +8708,7 @@
8624
8708
  "properties": [
8625
8709
  {
8626
8710
  "name": "analysis",
8627
- "description": "The [line of sight analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\nobject being created by the component.",
8711
+ "description": "The [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Line Of Sight component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n//Create the analysis.\nconst lineOfSightAnalysis = new LineOfSightAnalysis({\n observer: new LineOfSightAnalysisObserver({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624828.3377593,\n y: 4550305.319405007,\n z: 105.55410975124687\n }),\n }),\n targets: [ new LineOfSightAnalysisTarget({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624944.17687458,\n y: 4550420.577689567,\n z: 0\n }),\n })\n]\n});\n// Get the Scene and Line Of Sight component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst lineOfSight = document.querySelector(\"arcgis-line-of-sight\");\nawait lineOfSight.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(lineOfSightAnalysis);\n// Connect the analysis to the component:\nlineOfSight.analysis = lineOfSightAnalysis;\n```",
8628
8712
  "type": "LineOfSightAnalysis"
8629
8713
  },
8630
8714
  {
@@ -8644,7 +8728,7 @@
8644
8728
  },
8645
8729
  {
8646
8730
  "name": "messageOverrides",
8647
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
8731
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
8648
8732
  "type": "Record<string, unknown>"
8649
8733
  },
8650
8734
  {
@@ -8653,6 +8737,7 @@
8653
8737
  },
8654
8738
  {
8655
8739
  "name": "referenceElement",
8740
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
8656
8741
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
8657
8742
  },
8658
8743
  {
@@ -8677,7 +8762,7 @@
8677
8762
  },
8678
8763
  {
8679
8764
  "name": "arcgis-link-chart",
8680
- "description": "Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html) from an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html).\n\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the link chart has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the link chart.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.",
8765
+ "description": "Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html) from an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html).\n\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the link chart has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the link chart.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.",
8681
8766
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/",
8682
8767
  "attributes": [
8683
8768
  {
@@ -8933,7 +9018,7 @@
8933
9018
  },
8934
9019
  {
8935
9020
  "name": "graphics",
8936
- "description": "Allows for adding graphics directly to the default graphics in the View.\nExample:\n```\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n```\nExample:\n```\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```",
9021
+ "description": "Allows for adding graphics directly to the default graphics in the View.",
8937
9022
  "type": "Collection<Graphic>"
8938
9023
  },
8939
9024
  {
@@ -9240,6 +9325,7 @@
9240
9325
  },
9241
9326
  {
9242
9327
  "name": "reference-element",
9328
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)",
9243
9329
  "value": {
9244
9330
  "type": "string"
9245
9331
  }
@@ -9308,7 +9394,7 @@
9308
9394
  },
9309
9395
  {
9310
9396
  "name": "messageOverrides",
9311
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
9397
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
9312
9398
  "type": "Record<string, unknown>"
9313
9399
  },
9314
9400
  {
@@ -9322,6 +9408,7 @@
9322
9408
  },
9323
9409
  {
9324
9410
  "name": "referenceElement",
9411
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)",
9325
9412
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
9326
9413
  },
9327
9414
  {
@@ -9351,7 +9438,7 @@
9351
9438
  },
9352
9439
  {
9353
9440
  "name": "arcgis-locate",
9354
- "description": "The Locate component animates the Map or Scene to the user's current location.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`",
9441
+ "description": "The Locate component animates the Map or Scene to the user's current location.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that support\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility).\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`",
9355
9442
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-locate/",
9356
9443
  "attributes": [
9357
9444
  {
@@ -9410,6 +9497,7 @@
9410
9497
  },
9411
9498
  {
9412
9499
  "name": "reference-element",
9500
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
9413
9501
  "value": {
9414
9502
  "type": "string"
9415
9503
  }
@@ -9492,7 +9580,7 @@
9492
9580
  },
9493
9581
  {
9494
9582
  "name": "messageOverrides",
9495
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
9583
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
9496
9584
  "type": "Record<string, unknown>"
9497
9585
  },
9498
9586
  {
@@ -9505,6 +9593,7 @@
9505
9593
  },
9506
9594
  {
9507
9595
  "name": "referenceElement",
9596
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
9508
9597
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
9509
9598
  },
9510
9599
  {
@@ -9542,7 +9631,7 @@
9542
9631
  },
9543
9632
  {
9544
9633
  "name": "arcgis-map",
9545
- "description": "The ArcGIS Map Component is used to add 2D maps to web applications. For 3D maps, use the\n[ArcGIS Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and loads a WebMap from either [ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\"></arcgis-map>\n```\n\nAlternatively, the Map component can be initialized without a WebMap item.\n\n```html\n<arcgis-map basemap=\"satellite\" center=\"-154.88, 19.46\" zoom=\"15\"></arcgis-map>\n```\n\nOther components can be added and connected to the Map component.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\">\n <arcgis-zoom position=\"top-left\"></arcgis-zoom>\n <arcgis-legend position=\"bottom-left\"></arcgis-legend>\n</arcgis-map>\n```\n\nThe Map component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/) of the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My Layer\" });\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Map component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-map)\n- [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.add(table)` instead.\n\nAdds a table to the map tables collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the map tables collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `hitTest(screenPoint: __esri.MapViewScreenPoint | MouseEvent, options?: __esri.MapViewHitTestOptions): Promise<__esri.HitTestResult>` - Returns hit test results from each layer that intersects the specified screen coordinates.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `takeScreenshot(options?: __esri.MapViewTakeScreenshotOptions): Promise<__esri.Screenshot>` - Create a screenshot of the current view.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.",
9634
+ "description": "The ArcGIS Map component is used to add 2D maps to web applications. For 3D maps, use the\n[ArcGIS Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and loads a WebMap from either [ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\"></arcgis-map>\n```\n\nAlternatively, the Map component can be initialized without a WebMap item.\n\n```html\n<arcgis-map basemap=\"satellite\" center=\"-154.88, 19.46\" zoom=\"15\"></arcgis-map>\n```\n\nOther components can be added and connected to the Map component.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\">\n <arcgis-zoom position=\"top-left\"></arcgis-zoom>\n <arcgis-legend position=\"bottom-left\"></arcgis-legend>\n</arcgis-map>\n```\n\nThe Map component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/) of the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My Layer\" });\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Map component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-map)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the map tables collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the map tables collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `hitTest(screenPoint: __esri.MapViewScreenPoint | MouseEvent, options?: __esri.MapViewHitTestOptions): Promise<__esri.HitTestResult>` - Returns hit test results from each layer that intersects the specified screen coordinates.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `takeScreenshot(options?: __esri.MapViewTakeScreenshotOptions): Promise<__esri.Screenshot>` - Create a screenshot of the current view.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.",
9546
9635
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/",
9547
9636
  "attributes": [
9548
9637
  {
@@ -9815,7 +9904,7 @@
9815
9904
  },
9816
9905
  {
9817
9906
  "name": "graphics",
9818
- "description": "Allows for adding graphics directly to the default graphics in the View.\nExample:\n```\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n```\nExample:\n```\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```",
9907
+ "description": "Allows for adding graphics directly to the default graphics in the View.",
9819
9908
  "type": "Collection<Graphic>"
9820
9909
  },
9821
9910
  {
@@ -10172,6 +10261,7 @@
10172
10261
  },
10173
10262
  {
10174
10263
  "name": "reference-element",
10264
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
10175
10265
  "value": {
10176
10266
  "type": "string"
10177
10267
  }
@@ -10245,6 +10335,7 @@
10245
10335
  },
10246
10336
  {
10247
10337
  "name": "referenceElement",
10338
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
10248
10339
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
10249
10340
  },
10250
10341
  {
@@ -10269,7 +10360,7 @@
10269
10360
  },
10270
10361
  {
10271
10362
  "name": "arcgis-navigation-toggle",
10272
- "description": "The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\nThe Navigation Toggle component is only supported in 3D.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `toggle(): Promise<void>`",
10363
+ "description": "The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\n**Known limitations**\n\nNavigation Toggle is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `toggle(): Promise<void>`",
10273
10364
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-navigation-toggle/",
10274
10365
  "attributes": [
10275
10366
  {
@@ -10299,7 +10390,7 @@
10299
10390
  },
10300
10391
  {
10301
10392
  "name": "navigation-mode",
10302
- "description": "The navigation mode of the view. See the table below for a list of\npossible values.\n\nPossible Value | Description\n---------------|-------------\npan | The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\nrotate | The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.",
10393
+ "description": "The navigation mode of the view. The possible values:\n\n* `pan` - The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\n* `rotate` - The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.",
10303
10394
  "default": "\"pan\"",
10304
10395
  "value": {
10305
10396
  "type": [
@@ -10327,6 +10418,7 @@
10327
10418
  },
10328
10419
  {
10329
10420
  "name": "reference-element",
10421
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
10330
10422
  "value": {
10331
10423
  "type": "string"
10332
10424
  }
@@ -10334,7 +10426,6 @@
10334
10426
  {
10335
10427
  "name": "state",
10336
10428
  "description": "The current state of the component.",
10337
- "default": "\"disabled\"",
10338
10429
  "value": {
10339
10430
  "type": [
10340
10431
  "\"disabled\"",
@@ -10374,12 +10465,12 @@
10374
10465
  },
10375
10466
  {
10376
10467
  "name": "messageOverrides",
10377
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
10468
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
10378
10469
  "type": "Record<string, unknown>"
10379
10470
  },
10380
10471
  {
10381
10472
  "name": "navigationMode",
10382
- "description": "The navigation mode of the view. See the table below for a list of\npossible values.\n\nPossible Value | Description\n---------------|-------------\npan | The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\nrotate | The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.",
10473
+ "description": "The navigation mode of the view. The possible values:\n\n* `pan` - The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\n* `rotate` - The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.",
10383
10474
  "type": "\"pan\" | \"rotate\""
10384
10475
  },
10385
10476
  {
@@ -10388,6 +10479,7 @@
10388
10479
  },
10389
10480
  {
10390
10481
  "name": "referenceElement",
10482
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
10391
10483
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
10392
10484
  },
10393
10485
  {
@@ -10543,6 +10635,7 @@
10543
10635
  },
10544
10636
  {
10545
10637
  "name": "reference-element",
10638
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
10546
10639
  "value": {
10547
10640
  "type": "string"
10548
10641
  }
@@ -10647,6 +10740,7 @@
10647
10740
  },
10648
10741
  {
10649
10742
  "name": "referenceElement",
10743
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
10650
10744
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
10651
10745
  },
10652
10746
  {
@@ -10693,6 +10787,7 @@
10693
10787
  },
10694
10788
  {
10695
10789
  "name": "reference-element",
10790
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
10696
10791
  "value": {
10697
10792
  "type": "string"
10698
10793
  }
@@ -10713,6 +10808,7 @@
10713
10808
  },
10714
10809
  {
10715
10810
  "name": "referenceElement",
10811
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
10716
10812
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
10717
10813
  }
10718
10814
  ],
@@ -10727,7 +10823,7 @@
10727
10823
  },
10728
10824
  {
10729
10825
  "name": "arcgis-print",
10730
- "description": "The Print widget connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed.\nIt takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS,\nwhich can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc.\nThe Print widget works with the [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) which generates a printer-ready version of the map.\n\nThe Print widget has two required properties: [view](#view) (reference to the MapView)\nand [printServiceUrl](#printServiceUrl) (URL of the REST endpoint of the Export Web Map Task).\nThe widget can preserve map scale or map extent in the printout. By default, the map extent is\npreserved. Use [TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) to preserve scale\ninstead.\n\nThe Print widget prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layout)\nexcept `map-only`. If using a custom print service, then `customTextElements` are supported for each print\ntemplate. Values found there will be populated in the Print widget under `Advanced options`. These values can\nbe overwritten in the Print widget UI, or programmatically using the\n[templateCustomTextElements](#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions).\n\n**Known Limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) for a detailed list of known limitations.\n\n```html\n<arcgis-map item-id=\"45725ba7d9fb47a0925398919b13d1fa\">\n <arcgis-print position=\"top-right\"></arcgis-print>\n</arcgis-map>\n```\n\n```js\n// get a reference to the component\nconst components = document.querySelectorAll(\"arcgis-print\");\n\nconst portal = new Portal({\n url: \"https://zara.mapsdevext.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://zara.mapsdevext.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSubmit**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
10826
+ "description": "The Print component connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed.\nIt takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS,\nwhich can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc.\nThe Print component works with the [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) module, which generates a printer-ready version of the map.\n\nThe Print component uses the ArcGIS Online print service by default, but it can be configured to use a custom print service with the [printServiceUrl](#printServiceUrl) property.\nThe component can preserve map scale or map extent in the printout. By default, the map extent is preserved. Use\n[TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) to preserve scale instead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layout)\nexcept `map-only`. If using a custom print service, then `customTextElements` are supported for each print\ntemplate. Values found there will be populated in the Print component under `Advanced options`. These values can\nbe overwritten in the Print component UI, or programmatically using the\n[templateCustomTextElements](#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions).\n\n**Known limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) for a detailed list of known limitations.\n\n```html\n<arcgis-map item-id=\"45725ba7d9fb47a0925398919b13d1fa\">\n <arcgis-print position=\"top-right\"></arcgis-print>\n</arcgis-map>\n```\n\n```js\n// get a reference to the component\nconst components = document.querySelectorAll(\"arcgis-print\");\n\nconst portal = new Portal({\n url: \"https://user.maps.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://user.maps.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```\n--\n\n### Events\n- **arcgisComplete** - Emitted when the component is complete.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSubmit** - Emitted when the component is submitted.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
10731
10827
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-print/",
10732
10828
  "attributes": [
10733
10829
  {
@@ -10740,6 +10836,7 @@
10740
10836
  },
10741
10837
  {
10742
10838
  "name": "allowed-formats-for-saving",
10839
+ "description": "Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.",
10743
10840
  "value": {
10744
10841
  "type": "\"all\""
10745
10842
  }
@@ -10785,7 +10882,7 @@
10785
10882
  },
10786
10883
  {
10787
10884
  "name": "heading-level",
10788
- "description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the widget's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
10885
+ "description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
10789
10886
  "default": "3",
10790
10887
  "value": {
10791
10888
  "type": [
@@ -10800,6 +10897,7 @@
10800
10897
  },
10801
10898
  {
10802
10899
  "name": "hide-header",
10900
+ "description": "Indicates whether the component's header is hidden.",
10803
10901
  "default": "false",
10804
10902
  "value": {
10805
10903
  "type": "boolean"
@@ -10822,6 +10920,7 @@
10822
10920
  },
10823
10921
  {
10824
10922
  "name": "position",
10923
+ "description": "The UI position of a component.",
10825
10924
  "default": "\"top-left\"",
10826
10925
  "value": {
10827
10926
  "type": [
@@ -10839,20 +10938,21 @@
10839
10938
  },
10840
10939
  {
10841
10940
  "name": "print-service-url",
10842
- "description": "The URL of the REST endpoint of the Export Web Map Task.\nIf the [portal](#portal) property is set, it is not necessary to set this property.",
10941
+ "description": "The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](#portal) property is set, this property will use the portal's print service URL.",
10843
10942
  "value": {
10844
10943
  "type": "string"
10845
10944
  }
10846
10945
  },
10847
10946
  {
10848
10947
  "name": "reference-element",
10948
+ "description": "By passing the `id` of the Map or Scene component into this property, you can position components from the `@arcgis/map-components`\npackage anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component).",
10849
10949
  "value": {
10850
10950
  "type": "string"
10851
10951
  }
10852
10952
  },
10853
10953
  {
10854
10954
  "name": "show-print-area-enabled",
10855
- "description": "The initial state of the print area toggle in the Print widget UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.",
10955
+ "description": "The initial state of the print area toggle in the Print component UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.",
10856
10956
  "default": "false",
10857
10957
  "value": {
10858
10958
  "type": "boolean"
@@ -10860,7 +10960,7 @@
10860
10960
  },
10861
10961
  {
10862
10962
  "name": "state",
10863
- "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#state)",
10963
+ "description": "The state of the Print component.",
10864
10964
  "default": "\"disabled\"",
10865
10965
  "value": {
10866
10966
  "type": [
@@ -10875,7 +10975,8 @@
10875
10975
  "events": [
10876
10976
  {
10877
10977
  "name": "arcgisComplete",
10878
- "type": "{ link: FileLink; }"
10978
+ "type": "PrintCompleteEvent",
10979
+ "description": "Emitted when the component is complete."
10879
10980
  },
10880
10981
  {
10881
10982
  "name": "arcgisPropertyChange",
@@ -10889,7 +10990,8 @@
10889
10990
  },
10890
10991
  {
10891
10992
  "name": "arcgisSubmit",
10892
- "type": "{ link: FileLink; }"
10993
+ "type": "PrintSubmitEvent",
10994
+ "description": "Emitted when the component is submitted."
10893
10995
  }
10894
10996
  ],
10895
10997
  "js": {
@@ -10901,6 +11003,7 @@
10901
11003
  },
10902
11004
  {
10903
11005
  "name": "allowedFormatsForSaving",
11006
+ "description": "Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.",
10904
11007
  "type": "\"all\" | Array<string>"
10905
11008
  },
10906
11009
  {
@@ -10929,7 +11032,7 @@
10929
11032
  },
10930
11033
  {
10931
11034
  "name": "exportedLinks",
10932
- "description": "The collection of links exported from the Print widget.",
11035
+ "description": "The collection of links exported from the Print component.",
10933
11036
  "type": "Collection<FileLink>"
10934
11037
  },
10935
11038
  {
@@ -10939,11 +11042,12 @@
10939
11042
  },
10940
11043
  {
10941
11044
  "name": "headingLevel",
10942
- "description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the widget's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
11045
+ "description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
10943
11046
  "type": "1 | 2 | 3 | 4 | 5 | 6"
10944
11047
  },
10945
11048
  {
10946
11049
  "name": "hideHeader",
11050
+ "description": "Indicates whether the component's header is hidden.",
10947
11051
  "type": "boolean"
10948
11052
  },
10949
11053
  {
@@ -10958,30 +11062,32 @@
10958
11062
  },
10959
11063
  {
10960
11064
  "name": "messageOverrides",
10961
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
11065
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
10962
11066
  "type": "Record<string, unknown>"
10963
11067
  },
10964
11068
  {
10965
11069
  "name": "outSpatialReference",
10966
- "description": "The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) used to render\nthe printed map on the server.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#outSpatialReference)",
11070
+ "description": "The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) used to render the printed map on the server.",
10967
11071
  "type": "SpatialReference"
10968
11072
  },
10969
11073
  {
10970
11074
  "name": "portal",
10971
- "description": "It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm).\nUse this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search.\nThis is especially helpful when working with a [custom](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html).\n\nIf this property is set, it is not necessary to set the [printServiceUrl](#printServiceUrl) property.",
11075
+ "description": "It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm).\nUse this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search.\nThis is especially helpful when working with a [custom template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html).\n\nIf this property is set, it is not necessary to set the [printServiceUrl](#printServiceUrl) property.",
10972
11076
  "type": "Portal"
10973
11077
  },
10974
11078
  {
10975
11079
  "name": "position",
11080
+ "description": "The UI position of a component.",
10976
11081
  "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
10977
11082
  },
10978
11083
  {
10979
11084
  "name": "printServiceUrl",
10980
- "description": "The URL of the REST endpoint of the Export Web Map Task.\nIf the [portal](#portal) property is set, it is not necessary to set this property.",
11085
+ "description": "The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](#portal) property is set, this property will use the portal's print service URL.",
10981
11086
  "type": "string"
10982
11087
  },
10983
11088
  {
10984
11089
  "name": "referenceElement",
11090
+ "description": "By passing the `id` of the Map or Scene component into this property, you can position components from the `@arcgis/map-components`\npackage anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component).",
10985
11091
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
10986
11092
  },
10987
11093
  {
@@ -10990,29 +11096,30 @@
10990
11096
  },
10991
11097
  {
10992
11098
  "name": "showPrintAreaEnabled",
10993
- "description": "The initial state of the print area toggle in the Print widget UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.",
11099
+ "description": "The initial state of the print area toggle in the Print component UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.",
10994
11100
  "type": "boolean"
10995
11101
  },
10996
11102
  {
10997
11103
  "name": "state",
10998
- "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#state)",
11104
+ "description": "The state of the Print component.",
10999
11105
  "type": "\"disabled\" | \"error\" | \"initializing\" | \"ready\""
11000
11106
  },
11001
11107
  {
11002
11108
  "name": "templateCustomTextElements",
11003
- "description": "An object containing an array of `customTextElements` name-value pair objects\nfor each print template in a custom print service. Use this property to update\nthe text for custom text elements on the page layout.\n\nThe Print widget calls the `Get Layout Templates Info` task on the GPServer\nto discover possible `customTextElements` values for each template. The name of\nthe task must match `Get Layout Templates Info`, templates must be published\nwith `customTextElements`, and values must be strings. Values found there will be\npopulated in the Print widget under `Advanced options`. These values can be\noverwritten in the Print widget UI, or programmatically using this property.\nTo list all print templates available on the print service to see\nsee which templates were published with `customTextElements`, use the\n[effectiveTemplateCustomTextElements](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#effectiveTemplateCustomTextElements)\nproperty.",
11109
+ "description": "An object containing an array of `customTextElements` name-value pair objects\nfor each print template in a custom print service. Use this property to update\nthe text for custom text elements on the page layout.\n\nThe Print component calls the `Get Layout Templates Info` task on the GPServer\nto discover possible `customTextElements` values for each template. The name of\nthe task must match `Get Layout Templates Info`, templates must be published\nwith `customTextElements`, and values must be strings. Values found there will be\npopulated in the Print component under `Advanced options`. These values can be\noverwritten in the Print component UI, or programmatically using this property.\nTo list all print templates available on the print service to see\nsee which templates were published with `customTextElements`, use the\n[effectiveTemplateCustomTextElements](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#effectiveTemplateCustomTextElements)\nproperty.",
11004
11110
  "type": "{\n [x: string]: Array<HashMap<string>> | undefined;\n}"
11005
11111
  },
11006
11112
  {
11007
11113
  "name": "templateOptions",
11008
- "description": "Defines the layout template options used by the [Print](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) widget to generate the print page.",
11114
+ "description": "Defines the layout template options used by the Print component to generate the print page.",
11009
11115
  "type": "TemplateOptions"
11010
11116
  }
11011
11117
  ],
11012
11118
  "events": [
11013
11119
  {
11014
11120
  "name": "arcgisComplete",
11015
- "type": "{ link: FileLink; }"
11121
+ "type": "PrintCompleteEvent",
11122
+ "description": "Emitted when the component is complete."
11016
11123
  },
11017
11124
  {
11018
11125
  "name": "arcgisPropertyChange",
@@ -11026,14 +11133,15 @@
11026
11133
  },
11027
11134
  {
11028
11135
  "name": "arcgisSubmit",
11029
- "type": "{ link: FileLink; }"
11136
+ "type": "PrintSubmitEvent",
11137
+ "description": "Emitted when the component is submitted."
11030
11138
  }
11031
11139
  ]
11032
11140
  }
11033
11141
  },
11034
11142
  {
11035
11143
  "name": "arcgis-scale-bar",
11036
- "description": "The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known Limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
11144
+ "description": "The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
11037
11145
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-bar/",
11038
11146
  "attributes": [
11039
11147
  {
@@ -11089,6 +11197,7 @@
11089
11197
  },
11090
11198
  {
11091
11199
  "name": "reference-element",
11200
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
11092
11201
  "value": {
11093
11202
  "type": "string"
11094
11203
  }
@@ -11136,7 +11245,7 @@
11136
11245
  },
11137
11246
  {
11138
11247
  "name": "messageOverrides",
11139
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
11248
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
11140
11249
  "type": "Record<string, unknown>"
11141
11250
  },
11142
11251
  {
@@ -11145,6 +11254,7 @@
11145
11254
  },
11146
11255
  {
11147
11256
  "name": "referenceElement",
11257
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
11148
11258
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
11149
11259
  },
11150
11260
  {
@@ -11278,6 +11388,7 @@
11278
11388
  },
11279
11389
  {
11280
11390
  "name": "reference-element",
11391
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
11281
11392
  "value": {
11282
11393
  "type": "string"
11283
11394
  }
@@ -11376,6 +11487,7 @@
11376
11487
  },
11377
11488
  {
11378
11489
  "name": "referenceElement",
11490
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
11379
11491
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
11380
11492
  },
11381
11493
  {
@@ -11405,7 +11517,7 @@
11405
11517
  },
11406
11518
  {
11407
11519
  "name": "arcgis-scene",
11408
- "description": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes:\n[zoom](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#zoom),\n[scale](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#scale),\n[center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center),\n[rotation](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#rotation),\n[extent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#camera),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewpoint).\nThis event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#stationary)\ntoggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n```\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup).\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its\n[map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map),\n[popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.\n- `whenAnalysisView(analysis: __esri.AreaMeasurementAnalysis | __esri.DimensionAnalysis | __esri.DirectLineMeasurementAnalysis | __esri.LineOfSightAnalysis | __esri.SliceAnalysis | __esri.ViewshedAnalysis): Promise<__esri.AreaMeasurementAnalysisView3D | __esri.DimensionAnalysisView3D | __esri.DirectLineMeasurementAnalysisView3D | __esri.LineOfSightAnalysisView3D | __esri.SliceAnalysisView3D | __esri.ViewshedAnalysisView3D>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)",
11520
+ "description": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nconst layer = new GraphicsLayer({ title: \"My layer\"});\nviewElement.map.add(layer);\n```\n\n**See also**\n\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create)\n- **arcgisViewAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes: [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[camera](#camera), [viewpoint](#viewpoint). This event will also emit if [stationary](#stationary) toggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](#popup).\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its [map](#map), [popup](#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView(analysis: __esri.AreaMeasurementAnalysis | __esri.DimensionAnalysis | __esri.DirectLineMeasurementAnalysis | __esri.LineOfSightAnalysis | __esri.SliceAnalysis | __esri.ViewshedAnalysis): Promise<__esri.AreaMeasurementAnalysisView3D | __esri.DimensionAnalysisView3D | __esri.DirectLineMeasurementAnalysisView3D | __esri.LineOfSightAnalysisView3D | __esri.SliceAnalysisView3D | __esri.ViewshedAnalysisView3D>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)",
11409
11521
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/",
11410
11522
  "attributes": [
11411
11523
  {
@@ -11433,35 +11545,35 @@
11433
11545
  },
11434
11546
  {
11435
11547
  "name": "camera-fov",
11436
- "description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov)",
11548
+ "description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov)",
11437
11549
  "value": {
11438
11550
  "type": "number"
11439
11551
  }
11440
11552
  },
11441
11553
  {
11442
11554
  "name": "camera-heading",
11443
- "description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading)",
11555
+ "description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading)",
11444
11556
  "value": {
11445
11557
  "type": "number"
11446
11558
  }
11447
11559
  },
11448
11560
  {
11449
11561
  "name": "camera-position",
11450
- "description": "The position of the camera defined by a map point. It can be a string with the format `\"<longitude>, <latitude>, <elevation>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)",
11562
+ "description": "The position of the camera defined by a map point. It can either be set with a\n[Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)",
11451
11563
  "value": {
11452
11564
  "type": "string"
11453
11565
  }
11454
11566
  },
11455
11567
  {
11456
11568
  "name": "camera-tilt",
11457
- "description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt)",
11569
+ "description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt)",
11458
11570
  "value": {
11459
11571
  "type": "number"
11460
11572
  }
11461
11573
  },
11462
11574
  {
11463
11575
  "name": "center",
11464
- "description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)",
11576
+ "description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)",
11465
11577
  "value": {
11466
11578
  "type": "string"
11467
11579
  }
@@ -11476,7 +11588,7 @@
11476
11588
  },
11477
11589
  {
11478
11590
  "name": "ground",
11479
- "description": "Specifies the surface properties for the map. It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
11591
+ "description": "Specifies the surface properties for the [map](#map). It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
11480
11592
  "value": {
11481
11593
  "type": "string"
11482
11594
  }
@@ -11498,7 +11610,7 @@
11498
11610
  },
11499
11611
  {
11500
11612
  "name": "quality-profile",
11501
- "description": "SceneView can draw scenes in three different quality modes: `high`, `medium` and `low`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile)",
11613
+ "description": "Scenes can be drawn in three different quality modes: `high`, `medium` and `low`.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile)",
11502
11614
  "value": {
11503
11615
  "type": [
11504
11616
  "\"high\"",
@@ -11509,7 +11621,7 @@
11509
11621
  },
11510
11622
  {
11511
11623
  "name": "scale",
11512
- "description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)",
11624
+ "description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)",
11513
11625
  "value": {
11514
11626
  "type": "number"
11515
11627
  }
@@ -11535,22 +11647,37 @@
11535
11647
  },
11536
11648
  {
11537
11649
  "name": "zoom",
11538
- "description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\nSetting this property in conjunction with [center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom)",
11650
+ "description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\nSetting this property in conjunction with [center](#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom)",
11539
11651
  "value": {
11540
11652
  "type": "number"
11541
11653
  }
11542
11654
  }
11543
11655
  ],
11544
11656
  "events": [
11657
+ {
11658
+ "name": "arcgisViewAnalysisViewCreate",
11659
+ "type": "ViewAnalysisViewCreateEvent",
11660
+ "description": "Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create)"
11661
+ },
11662
+ {
11663
+ "name": "arcgisViewAnalysisViewCreateError",
11664
+ "type": "ViewAnalysisViewCreateErrorEvent",
11665
+ "description": "Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)"
11666
+ },
11667
+ {
11668
+ "name": "arcgisViewAnalysisViewDestroy",
11669
+ "type": "ViewAnalysisViewDestroyEvent",
11670
+ "description": "Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)"
11671
+ },
11545
11672
  {
11546
11673
  "name": "arcgisViewChange",
11547
11674
  "type": "void",
11548
- "description": "This event is for view related property changes:\n[zoom](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#zoom),\n[scale](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#scale),\n[center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center),\n[rotation](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#rotation),\n[extent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#camera),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewpoint).\nThis event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#stationary)\ntoggles from `true` to `false`."
11675
+ "description": "This event is for view related property changes: [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[camera](#camera), [viewpoint](#viewpoint). This event will also emit if [stationary](#stationary) toggles from `true` to `false`."
11549
11676
  },
11550
11677
  {
11551
11678
  "name": "arcgisViewClick",
11552
11679
  "type": "ViewClickEvent",
11553
- "description": "Fires after a user clicks on the view.\n\n```\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)"
11680
+ "description": "Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)"
11554
11681
  },
11555
11682
  {
11556
11683
  "name": "arcgisViewDoubleClick",
@@ -11635,7 +11762,7 @@
11635
11762
  {
11636
11763
  "name": "arcgisViewReadyChange",
11637
11764
  "type": "void",
11638
- "description": "This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n```\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```"
11765
+ "description": "This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed."
11639
11766
  }
11640
11767
  ],
11641
11768
  "js": {
@@ -11672,37 +11799,37 @@
11672
11799
  },
11673
11800
  {
11674
11801
  "name": "camera",
11675
- "description": "The [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html) allows to set the observation point from which the visible portion (or perspective)\nof the view is determined. When set in the constructor, this property overrides the\n[center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center),\n[extent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#extent),\n[scale](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#scale),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewpoint), and\n[zoom](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#zoom) properties.\n\nSetting the camera immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.",
11802
+ "description": "The [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html) allows to set the observation point from which the visible portion (or perspective)\nof the view is determined. When set in the constructor, this property overrides the [center](#center), [extent](#extent), [scale](#scale), [viewpoint](#viewpoint), and [zoom](#zoom) properties.\n\nSetting the camera immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.",
11676
11803
  "type": "Camera"
11677
11804
  },
11678
11805
  {
11679
11806
  "name": "cameraFov",
11680
- "description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov)",
11807
+ "description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov)",
11681
11808
  "type": "number"
11682
11809
  },
11683
11810
  {
11684
11811
  "name": "cameraHeading",
11685
- "description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading)",
11812
+ "description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading)",
11686
11813
  "type": "number"
11687
11814
  },
11688
11815
  {
11689
11816
  "name": "cameraPosition",
11690
- "description": "The position of the camera defined by a map point. It can be a string with the format `\"<longitude>, <latitude>, <elevation>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)",
11817
+ "description": "The position of the camera defined by a map point. It can either be set with a\n[Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)",
11691
11818
  "type": "Array<number> | Point | string"
11692
11819
  },
11693
11820
  {
11694
11821
  "name": "cameraTilt",
11695
- "description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt)",
11822
+ "description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt)",
11696
11823
  "type": "number"
11697
11824
  },
11698
11825
  {
11699
11826
  "name": "center",
11700
- "description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)",
11827
+ "description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)",
11701
11828
  "type": "Array<number> | Point | string"
11702
11829
  },
11703
11830
  {
11704
11831
  "name": "clippingArea",
11705
- "description": "Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html)\nof a [local scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewingMode).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea)",
11832
+ "description": "Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html)\nof a Scene in `local` [viewingMode](#viewingMode).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea)",
11706
11833
  "type": "Extent"
11707
11834
  },
11708
11835
  {
@@ -11717,12 +11844,12 @@
11717
11844
  },
11718
11845
  {
11719
11846
  "name": "environment",
11720
- "description": "Specifies various properties of the environment's visualization in the view, like the lighting, background, weather, etc.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment)",
11847
+ "description": "Specifies various properties of the environment's visualization within the view, including lighting, background, weather, and more.\nThe Scene will redraw automatically when any property of environment changes.\n\nModifying the lighting:\n\n```js\nviewElement.environment.lighting = {\n type: \"sun\", // autocasts as new SunLighting()\n date: new Date(), // sets the lighting to reflect the current time of day\n directShadowsEnabled: true,\n};\n```\n\nSetting the background:\n\n```js\nviewElement.environment = {\n background: {\n type: \"color\",\n color: [255, 252, 244, 1]\n },\n starsEnabled: false,\n atmosphereEnabled: false\n};\n```\n\nChanging the weather in the scene:\n\n```js\nviewElement.environment.weather = {\n type: \"rainy\", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })\n cloudCover: 0.7,\n precipitation: 0.3\n};\n```\n\n**See also**\n\n- [SunLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)\n- [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html)\n- [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n- [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment)",
11721
11848
  "type": "SceneViewEnvironment"
11722
11849
  },
11723
11850
  {
11724
11851
  "name": "extent",
11725
- "description": "The extent represents the visible portion of a map within the view as an instance of\n[Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html).\n\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\nWhen the view is rotated, the extent does not update to include the newly visible portions of the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent)",
11852
+ "description": "The extent represents the visible portion of a [map](#map) within the view as an instance of\n[Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html).\n\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's [goTo()](#goTo) method.\nWhen the view is rotated, the extent does not update to include the newly visible portions of the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent)",
11726
11853
  "type": "Extent"
11727
11854
  },
11728
11855
  {
@@ -11735,6 +11862,11 @@
11735
11862
  "description": "Applies a display filter on the view for a specific set of floor levels.\nIt can filter the map display on floor-aware layers by zero or more level IDs.",
11736
11863
  "type": "Collection<string>"
11737
11864
  },
11865
+ {
11866
+ "name": "focusAreas",
11867
+ "description": "A container of all [focus areas](https://developers.arcgis.com/javascript/latest/api-reference/esri-effects-FocusAreas.html) present in the map.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#focusAreas)",
11868
+ "type": "FocusAreas"
11869
+ },
11738
11870
  {
11739
11871
  "name": "gamepad",
11740
11872
  "description": "Gamepad input specific configuration settings.",
@@ -11742,12 +11874,12 @@
11742
11874
  },
11743
11875
  {
11744
11876
  "name": "graphics",
11745
- "description": "Allows for adding graphics directly to the default graphics in the view.\nExamples:\n```\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```",
11877
+ "description": "Allows for adding graphics directly to the default graphics in the view.",
11746
11878
  "type": "Collection<Graphic>"
11747
11879
  },
11748
11880
  {
11749
11881
  "name": "ground",
11750
- "description": "Specifies the surface properties for the map. It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
11882
+ "description": "Specifies the surface properties for the [map](#map). It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
11751
11883
  "type": "Ground | string"
11752
11884
  },
11753
11885
  {
@@ -11777,7 +11909,7 @@
11777
11909
  },
11778
11910
  {
11779
11911
  "name": "layerViews",
11780
- "description": "A collection containing a hierarchical list of all the created\n[LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the\n[operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map.",
11912
+ "description": "A collection containing a hierarchical list of all the created\n[LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the\n[operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](#map).",
11781
11913
  "type": "Collection<LayerView>"
11782
11914
  },
11783
11915
  {
@@ -11812,7 +11944,7 @@
11812
11944
  },
11813
11945
  {
11814
11946
  "name": "popup",
11815
- "description": "A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) object that displays general content or attributes from\n[layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#map).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#popup)",
11947
+ "description": "A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html)\nobject that displays general content or attributes from [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers)\nin the [map](#map).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#popup)",
11816
11948
  "type": "Popup"
11817
11949
  },
11818
11950
  {
@@ -11822,7 +11954,7 @@
11822
11954
  },
11823
11955
  {
11824
11956
  "name": "qualityProfile",
11825
- "description": "SceneView can draw scenes in three different quality modes: `high`, `medium` and `low`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile)",
11957
+ "description": "Scenes can be drawn in three different quality modes: `high`, `medium` and `low`.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile)",
11826
11958
  "type": "\"high\" | \"low\" | \"medium\""
11827
11959
  },
11828
11960
  {
@@ -11832,12 +11964,12 @@
11832
11964
  },
11833
11965
  {
11834
11966
  "name": "resolution",
11835
- "description": "Represents the current value of one pixel in the unit of the view's\n[spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#spatialReference).\nThe resolution is calculated by dividing the view's [extent width](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#width)\nby [its width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#width).",
11967
+ "description": "Represents the current value of one pixel in the unit of the view's\n[spatialReference](#spatialReference).\nThe resolution is calculated by dividing the [Scene's extent](#extent) [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#width)\nby [its width](#width).",
11836
11968
  "type": "number"
11837
11969
  },
11838
11970
  {
11839
11971
  "name": "scale",
11840
- "description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)",
11972
+ "description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)",
11841
11973
  "type": "number"
11842
11974
  },
11843
11975
  {
@@ -11857,7 +11989,7 @@
11857
11989
  },
11858
11990
  {
11859
11991
  "name": "theme",
11860
- "description": "This property specifies the base colors used by some widgets\nand components to render graphics and labels.\nThis only affects those elements that would otherwise use the default orange pattern.",
11992
+ "description": "This property specifies the base colors used by some components to render graphics and labels.\nThis only affects those elements that would otherwise use the default orange pattern.",
11861
11993
  "type": "Theme"
11862
11994
  },
11863
11995
  {
@@ -11882,30 +12014,45 @@
11882
12014
  },
11883
12015
  {
11884
12016
  "name": "viewpoint",
11885
- "description": "Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nor point of observation on the view.\n\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint)",
12017
+ "description": "Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nor point of observation on the view.\n\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's [goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint)",
11886
12018
  "type": "Viewpoint"
11887
12019
  },
11888
12020
  {
11889
12021
  "name": "visibleArea",
11890
- "description": "The visibleArea represents the visible portion of a [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) within the view as\nan instance of a [Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#visibleArea)",
12022
+ "description": "The visibleArea represents the visible portion of a [map](#map) within the view as an instance of a\n[Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#visibleArea)",
11891
12023
  "type": "Polygon"
11892
12024
  },
11893
12025
  {
11894
12026
  "name": "zoom",
11895
- "description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#goTo) method.\nSetting this property in conjunction with [center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom)",
12027
+ "description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\nSetting this property in conjunction with [center](#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom)",
11896
12028
  "type": "number"
11897
12029
  }
11898
12030
  ],
11899
12031
  "events": [
12032
+ {
12033
+ "name": "arcgisViewAnalysisViewCreate",
12034
+ "type": "ViewAnalysisViewCreateEvent",
12035
+ "description": "Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create)"
12036
+ },
12037
+ {
12038
+ "name": "arcgisViewAnalysisViewCreateError",
12039
+ "type": "ViewAnalysisViewCreateErrorEvent",
12040
+ "description": "Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)"
12041
+ },
12042
+ {
12043
+ "name": "arcgisViewAnalysisViewDestroy",
12044
+ "type": "ViewAnalysisViewDestroyEvent",
12045
+ "description": "Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)"
12046
+ },
11900
12047
  {
11901
12048
  "name": "arcgisViewChange",
11902
12049
  "type": "void",
11903
- "description": "This event is for view related property changes:\n[zoom](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#zoom),\n[scale](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#scale),\n[center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center),\n[rotation](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#rotation),\n[extent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#camera),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewpoint).\nThis event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#stationary)\ntoggles from `true` to `false`."
12050
+ "description": "This event is for view related property changes: [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[camera](#camera), [viewpoint](#viewpoint). This event will also emit if [stationary](#stationary) toggles from `true` to `false`."
11904
12051
  },
11905
12052
  {
11906
12053
  "name": "arcgisViewClick",
11907
12054
  "type": "ViewClickEvent",
11908
- "description": "Fires after a user clicks on the view.\n\n```\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)"
12055
+ "description": "Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)"
11909
12056
  },
11910
12057
  {
11911
12058
  "name": "arcgisViewDoubleClick",
@@ -11990,14 +12137,14 @@
11990
12137
  {
11991
12138
  "name": "arcgisViewReadyChange",
11992
12139
  "type": "void",
11993
- "description": "This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n```\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```"
12140
+ "description": "This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed."
11994
12141
  }
11995
12142
  ]
11996
12143
  }
11997
12144
  },
11998
12145
  {
11999
12146
  "name": "arcgis-search",
12000
- "description": "The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,\nBuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the\nfindAddressCandidates operation is used, whereas queries are used on feature layers.\n\nBy default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.\nIf a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey\nis present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property.\n\nThe Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data\nsources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property\nof the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.\nHowever, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a\nspecified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.\nThis behavior can be changed by using the localSearchDisabled property.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSearchClear** - Fires when a result is cleared from the input box or a new result is selected.\n- **arcgisSearchComplete** - Fires when the [search()](#search) method is called and returns its results.\n- **arcgisSearchStart** - Fires when the [search()](#search) method starts.\n- **arcgisSelectResult** - Fires when a search result is selected.\n- **arcgisSuggestComplete** - Fires when the [suggest](#suggest) method is called and returns its results.\n- **arcgisSuggestStart** - Fires when the [suggest()](#suggest) method starts.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `setFocus(): Promise<void>` - Brings focus to the component's text input.",
12147
+ "description": "The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,\nBuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the\nfindAddressCandidates operation is used, whereas queries are used on feature layers.\n\nBy default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.\nIf a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey\nis present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property.\n\nThe Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data\nsources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property\nof the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.\nHowever, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a\nspecified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.\nThis behavior can be changed by using the localSearchDisabled property.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSearchClear** - Fires when a result is cleared from the input box or a new result is selected.\n- **arcgisSearchComplete** - Fires when the [search()](#search) method is called and returns its results.\n- **arcgisSearchStart** - Fires when the [search()](#search) method starts.\n- **arcgisSelectResult** - Fires when a search result is selected.\n- **arcgisSuggestComplete** - Fires when the [suggest](#suggest) method is called and returns its results.\n- **arcgisSuggestStart** - Fires when the [suggest()](#suggest) method starts.\n\n### Methods\n- `clear(): void` - Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.\nIt also hides any open menus.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `search(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | Nil | number[] | string): Promise<__esri.SearchResponse | Nil>` - Depending on the sources specified, search() queries the feature layer(s) and/or performs\naddress matching using any specified [locator(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) and\nreturns any applicable results.\n- `setFocus(): Promise<void>` - Brings focus to the component's text input.\n- `suggest(query?: string): Promise<__esri.SuggestResponse | Nil>` - Performs a suggest() request on the active Locator. It also uses the current value of\nthe component or one that is passed in.\n\nSuggestions are available if working with a 10.3 or greater geocoding service that has\n[suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e.\n`supportsPagination = true`.",
12001
12148
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/",
12002
12149
  "attributes": [
12003
12150
  {
@@ -12037,9 +12184,9 @@
12037
12184
  }
12038
12185
  },
12039
12186
  {
12040
- "name": "auto-select",
12187
+ "name": "auto-select-disabled",
12041
12188
  "description": "Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
12042
- "default": "true",
12189
+ "default": "false",
12043
12190
  "value": {
12044
12191
  "type": "boolean"
12045
12192
  }
@@ -12061,9 +12208,9 @@
12061
12208
  }
12062
12209
  },
12063
12210
  {
12064
- "name": "include-default-sources",
12211
+ "name": "include-default-sources-disabled",
12065
12212
  "description": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).",
12066
- "default": "true",
12213
+ "default": "false",
12067
12214
  "value": {
12068
12215
  "type": "boolean"
12069
12216
  }
@@ -12076,9 +12223,9 @@
12076
12223
  }
12077
12224
  },
12078
12225
  {
12079
- "name": "location-enabled",
12226
+ "name": "location-disabled",
12080
12227
  "description": "Enables location services within the component.\n\n![locationEnabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-locationEnabled.png)\n\n::: esri-md class=\"warning\"\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that supports\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).\n:::",
12081
- "default": "true",
12228
+ "default": "false",
12082
12229
  "value": {
12083
12230
  "type": "boolean"
12084
12231
  }
@@ -12108,9 +12255,9 @@
12108
12255
  }
12109
12256
  },
12110
12257
  {
12111
- "name": "popup-enabled",
12258
+ "name": "popup-disabled",
12112
12259
  "description": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can\nbe clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).",
12113
- "default": "true",
12260
+ "default": "false",
12114
12261
  "value": {
12115
12262
  "type": "boolean"
12116
12263
  }
@@ -12134,22 +12281,23 @@
12134
12281
  },
12135
12282
  {
12136
12283
  "name": "reference-element",
12284
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
12137
12285
  "value": {
12138
12286
  "type": "string"
12139
12287
  }
12140
12288
  },
12141
12289
  {
12142
- "name": "result-graphic-enabled",
12290
+ "name": "result-graphic-disabled",
12143
12291
  "description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
12144
- "default": "true",
12292
+ "default": "false",
12145
12293
  "value": {
12146
12294
  "type": "boolean"
12147
12295
  }
12148
12296
  },
12149
12297
  {
12150
- "name": "search-all-enabled",
12298
+ "name": "search-all-disabled",
12151
12299
  "description": "Indicates whether to display the option to search all sources. When `true`, the \"All\" option\nis displayed by default:\n\n![search-searchAllEnabled-true](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-enablesearchingall-true.png)\n\nWhen `false`, no option to search all sources at once is available:\n\n![search-searchAllEnabled-false](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-enablesearchingall-false.png)",
12152
- "default": "true",
12300
+ "default": "false",
12153
12301
  "value": {
12154
12302
  "type": "boolean"
12155
12303
  }
@@ -12163,7 +12311,7 @@
12163
12311
  },
12164
12312
  {
12165
12313
  "name": "state",
12166
- "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
12314
+ "description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
12167
12315
  "default": "\"ready\"",
12168
12316
  "value": {
12169
12317
  "type": [
@@ -12175,9 +12323,9 @@
12175
12323
  }
12176
12324
  },
12177
12325
  {
12178
- "name": "suggestions-enabled",
12326
+ "name": "suggestions-disabled",
12179
12327
  "description": "Enable suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
12180
- "default": "true",
12328
+ "default": "false",
12181
12329
  "value": {
12182
12330
  "type": "boolean"
12183
12331
  }
@@ -12258,7 +12406,7 @@
12258
12406
  "type": "boolean"
12259
12407
  },
12260
12408
  {
12261
- "name": "autoSelect",
12409
+ "name": "autoSelectDisabled",
12262
12410
  "description": "Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
12263
12411
  "type": "boolean"
12264
12412
  },
@@ -12283,7 +12431,7 @@
12283
12431
  "type": "string"
12284
12432
  },
12285
12433
  {
12286
- "name": "includeDefaultSources",
12434
+ "name": "includeDefaultSourcesDisabled",
12287
12435
  "description": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).",
12288
12436
  "type": "Function | boolean"
12289
12437
  },
@@ -12293,7 +12441,7 @@
12293
12441
  "type": "string"
12294
12442
  },
12295
12443
  {
12296
- "name": "locationEnabled",
12444
+ "name": "locationDisabled",
12297
12445
  "description": "Enables location services within the component.\n\n![locationEnabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-locationEnabled.png)\n\n::: esri-md class=\"warning\"\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that supports\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).\n:::",
12298
12446
  "type": "boolean"
12299
12447
  },
@@ -12309,7 +12457,7 @@
12309
12457
  },
12310
12458
  {
12311
12459
  "name": "messageOverrides",
12312
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
12460
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
12313
12461
  "type": "Record<string, unknown>"
12314
12462
  },
12315
12463
  {
@@ -12318,7 +12466,7 @@
12318
12466
  "type": "number"
12319
12467
  },
12320
12468
  {
12321
- "name": "popupEnabled",
12469
+ "name": "popupDisabled",
12322
12470
  "description": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can\nbe clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).",
12323
12471
  "type": "boolean"
12324
12472
  },
@@ -12338,6 +12486,7 @@
12338
12486
  },
12339
12487
  {
12340
12488
  "name": "referenceElement",
12489
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
12341
12490
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
12342
12491
  },
12343
12492
  {
@@ -12346,7 +12495,7 @@
12346
12495
  "type": "Graphic"
12347
12496
  },
12348
12497
  {
12349
- "name": "resultGraphicEnabled",
12498
+ "name": "resultGraphicDisabled",
12350
12499
  "description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
12351
12500
  "type": "boolean"
12352
12501
  },
@@ -12356,7 +12505,7 @@
12356
12505
  "type": "Array<SearchResults>"
12357
12506
  },
12358
12507
  {
12359
- "name": "searchAllEnabled",
12508
+ "name": "searchAllDisabled",
12360
12509
  "description": "Indicates whether to display the option to search all sources. When `true`, the \"All\" option\nis displayed by default:\n\n![search-searchAllEnabled-true](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-enablesearchingall-true.png)\n\nWhen `false`, no option to search all sources at once is available:\n\n![search-searchAllEnabled-false](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-enablesearchingall-false.png)",
12361
12510
  "type": "boolean"
12362
12511
  },
@@ -12377,7 +12526,7 @@
12377
12526
  },
12378
12527
  {
12379
12528
  "name": "state",
12380
- "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
12529
+ "description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
12381
12530
  "type": "\"disabled\" | \"loading\" | \"ready\" | \"searching\""
12382
12531
  },
12383
12532
  {
@@ -12386,7 +12535,7 @@
12386
12535
  "type": "Array<SuggestResults>"
12387
12536
  },
12388
12537
  {
12389
- "name": "suggestionsEnabled",
12538
+ "name": "suggestionsDisabled",
12390
12539
  "description": "Enable suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
12391
12540
  "type": "boolean"
12392
12541
  }
@@ -12465,7 +12614,7 @@
12465
12614
  },
12466
12615
  {
12467
12616
  "name": "messages",
12468
- "type": "({\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n} & {\n _lang: string;\n _t9nLocale: \"id\" | \"el\" | \"hr\" | \"th\" | \"tr\" | \"sl\" | \"it\" | \"ca\" | \"de\" | \"fi\" | \"ar\" | \"da\" | \"vi\" | \"pl\" | \"et\" | \"bs\" | \"sk\" | \"es\" | \"en\" | \"ru\" | \"ro\" | \"no\" | \"lt\" | \"cs\" | \"he\" | \"fr\" | \"sv\" | \"bg\" | \"lv\" | \"nl\" | \"sr\" | \"hu\" | \"ja\" | \"ko\" | \"nb\" | \"pt-BR\" | \"pt-PT\" | \"uk\" | \"zh-CN\" | \"zh-HK\" | \"zh-TW\";\n _loading: boolean;\n _overrides: {\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n };\n _original?: {\n componentLabel: string;\n searchButtonTitle: string;\n placeholder: string;\n searchIn: string;\n all: string;\n allPlaceholder: string;\n locateError: string;\n untitledResult: string;\n untitledSource: string;\n noResults: string;\n noResultsFound: string;\n noResultsFoundForValue: string;\n showMoreResults: string;\n hideMoreResults: string;\n searchResult: string;\n moreResultsHeader: string;\n useCurrentLocation: string;\n } | undefined;\n})"
12617
+ "type": "({\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n} & {\n _lang: string;\n _t9nLocale: \"id\" | \"el\" | \"hr\" | \"th\" | \"tr\" | \"sl\" | \"it\" | \"ca\" | \"de\" | \"fi\" | \"ar\" | \"da\" | \"vi\" | \"pl\" | \"he\" | \"et\" | \"bs\" | \"sk\" | \"es\" | \"en\" | \"ru\" | \"ro\" | \"no\" | \"lt\" | \"cs\" | \"fr\" | \"sv\" | \"bg\" | \"lv\" | \"nl\" | \"sr\" | \"hu\" | \"ja\" | \"ko\" | \"nb\" | \"pt-BR\" | \"pt-PT\" | \"uk\" | \"zh-CN\" | \"zh-HK\" | \"zh-TW\";\n _loading: boolean;\n _overrides: {\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n };\n _original?: {\n componentLabel: string;\n searchButtonTitle: string;\n placeholder: string;\n searchIn: string;\n all: string;\n allPlaceholder: string;\n locateError: string;\n untitledResult: string;\n untitledSource: string;\n noResults: string;\n noResultsFound: string;\n noResultsFoundForValue: string;\n showMoreResults: string;\n hideMoreResults: string;\n searchResult: string;\n moreResultsHeader: string;\n useCurrentLocation: string;\n } | undefined;\n})"
12469
12618
  },
12470
12619
  {
12471
12620
  "name": "viewModel",
@@ -12483,7 +12632,7 @@
12483
12632
  },
12484
12633
  {
12485
12634
  "name": "arcgis-shadow-cast",
12486
- "description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getDuration(point: __esri.Point): Promise<number>`\n- `start(): Promise<void>`\n- `stop(): Promise<void>`",
12635
+ "description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nThis type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.\n\nThe component calculates the cumulative shadows for a time range during a single day. The user can\nconfigure the time range and select a calendar date. This time range and calendar date are only used\nfor the shadow analysis and are not connected to the lighting in the scene.\nTo control the lighting in the scene, the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component can be used.\nChanging the timezone in the component updates the visualization by interpreting the time range as being\nin that timezone. This behavior is different from the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component,\nwhere selecting a timezone updates the [environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) date and time according to the camera position.\n\nThe component provides three [visualization modes](#visualizationType): threshold, duration, and discrete mode.\n\nIn the **threshold** mode, only the areas that receive\nshadows for more than a certain amount of time are displayed. In the image below, on May 1, 2021 the red areas receive\nshadow for more than 4 hours within the time interval of 10AM to 4PM.\n\n[![threshold mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-threshold.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Total shadow duration** mode displays the duration of the cumulative shadow using opacity: areas that don't\nreceive any shadow are fully transparent and areas that receive a maximum amount of shadow have a default opacity\nof 0.7. The values in between are interpolated. Hovering over the Scene will display a tooltip showing the\namount of time that location is in shadow, rounded to 15-minute intervals. In this mode, the visualization\ncan display shadow cast in a continuous way or in 1-hour intervals.\n\n[![duration mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-duration.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Discrete shadows** is a third visualization mode which displays individual shadows at a given time interval.\nFor example, setting the time range to 10AM-11AM and the visualization time interval to 30 minutes will display\nshadows for 10AM, 10:30AM and 11:00AM.\n\n[![discrete mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-discrete.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\nThe defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay), [endTimeOfDay](#endTimeOfDay), and [visualizationType](#visualizationType) properties.\n\n**Known limitations**\n\n* Shadow Cast is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* Terrain does not cast shadows and it is therefore not taken into account in this analysis.\n* The component does not take into account the daylight savings.\nUse the timezone dropdown to adjust the offset from the Coordinated Universal Time (UTC) and account for the daylight saving time.\n* The timezone is automatically detected by the component based on the camera location. In some situations, this might not be accurate.\nIn case of an inaccurate timezone, users can set it manually using the timezone dropdown.\n\n**See also**\n\n- [Sample - Shadow cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getDuration(point: __esri.Point): Promise<number>` - Returns the time (in milliseconds) spent in shadow for a certain point on the screen.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#getDuration)\n- `start(): Promise<void>` - Starts the component. While running, it will automatically perform shadow accumulation.\n- `stop(): Promise<void>` - Stops the component.",
12487
12636
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/",
12488
12637
  "attributes": [
12489
12638
  {
@@ -12496,6 +12645,7 @@
12496
12645
  },
12497
12646
  {
12498
12647
  "name": "date",
12648
+ "description": "The calendar date used to calculate the shadow cast. This date excludes the time. If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.\nIf no date is set, then it defaults to the current date in local system time.\n\n_See also_\n\n* [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)",
12499
12649
  "value": {
12500
12650
  "type": [
12501
12651
  "number",
@@ -12505,7 +12655,7 @@
12505
12655
  },
12506
12656
  {
12507
12657
  "name": "end-time-of-day",
12508
- "description": "Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date)) when the shadow cast computation should stop.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)",
12658
+ "description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)",
12509
12659
  "default": "16 * 3600 * 1000",
12510
12660
  "value": {
12511
12661
  "type": "number"
@@ -12591,7 +12741,7 @@
12591
12741
  },
12592
12742
  {
12593
12743
  "name": "icon",
12594
- "description": "Icon which represents the widget.",
12744
+ "description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
12595
12745
  "default": "\"measure-building-height-shadow\"",
12596
12746
  "value": {
12597
12747
  "type": "string"
@@ -12599,7 +12749,7 @@
12599
12749
  },
12600
12750
  {
12601
12751
  "name": "label",
12602
- "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#label)",
12752
+ "description": "The component's default label.",
12603
12753
  "value": {
12604
12754
  "type": "string"
12605
12755
  }
@@ -12623,13 +12773,14 @@
12623
12773
  },
12624
12774
  {
12625
12775
  "name": "reference-element",
12776
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
12626
12777
  "value": {
12627
12778
  "type": "string"
12628
12779
  }
12629
12780
  },
12630
12781
  {
12631
12782
  "name": "start-time-of-day",
12632
- "description": "Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date))\nwhen the shadow cast computation should start.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)",
12783
+ "description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)",
12633
12784
  "default": "10 * 3600 * 1000",
12634
12785
  "value": {
12635
12786
  "type": "number"
@@ -12637,7 +12788,7 @@
12637
12788
  },
12638
12789
  {
12639
12790
  "name": "state",
12640
- "description": "The current state of the view model that can be used for rendering the UI\nof the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#state)",
12791
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
12641
12792
  "default": "\"disabled\"",
12642
12793
  "value": {
12643
12794
  "type": [
@@ -12648,14 +12799,14 @@
12648
12799
  },
12649
12800
  {
12650
12801
  "name": "utc-offset",
12651
- "description": "The difference in hours between UTC time and the times displayed in the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#utcOffset)",
12802
+ "description": "The difference in hours between UTC time and the times displayed in the component.",
12652
12803
  "value": {
12653
12804
  "type": "number"
12654
12805
  }
12655
12806
  },
12656
12807
  {
12657
12808
  "name": "visualization-type",
12658
- "description": "Type of visualization to use when showing the shadows.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType)",
12809
+ "description": "Type of visualization to use when showing the shadows. There are 3 types of visualization:\n* `threshold` - only displays areas that receive shadows for a period longer than a given threshold value\n* `duration` - displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals\n* `discrete` - displays individual shadows cast at a given time interval",
12659
12810
  "default": "\"threshold\"",
12660
12811
  "value": {
12661
12812
  "type": [
@@ -12687,21 +12838,22 @@
12687
12838
  },
12688
12839
  {
12689
12840
  "name": "date",
12841
+ "description": "The calendar date used to calculate the shadow cast. This date excludes the time. If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.\nIf no date is set, then it defaults to the current date in local system time.\n\n_See also_\n\n* [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)",
12690
12842
  "type": "Date | number | string"
12691
12843
  },
12692
12844
  {
12693
12845
  "name": "discreteOptions",
12694
- "description": "The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to \"discrete\".\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#discreteOptions)",
12846
+ "description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"discrete\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DiscreteOptions.html)",
12695
12847
  "type": "DiscreteOptions"
12696
12848
  },
12697
12849
  {
12698
12850
  "name": "durationOptions",
12699
- "description": "The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to \"duration\".\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#durationOptions)",
12851
+ "description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"duration\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DurationOptions.html)",
12700
12852
  "type": "DurationOptions"
12701
12853
  },
12702
12854
  {
12703
12855
  "name": "endTimeOfDay",
12704
- "description": "Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date)) when the shadow cast computation should stop.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)",
12856
+ "description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)",
12705
12857
  "type": "number"
12706
12858
  },
12707
12859
  {
@@ -12751,12 +12903,12 @@
12751
12903
  },
12752
12904
  {
12753
12905
  "name": "icon",
12754
- "description": "Icon which represents the widget.",
12906
+ "description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
12755
12907
  "type": "string"
12756
12908
  },
12757
12909
  {
12758
12910
  "name": "label",
12759
- "description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast.html#label)",
12911
+ "description": "The component's default label.",
12760
12912
  "type": "string"
12761
12913
  },
12762
12914
  {
@@ -12765,31 +12917,32 @@
12765
12917
  },
12766
12918
  {
12767
12919
  "name": "referenceElement",
12920
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
12768
12921
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
12769
12922
  },
12770
12923
  {
12771
12924
  "name": "startTimeOfDay",
12772
- "description": "Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#date))\nwhen the shadow cast computation should start.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)",
12925
+ "description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)",
12773
12926
  "type": "number"
12774
12927
  },
12775
12928
  {
12776
12929
  "name": "state",
12777
- "description": "The current state of the view model that can be used for rendering the UI\nof the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#state)",
12930
+ "description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
12778
12931
  "type": "\"disabled\" | \"ready\""
12779
12932
  },
12780
12933
  {
12781
12934
  "name": "thresholdOptions",
12782
- "description": "The configuration used when the widget's [visualizationType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType) is set to \"threshold\".\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#thresholdOptions)",
12935
+ "description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"threshold\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ThresholdOptions.html)",
12783
12936
  "type": "ThresholdOptions"
12784
12937
  },
12785
12938
  {
12786
12939
  "name": "utcOffset",
12787
- "description": "The difference in hours between UTC time and the times displayed in the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#utcOffset)",
12940
+ "description": "The difference in hours between UTC time and the times displayed in the component.",
12788
12941
  "type": "number"
12789
12942
  },
12790
12943
  {
12791
12944
  "name": "visualizationType",
12792
- "description": "Type of visualization to use when showing the shadows.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#visualizationType)",
12945
+ "description": "Type of visualization to use when showing the shadows. There are 3 types of visualization:\n* `threshold` - only displays areas that receive shadows for a period longer than a given threshold value\n* `duration` - displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals\n* `discrete` - displays individual shadows cast at a given time interval",
12793
12946
  "type": "\"discrete\" | \"duration\" | \"threshold\""
12794
12947
  }
12795
12948
  ],
@@ -13041,6 +13194,7 @@
13041
13194
  },
13042
13195
  {
13043
13196
  "name": "reference-element",
13197
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
13044
13198
  "value": {
13045
13199
  "type": "string"
13046
13200
  }
@@ -13283,6 +13437,7 @@
13283
13437
  },
13284
13438
  {
13285
13439
  "name": "referenceElement",
13440
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
13286
13441
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
13287
13442
  },
13288
13443
  {
@@ -13356,7 +13511,7 @@
13356
13511
  },
13357
13512
  {
13358
13513
  "name": "arcgis-slice",
13359
- "description": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a 3D view. It applies\n[slice analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\nto any layer type, making it possible to see inside buildings or to explore geological surfaces.\n\nThe slicing [shape](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#shape)\nis always a [plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).\nBy default, the plane is either horizontal or vertical. To allow a tilt angle for the plane, set\n[tiltEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#tiltEnabled)\nto `true`. The slice hides any content in front of the surface. The handles on the sides of the plane can be used to adjust\nthe size, heading, tilt, and position of the slice plane.\nThe [SlicePlane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html)\ncan be set or retrieved using the [shape](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#shape) property.\n\nOnce the slice plane is applied, layers can be excluded from the slicing. For example, by excluding the sublayers which include\ncolumns and floor slabs, the inner structure of a building can investigated.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the [shape](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#shape) of the slice,\neffectively removing it from the view. Other properties like [excludedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#excludedLayers)\nand [excludeGroundSurface](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#excludeGroundSurface) are not modified.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start the interactive creation of a new slice, clearing the previous\n[shape](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/#shape).",
13514
+ "description": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). It applies\n[slice analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\nto any layer type, making it possible to see inside buildings or to explore geological surfaces.\n\n[![slice](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/slice.gif)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nThe slicing [shape](#shape)\nis always a [plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).\nBy default, the plane is either horizontal or vertical. To allow a tilt angle for the plane, set\n[tiltEnabled](#tiltEnabled)\nto `true`. The slice hides any content in front of the surface. The handles on the sides of the plane can be used to adjust\nthe size, heading, tilt, and position of the slice plane.\nThe [SlicePlane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html)\ncan be set or retrieved using the [shape](#shape) property.\n\nOnce the slice plane is applied, layers can be excluded from the slicing. For example, by excluding the sublayers which include\ncolumns and floor slabs, the inner structure of a building can investigated.\n\n[![slice-exclude](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/slice-exclude.png)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nHolding the `Shift` key while creating a new slice applies it vertically.\n\n**Known limitation**\n\nSlice is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the [shape](#shape) of the slice, effectively removing it from the view. Other properties like [excludedLayers](#excludedLayers)\nand [excludeGroundSurface](#excludeGroundSurface) are not modified.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start the interactive creation of a new slice, clearing the previous [shape](#shape).",
13360
13515
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/",
13361
13516
  "attributes": [
13362
13517
  {
@@ -13423,6 +13578,7 @@
13423
13578
  },
13424
13579
  {
13425
13580
  "name": "reference-element",
13581
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
13426
13582
  "value": {
13427
13583
  "type": "string"
13428
13584
  }
@@ -13465,7 +13621,7 @@
13465
13621
  "properties": [
13466
13622
  {
13467
13623
  "name": "analysis",
13468
- "description": "The [slice analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\nobject being created by the component.",
13624
+ "description": "The [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Slice component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst sliceAnalysis = new SliceAnalysis({\n shape: new SlicePlane({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624925.727820931,\n y: 4550341.695170021,\n z: 56\n }),\n tilt: 270,\n width: 310,\n height: 190,\n heading: 45\n })\n});\n// Get the Scene and Slice component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst slice = document.querySelector(\"arcgis-slice\");\nawait slice.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(sliceAnalysis);\n// Connect the analysis to the slice component:\nslice.analysis = sliceAnalysis;\n```",
13469
13625
  "type": "SliceAnalysis"
13470
13626
  },
13471
13627
  {
@@ -13499,7 +13655,7 @@
13499
13655
  },
13500
13656
  {
13501
13657
  "name": "messageOverrides",
13502
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
13658
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
13503
13659
  "type": "Record<string, unknown>"
13504
13660
  },
13505
13661
  {
@@ -13508,11 +13664,12 @@
13508
13664
  },
13509
13665
  {
13510
13666
  "name": "referenceElement",
13667
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
13511
13668
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
13512
13669
  },
13513
13670
  {
13514
13671
  "name": "shape",
13515
- "description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a plane.\nExample:\n```\n// Clone the shape to modify its properties\nconst shape = slice.shape.clone();\n// Set new values for heading and tilt\nshape.heading = 180;\nshape.tilt = 45;\n// Apply the new shape to the slice component's shape\nslice.shape = shape;\n```",
13672
+ "description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a\n[plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).",
13516
13673
  "type": "SlicePlane"
13517
13674
  },
13518
13675
  {
@@ -13660,6 +13817,7 @@
13660
13817
  },
13661
13818
  {
13662
13819
  "name": "reference-element",
13820
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
13663
13821
  "value": {
13664
13822
  "type": "string"
13665
13823
  }
@@ -13862,6 +14020,7 @@
13862
14020
  },
13863
14021
  {
13864
14022
  "name": "referenceElement",
14023
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
13865
14024
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
13866
14025
  },
13867
14026
  {
@@ -13980,7 +14139,7 @@
13980
14139
  },
13981
14140
  {
13982
14141
  "name": "arcgis-swipe",
13983
- "description": "The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known Limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
14142
+ "description": "The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
13984
14143
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/",
13985
14144
  "attributes": [
13986
14145
  {
@@ -14061,6 +14220,7 @@
14061
14220
  },
14062
14221
  {
14063
14222
  "name": "reference-element",
14223
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
14064
14224
  "value": {
14065
14225
  "type": "string"
14066
14226
  }
@@ -14141,7 +14301,7 @@
14141
14301
  },
14142
14302
  {
14143
14303
  "name": "messageOverrides",
14144
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
14304
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
14145
14305
  "type": "Record<string, unknown>"
14146
14306
  },
14147
14307
  {
@@ -14150,6 +14310,7 @@
14150
14310
  },
14151
14311
  {
14152
14312
  "name": "referenceElement",
14313
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
14153
14314
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
14154
14315
  },
14155
14316
  {
@@ -14299,6 +14460,7 @@
14299
14460
  },
14300
14461
  {
14301
14462
  "name": "reference-element",
14463
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
14302
14464
  "value": {
14303
14465
  "type": "string"
14304
14466
  }
@@ -14469,6 +14631,7 @@
14469
14631
  },
14470
14632
  {
14471
14633
  "name": "referenceElement",
14634
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
14472
14635
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
14473
14636
  },
14474
14637
  {
@@ -14636,6 +14799,7 @@
14636
14799
  },
14637
14800
  {
14638
14801
  "name": "reference-element",
14802
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
14639
14803
  "value": {
14640
14804
  "type": "string"
14641
14805
  }
@@ -14748,6 +14912,7 @@
14748
14912
  },
14749
14913
  {
14750
14914
  "name": "referenceElement",
14915
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
14751
14916
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
14752
14917
  },
14753
14918
  {
@@ -14909,7 +15074,7 @@
14909
15074
  },
14910
15075
  {
14911
15076
  "name": "messageOverrides",
14912
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
15077
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
14913
15078
  "type": "Record<string, unknown>"
14914
15079
  },
14915
15080
  {
@@ -14942,7 +15107,7 @@
14942
15107
  },
14943
15108
  {
14944
15109
  "name": "arcgis-track",
14945
- "description": "The Track component is a button that animates the map or scene to the user's location when clicked.\nThe view rotates based on device heading.\nThe default heading symbol will display when speed is greater than zero and the browser provides heading information.\n\n**Known Limitations**\n\n- The heading symbol is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`\n- `stop(): Promise<void>`",
15110
+ "description": "The Track component is a button that when activated continuously animates the Map or Scene\nto the user's location as the user moves.\nThe view rotates based on device heading, and the default heading symbol will display\nwhen speed is greater than zero and the browser provides heading information.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that support\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility).\n\n**Known limitations**\n\n- The heading symbol is not currently supported within a [Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start tracking the user's location. Only start the component on a user gesture such as a click event.\n- `stop(): Promise<void>` - Stop tracking the user's location.",
14946
15111
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-track/",
14947
15112
  "attributes": [
14948
15113
  {
@@ -15010,6 +15175,7 @@
15010
15175
  },
15011
15176
  {
15012
15177
  "name": "reference-element",
15178
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
15013
15179
  "value": {
15014
15180
  "type": "string"
15015
15181
  }
@@ -15032,7 +15198,7 @@
15032
15198
  },
15033
15199
  {
15034
15200
  "name": "state",
15035
- "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#state)",
15201
+ "description": "The current state of the component.",
15036
15202
  "default": "\"disabled\"",
15037
15203
  "value": {
15038
15204
  "type": [
@@ -15109,7 +15275,7 @@
15109
15275
  },
15110
15276
  {
15111
15277
  "name": "messageOverrides",
15112
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
15278
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
15113
15279
  "type": "Record<string, unknown>"
15114
15280
  },
15115
15281
  {
@@ -15123,6 +15289,7 @@
15123
15289
  },
15124
15290
  {
15125
15291
  "name": "referenceElement",
15292
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
15126
15293
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
15127
15294
  },
15128
15295
  {
@@ -15137,7 +15304,7 @@
15137
15304
  },
15138
15305
  {
15139
15306
  "name": "state",
15140
- "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Track-TrackViewModel.html#state)",
15307
+ "description": "The current state of the component.",
15141
15308
  "type": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"ready\" | \"tracking\" | \"waiting\""
15142
15309
  },
15143
15310
  {
@@ -15170,7 +15337,7 @@
15170
15337
  },
15171
15338
  {
15172
15339
  "name": "arcgis-utility-network-associations",
15173
- "description": "The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
15340
+ "description": "The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
15174
15341
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-associations/",
15175
15342
  "attributes": [
15176
15343
  {
@@ -15310,6 +15477,7 @@
15310
15477
  },
15311
15478
  {
15312
15479
  "name": "reference-element",
15480
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
15313
15481
  "value": {
15314
15482
  "type": "string"
15315
15483
  }
@@ -15375,7 +15543,7 @@
15375
15543
  },
15376
15544
  {
15377
15545
  "name": "visible-elements-connectivity-associations-settings-arrows-toggle",
15378
- "description": "**Deprecated**: since 4.32. Use hideConnectivityAssociationsSettingsArrowsToggle instead. ",
15546
+ "description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsArrowsToggle instead. ",
15379
15547
  "default": "false",
15380
15548
  "value": {
15381
15549
  "type": "boolean"
@@ -15383,7 +15551,7 @@
15383
15551
  },
15384
15552
  {
15385
15553
  "name": "visible-elements-connectivity-associations-settings-cap-select",
15386
- "description": "**Deprecated**: since 4.32. Use hideConnectivityAssociationsSettingsCapSelect instead. ",
15554
+ "description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsCapSelect instead. ",
15387
15555
  "default": "false",
15388
15556
  "value": {
15389
15557
  "type": "boolean"
@@ -15391,7 +15559,7 @@
15391
15559
  },
15392
15560
  {
15393
15561
  "name": "visible-elements-connectivity-associations-settings-color-picker",
15394
- "description": "**Deprecated**: since 4.32. Use hideConnectivityAssociationsSettingsColorPicker instead. ",
15562
+ "description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsColorPicker instead. ",
15395
15563
  "default": "true",
15396
15564
  "value": {
15397
15565
  "type": "boolean"
@@ -15399,7 +15567,7 @@
15399
15567
  },
15400
15568
  {
15401
15569
  "name": "visible-elements-connectivity-associations-settings-style-picker",
15402
- "description": "**Deprecated**: since 4.32. Use hideConnectivityAssociationsSettingsStylePicker instead. ",
15570
+ "description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsStylePicker instead. ",
15403
15571
  "default": "true",
15404
15572
  "value": {
15405
15573
  "type": "boolean"
@@ -15407,7 +15575,7 @@
15407
15575
  },
15408
15576
  {
15409
15577
  "name": "visible-elements-connectivity-associations-settings-width-input",
15410
- "description": "**Deprecated**: since 4.32. Use hideConnectivityAssociationsSettingsWidthInput instead. ",
15578
+ "description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsWidthInput instead. ",
15411
15579
  "default": "true",
15412
15580
  "value": {
15413
15581
  "type": "boolean"
@@ -15415,7 +15583,7 @@
15415
15583
  },
15416
15584
  {
15417
15585
  "name": "visible-elements-max-allowable-associations-slider",
15418
- "description": "**Deprecated**: since 4.32. Use hideMaxAllowableAssociationsSlider instead. ",
15586
+ "description": "**Deprecated**: since 4.32, use hideMaxAllowableAssociationsSlider instead. ",
15419
15587
  "default": "false",
15420
15588
  "value": {
15421
15589
  "type": "boolean"
@@ -15423,7 +15591,7 @@
15423
15591
  },
15424
15592
  {
15425
15593
  "name": "visible-elements-structural-attachment-associations-settings-arrows-toggle",
15426
- "description": "**Deprecated**: since 4.32. Use hideStructuralAttachmentAssociationsSettingsArrowsToggle instead. ",
15594
+ "description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsArrowsToggle instead. ",
15427
15595
  "default": "false",
15428
15596
  "value": {
15429
15597
  "type": "boolean"
@@ -15431,7 +15599,7 @@
15431
15599
  },
15432
15600
  {
15433
15601
  "name": "visible-elements-structural-attachment-associations-settings-cap-select",
15434
- "description": "**Deprecated**: since 4.32. Use hideStructuralAttachmentAssociationsSettingsCapSelect instead. ",
15602
+ "description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsCapSelect instead. ",
15435
15603
  "default": "false",
15436
15604
  "value": {
15437
15605
  "type": "boolean"
@@ -15439,7 +15607,7 @@
15439
15607
  },
15440
15608
  {
15441
15609
  "name": "visible-elements-structural-attachment-associations-settings-color-picker",
15442
- "description": "**Deprecated**: since 4.32. Use hideStructuralAttachmentAssociationsSettingsColorPicker instead. ",
15610
+ "description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsColorPicker instead. ",
15443
15611
  "default": "true",
15444
15612
  "value": {
15445
15613
  "type": "boolean"
@@ -15447,7 +15615,7 @@
15447
15615
  },
15448
15616
  {
15449
15617
  "name": "visible-elements-structural-attachment-associations-settings-style-picker",
15450
- "description": "**Deprecated**: since 4.32. Use hideStructuralAttachmentAssociationsSettingsStylePicker instead. ",
15618
+ "description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsStylePicker instead. ",
15451
15619
  "default": "true",
15452
15620
  "value": {
15453
15621
  "type": "boolean"
@@ -15455,7 +15623,7 @@
15455
15623
  },
15456
15624
  {
15457
15625
  "name": "visible-elements-structural-attachment-associations-settings-width-input",
15458
- "description": "**Deprecated**: since 4.32. Use hideStructuralAttachmentAssociationsSettingsWidthInput instead. ",
15626
+ "description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsWidthInput instead. ",
15459
15627
  "default": "true",
15460
15628
  "value": {
15461
15629
  "type": "boolean"
@@ -15556,6 +15724,7 @@
15556
15724
  },
15557
15725
  {
15558
15726
  "name": "referenceElement",
15727
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
15559
15728
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
15560
15729
  },
15561
15730
  {
@@ -15688,7 +15857,7 @@
15688
15857
  },
15689
15858
  {
15690
15859
  "name": "gdb-version",
15691
- "description": "**Deprecated**: since version 4.31, gdbVersion will be removed and the gdbVersion of the {@link module :esri/networks/UtilityNetwork} will be consumed directly.. The Geodatabase version to pass into the trace.",
15860
+ "description": "**Deprecated**: `gdbVersion` is deprecated since version 4.31.. The Geodatabase version to pass into the trace.",
15692
15861
  "default": "\"sde.DEFAULT\"",
15693
15862
  "value": {
15694
15863
  "type": "string"
@@ -15728,6 +15897,7 @@
15728
15897
  },
15729
15898
  {
15730
15899
  "name": "reference-element",
15900
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
15731
15901
  "value": {
15732
15902
  "type": "string"
15733
15903
  }
@@ -15853,6 +16023,7 @@
15853
16023
  },
15854
16024
  {
15855
16025
  "name": "referenceElement",
16026
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
15856
16027
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
15857
16028
  },
15858
16029
  {
@@ -15978,6 +16149,7 @@
15978
16149
  },
15979
16150
  {
15980
16151
  "name": "reference-element",
16152
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
15981
16153
  "value": {
15982
16154
  "type": "string"
15983
16155
  }
@@ -16038,6 +16210,7 @@
16038
16210
  },
16039
16211
  {
16040
16212
  "name": "referenceElement",
16213
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
16041
16214
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
16042
16215
  },
16043
16216
  {
@@ -16192,6 +16365,7 @@
16192
16365
  },
16193
16366
  {
16194
16367
  "name": "reference-element",
16368
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
16195
16369
  "value": {
16196
16370
  "type": "string"
16197
16371
  }
@@ -16304,6 +16478,7 @@
16304
16478
  },
16305
16479
  {
16306
16480
  "name": "referenceElement",
16481
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
16307
16482
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
16308
16483
  },
16309
16484
  {
@@ -16393,7 +16568,7 @@
16393
16568
  },
16394
16569
  {
16395
16570
  "name": "page-size",
16396
- "description": "Specifies the number of versions displayed on each page of the Version Management Component.",
16571
+ "description": "Specifies the number of versions displayed on each page of the Version Management component.",
16397
16572
  "default": "5",
16398
16573
  "value": {
16399
16574
  "type": "number"
@@ -16418,6 +16593,7 @@
16418
16593
  },
16419
16594
  {
16420
16595
  "name": "reference-element",
16596
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
16421
16597
  "value": {
16422
16598
  "type": "string"
16423
16599
  }
@@ -16469,7 +16645,7 @@
16469
16645
  },
16470
16646
  {
16471
16647
  "name": "initialVersionInfos",
16472
- "description": "The `initialVersionInfos` property enables users to initialize the Version Management Component with a predefined set of versions.\nBy providing an array of `InitialVersionInfo`, the component displays a specified version for each feature service upon initialization.",
16648
+ "description": "The `initialVersionInfos` property enables users to initialize the Version Management component with a predefined set of versions.\nBy providing an array of `InitialVersionInfo`, the component displays a specified version for each feature service upon initialization.",
16473
16649
  "type": "Array<{\n url: string;\n name: string;\n}>"
16474
16650
  },
16475
16651
  {
@@ -16478,7 +16654,7 @@
16478
16654
  },
16479
16655
  {
16480
16656
  "name": "messageOverrides",
16481
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
16657
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
16482
16658
  "type": "Record<string, unknown>"
16483
16659
  },
16484
16660
  {
@@ -16487,7 +16663,7 @@
16487
16663
  },
16488
16664
  {
16489
16665
  "name": "pageSize",
16490
- "description": "Specifies the number of versions displayed on each page of the Version Management Component.",
16666
+ "description": "Specifies the number of versions displayed on each page of the Version Management component.",
16491
16667
  "type": "number"
16492
16668
  },
16493
16669
  {
@@ -16496,6 +16672,7 @@
16496
16672
  },
16497
16673
  {
16498
16674
  "name": "referenceElement",
16675
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
16499
16676
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
16500
16677
  },
16501
16678
  {
@@ -16505,7 +16682,7 @@
16505
16682
  },
16506
16683
  {
16507
16684
  "name": "versioningStates",
16508
- "description": "This class provides functionality for managing versions in a versioned geodatabase.\nIn the event that the Version Management component is destroyed, the VersioningStates can be utilized to maintain the current state of the Version Management Component.\nThe Version Management Component can be reinitialized using a `Collection<VersioningState>`, or a predefined `Collection<VersioningState>` can be provided during the initial instantiation of the Version Management Component.",
16685
+ "description": "This class provides functionality for managing versions in a versioned geodatabase.\nIn the event that the Version Management component is destroyed, the VersioningStates can be utilized to maintain the current state of the Version Management component.\nThe Version Management component can be reinitialized using a `Collection<VersioningState>`, or a predefined `Collection<VersioningState>` can be provided during the initial instantiation of the Version Management component.",
16509
16686
  "type": "Collection<VersioningState>"
16510
16687
  }
16511
16688
  ],
@@ -16524,7 +16701,7 @@
16524
16701
  },
16525
16702
  {
16526
16703
  "name": "arcgis-video",
16527
- "description": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid url or layer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n\n**Example**\n\n```html\n<arcgis-video layer-url=\"YOUR_VIDEO_LAYER_URL\"></arcgis-video>\n```\n--\n\n### Events\n- **arcgisViewReadyChange**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.",
16704
+ "description": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid VideoLayer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n--\n\n### Events\n- **arcgisViewReadyChange**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.",
16528
16705
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/",
16529
16706
  "attributes": [
16530
16707
  {
@@ -16533,12 +16710,6 @@
16533
16710
  "value": {
16534
16711
  "type": "boolean"
16535
16712
  }
16536
- },
16537
- {
16538
- "name": "layer-url",
16539
- "value": {
16540
- "type": "string"
16541
- }
16542
16713
  }
16543
16714
  ],
16544
16715
  "events": [
@@ -16558,10 +16729,6 @@
16558
16729
  "description": "The [VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html) to display in the view.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-VideoView.html#layer)",
16559
16730
  "type": "VideoLayer"
16560
16731
  },
16561
- {
16562
- "name": "layerUrl",
16563
- "type": "string"
16564
- },
16565
16732
  {
16566
16733
  "name": "ready",
16567
16734
  "description": "When `true`, this property indicates whether the view successfully satisfied all dependencies,\nsignaling that the following conditions are met.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-VideoView.html#ready)",
@@ -16583,7 +16750,7 @@
16583
16750
  },
16584
16751
  {
16585
16752
  "name": "arcgis-video-player",
16586
- "description": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known Limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[![](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/video-player-video-preview.png)](https://mediaspace.esri.com/media/1_ctc3psfr)\n\n**Example**\n\n```html\n<arcgis-map>\n <arcgis-video-player></arcgis-video-player>\n</arcgis-map>\n```\n\n```js\nconst [Map, VideoLayer] = await $arcgis.import([\n \"@arcgis/core/Map.js\",\n \"@arcgis/core/layers/VideoLayer.js\",\n]);\n\nconst viewElement = document.querySelector(\"arcgis-map\");\nconst videoPlayerElement = document.querySelector(\"arcgis-video-player\");\n\nconst videoLayer = new VideoLayer({\n url: \"YOUR_VIDEO_LAYER_URL\",\n});\n\nviewElement.map = new Map({\n basemap: \"topo-vector\",\n layers: [videoLayer],\n});\nawait viewElement.viewOnReady();\n\nawait videoLayer.load();\nif (videoLayer.loaded) {\n videoPlayerElement.layer = videoLayer;\n}\n\nawait viewElement.whenLayerView(videoLayer);\nviewElement.goTo(videoLayer.fullExtent);\n```\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisVideoReady**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
16753
+ "description": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[![](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/video-player-video-preview.png)](https://mediaspace.esri.com/media/1_ctc3psfr)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisVideoReady**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
16587
16754
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/",
16588
16755
  "attributes": [
16589
16756
  {
@@ -16594,6 +16761,19 @@
16594
16761
  "type": "boolean"
16595
16762
  }
16596
16763
  },
16764
+ {
16765
+ "name": "following-mode",
16766
+ "description": "Determines which telemetry elements to follow when the video layer is playing.",
16767
+ "default": "\"follow-both\"",
16768
+ "value": {
16769
+ "type": [
16770
+ "\"follow-both\"",
16771
+ "\"follow-frame\"",
16772
+ "\"follow-sensor\"",
16773
+ "\"none\""
16774
+ ]
16775
+ }
16776
+ },
16597
16777
  {
16598
16778
  "name": "hide-header",
16599
16779
  "description": "Indicates whether to display the video player's header information.",
@@ -16636,6 +16816,7 @@
16636
16816
  },
16637
16817
  {
16638
16818
  "name": "reference-element",
16819
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
16639
16820
  "value": {
16640
16821
  "type": "string"
16641
16822
  }
@@ -16680,6 +16861,11 @@
16680
16861
  "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/#destroy) method when you are done to\nprevent memory leaks.",
16681
16862
  "type": "boolean"
16682
16863
  },
16864
+ {
16865
+ "name": "followingMode",
16866
+ "description": "Determines which telemetry elements to follow when the video layer is playing.",
16867
+ "type": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\""
16868
+ },
16683
16869
  {
16684
16870
  "name": "hideHeader",
16685
16871
  "description": "Indicates whether to display the video player's header information.",
@@ -16702,7 +16888,7 @@
16702
16888
  },
16703
16889
  {
16704
16890
  "name": "messageOverrides",
16705
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
16891
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
16706
16892
  "type": "Record<string, unknown>"
16707
16893
  },
16708
16894
  {
@@ -16711,6 +16897,7 @@
16711
16897
  },
16712
16898
  {
16713
16899
  "name": "referenceElement",
16900
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
16714
16901
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
16715
16902
  },
16716
16903
  {
@@ -16739,7 +16926,7 @@
16739
16926
  },
16740
16927
  {
16741
16928
  "name": "arcgis-weather",
16742
- "description": "The Weather component provides an interface for easily selecting and configuring the weather effects in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
16929
+ "description": "The Weather component allows easy selection and configuration of weather effects in a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThe available weather types are:\n[sunny](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html),\n[cloudy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html),\n[rainy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html),\n[snowy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html), and\n[foggy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html).\n\nTo set the weather programmatically, apply the desired weather type to the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) property of the Scene component.\n\n```js\n// Access the Scene component.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// Specify the weather settings.\nviewElement.environment.weather = {\n type: \"rainy\", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })\n cloudCover: 0.7,\n precipitation: 0.3\n};\n```\n\nTo determine if the weather visualization is available, check the boolean value of `viewElement.environment.weatherAvailable`. The weather is only available:\n * in `global` [viewing mode](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewingMode),\n * when `atmosphereEnabled` property on [environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) is `true`,\n * at lower altitudes, near the ground.\n\n**Known limitations**\n\nWeather is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html)\n- [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
16743
16930
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-weather/",
16744
16931
  "attributes": [
16745
16932
  {
@@ -16808,6 +16995,7 @@
16808
16995
  },
16809
16996
  {
16810
16997
  "name": "reference-element",
16998
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
16811
16999
  "value": {
16812
17000
  "type": "string"
16813
17001
  }
@@ -16865,7 +17053,7 @@
16865
17053
  },
16866
17054
  {
16867
17055
  "name": "messageOverrides",
16868
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
17056
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
16869
17057
  "type": "Record<string, unknown>"
16870
17058
  },
16871
17059
  {
@@ -16874,6 +17062,7 @@
16874
17062
  },
16875
17063
  {
16876
17064
  "name": "referenceElement",
17065
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
16877
17066
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
16878
17067
  },
16879
17068
  {
@@ -16954,6 +17143,7 @@
16954
17143
  },
16955
17144
  {
16956
17145
  "name": "reference-element",
17146
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
16957
17147
  "value": {
16958
17148
  "type": "string"
16959
17149
  }
@@ -17006,7 +17196,7 @@
17006
17196
  },
17007
17197
  {
17008
17198
  "name": "messageOverrides",
17009
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
17199
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
17010
17200
  "type": "Record<string, unknown>"
17011
17201
  },
17012
17202
  {
@@ -17015,6 +17205,7 @@
17015
17205
  },
17016
17206
  {
17017
17207
  "name": "referenceElement",
17208
+ "description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
17018
17209
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
17019
17210
  },
17020
17211
  {