@arcgis/map-components 4.34.0-next.2 → 4.34.0-next.21

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 (293) hide show
  1. package/dist/cdn/2DIKFW7K.js +4 -0
  2. package/dist/cdn/{VRX7IRTW.js → 2FYM5HUD.js} +2 -2
  3. package/dist/cdn/{O57FJWKG.js → 3DS726OD.js} +2 -2
  4. package/dist/cdn/{IE47QEIE.js → 3KEZHG7W.js} +2 -2
  5. package/dist/cdn/3MMOB4OK.js +4 -0
  6. package/dist/cdn/{BOWV4BI5.js → 424JEX3C.js} +2 -2
  7. package/dist/cdn/{YTQ5WKUI.js → 43PD534X.js} +2 -2
  8. package/dist/cdn/4BAEO7AP.js +4 -0
  9. package/dist/cdn/{JXL7WD2E.js → 4JOU6IR7.js} +2 -2
  10. package/dist/cdn/{M6KBDQ4B.js → 53L3YUOX.js} +2 -2
  11. package/dist/cdn/{5APGWHKF.js → 5F6GXQGE.js} +2 -2
  12. package/dist/cdn/{DKMOPJ25.js → 5NKRC3D7.js} +2 -2
  13. package/dist/cdn/{M67BOC6R.js → 5REOJGCZ.js} +2 -2
  14. package/dist/cdn/{WIZ7RQYM.js → 5RL5K3OT.js} +2 -2
  15. package/dist/cdn/{LQXNDSAI.js → 5SEOV35O.js} +2 -2
  16. package/dist/cdn/{CUYQCXUJ.js → 5ZRRIWMB.js} +2 -2
  17. package/dist/cdn/{RKKLVIKS.js → 642ZLA6X.js} +2 -2
  18. package/dist/cdn/{6ESK4QPA.js → 66QYKE2Z.js} +2 -2
  19. package/dist/cdn/{FG2UUN5Y.js → 6FZFDLZE.js} +2 -2
  20. package/dist/cdn/{HSYMUXB2.js → 6JHKCUPI.js} +2 -2
  21. package/dist/cdn/{LLSIG464.js → 6JJ56G4C.js} +2 -2
  22. package/dist/cdn/{FVCCBN6R.js → 7LRZIJD4.js} +2 -2
  23. package/dist/cdn/{76V2F3M5.js → 7OYYQFDC.js} +2 -2
  24. package/dist/cdn/{QGDMGHZ3.js → A23355Z6.js} +2 -2
  25. package/dist/cdn/{V4FN65Z4.js → AAR2FOAL.js} +2 -2
  26. package/dist/cdn/{VIU4ZSIY.js → BGMADJYI.js} +2 -2
  27. package/dist/cdn/{A5THM6EA.js → BNVGHHPA.js} +2 -2
  28. package/dist/cdn/{LRCALZS4.js → BPLHLHQI.js} +2 -2
  29. package/dist/cdn/{VMDVUG52.js → BUMNG3LD.js} +1 -1
  30. package/dist/cdn/{AACC3FYE.js → BX4E7VS7.js} +1 -1
  31. package/dist/cdn/{3TIDM52T.js → C24AID7J.js} +2 -2
  32. package/dist/cdn/{YXIBBCVA.js → CB5UF2XM.js} +2 -2
  33. package/dist/cdn/{U7HB3CPN.js → CB7JLC5X.js} +2 -2
  34. package/dist/cdn/{ESEGUX5O.js → CLRYXHEP.js} +2 -2
  35. package/dist/cdn/{T7VRSGAE.js → CLW2LXNE.js} +2 -2
  36. package/dist/cdn/{DHZBSCQC.js → CNIJHZ6G.js} +2 -2
  37. package/dist/cdn/{FQM7ZIUE.js → CS43UYS3.js} +2 -2
  38. package/dist/cdn/DEYMBEU3.js +4 -0
  39. package/dist/cdn/{T356JENG.js → DFZCDEDC.js} +2 -2
  40. package/dist/cdn/{O24P7Q3C.js → DHJGGWH3.js} +2 -2
  41. package/dist/cdn/{LIRUDJLH.js → DRQJRZPI.js} +2 -2
  42. package/dist/cdn/{TEM46PXT.js → DZPKP76T.js} +2 -2
  43. package/dist/cdn/{MQJ7XLGK.js → EBWTFJHE.js} +2 -2
  44. package/dist/cdn/{RAN4WBBO.js → EF63U2JV.js} +2 -2
  45. package/dist/cdn/{PNN554XV.js → EQ7EDIWI.js} +2 -2
  46. package/dist/cdn/{3E5JGS7I.js → ETD3XMI3.js} +2 -2
  47. package/dist/cdn/{3ZGNCN4N.js → EVNA5MC3.js} +2 -2
  48. package/dist/cdn/{YL5UD5QK.js → F3GJKUFE.js} +2 -2
  49. package/dist/cdn/{N762OEGT.js → FKPX7WM5.js} +2 -2
  50. package/dist/cdn/{LG2VTIMN.js → FQDORCBB.js} +2 -2
  51. package/dist/cdn/{AX6ZNG7O.js → FRGNCM64.js} +2 -2
  52. package/dist/cdn/{AXKSXWQK.js → FRZCSSHL.js} +2 -2
  53. package/dist/cdn/{2HMQBLGX.js → G2R2TI3S.js} +2 -2
  54. package/dist/cdn/{4P26B2AA.js → GJ5VNK7J.js} +2 -2
  55. package/dist/cdn/{WBS3PEXG.js → H6CCKH3K.js} +2 -2
  56. package/dist/cdn/{JSU4NS5T.js → HN67NNCU.js} +2 -2
  57. package/dist/cdn/{R6KUTRWE.js → HU437PBD.js} +2 -2
  58. package/dist/cdn/{LQPNE6GS.js → I6SJPORS.js} +2 -2
  59. package/dist/cdn/{X5HMIK3S.js → IJ7MA37M.js} +2 -2
  60. package/dist/cdn/{R42MVK6T.js → J7JF3XPD.js} +2 -2
  61. package/dist/cdn/{6QZWTGCD.js → JBL7IRTU.js} +2 -2
  62. package/dist/cdn/JPLKNPQA.js +4 -0
  63. package/dist/cdn/{Z4ZNKWSQ.js → JRDM5MDJ.js} +2 -2
  64. package/dist/cdn/{6KAI6YXC.js → JZCLD3KO.js} +2 -2
  65. package/dist/cdn/{E6EE4TT7.js → K7HCPE2N.js} +1 -1
  66. package/dist/cdn/{ZV44DXHW.js → KKGH2C3Z.js} +2 -2
  67. package/dist/cdn/{E77FQK43.js → L4DKFMF5.js} +2 -2
  68. package/dist/cdn/{47WXI5OV.js → LIYKJGIW.js} +2 -2
  69. package/dist/cdn/{42ZLP4TO.js → MV7VWEYM.js} +2 -2
  70. package/dist/cdn/{IBKAQQBC.js → N4ZIWHV3.js} +2 -2
  71. package/dist/cdn/{R63E5IDP.js → NPNSCUQO.js} +2 -2
  72. package/dist/cdn/{OBPKMGHI.js → O356CRDT.js} +2 -2
  73. package/dist/cdn/{X7Q6FQWN.js → OEXDVI45.js} +2 -2
  74. package/dist/cdn/{JPZTEH2M.js → OMHCZ2JB.js} +2 -2
  75. package/dist/cdn/{D6KJDF5I.js → OTNIXMGB.js} +2 -2
  76. package/dist/cdn/{5IGCHT4A.js → OTUHRWHR.js} +2 -2
  77. package/dist/cdn/{Z5VECA2W.js → OU5G2DJR.js} +2 -2
  78. package/dist/cdn/{ARSEOYQC.js → OVOEHU54.js} +2 -2
  79. package/dist/cdn/{BGVGYLIS.js → P7L7BDYD.js} +2 -2
  80. package/dist/cdn/PHWCCAQ2.js +4 -0
  81. package/dist/cdn/PSDSRTPJ.js +4 -0
  82. package/dist/cdn/{BTB5CEYG.js → PTDXUPZF.js} +2 -2
  83. package/dist/cdn/{BL6FEQUL.js → PW2HC2NU.js} +1 -1
  84. package/dist/cdn/{UJWLDNQL.js → PZ4RMX6S.js} +2 -2
  85. package/dist/cdn/{QDLWV3GL.js → Q73PVO5W.js} +2 -2
  86. package/dist/cdn/{7CVQJHEU.js → QAA6DTB4.js} +2 -2
  87. package/dist/cdn/{L3FVC43E.js → QEHF2KLL.js} +2 -2
  88. package/dist/cdn/{FPQAF5U2.js → QQB4P4ZC.js} +2 -2
  89. package/dist/cdn/{NBZE6Q5O.js → QRMDO65V.js} +1 -1
  90. package/dist/cdn/{HDHYECZP.js → QUJG3MRO.js} +1 -1
  91. package/dist/cdn/{YM2YPJK6.js → QZYW5VJZ.js} +2 -2
  92. package/dist/cdn/{OPRL4XLU.js → RN5XSBBC.js} +2 -2
  93. package/dist/cdn/{2Z4KRGOJ.js → RYHE2Z3B.js} +1 -1
  94. package/dist/cdn/{PVCZG5NR.js → SRAVTPGX.js} +2 -2
  95. package/dist/cdn/{DH3QB5M5.js → SSM2TMFU.js} +2 -2
  96. package/dist/cdn/T27TN2ZA.js +4 -0
  97. package/dist/cdn/{QTUCLDNK.js → TCVH3XKB.js} +1 -1
  98. package/dist/cdn/{QS6PLBTH.js → TJECRHFL.js} +2 -2
  99. package/dist/cdn/{ZF2Y2DMS.js → TR2YSPHO.js} +2 -2
  100. package/dist/cdn/{LE6LUZKM.js → TZVXJLRY.js} +2 -2
  101. package/dist/cdn/{YF5TCRIS.js → UCBVSKFA.js} +2 -2
  102. package/dist/cdn/{WXDH6ABX.js → UCT65SQB.js} +2 -2
  103. package/dist/cdn/UEZ5YQ3H.js +4 -0
  104. package/dist/cdn/{BBUM7LXZ.js → UWRMR7WR.js} +2 -2
  105. package/dist/cdn/{QWVS3J6Z.js → VF6QOAJ5.js} +2 -2
  106. package/dist/cdn/{54LBYLM4.js → VS4AYNWU.js} +2 -2
  107. package/dist/cdn/{2DFTJYET.js → WABX3KLG.js} +2 -2
  108. package/dist/cdn/{6YEXM7GA.js → WGIICTQ3.js} +2 -2
  109. package/dist/cdn/{HRAFJUBY.js → WRQSDQRN.js} +2 -2
  110. package/dist/cdn/{Y6UM5JRX.js → XBYMLIMK.js} +2 -2
  111. package/dist/cdn/{YXTLBEV3.js → XCTEMILF.js} +2 -2
  112. package/dist/cdn/{2ITL25LA.js → XGYPWURU.js} +2 -2
  113. package/dist/cdn/{DXPQND6H.js → XI675RK3.js} +2 -2
  114. package/dist/cdn/XYQWQY4J.js +4 -0
  115. package/dist/cdn/{TV675TMD.js → YWYJIIEX.js} +2 -2
  116. package/dist/cdn/{MSGRPQLQ.js → Z5F4NJ2I.js} +2 -2
  117. package/dist/cdn/ZCA755OW.js +4 -0
  118. package/dist/cdn/{FMX5JKGL.js → ZI53EUJK.js} +2 -2
  119. package/dist/cdn/{OSL33XSZ.js → ZU62IMDO.js} +2 -2
  120. package/dist/cdn/{V2GGQDQV.js → ZV376OBS.js} +2 -2
  121. package/dist/cdn/index.js +2 -2
  122. package/dist/cdn/main.css +1 -1
  123. package/dist/chunks/AnalysisViewModel.js +1 -1
  124. package/dist/chunks/async-utils.js +1 -1
  125. package/dist/chunks/basemap-gallery-resources.js +1 -1
  126. package/dist/chunks/component-utils.js +1 -1
  127. package/dist/chunks/createCloseEvent.js +1 -1
  128. package/dist/chunks/globalCss.js +1 -1
  129. package/dist/chunks/heading.js +1 -1
  130. package/dist/chunks/layer-list.js +1 -1
  131. package/dist/chunks/legacyIcon.js +1 -1
  132. package/dist/chunks/maybe.js +1 -1
  133. package/dist/chunks/measurementUtils.js +1 -1
  134. package/dist/chunks/runtime.js +1 -1
  135. package/dist/chunks/useHandles.js +1 -1
  136. package/dist/chunks/useT9n.js +1 -1
  137. package/dist/chunks/useView.js +1 -1
  138. package/dist/chunks/useViewModel.js +1 -1
  139. package/dist/chunks/useWidget.js +1 -1
  140. package/dist/chunks/utils.js +1 -1
  141. package/dist/components/arcgis-area-measurement-2d/customElement.js +1 -1
  142. package/dist/components/arcgis-area-measurement-3d/customElement.d.ts +2 -2
  143. package/dist/components/arcgis-area-measurement-3d/customElement.js +3 -6
  144. package/dist/components/arcgis-attachments/customElement.js +1 -1
  145. package/dist/components/arcgis-basemap-gallery/customElement.d.ts +5 -1
  146. package/dist/components/arcgis-basemap-gallery/customElement.js +1 -1
  147. package/dist/components/arcgis-basemap-gallery-item/customElement.js +1 -1
  148. package/dist/components/arcgis-basemap-layer-list/customElement.js +1 -1
  149. package/dist/components/arcgis-basemap-toggle/customElement.d.ts +5 -1
  150. package/dist/components/arcgis-basemap-toggle/customElement.js +1 -1
  151. package/dist/components/arcgis-bookmarks/customElement.js +1 -1
  152. package/dist/components/arcgis-building-explorer/customElement.js +1 -1
  153. package/dist/components/arcgis-catalog-layer-list/customElement.js +1 -1
  154. package/dist/components/arcgis-compass/customElement.d.ts +5 -1
  155. package/dist/components/arcgis-compass/customElement.js +1 -1
  156. package/dist/components/arcgis-coordinate-conversion/customElement.d.ts +1 -1
  157. package/dist/components/arcgis-coordinate-conversion/customElement.js +3 -3
  158. package/dist/components/arcgis-daylight/customElement.js +1 -1
  159. package/dist/components/arcgis-direct-line-measurement-3d/customElement.d.ts +2 -2
  160. package/dist/components/arcgis-direct-line-measurement-3d/customElement.js +3 -6
  161. package/dist/components/arcgis-directional-pad/customElement.d.ts +5 -1
  162. package/dist/components/arcgis-directional-pad/customElement.js +1 -1
  163. package/dist/components/arcgis-directions/customElement.js +1 -1
  164. package/dist/components/arcgis-distance-measurement-2d/customElement.js +1 -1
  165. package/dist/components/arcgis-editor/customElement.js +1 -1
  166. package/dist/components/arcgis-elevation-profile/customElement.js +1 -1
  167. package/dist/components/arcgis-expand/customElement.d.ts +2 -1
  168. package/dist/components/arcgis-expand/customElement.js +1 -1
  169. package/dist/components/arcgis-feature/customElement.js +1 -1
  170. package/dist/components/arcgis-feature-content/customElement.d.ts +25 -0
  171. package/dist/components/arcgis-feature-content/customElement.js +92 -0
  172. package/dist/components/arcgis-feature-content/index.d.ts +2 -0
  173. package/dist/components/arcgis-feature-content/index.js +2 -0
  174. package/dist/components/arcgis-feature-form/customElement.js +1 -1
  175. package/dist/components/arcgis-feature-table/customElement.js +1 -1
  176. package/dist/components/arcgis-feature-templates/customElement.js +1 -1
  177. package/dist/components/arcgis-features/customElement.js +1 -1
  178. package/dist/components/arcgis-floor-filter/customElement.js +1 -1
  179. package/dist/components/arcgis-fullscreen/customElement.d.ts +11 -1
  180. package/dist/components/arcgis-fullscreen/customElement.js +1 -1
  181. package/dist/components/arcgis-grid-controls/customElement.d.ts +5 -1
  182. package/dist/components/arcgis-grid-controls/customElement.js +1 -1
  183. package/dist/components/arcgis-histogram-range-slider/customElement.js +1 -1
  184. package/dist/components/arcgis-home/customElement.d.ts +18 -12
  185. package/dist/components/arcgis-home/customElement.js +1 -1
  186. package/dist/components/arcgis-labeled-switch/customElement.js +1 -1
  187. package/dist/components/arcgis-layer-list/customElement.js +1 -1
  188. package/dist/components/arcgis-layer-list-item/customElement.js +1 -1
  189. package/dist/components/arcgis-legend/customElement.js +1 -1
  190. package/dist/components/arcgis-line-of-sight/customElement.d.ts +6 -3
  191. package/dist/components/arcgis-line-of-sight/customElement.js +9 -12
  192. package/dist/components/arcgis-link-chart/customElement.d.ts +24 -7
  193. package/dist/components/arcgis-link-chart/customElement.js +14 -5
  194. package/dist/components/arcgis-link-chart-layout-switcher/customElement.d.ts +8 -3
  195. package/dist/components/arcgis-link-chart-layout-switcher/customElement.js +1 -1
  196. package/dist/components/arcgis-locate/customElement.d.ts +5 -1
  197. package/dist/components/arcgis-locate/customElement.js +1 -1
  198. package/dist/components/arcgis-map/customElement.d.ts +27 -9
  199. package/dist/components/arcgis-map/customElement.js +25 -14
  200. package/dist/components/arcgis-measurement/customElement.js +1 -1
  201. package/dist/components/arcgis-measurement-content/customElement.js +1 -1
  202. package/dist/components/arcgis-navigation-toggle/customElement.d.ts +5 -1
  203. package/dist/components/arcgis-navigation-toggle/customElement.js +1 -1
  204. package/dist/components/arcgis-oriented-imagery-viewer/customElement.js +1 -1
  205. package/dist/components/arcgis-placement/customElement.js +1 -1
  206. package/dist/components/arcgis-print/customElement.d.ts +52 -34
  207. package/dist/components/arcgis-print/customElement.js +1 -1
  208. package/dist/components/arcgis-print-custom-text-elements/customElement.js +1 -1
  209. package/dist/components/arcgis-print-dpi-input/customElement.js +1 -1
  210. package/dist/components/arcgis-print-export-button/customElement.js +1 -1
  211. package/dist/components/arcgis-print-exported-link/customElement.js +1 -1
  212. package/dist/components/arcgis-print-exports-panel/customElement.js +1 -1
  213. package/dist/components/arcgis-print-format-select/customElement.js +1 -1
  214. package/dist/components/arcgis-print-layout-advanced-options/customElement.js +1 -1
  215. package/dist/components/arcgis-print-layout-panel/customElement.js +1 -1
  216. package/dist/components/arcgis-print-main-panel/customElement.js +1 -1
  217. package/dist/components/arcgis-print-map-only-advanced-options/customElement.js +1 -1
  218. package/dist/components/arcgis-print-map-only-panel/customElement.js +1 -1
  219. package/dist/components/arcgis-print-out-spatial-reference-input/customElement.js +1 -1
  220. package/dist/components/arcgis-print-preview-input/customElement.js +1 -1
  221. package/dist/components/arcgis-print-scale-section/customElement.js +1 -1
  222. package/dist/components/arcgis-print-template-select/customElement.js +1 -1
  223. package/dist/components/arcgis-print-template-selector/customElement.js +1 -1
  224. package/dist/components/arcgis-scale-bar/customElement.d.ts +6 -2
  225. package/dist/components/arcgis-scale-bar/customElement.js +1 -1
  226. package/dist/components/arcgis-scale-range-slider/customElement.js +1 -1
  227. package/dist/components/arcgis-scene/customElement.d.ts +29 -9
  228. package/dist/components/arcgis-scene/customElement.js +23 -12
  229. package/dist/components/arcgis-search/customElement.d.ts +40 -15
  230. package/dist/components/arcgis-search/customElement.js +39 -36
  231. package/dist/components/arcgis-search-result-renderer/customElement.js +1 -1
  232. package/dist/components/arcgis-shadow-cast/customElement.js +1 -1
  233. package/dist/components/arcgis-sketch/customElement.js +1 -1
  234. package/dist/components/arcgis-slice/customElement.d.ts +8 -3
  235. package/dist/components/arcgis-slice/customElement.js +1 -1
  236. package/dist/components/arcgis-slider/customElement.js +1 -1
  237. package/dist/components/arcgis-swipe/customElement.d.ts +6 -2
  238. package/dist/components/arcgis-swipe/customElement.js +1 -1
  239. package/dist/components/arcgis-table-list/customElement.js +1 -1
  240. package/dist/components/arcgis-time-slider/customElement.js +1 -1
  241. package/dist/components/arcgis-time-zone-label/customElement.d.ts +3 -1
  242. package/dist/components/arcgis-time-zone-label/customElement.js +1 -1
  243. package/dist/components/arcgis-track/customElement.d.ts +6 -2
  244. package/dist/components/arcgis-track/customElement.js +1 -1
  245. package/dist/components/arcgis-unit-select/customElement.d.ts +5 -1
  246. package/dist/components/arcgis-unit-select/customElement.js +1 -1
  247. package/dist/components/arcgis-utility-network-associations/customElement.js +1 -1
  248. package/dist/components/arcgis-utility-network-trace/customElement.js +1 -1
  249. package/dist/components/arcgis-utility-network-validate-topology/customElement.js +1 -1
  250. package/dist/components/arcgis-value-picker/customElement.js +1 -1
  251. package/dist/components/arcgis-version-management/customElement.d.ts +9 -5
  252. package/dist/components/arcgis-version-management/customElement.js +1 -1
  253. package/dist/components/arcgis-version-management-service-item/customElement.js +1 -1
  254. package/dist/components/arcgis-version-management-version-item/customElement.js +1 -1
  255. package/dist/components/arcgis-version-management-version-list/customElement.js +1 -1
  256. package/dist/components/arcgis-version-management-version-properties/customElement.js +1 -1
  257. package/dist/components/arcgis-video/customElement.d.ts +20 -9
  258. package/dist/components/arcgis-video/customElement.js +10 -19
  259. package/dist/components/arcgis-video-player/customElement.d.ts +18 -5
  260. package/dist/components/arcgis-video-player/customElement.js +32 -26
  261. package/dist/components/arcgis-video-player-action-bar/customElement.js +1 -1
  262. package/dist/components/arcgis-video-player-actions-group/customElement.js +1 -1
  263. package/dist/components/arcgis-video-player-controls-group/customElement.js +12 -12
  264. package/dist/components/arcgis-video-player-metadata/customElement.js +2 -2
  265. package/dist/components/arcgis-video-player-settings/customElement.js +2 -2
  266. package/dist/components/arcgis-video-player-slider/customElement.js +1 -1
  267. package/dist/components/arcgis-weather/customElement.d.ts +5 -1
  268. package/dist/components/arcgis-weather/customElement.js +1 -1
  269. package/dist/components/arcgis-zoom/customElement.d.ts +5 -1
  270. package/dist/components/arcgis-zoom/customElement.js +1 -1
  271. package/dist/docs/api.json +746 -233
  272. package/dist/docs/docs.json +666 -223
  273. package/dist/docs/vscode.html-custom-data.json +71 -32
  274. package/dist/docs/web-types.json +188 -100
  275. package/dist/index.d.ts +19 -0
  276. package/dist/index.js +1 -1
  277. package/dist/loader.js +9 -8
  278. package/dist/types/lumina.d.ts +17 -11
  279. package/dist/types/preact.d.ts +18 -11
  280. package/dist/types/react.d.ts +19 -11
  281. package/dist/types/stencil.d.ts +17 -11
  282. package/dist/utils/feature-utils.d.ts +10 -0
  283. package/package.json +3 -3
  284. package/dist/cdn/4B65IRU5.js +0 -4
  285. package/dist/cdn/4WJ66SFY.js +0 -4
  286. package/dist/cdn/6X652SXL.js +0 -4
  287. package/dist/cdn/DNMZ4O6N.js +0 -4
  288. package/dist/cdn/HP3N5VUA.js +0 -4
  289. package/dist/cdn/NR7JLVJV.js +0 -4
  290. package/dist/cdn/NTUHH5NA.js +0 -4
  291. package/dist/cdn/OZTG4AFE.js +0 -4
  292. package/dist/cdn/XLHDAUF2.js +0 -4
  293. package/dist/cdn/ZB452APZ.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.2",
4
+ "version": "4.34.0-next.21",
5
5
  "description-markup": "markdown",
6
6
  "contributions": {
7
7
  "html": {
@@ -271,6 +271,7 @@
271
271
  "properties": [
272
272
  {
273
273
  "name": "analysis",
274
+ "description": "Analysis data object.",
274
275
  "type": "AreaMeasurementAnalysis"
275
276
  },
276
277
  {
@@ -709,7 +710,7 @@
709
710
  },
710
711
  {
711
712
  "name": "messageOverrides",
712
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
713
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
713
714
  "type": "Record<string, unknown>"
714
715
  },
715
716
  {
@@ -1331,7 +1332,7 @@
1331
1332
  },
1332
1333
  {
1333
1334
  "name": "messageOverrides",
1334
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
1335
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
1335
1336
  "type": "Record<string, unknown>"
1336
1337
  },
1337
1338
  {
@@ -2348,7 +2349,7 @@
2348
2349
  },
2349
2350
  {
2350
2351
  "name": "messageOverrides",
2351
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
2352
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
2352
2353
  "type": "Record<string, unknown>"
2353
2354
  },
2354
2355
  {
@@ -2413,14 +2414,14 @@
2413
2414
  }
2414
2415
  },
2415
2416
  {
2416
- "name": "hide-edit-button",
2417
+ "name": "hide-expand-button",
2417
2418
  "default": "false",
2418
2419
  "value": {
2419
2420
  "type": "boolean"
2420
2421
  }
2421
2422
  },
2422
2423
  {
2423
- "name": "hide-expand-button",
2424
+ "name": "hide-input-button",
2424
2425
  "default": "false",
2425
2426
  "value": {
2426
2427
  "type": "boolean"
@@ -2583,11 +2584,11 @@
2583
2584
  "type": "boolean"
2584
2585
  },
2585
2586
  {
2586
- "name": "hideEditButton",
2587
+ "name": "hideExpandButton",
2587
2588
  "type": "boolean"
2588
2589
  },
2589
2590
  {
2590
- "name": "hideExpandButton",
2591
+ "name": "hideInputButton",
2591
2592
  "type": "boolean"
2592
2593
  },
2593
2594
  {
@@ -3078,7 +3079,7 @@
3078
3079
  },
3079
3080
  {
3080
3081
  "name": "messageOverrides",
3081
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
3082
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
3082
3083
  "type": "Record<string, unknown>"
3083
3084
  },
3084
3085
  {
@@ -3486,6 +3487,7 @@
3486
3487
  "properties": [
3487
3488
  {
3488
3489
  "name": "analysis",
3490
+ "description": "Analysis data object.",
3489
3491
  "type": "DirectLineMeasurementAnalysis"
3490
3492
  },
3491
3493
  {
@@ -3640,6 +3642,7 @@
3640
3642
  "properties": [
3641
3643
  {
3642
3644
  "name": "analysis",
3645
+ "description": "Analysis data object.",
3643
3646
  "type": "DirectLineMeasurementAnalysis"
3644
3647
  },
3645
3648
  {
@@ -4431,7 +4434,7 @@
4431
4434
  },
4432
4435
  {
4433
4436
  "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>`",
4437
+ "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
4438
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/",
4436
4439
  "attributes": [
4437
4440
  {
@@ -4986,6 +4989,56 @@
4986
4989
  ]
4987
4990
  }
4988
4991
  },
4992
+ {
4993
+ "name": "arcgis-feature-content",
4994
+ "description": "### 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.",
4995
+ "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-content/",
4996
+ "attributes": [
4997
+ {
4998
+ "name": "auto-destroy-disabled",
4999
+ "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-feature-content/#destroy) method when you are done to\nprevent memory leaks.",
5000
+ "default": "false",
5001
+ "value": {
5002
+ "type": "boolean"
5003
+ }
5004
+ }
5005
+ ],
5006
+ "events": [
5007
+ {
5008
+ "name": "arcgisReady",
5009
+ "type": "void",
5010
+ "description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
5011
+ }
5012
+ ],
5013
+ "js": {
5014
+ "properties": [
5015
+ {
5016
+ "name": "autoDestroyDisabled",
5017
+ "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-feature-content/#destroy) method when you are done to\nprevent memory leaks.",
5018
+ "type": "boolean"
5019
+ },
5020
+ {
5021
+ "name": "creator",
5022
+ "type": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))"
5023
+ },
5024
+ {
5025
+ "name": "destroyer",
5026
+ "type": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))"
5027
+ },
5028
+ {
5029
+ "name": "graphic",
5030
+ "type": "Graphic"
5031
+ }
5032
+ ],
5033
+ "events": [
5034
+ {
5035
+ "name": "arcgisReady",
5036
+ "type": "void",
5037
+ "description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
5038
+ }
5039
+ ]
5040
+ }
5041
+ },
4989
5042
  {
4990
5043
  "name": "arcgis-feature-form",
4991
5044
  "description": "### 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- **arcgisSubmit**\n- **arcgisValueChange** - Fires when a field value is updated.\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- `getValues(): Promise<any>` - Returns all of the field values, regardless of update status.\n- `submit(): Promise<void>` - Fires the submit event.",
@@ -6974,7 +7027,7 @@
6974
7027
  },
6975
7028
  {
6976
7029
  "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.",
7030
+ "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
7031
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-fullscreen/",
6979
7032
  "attributes": [
6980
7033
  {
@@ -7045,7 +7098,7 @@
7045
7098
  },
7046
7099
  {
7047
7100
  "name": "messageOverrides",
7048
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
7101
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
7049
7102
  "type": "Record<string, unknown>"
7050
7103
  },
7051
7104
  {
@@ -7443,7 +7496,7 @@
7443
7496
  },
7444
7497
  {
7445
7498
  "name": "messageOverrides",
7446
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
7499
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
7447
7500
  "type": "Record<string, unknown>"
7448
7501
  },
7449
7502
  {
@@ -7884,7 +7937,7 @@
7884
7937
  },
7885
7938
  {
7886
7939
  "name": "messageOverrides",
7887
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
7940
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
7888
7941
  "type": "Record<string, unknown>"
7889
7942
  },
7890
7943
  {
@@ -7902,7 +7955,7 @@
7902
7955
  },
7903
7956
  {
7904
7957
  "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.",
7958
+ "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
7959
  "type": "Viewpoint"
7907
7960
  }
7908
7961
  ],
@@ -8644,7 +8697,7 @@
8644
8697
  },
8645
8698
  {
8646
8699
  "name": "messageOverrides",
8647
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
8700
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
8648
8701
  "type": "Record<string, unknown>"
8649
8702
  },
8650
8703
  {
@@ -8677,7 +8730,7 @@
8677
8730
  },
8678
8731
  {
8679
8732
  "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.",
8733
+ "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
8734
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/",
8682
8735
  "attributes": [
8683
8736
  {
@@ -8931,9 +8984,14 @@
8931
8984
  "description": "A rejected view indicates a fatal error making it unable to display.",
8932
8985
  "type": "Error"
8933
8986
  },
8987
+ {
8988
+ "name": "focusAreas",
8989
+ "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)",
8990
+ "type": "FocusAreas"
8991
+ },
8934
8992
  {
8935
8993
  "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```",
8994
+ "description": "Allows for adding graphics directly to the default graphics in the View.",
8937
8995
  "type": "Collection<Graphic>"
8938
8996
  },
8939
8997
  {
@@ -9308,7 +9366,7 @@
9308
9366
  },
9309
9367
  {
9310
9368
  "name": "messageOverrides",
9311
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
9369
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
9312
9370
  "type": "Record<string, unknown>"
9313
9371
  },
9314
9372
  {
@@ -9492,7 +9550,7 @@
9492
9550
  },
9493
9551
  {
9494
9552
  "name": "messageOverrides",
9495
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
9553
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
9496
9554
  "type": "Record<string, unknown>"
9497
9555
  },
9498
9556
  {
@@ -9542,7 +9600,7 @@
9542
9600
  },
9543
9601
  {
9544
9602
  "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.",
9603
+ "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 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
9604
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/",
9547
9605
  "attributes": [
9548
9606
  {
@@ -9808,6 +9866,11 @@
9808
9866
  "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.",
9809
9867
  "type": "Collection<string>"
9810
9868
  },
9869
+ {
9870
+ "name": "focusAreas",
9871
+ "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)",
9872
+ "type": "FocusAreas"
9873
+ },
9811
9874
  {
9812
9875
  "name": "gamepad",
9813
9876
  "description": "Gamepad input specific configuration settings.",
@@ -9815,7 +9878,7 @@
9815
9878
  },
9816
9879
  {
9817
9880
  "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```",
9881
+ "description": "Allows for adding graphics directly to the default graphics in the View.",
9819
9882
  "type": "Collection<Graphic>"
9820
9883
  },
9821
9884
  {
@@ -10374,7 +10437,7 @@
10374
10437
  },
10375
10438
  {
10376
10439
  "name": "messageOverrides",
10377
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
10440
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
10378
10441
  "type": "Record<string, unknown>"
10379
10442
  },
10380
10443
  {
@@ -10727,7 +10790,7 @@
10727
10790
  },
10728
10791
  {
10729
10792
  "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.",
10793
+ "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
10794
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-print/",
10732
10795
  "attributes": [
10733
10796
  {
@@ -10740,6 +10803,7 @@
10740
10803
  },
10741
10804
  {
10742
10805
  "name": "allowed-formats-for-saving",
10806
+ "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
10807
  "value": {
10744
10808
  "type": "\"all\""
10745
10809
  }
@@ -10785,7 +10849,7 @@
10785
10849
  },
10786
10850
  {
10787
10851
  "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.",
10852
+ "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
10853
  "default": "3",
10790
10854
  "value": {
10791
10855
  "type": [
@@ -10800,6 +10864,7 @@
10800
10864
  },
10801
10865
  {
10802
10866
  "name": "hide-header",
10867
+ "description": "Indicates whether the component's header is hidden.",
10803
10868
  "default": "false",
10804
10869
  "value": {
10805
10870
  "type": "boolean"
@@ -10822,6 +10887,7 @@
10822
10887
  },
10823
10888
  {
10824
10889
  "name": "position",
10890
+ "description": "The UI position of a component.",
10825
10891
  "default": "\"top-left\"",
10826
10892
  "value": {
10827
10893
  "type": [
@@ -10839,20 +10905,21 @@
10839
10905
  },
10840
10906
  {
10841
10907
  "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.",
10908
+ "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
10909
  "value": {
10844
10910
  "type": "string"
10845
10911
  }
10846
10912
  },
10847
10913
  {
10848
10914
  "name": "reference-element",
10915
+ "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
10916
  "value": {
10850
10917
  "type": "string"
10851
10918
  }
10852
10919
  },
10853
10920
  {
10854
10921
  "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.",
10922
+ "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
10923
  "default": "false",
10857
10924
  "value": {
10858
10925
  "type": "boolean"
@@ -10860,7 +10927,7 @@
10860
10927
  },
10861
10928
  {
10862
10929
  "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)",
10930
+ "description": "The state of the Print component.",
10864
10931
  "default": "\"disabled\"",
10865
10932
  "value": {
10866
10933
  "type": [
@@ -10875,7 +10942,8 @@
10875
10942
  "events": [
10876
10943
  {
10877
10944
  "name": "arcgisComplete",
10878
- "type": "{ link: FileLink; }"
10945
+ "type": "{ link: FileLink; }",
10946
+ "description": "Emitted when the component is complete."
10879
10947
  },
10880
10948
  {
10881
10949
  "name": "arcgisPropertyChange",
@@ -10889,7 +10957,8 @@
10889
10957
  },
10890
10958
  {
10891
10959
  "name": "arcgisSubmit",
10892
- "type": "{ link: FileLink; }"
10960
+ "type": "{ link: FileLink; }",
10961
+ "description": "Emitted when the component is submitted."
10893
10962
  }
10894
10963
  ],
10895
10964
  "js": {
@@ -10901,6 +10970,7 @@
10901
10970
  },
10902
10971
  {
10903
10972
  "name": "allowedFormatsForSaving",
10973
+ "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
10974
  "type": "\"all\" | Array<string>"
10905
10975
  },
10906
10976
  {
@@ -10929,7 +10999,7 @@
10929
10999
  },
10930
11000
  {
10931
11001
  "name": "exportedLinks",
10932
- "description": "The collection of links exported from the Print widget.",
11002
+ "description": "The collection of links exported from the Print component.",
10933
11003
  "type": "Collection<FileLink>"
10934
11004
  },
10935
11005
  {
@@ -10939,11 +11009,12 @@
10939
11009
  },
10940
11010
  {
10941
11011
  "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.",
11012
+ "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
11013
  "type": "1 | 2 | 3 | 4 | 5 | 6"
10944
11014
  },
10945
11015
  {
10946
11016
  "name": "hideHeader",
11017
+ "description": "Indicates whether the component's header is hidden.",
10947
11018
  "type": "boolean"
10948
11019
  },
10949
11020
  {
@@ -10958,30 +11029,32 @@
10958
11029
  },
10959
11030
  {
10960
11031
  "name": "messageOverrides",
10961
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
11032
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
10962
11033
  "type": "Record<string, unknown>"
10963
11034
  },
10964
11035
  {
10965
11036
  "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)",
11037
+ "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
11038
  "type": "SpatialReference"
10968
11039
  },
10969
11040
  {
10970
11041
  "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.",
11042
+ "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
11043
  "type": "Portal"
10973
11044
  },
10974
11045
  {
10975
11046
  "name": "position",
11047
+ "description": "The UI position of a component.",
10976
11048
  "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
10977
11049
  },
10978
11050
  {
10979
11051
  "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.",
11052
+ "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
11053
  "type": "string"
10982
11054
  },
10983
11055
  {
10984
11056
  "name": "referenceElement",
11057
+ "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
11058
  "type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
10986
11059
  },
10987
11060
  {
@@ -10990,29 +11063,30 @@
10990
11063
  },
10991
11064
  {
10992
11065
  "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.",
11066
+ "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
11067
  "type": "boolean"
10995
11068
  },
10996
11069
  {
10997
11070
  "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)",
11071
+ "description": "The state of the Print component.",
10999
11072
  "type": "\"disabled\" | \"error\" | \"initializing\" | \"ready\""
11000
11073
  },
11001
11074
  {
11002
11075
  "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.",
11076
+ "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
11077
  "type": "{\n [x: string]: Array<HashMap<string>> | undefined;\n}"
11005
11078
  },
11006
11079
  {
11007
11080
  "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.",
11081
+ "description": "Defines the layout template options used by the Print component to generate the print page.",
11009
11082
  "type": "TemplateOptions"
11010
11083
  }
11011
11084
  ],
11012
11085
  "events": [
11013
11086
  {
11014
11087
  "name": "arcgisComplete",
11015
- "type": "{ link: FileLink; }"
11088
+ "type": "{ link: FileLink; }",
11089
+ "description": "Emitted when the component is complete."
11016
11090
  },
11017
11091
  {
11018
11092
  "name": "arcgisPropertyChange",
@@ -11026,14 +11100,15 @@
11026
11100
  },
11027
11101
  {
11028
11102
  "name": "arcgisSubmit",
11029
- "type": "{ link: FileLink; }"
11103
+ "type": "{ link: FileLink; }",
11104
+ "description": "Emitted when the component is submitted."
11030
11105
  }
11031
11106
  ]
11032
11107
  }
11033
11108
  },
11034
11109
  {
11035
11110
  "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.",
11111
+ "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
11112
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-bar/",
11038
11113
  "attributes": [
11039
11114
  {
@@ -11136,7 +11211,7 @@
11136
11211
  },
11137
11212
  {
11138
11213
  "name": "messageOverrides",
11139
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
11214
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
11140
11215
  "type": "Record<string, unknown>"
11141
11216
  },
11142
11217
  {
@@ -11405,7 +11480,7 @@
11405
11480
  },
11406
11481
  {
11407
11482
  "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)",
11483
+ "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```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](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```js\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```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
11484
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/",
11410
11485
  "attributes": [
11411
11486
  {
@@ -11550,7 +11625,7 @@
11550
11625
  {
11551
11626
  "name": "arcgisViewClick",
11552
11627
  "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)"
11628
+ "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
11629
  },
11555
11630
  {
11556
11631
  "name": "arcgisViewDoubleClick",
@@ -11635,7 +11710,7 @@
11635
11710
  {
11636
11711
  "name": "arcgisViewReadyChange",
11637
11712
  "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```"
11713
+ "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```js\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```"
11639
11714
  }
11640
11715
  ],
11641
11716
  "js": {
@@ -11735,6 +11810,11 @@
11735
11810
  "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
11811
  "type": "Collection<string>"
11737
11812
  },
11813
+ {
11814
+ "name": "focusAreas",
11815
+ "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)",
11816
+ "type": "FocusAreas"
11817
+ },
11738
11818
  {
11739
11819
  "name": "gamepad",
11740
11820
  "description": "Gamepad input specific configuration settings.",
@@ -11742,7 +11822,7 @@
11742
11822
  },
11743
11823
  {
11744
11824
  "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```",
11825
+ "description": "Allows for adding graphics directly to the default graphics in the view.",
11746
11826
  "type": "Collection<Graphic>"
11747
11827
  },
11748
11828
  {
@@ -11905,7 +11985,7 @@
11905
11985
  {
11906
11986
  "name": "arcgisViewClick",
11907
11987
  "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)"
11988
+ "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
11989
  },
11910
11990
  {
11911
11991
  "name": "arcgisViewDoubleClick",
@@ -11990,14 +12070,14 @@
11990
12070
  {
11991
12071
  "name": "arcgisViewReadyChange",
11992
12072
  "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```"
12073
+ "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```js\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```"
11994
12074
  }
11995
12075
  ]
11996
12076
  }
11997
12077
  },
11998
12078
  {
11999
12079
  "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.",
12080
+ "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
12081
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/",
12002
12082
  "attributes": [
12003
12083
  {
@@ -12037,9 +12117,9 @@
12037
12117
  }
12038
12118
  },
12039
12119
  {
12040
- "name": "auto-select",
12120
+ "name": "auto-select-disabled",
12041
12121
  "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",
12122
+ "default": "false",
12043
12123
  "value": {
12044
12124
  "type": "boolean"
12045
12125
  }
@@ -12061,9 +12141,9 @@
12061
12141
  }
12062
12142
  },
12063
12143
  {
12064
- "name": "include-default-sources",
12144
+ "name": "include-default-sources-disabled",
12065
12145
  "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",
12146
+ "default": "false",
12067
12147
  "value": {
12068
12148
  "type": "boolean"
12069
12149
  }
@@ -12076,9 +12156,9 @@
12076
12156
  }
12077
12157
  },
12078
12158
  {
12079
- "name": "location-enabled",
12159
+ "name": "location-disabled",
12080
12160
  "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",
12161
+ "default": "false",
12082
12162
  "value": {
12083
12163
  "type": "boolean"
12084
12164
  }
@@ -12108,9 +12188,9 @@
12108
12188
  }
12109
12189
  },
12110
12190
  {
12111
- "name": "popup-enabled",
12191
+ "name": "popup-disabled",
12112
12192
  "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",
12193
+ "default": "false",
12114
12194
  "value": {
12115
12195
  "type": "boolean"
12116
12196
  }
@@ -12139,17 +12219,17 @@
12139
12219
  }
12140
12220
  },
12141
12221
  {
12142
- "name": "result-graphic-enabled",
12222
+ "name": "result-graphic-disabled",
12143
12223
  "description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
12144
- "default": "true",
12224
+ "default": "false",
12145
12225
  "value": {
12146
12226
  "type": "boolean"
12147
12227
  }
12148
12228
  },
12149
12229
  {
12150
- "name": "search-all-enabled",
12230
+ "name": "search-all-disabled",
12151
12231
  "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",
12232
+ "default": "false",
12153
12233
  "value": {
12154
12234
  "type": "boolean"
12155
12235
  }
@@ -12175,9 +12255,9 @@
12175
12255
  }
12176
12256
  },
12177
12257
  {
12178
- "name": "suggestions-enabled",
12258
+ "name": "suggestions-disabled",
12179
12259
  "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",
12260
+ "default": "false",
12181
12261
  "value": {
12182
12262
  "type": "boolean"
12183
12263
  }
@@ -12258,7 +12338,7 @@
12258
12338
  "type": "boolean"
12259
12339
  },
12260
12340
  {
12261
- "name": "autoSelect",
12341
+ "name": "autoSelectDisabled",
12262
12342
  "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
12343
  "type": "boolean"
12264
12344
  },
@@ -12283,7 +12363,7 @@
12283
12363
  "type": "string"
12284
12364
  },
12285
12365
  {
12286
- "name": "includeDefaultSources",
12366
+ "name": "includeDefaultSourcesDisabled",
12287
12367
  "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
12368
  "type": "Function | boolean"
12289
12369
  },
@@ -12293,7 +12373,7 @@
12293
12373
  "type": "string"
12294
12374
  },
12295
12375
  {
12296
- "name": "locationEnabled",
12376
+ "name": "locationDisabled",
12297
12377
  "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
12378
  "type": "boolean"
12299
12379
  },
@@ -12309,7 +12389,7 @@
12309
12389
  },
12310
12390
  {
12311
12391
  "name": "messageOverrides",
12312
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
12392
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
12313
12393
  "type": "Record<string, unknown>"
12314
12394
  },
12315
12395
  {
@@ -12318,7 +12398,7 @@
12318
12398
  "type": "number"
12319
12399
  },
12320
12400
  {
12321
- "name": "popupEnabled",
12401
+ "name": "popupDisabled",
12322
12402
  "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
12403
  "type": "boolean"
12324
12404
  },
@@ -12346,7 +12426,7 @@
12346
12426
  "type": "Graphic"
12347
12427
  },
12348
12428
  {
12349
- "name": "resultGraphicEnabled",
12429
+ "name": "resultGraphicDisabled",
12350
12430
  "description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
12351
12431
  "type": "boolean"
12352
12432
  },
@@ -12356,7 +12436,7 @@
12356
12436
  "type": "Array<SearchResults>"
12357
12437
  },
12358
12438
  {
12359
- "name": "searchAllEnabled",
12439
+ "name": "searchAllDisabled",
12360
12440
  "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
12441
  "type": "boolean"
12362
12442
  },
@@ -12386,7 +12466,7 @@
12386
12466
  "type": "Array<SuggestResults>"
12387
12467
  },
12388
12468
  {
12389
- "name": "suggestionsEnabled",
12469
+ "name": "suggestionsDisabled",
12390
12470
  "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
12471
  "type": "boolean"
12392
12472
  }
@@ -13499,7 +13579,7 @@
13499
13579
  },
13500
13580
  {
13501
13581
  "name": "messageOverrides",
13502
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
13582
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
13503
13583
  "type": "Record<string, unknown>"
13504
13584
  },
13505
13585
  {
@@ -13512,7 +13592,7 @@
13512
13592
  },
13513
13593
  {
13514
13594
  "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```",
13595
+ "description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a plane.",
13516
13596
  "type": "SlicePlane"
13517
13597
  },
13518
13598
  {
@@ -13980,7 +14060,7 @@
13980
14060
  },
13981
14061
  {
13982
14062
  "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.",
14063
+ "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
14064
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/",
13985
14065
  "attributes": [
13986
14066
  {
@@ -14141,7 +14221,7 @@
14141
14221
  },
14142
14222
  {
14143
14223
  "name": "messageOverrides",
14144
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
14224
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
14145
14225
  "type": "Record<string, unknown>"
14146
14226
  },
14147
14227
  {
@@ -14909,7 +14989,7 @@
14909
14989
  },
14910
14990
  {
14911
14991
  "name": "messageOverrides",
14912
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
14992
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
14913
14993
  "type": "Record<string, unknown>"
14914
14994
  },
14915
14995
  {
@@ -14942,7 +15022,7 @@
14942
15022
  },
14943
15023
  {
14944
15024
  "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>`",
15025
+ "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>`",
14946
15026
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-track/",
14947
15027
  "attributes": [
14948
15028
  {
@@ -15109,7 +15189,7 @@
15109
15189
  },
15110
15190
  {
15111
15191
  "name": "messageOverrides",
15112
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
15192
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
15113
15193
  "type": "Record<string, unknown>"
15114
15194
  },
15115
15195
  {
@@ -16393,7 +16473,7 @@
16393
16473
  },
16394
16474
  {
16395
16475
  "name": "page-size",
16396
- "description": "Specifies the number of versions displayed on each page of the Version Management Component.",
16476
+ "description": "Specifies the number of versions displayed on each page of the Version Management component.",
16397
16477
  "default": "5",
16398
16478
  "value": {
16399
16479
  "type": "number"
@@ -16469,7 +16549,7 @@
16469
16549
  },
16470
16550
  {
16471
16551
  "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.",
16552
+ "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
16553
  "type": "Array<{\n url: string;\n name: string;\n}>"
16474
16554
  },
16475
16555
  {
@@ -16478,7 +16558,7 @@
16478
16558
  },
16479
16559
  {
16480
16560
  "name": "messageOverrides",
16481
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
16561
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
16482
16562
  "type": "Record<string, unknown>"
16483
16563
  },
16484
16564
  {
@@ -16487,7 +16567,7 @@
16487
16567
  },
16488
16568
  {
16489
16569
  "name": "pageSize",
16490
- "description": "Specifies the number of versions displayed on each page of the Version Management Component.",
16570
+ "description": "Specifies the number of versions displayed on each page of the Version Management component.",
16491
16571
  "type": "number"
16492
16572
  },
16493
16573
  {
@@ -16505,7 +16585,7 @@
16505
16585
  },
16506
16586
  {
16507
16587
  "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.",
16588
+ "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
16589
  "type": "Collection<VersioningState>"
16510
16590
  }
16511
16591
  ],
@@ -16524,7 +16604,7 @@
16524
16604
  },
16525
16605
  {
16526
16606
  "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.",
16607
+ "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
16608
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/",
16529
16609
  "attributes": [
16530
16610
  {
@@ -16533,12 +16613,6 @@
16533
16613
  "value": {
16534
16614
  "type": "boolean"
16535
16615
  }
16536
- },
16537
- {
16538
- "name": "layer-url",
16539
- "value": {
16540
- "type": "string"
16541
- }
16542
16616
  }
16543
16617
  ],
16544
16618
  "events": [
@@ -16558,10 +16632,6 @@
16558
16632
  "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
16633
  "type": "VideoLayer"
16560
16634
  },
16561
- {
16562
- "name": "layerUrl",
16563
- "type": "string"
16564
- },
16565
16635
  {
16566
16636
  "name": "ready",
16567
16637
  "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 +16653,7 @@
16583
16653
  },
16584
16654
  {
16585
16655
  "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.",
16656
+ "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
16657
  "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/",
16588
16658
  "attributes": [
16589
16659
  {
@@ -16594,6 +16664,19 @@
16594
16664
  "type": "boolean"
16595
16665
  }
16596
16666
  },
16667
+ {
16668
+ "name": "following-mode",
16669
+ "description": "Determines which telemetry elements to follow when the video layer is playing.",
16670
+ "default": "\"follow-both\"",
16671
+ "value": {
16672
+ "type": [
16673
+ "\"follow-both\"",
16674
+ "\"follow-frame\"",
16675
+ "\"follow-sensor\"",
16676
+ "\"none\""
16677
+ ]
16678
+ }
16679
+ },
16597
16680
  {
16598
16681
  "name": "hide-header",
16599
16682
  "description": "Indicates whether to display the video player's header information.",
@@ -16680,6 +16763,11 @@
16680
16763
  "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
16764
  "type": "boolean"
16682
16765
  },
16766
+ {
16767
+ "name": "followingMode",
16768
+ "description": "Determines which telemetry elements to follow when the video layer is playing.",
16769
+ "type": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\""
16770
+ },
16683
16771
  {
16684
16772
  "name": "hideHeader",
16685
16773
  "description": "Indicates whether to display the video player's header information.",
@@ -16702,7 +16790,7 @@
16702
16790
  },
16703
16791
  {
16704
16792
  "name": "messageOverrides",
16705
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
16793
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
16706
16794
  "type": "Record<string, unknown>"
16707
16795
  },
16708
16796
  {
@@ -16865,7 +16953,7 @@
16865
16953
  },
16866
16954
  {
16867
16955
  "name": "messageOverrides",
16868
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
16956
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
16869
16957
  "type": "Record<string, unknown>"
16870
16958
  },
16871
16959
  {
@@ -17006,7 +17094,7 @@
17006
17094
  },
17007
17095
  {
17008
17096
  "name": "messageOverrides",
17009
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
17097
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
17010
17098
  "type": "Record<string, unknown>"
17011
17099
  },
17012
17100
  {