@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,8 +1,8 @@
1
1
  {
2
- "timestamp": "2025-05-24T05:01:09",
2
+ "timestamp": "2025-06-10T04:47:59",
3
3
  "compiler": {
4
4
  "name": "@arcgis/lumina-compiler",
5
- "version": "4.34.0-next.2",
5
+ "version": "4.34.0-next.21",
6
6
  "typescriptVersion": "5.8.3"
7
7
  },
8
8
  "schemaVersion": "1.0.0",
@@ -98,7 +98,7 @@
98
98
  "docsTags": [
99
99
  {
100
100
  "name": "example",
101
- "text": "const arcgisAreaMeasurement2d = document.createElement(\"arcgis-area-measurement-2d\");\ndocument.body.append(arcgisAreaMeasurement2d);\narcgisAreaMeasurement2d.componentOnReady().then(() => {\n console.log(\"arcgis-area-measurement-2d is ready to go!\");\n});"
101
+ "text": "```js\nconst arcgisAreaMeasurement2d = document.createElement(\"arcgis-area-measurement-2d\");\ndocument.body.append(arcgisAreaMeasurement2d);\narcgisAreaMeasurement2d.componentOnReady().then(() => {\n console.log(\"arcgis-area-measurement-2d is ready to go!\");\n});\n```"
102
102
  }
103
103
  ]
104
104
  },
@@ -675,6 +675,7 @@
675
675
  {
676
676
  "kind": "field",
677
677
  "name": "analysis",
678
+ "description": "Analysis data object.",
678
679
  "type": {
679
680
  "text": "AreaMeasurementAnalysis",
680
681
  "references": [
@@ -687,8 +688,7 @@
687
688
  "end": 23
688
689
  }
689
690
  ]
690
- },
691
- "readonly": true
691
+ }
692
692
  },
693
693
  {
694
694
  "kind": "field",
@@ -752,7 +752,7 @@
752
752
  "docsTags": [
753
753
  {
754
754
  "name": "example",
755
- "text": "const arcgisAreaMeasurement3d = document.createElement(\"arcgis-area-measurement-3d\");\ndocument.body.append(arcgisAreaMeasurement3d);\narcgisAreaMeasurement3d.componentOnReady().then(() => {\n console.log(\"arcgis-area-measurement-3d is ready to go!\");\n});"
755
+ "text": "```js\nconst arcgisAreaMeasurement3d = document.createElement(\"arcgis-area-measurement-3d\");\ndocument.body.append(arcgisAreaMeasurement3d);\narcgisAreaMeasurement3d.componentOnReady().then(() => {\n console.log(\"arcgis-area-measurement-3d is ready to go!\");\n});\n```"
756
756
  }
757
757
  ]
758
758
  },
@@ -1364,7 +1364,7 @@
1364
1364
  "docsTags": [
1365
1365
  {
1366
1366
  "name": "example",
1367
- "text": "const arcgisAttachments = document.createElement(\"arcgis-attachments\");\ndocument.body.append(arcgisAttachments);\narcgisAttachments.componentOnReady().then(() => {\n console.log(\"arcgis-attachments is ready to go!\");\n});"
1367
+ "text": "```js\nconst arcgisAttachments = document.createElement(\"arcgis-attachments\");\ndocument.body.append(arcgisAttachments);\narcgisAttachments.componentOnReady().then(() => {\n console.log(\"arcgis-attachments is ready to go!\");\n});\n```"
1368
1368
  }
1369
1369
  ]
1370
1370
  },
@@ -2091,7 +2091,7 @@
2091
2091
  "docsTags": [
2092
2092
  {
2093
2093
  "name": "example",
2094
- "text": "const arcgisBasemapGallery = document.createElement(\"arcgis-basemap-gallery\");\ndocument.body.append(arcgisBasemapGallery);\narcgisBasemapGallery.componentOnReady().then(() => {\n console.log(\"arcgis-basemap-gallery is ready to go!\");\n});"
2094
+ "text": "```js\nconst arcgisBasemapGallery = document.createElement(\"arcgis-basemap-gallery\");\ndocument.body.append(arcgisBasemapGallery);\narcgisBasemapGallery.componentOnReady().then(() => {\n console.log(\"arcgis-basemap-gallery is ready to go!\");\n});\n```"
2095
2095
  }
2096
2096
  ]
2097
2097
  },
@@ -2207,7 +2207,7 @@
2207
2207
  {
2208
2208
  "kind": "field",
2209
2209
  "name": "messageOverrides",
2210
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
2210
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
2211
2211
  "type": {
2212
2212
  "text": "Record<string, unknown>"
2213
2213
  }
@@ -2807,7 +2807,7 @@
2807
2807
  "docsTags": [
2808
2808
  {
2809
2809
  "name": "example",
2810
- "text": "const arcgisBasemapLayerList = document.createElement(\"arcgis-basemap-layer-list\");\ndocument.body.append(arcgisBasemapLayerList);\narcgisBasemapLayerList.componentOnReady().then(() => {\n console.log(\"arcgis-basemap-layer-list is ready to go!\");\n});"
2810
+ "text": "```js\nconst arcgisBasemapLayerList = document.createElement(\"arcgis-basemap-layer-list\");\ndocument.body.append(arcgisBasemapLayerList);\narcgisBasemapLayerList.componentOnReady().then(() => {\n console.log(\"arcgis-basemap-layer-list is ready to go!\");\n});\n```"
2811
2811
  }
2812
2812
  ]
2813
2813
  },
@@ -3949,7 +3949,7 @@
3949
3949
  "docsTags": [
3950
3950
  {
3951
3951
  "name": "example",
3952
- "text": "const arcgisBasemapToggle = document.createElement(\"arcgis-basemap-toggle\");\ndocument.body.append(arcgisBasemapToggle);\narcgisBasemapToggle.componentOnReady().then(() => {\n console.log(\"arcgis-basemap-toggle is ready to go!\");\n});"
3952
+ "text": "```js\nconst arcgisBasemapToggle = document.createElement(\"arcgis-basemap-toggle\");\ndocument.body.append(arcgisBasemapToggle);\narcgisBasemapToggle.componentOnReady().then(() => {\n console.log(\"arcgis-basemap-toggle is ready to go!\");\n});\n```"
3953
3953
  }
3954
3954
  ]
3955
3955
  },
@@ -4012,7 +4012,7 @@
4012
4012
  {
4013
4013
  "kind": "field",
4014
4014
  "name": "messageOverrides",
4015
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
4015
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
4016
4016
  "type": {
4017
4017
  "text": "Record<string, unknown>"
4018
4018
  }
@@ -4506,7 +4506,7 @@
4506
4506
  "docsTags": [
4507
4507
  {
4508
4508
  "name": "example",
4509
- "text": "const arcgisBookmarks = document.createElement(\"arcgis-bookmarks\");\ndocument.body.append(arcgisBookmarks);\narcgisBookmarks.componentOnReady().then(() => {\n console.log(\"arcgis-bookmarks is ready to go!\");\n});"
4509
+ "text": "```js\nconst arcgisBookmarks = document.createElement(\"arcgis-bookmarks\");\ndocument.body.append(arcgisBookmarks);\narcgisBookmarks.componentOnReady().then(() => {\n console.log(\"arcgis-bookmarks is ready to go!\");\n});\n```"
4510
4510
  }
4511
4511
  ]
4512
4512
  },
@@ -5364,7 +5364,7 @@
5364
5364
  "docsTags": [
5365
5365
  {
5366
5366
  "name": "example",
5367
- "text": "const arcgisBuildingExplorer = document.createElement(\"arcgis-building-explorer\");\ndocument.body.append(arcgisBuildingExplorer);\narcgisBuildingExplorer.componentOnReady().then(() => {\n console.log(\"arcgis-building-explorer is ready to go!\");\n});"
5367
+ "text": "```js\nconst arcgisBuildingExplorer = document.createElement(\"arcgis-building-explorer\");\ndocument.body.append(arcgisBuildingExplorer);\narcgisBuildingExplorer.componentOnReady().then(() => {\n console.log(\"arcgis-building-explorer is ready to go!\");\n});\n```"
5368
5368
  }
5369
5369
  ]
5370
5370
  },
@@ -6034,7 +6034,7 @@
6034
6034
  "docsTags": [
6035
6035
  {
6036
6036
  "name": "example",
6037
- "text": "const arcgisCatalogLayerList = document.createElement(\"arcgis-catalog-layer-list\");\ndocument.body.append(arcgisCatalogLayerList);\narcgisCatalogLayerList.componentOnReady().then(() => {\n console.log(\"arcgis-catalog-layer-list is ready to go!\");\n});"
6037
+ "text": "```js\nconst arcgisCatalogLayerList = document.createElement(\"arcgis-catalog-layer-list\");\ndocument.body.append(arcgisCatalogLayerList);\narcgisCatalogLayerList.componentOnReady().then(() => {\n console.log(\"arcgis-catalog-layer-list is ready to go!\");\n});\n```"
6038
6038
  }
6039
6039
  ]
6040
6040
  },
@@ -6964,7 +6964,7 @@
6964
6964
  "docsTags": [
6965
6965
  {
6966
6966
  "name": "example",
6967
- "text": "const arcgisCompass = document.createElement(\"arcgis-compass\");\ndocument.body.append(arcgisCompass);\narcgisCompass.componentOnReady().then(() => {\n console.log(\"arcgis-compass is ready to go!\");\n});"
6967
+ "text": "```js\nconst arcgisCompass = document.createElement(\"arcgis-compass\");\ndocument.body.append(arcgisCompass);\narcgisCompass.componentOnReady().then(() => {\n console.log(\"arcgis-compass is ready to go!\");\n});\n```"
6968
6968
  }
6969
6969
  ]
6970
6970
  },
@@ -7040,7 +7040,7 @@
7040
7040
  {
7041
7041
  "kind": "field",
7042
7042
  "name": "messageOverrides",
7043
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
7043
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
7044
7044
  "type": {
7045
7045
  "text": "Record<string, unknown>"
7046
7046
  }
@@ -7429,7 +7429,7 @@
7429
7429
  "docsTags": [
7430
7430
  {
7431
7431
  "name": "example",
7432
- "text": "const arcgisCoordinateConversion = document.createElement(\"arcgis-coordinate-conversion\");\ndocument.body.append(arcgisCoordinateConversion);\narcgisCoordinateConversion.componentOnReady().then(() => {\n console.log(\"arcgis-coordinate-conversion is ready to go!\");\n});"
7432
+ "text": "```js\nconst arcgisCoordinateConversion = document.createElement(\"arcgis-coordinate-conversion\");\ndocument.body.append(arcgisCoordinateConversion);\narcgisCoordinateConversion.componentOnReady().then(() => {\n console.log(\"arcgis-coordinate-conversion is ready to go!\");\n});\n```"
7433
7433
  }
7434
7434
  ]
7435
7435
  },
@@ -7571,7 +7571,7 @@
7571
7571
  },
7572
7572
  {
7573
7573
  "kind": "field",
7574
- "name": "hideEditButton",
7574
+ "name": "hideExpandButton",
7575
7575
  "type": {
7576
7576
  "text": "boolean",
7577
7577
  "values": [
@@ -7581,11 +7581,11 @@
7581
7581
  ]
7582
7582
  },
7583
7583
  "default": "false",
7584
- "attribute": "hide-edit-button"
7584
+ "attribute": "hide-expand-button"
7585
7585
  },
7586
7586
  {
7587
7587
  "kind": "field",
7588
- "name": "hideExpandButton",
7588
+ "name": "hideInputButton",
7589
7589
  "type": {
7590
7590
  "text": "boolean",
7591
7591
  "values": [
@@ -7595,7 +7595,7 @@
7595
7595
  ]
7596
7596
  },
7597
7597
  "default": "false",
7598
- "attribute": "hide-expand-button"
7598
+ "attribute": "hide-input-button"
7599
7599
  },
7600
7600
  {
7601
7601
  "kind": "field",
@@ -8016,7 +8016,7 @@
8016
8016
  "fieldName": "hideCaptureButton"
8017
8017
  },
8018
8018
  {
8019
- "name": "hide-edit-button",
8019
+ "name": "hide-expand-button",
8020
8020
  "type": {
8021
8021
  "text": "boolean",
8022
8022
  "values": [
@@ -8026,10 +8026,10 @@
8026
8026
  ]
8027
8027
  },
8028
8028
  "default": "false",
8029
- "fieldName": "hideEditButton"
8029
+ "fieldName": "hideExpandButton"
8030
8030
  },
8031
8031
  {
8032
- "name": "hide-expand-button",
8032
+ "name": "hide-input-button",
8033
8033
  "type": {
8034
8034
  "text": "boolean",
8035
8035
  "values": [
@@ -8039,7 +8039,7 @@
8039
8039
  ]
8040
8040
  },
8041
8041
  "default": "false",
8042
- "fieldName": "hideExpandButton"
8042
+ "fieldName": "hideInputButton"
8043
8043
  },
8044
8044
  {
8045
8045
  "name": "hide-settings-button",
@@ -8351,7 +8351,7 @@
8351
8351
  "docsTags": [
8352
8352
  {
8353
8353
  "name": "example",
8354
- "text": "const arcgisDaylight = document.createElement(\"arcgis-daylight\");\ndocument.body.append(arcgisDaylight);\narcgisDaylight.componentOnReady().then(() => {\n console.log(\"arcgis-daylight is ready to go!\");\n});"
8354
+ "text": "```js\nconst arcgisDaylight = document.createElement(\"arcgis-daylight\");\ndocument.body.append(arcgisDaylight);\narcgisDaylight.componentOnReady().then(() => {\n console.log(\"arcgis-daylight is ready to go!\");\n});\n```"
8355
8355
  }
8356
8356
  ]
8357
8357
  },
@@ -9121,7 +9121,7 @@
9121
9121
  "docsTags": [
9122
9122
  {
9123
9123
  "name": "example",
9124
- "text": "const arcgisDirectionalPad = document.createElement(\"arcgis-directional-pad\");\ndocument.body.append(arcgisDirectionalPad);\narcgisDirectionalPad.componentOnReady().then(() => {\n console.log(\"arcgis-directional-pad is ready to go!\");\n});"
9124
+ "text": "```js\nconst arcgisDirectionalPad = document.createElement(\"arcgis-directional-pad\");\ndocument.body.append(arcgisDirectionalPad);\narcgisDirectionalPad.componentOnReady().then(() => {\n console.log(\"arcgis-directional-pad is ready to go!\");\n});\n```"
9125
9125
  }
9126
9126
  ]
9127
9127
  },
@@ -9214,7 +9214,7 @@
9214
9214
  {
9215
9215
  "kind": "field",
9216
9216
  "name": "messageOverrides",
9217
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
9217
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
9218
9218
  "type": {
9219
9219
  "text": "Record<string, unknown>"
9220
9220
  }
@@ -9708,7 +9708,7 @@
9708
9708
  "docsTags": [
9709
9709
  {
9710
9710
  "name": "example",
9711
- "text": "const arcgisDirections = document.createElement(\"arcgis-directions\");\ndocument.body.append(arcgisDirections);\narcgisDirections.componentOnReady().then(() => {\n console.log(\"arcgis-directions is ready to go!\");\n});"
9711
+ "text": "```js\nconst arcgisDirections = document.createElement(\"arcgis-directions\");\ndocument.body.append(arcgisDirections);\narcgisDirections.componentOnReady().then(() => {\n console.log(\"arcgis-directions is ready to go!\");\n});\n```"
9712
9712
  }
9713
9713
  ]
9714
9714
  },
@@ -10624,6 +10624,7 @@
10624
10624
  {
10625
10625
  "kind": "field",
10626
10626
  "name": "analysis",
10627
+ "description": "Analysis data object.",
10627
10628
  "type": {
10628
10629
  "text": "DirectLineMeasurementAnalysis",
10629
10630
  "references": [
@@ -10636,8 +10637,7 @@
10636
10637
  "end": 29
10637
10638
  }
10638
10639
  ]
10639
- },
10640
- "readonly": true
10640
+ }
10641
10641
  },
10642
10642
  {
10643
10643
  "kind": "field",
@@ -10701,7 +10701,7 @@
10701
10701
  "docsTags": [
10702
10702
  {
10703
10703
  "name": "example",
10704
- "text": "const arcgisDirectLineMeasurement3d = document.createElement(\"arcgis-direct-line-measurement-3d\");\ndocument.body.append(arcgisDirectLineMeasurement3d);\narcgisDirectLineMeasurement3d.componentOnReady().then(() => {\n console.log(\"arcgis-direct-line-measurement-3d is ready to go!\");\n});"
10704
+ "text": "```js\nconst arcgisDirectLineMeasurement3d = document.createElement(\"arcgis-direct-line-measurement-3d\");\ndocument.body.append(arcgisDirectLineMeasurement3d);\narcgisDirectLineMeasurement3d.componentOnReady().then(() => {\n console.log(\"arcgis-direct-line-measurement-3d is ready to go!\");\n});\n```"
10705
10705
  }
10706
10706
  ]
10707
10707
  },
@@ -11214,6 +11214,7 @@
11214
11214
  {
11215
11215
  "kind": "field",
11216
11216
  "name": "analysis",
11217
+ "description": "Analysis data object.",
11217
11218
  "type": {
11218
11219
  "text": "DirectLineMeasurementAnalysis",
11219
11220
  "references": [
@@ -11227,7 +11228,6 @@
11227
11228
  }
11228
11229
  ]
11229
11230
  },
11230
- "readonly": true,
11231
11231
  "inheritedFrom": {
11232
11232
  "name": "ArcgisDirectLineMeasurement3d",
11233
11233
  "module": "components/arcgis-direct-line-measurement-3d"
@@ -11303,7 +11303,7 @@
11303
11303
  "docsTags": [
11304
11304
  {
11305
11305
  "name": "example",
11306
- "text": "const deprecatedArcgisDirectLineMeasurement3d = document.createElement(\"arcgis-directline-measurement-3d\");\ndocument.body.append(deprecatedArcgisDirectLineMeasurement3d);\ndeprecatedArcgisDirectLineMeasurement3d.componentOnReady().then(() => {\n console.log(\"arcgis-directline-measurement-3d is ready to go!\");\n});"
11306
+ "text": "```js\nconst deprecatedArcgisDirectLineMeasurement3d = document.createElement(\"arcgis-directline-measurement-3d\");\ndocument.body.append(deprecatedArcgisDirectLineMeasurement3d);\ndeprecatedArcgisDirectLineMeasurement3d.componentOnReady().then(() => {\n console.log(\"arcgis-directline-measurement-3d is ready to go!\");\n});\n```"
11307
11307
  }
11308
11308
  ]
11309
11309
  },
@@ -11971,7 +11971,7 @@
11971
11971
  "docsTags": [
11972
11972
  {
11973
11973
  "name": "example",
11974
- "text": "const arcgisDistanceMeasurement2d = document.createElement(\"arcgis-distance-measurement-2d\");\ndocument.body.append(arcgisDistanceMeasurement2d);\narcgisDistanceMeasurement2d.componentOnReady().then(() => {\n console.log(\"arcgis-distance-measurement-2d is ready to go!\");\n});"
11974
+ "text": "```js\nconst arcgisDistanceMeasurement2d = document.createElement(\"arcgis-distance-measurement-2d\");\ndocument.body.append(arcgisDistanceMeasurement2d);\narcgisDistanceMeasurement2d.componentOnReady().then(() => {\n console.log(\"arcgis-distance-measurement-2d is ready to go!\");\n});\n```"
11975
11975
  }
11976
11976
  ]
11977
11977
  },
@@ -12629,7 +12629,7 @@
12629
12629
  "docsTags": [
12630
12630
  {
12631
12631
  "name": "example",
12632
- "text": "const arcgisEditor = document.createElement(\"arcgis-editor\");\ndocument.body.append(arcgisEditor);\narcgisEditor.componentOnReady().then(() => {\n console.log(\"arcgis-editor is ready to go!\");\n});"
12632
+ "text": "```js\nconst arcgisEditor = document.createElement(\"arcgis-editor\");\ndocument.body.append(arcgisEditor);\narcgisEditor.componentOnReady().then(() => {\n console.log(\"arcgis-editor is ready to go!\");\n});\n```"
12633
12633
  }
12634
12634
  ]
12635
12635
  },
@@ -13692,7 +13692,7 @@
13692
13692
  "docsTags": [
13693
13693
  {
13694
13694
  "name": "example",
13695
- "text": "const arcgisElevationProfile = document.createElement(\"arcgis-elevation-profile\");\ndocument.body.append(arcgisElevationProfile);\narcgisElevationProfile.componentOnReady().then(() => {\n console.log(\"arcgis-elevation-profile is ready to go!\");\n});"
13695
+ "text": "```js\nconst arcgisElevationProfile = document.createElement(\"arcgis-elevation-profile\");\ndocument.body.append(arcgisElevationProfile);\narcgisElevationProfile.componentOnReady().then(() => {\n console.log(\"arcgis-elevation-profile is ready to go!\");\n});\n```"
13696
13696
  }
13697
13697
  ]
13698
13698
  },
@@ -14645,15 +14645,19 @@
14645
14645
  "customElement": true,
14646
14646
  "name": "ArcgisExpand",
14647
14647
  "tagName": "arcgis-expand",
14648
- "description": "The Expand component acts as a clickable button for opening content.",
14648
+ "description": "The Expand component acts as a clickable button for displaying interactive content, most commonly other components.",
14649
14649
  "demos": [
14650
14650
  {
14651
14651
  "description": "Docs",
14652
14652
  "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/"
14653
14653
  },
14654
14654
  {
14655
- "description": "Demo",
14656
- "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--demo&singleStory=true"
14655
+ "description": "Expand with Custom Content\nThe Expand component with custom content. The content must be wrapped in a [Placement](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-placement/) component.",
14656
+ "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--custom-content&singleStory=true"
14657
+ },
14658
+ {
14659
+ "description": "Expand with Component Content\nThe Expand component with the [Basemap Gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) component.",
14660
+ "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--component-content&singleStory=true"
14657
14661
  }
14658
14662
  ],
14659
14663
  "superclass": {
@@ -14798,7 +14802,7 @@
14798
14802
  "docsTags": [
14799
14803
  {
14800
14804
  "name": "example",
14801
- "text": "const arcgisExpand = document.createElement(\"arcgis-expand\");\ndocument.body.append(arcgisExpand);\narcgisExpand.componentOnReady().then(() => {\n console.log(\"arcgis-expand is ready to go!\");\n});"
14805
+ "text": "```js\nconst arcgisExpand = document.createElement(\"arcgis-expand\");\ndocument.body.append(arcgisExpand);\narcgisExpand.componentOnReady().then(() => {\n console.log(\"arcgis-expand is ready to go!\");\n});\n```"
14802
14806
  }
14803
14807
  ]
14804
14808
  },
@@ -14902,7 +14906,13 @@
14902
14906
  ]
14903
14907
  },
14904
14908
  "default": "false",
14905
- "attribute": "focus-trap-disabled"
14909
+ "attribute": "focus-trap-disabled",
14910
+ "docsTags": [
14911
+ {
14912
+ "name": "since",
14913
+ "text": "4.33"
14914
+ }
14915
+ ]
14906
14916
  },
14907
14917
  {
14908
14918
  "kind": "field",
@@ -15645,7 +15655,7 @@
15645
15655
  "docsTags": [
15646
15656
  {
15647
15657
  "name": "example",
15648
- "text": "const arcgisFeature = document.createElement(\"arcgis-feature\");\ndocument.body.append(arcgisFeature);\narcgisFeature.componentOnReady().then(() => {\n console.log(\"arcgis-feature is ready to go!\");\n});"
15658
+ "text": "```js\nconst arcgisFeature = document.createElement(\"arcgis-feature\");\ndocument.body.append(arcgisFeature);\narcgisFeature.componentOnReady().then(() => {\n console.log(\"arcgis-feature is ready to go!\");\n});\n```"
15649
15659
  }
15650
15660
  ]
15651
15661
  },
@@ -16492,6 +16502,166 @@
16492
16502
  }
16493
16503
  ]
16494
16504
  },
16505
+ {
16506
+ "kind": "javascript-module",
16507
+ "path": "src/components/feature-content/feature-content.tsx",
16508
+ "declarations": [
16509
+ {
16510
+ "kind": "class",
16511
+ "customElement": true,
16512
+ "name": "ArcgisFeatureContent",
16513
+ "tagName": "arcgis-feature-content",
16514
+ "demos": [
16515
+ {
16516
+ "description": "Docs",
16517
+ "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-content/"
16518
+ }
16519
+ ],
16520
+ "superclass": {
16521
+ "name": "LitElement",
16522
+ "package": "@arcgis/lumina"
16523
+ },
16524
+ "encapsulation": "none",
16525
+ "pascalCaseName": "ArcgisFeatureContent",
16526
+ "importPath": "components/arcgis-feature-content",
16527
+ "members": [
16528
+ {
16529
+ "kind": "field",
16530
+ "name": "autoDestroyDisabled",
16531
+ "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.",
16532
+ "type": {
16533
+ "text": "boolean",
16534
+ "values": [
16535
+ {
16536
+ "type": "boolean"
16537
+ }
16538
+ ]
16539
+ },
16540
+ "default": "false",
16541
+ "attribute": "auto-destroy-disabled"
16542
+ },
16543
+ {
16544
+ "kind": "method",
16545
+ "name": "componentOnReady",
16546
+ "return": {
16547
+ "type": {
16548
+ "text": "Promise<void>",
16549
+ "references": [
16550
+ {
16551
+ "module": "lib/lib.es5.d.ts",
16552
+ "name": "Promise",
16553
+ "package": "typescript",
16554
+ "start": 0,
16555
+ "end": 7
16556
+ }
16557
+ ]
16558
+ }
16559
+ },
16560
+ "description": "Create a promise that resolves once component is fully loaded.",
16561
+ "signature": "(): Promise<void>",
16562
+ "async": true,
16563
+ "inheritedFrom": {
16564
+ "name": "LitElement",
16565
+ "package": "@arcgis/lumina"
16566
+ },
16567
+ "docsTags": [
16568
+ {
16569
+ "name": "example",
16570
+ "text": "```js\nconst arcgisFeatureContent = document.createElement(\"arcgis-feature-content\");\ndocument.body.append(arcgisFeatureContent);\narcgisFeatureContent.componentOnReady().then(() => {\n console.log(\"arcgis-feature-content is ready to go!\");\n});\n```"
16571
+ }
16572
+ ]
16573
+ },
16574
+ {
16575
+ "kind": "field",
16576
+ "name": "creator",
16577
+ "type": {
16578
+ "text": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))"
16579
+ }
16580
+ },
16581
+ {
16582
+ "kind": "method",
16583
+ "name": "destroy",
16584
+ "description": "Permanently destroy the component.",
16585
+ "return": {
16586
+ "type": {
16587
+ "text": "Promise<void>",
16588
+ "references": [
16589
+ {
16590
+ "name": "Promise",
16591
+ "package": "typescript",
16592
+ "module": "lib/lib.es5.d.ts",
16593
+ "start": 0,
16594
+ "end": 7
16595
+ }
16596
+ ]
16597
+ }
16598
+ },
16599
+ "signature": "(): Promise<void>",
16600
+ "async": true
16601
+ },
16602
+ {
16603
+ "kind": "field",
16604
+ "name": "destroyer",
16605
+ "type": {
16606
+ "text": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))"
16607
+ }
16608
+ },
16609
+ {
16610
+ "kind": "field",
16611
+ "name": "graphic",
16612
+ "type": {
16613
+ "text": "Graphic",
16614
+ "references": [
16615
+ {
16616
+ "name": "Graphic",
16617
+ "package": "@arcgis/core",
16618
+ "module": "interfaces.d.ts",
16619
+ "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html",
16620
+ "start": 0,
16621
+ "end": 7
16622
+ }
16623
+ ]
16624
+ }
16625
+ }
16626
+ ],
16627
+ "attributes": [
16628
+ {
16629
+ "name": "auto-destroy-disabled",
16630
+ "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.",
16631
+ "type": {
16632
+ "text": "boolean",
16633
+ "values": [
16634
+ {
16635
+ "type": "boolean"
16636
+ }
16637
+ ]
16638
+ },
16639
+ "default": "false",
16640
+ "fieldName": "autoDestroyDisabled"
16641
+ }
16642
+ ],
16643
+ "events": [
16644
+ {
16645
+ "name": "arcgisReady",
16646
+ "description": "Emitted when the component associated with a map or scene view is is ready to be interacted with.",
16647
+ "type": {
16648
+ "text": "void"
16649
+ }
16650
+ }
16651
+ ]
16652
+ }
16653
+ ],
16654
+ "exports": [
16655
+ {
16656
+ "kind": "custom-element-definition",
16657
+ "name": "arcgis-feature-content",
16658
+ "declaration": {
16659
+ "name": "ArcgisFeatureContent",
16660
+ "module": "src/components/feature-content/feature-content.tsx"
16661
+ }
16662
+ }
16663
+ ]
16664
+ },
16495
16665
  {
16496
16666
  "kind": "javascript-module",
16497
16667
  "path": "src/components/feature-form/feature-form.tsx",
@@ -16561,7 +16731,7 @@
16561
16731
  "docsTags": [
16562
16732
  {
16563
16733
  "name": "example",
16564
- "text": "const arcgisFeatureForm = document.createElement(\"arcgis-feature-form\");\ndocument.body.append(arcgisFeatureForm);\narcgisFeatureForm.componentOnReady().then(() => {\n console.log(\"arcgis-feature-form is ready to go!\");\n});"
16734
+ "text": "```js\nconst arcgisFeatureForm = document.createElement(\"arcgis-feature-form\");\ndocument.body.append(arcgisFeatureForm);\narcgisFeatureForm.componentOnReady().then(() => {\n console.log(\"arcgis-feature-form is ready to go!\");\n});\n```"
16565
16735
  }
16566
16736
  ]
16567
16737
  },
@@ -17592,7 +17762,7 @@
17592
17762
  "docsTags": [
17593
17763
  {
17594
17764
  "name": "example",
17595
- "text": "const arcgisFeatureTable = document.createElement(\"arcgis-feature-table\");\ndocument.body.append(arcgisFeatureTable);\narcgisFeatureTable.componentOnReady().then(() => {\n console.log(\"arcgis-feature-table is ready to go!\");\n});"
17765
+ "text": "```js\nconst arcgisFeatureTable = document.createElement(\"arcgis-feature-table\");\ndocument.body.append(arcgisFeatureTable);\narcgisFeatureTable.componentOnReady().then(() => {\n console.log(\"arcgis-feature-table is ready to go!\");\n});\n```"
17596
17766
  }
17597
17767
  ]
17598
17768
  },
@@ -20720,7 +20890,7 @@
20720
20890
  "docsTags": [
20721
20891
  {
20722
20892
  "name": "example",
20723
- "text": "const arcgisFeatureTemplates = document.createElement(\"arcgis-feature-templates\");\ndocument.body.append(arcgisFeatureTemplates);\narcgisFeatureTemplates.componentOnReady().then(() => {\n console.log(\"arcgis-feature-templates is ready to go!\");\n});"
20893
+ "text": "```js\nconst arcgisFeatureTemplates = document.createElement(\"arcgis-feature-templates\");\ndocument.body.append(arcgisFeatureTemplates);\narcgisFeatureTemplates.componentOnReady().then(() => {\n console.log(\"arcgis-feature-templates is ready to go!\");\n});\n```"
20724
20894
  }
20725
20895
  ]
20726
20896
  },
@@ -21522,7 +21692,7 @@
21522
21692
  "docsTags": [
21523
21693
  {
21524
21694
  "name": "example",
21525
- "text": "const arcgisFeatures = document.createElement(\"arcgis-features\");\ndocument.body.append(arcgisFeatures);\narcgisFeatures.componentOnReady().then(() => {\n console.log(\"arcgis-features is ready to go!\");\n});"
21695
+ "text": "```js\nconst arcgisFeatures = document.createElement(\"arcgis-features\");\ndocument.body.append(arcgisFeatures);\narcgisFeatures.componentOnReady().then(() => {\n console.log(\"arcgis-features is ready to go!\");\n});\n```"
21526
21696
  }
21527
21697
  ]
21528
21698
  },
@@ -22869,7 +23039,7 @@
22869
23039
  "docsTags": [
22870
23040
  {
22871
23041
  "name": "example",
22872
- "text": "const arcgisFloorFilter = document.createElement(\"arcgis-floor-filter\");\ndocument.body.append(arcgisFloorFilter);\narcgisFloorFilter.componentOnReady().then(() => {\n console.log(\"arcgis-floor-filter is ready to go!\");\n});"
23042
+ "text": "```js\nconst arcgisFloorFilter = document.createElement(\"arcgis-floor-filter\");\ndocument.body.append(arcgisFloorFilter);\narcgisFloorFilter.componentOnReady().then(() => {\n console.log(\"arcgis-floor-filter is ready to go!\");\n});\n```"
22873
23043
  }
22874
23044
  ]
22875
23045
  },
@@ -23334,7 +23504,7 @@
23334
23504
  "customElement": true,
23335
23505
  "name": "ArcgisFullscreen",
23336
23506
  "tagName": "arcgis-fullscreen",
23337
- "description": "The Fullscreen component allows users to toggle the map or scene to fullscreen mode.",
23507
+ "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.",
23338
23508
  "demos": [
23339
23509
  {
23340
23510
  "description": "Docs",
@@ -23379,7 +23549,7 @@
23379
23549
  "docsTags": [
23380
23550
  {
23381
23551
  "name": "example",
23382
- "text": "const arcgisFullscreen = document.createElement(\"arcgis-fullscreen\");\ndocument.body.append(arcgisFullscreen);\narcgisFullscreen.componentOnReady().then(() => {\n console.log(\"arcgis-fullscreen is ready to go!\");\n});"
23552
+ "text": "```js\nconst arcgisFullscreen = document.createElement(\"arcgis-fullscreen\");\ndocument.body.append(arcgisFullscreen);\narcgisFullscreen.componentOnReady().then(() => {\n console.log(\"arcgis-fullscreen is ready to go!\");\n});\n```"
23383
23553
  }
23384
23554
  ]
23385
23555
  },
@@ -23418,7 +23588,7 @@
23418
23588
  {
23419
23589
  "kind": "field",
23420
23590
  "name": "messageOverrides",
23421
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
23591
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
23422
23592
  "type": {
23423
23593
  "text": "Record<string, unknown>"
23424
23594
  }
@@ -23742,7 +23912,7 @@
23742
23912
  "docsTags": [
23743
23913
  {
23744
23914
  "name": "example",
23745
- "text": "const arcgisGridControls = document.createElement(\"arcgis-grid-controls\");\ndocument.body.append(arcgisGridControls);\narcgisGridControls.componentOnReady().then(() => {\n console.log(\"arcgis-grid-controls is ready to go!\");\n});"
23915
+ "text": "```js\nconst arcgisGridControls = document.createElement(\"arcgis-grid-controls\");\ndocument.body.append(arcgisGridControls);\narcgisGridControls.componentOnReady().then(() => {\n console.log(\"arcgis-grid-controls is ready to go!\");\n});\n```"
23746
23916
  }
23747
23917
  ]
23748
23918
  },
@@ -24102,7 +24272,7 @@
24102
24272
  {
24103
24273
  "kind": "field",
24104
24274
  "name": "messageOverrides",
24105
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
24275
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
24106
24276
  "type": {
24107
24277
  "text": "Record<string, unknown>"
24108
24278
  }
@@ -25037,7 +25207,7 @@
25037
25207
  "docsTags": [
25038
25208
  {
25039
25209
  "name": "example",
25040
- "text": "const arcgisHistogramRangeSlider = document.createElement(\"arcgis-histogram-range-slider\");\ndocument.body.append(arcgisHistogramRangeSlider);\narcgisHistogramRangeSlider.componentOnReady().then(() => {\n console.log(\"arcgis-histogram-range-slider is ready to go!\");\n});"
25210
+ "text": "```js\nconst arcgisHistogramRangeSlider = document.createElement(\"arcgis-histogram-range-slider\");\ndocument.body.append(arcgisHistogramRangeSlider);\narcgisHistogramRangeSlider.componentOnReady().then(() => {\n console.log(\"arcgis-histogram-range-slider is ready to go!\");\n});\n```"
25041
25211
  }
25042
25212
  ]
25043
25213
  },
@@ -25843,12 +26013,6 @@
25843
26013
  ]
25844
26014
  }
25845
26015
  },
25846
- "docsTags": [
25847
- {
25848
- "name": "since",
25849
- "text": "4.9"
25850
- }
25851
- ],
25852
26016
  "signature": "(): Promise<void>",
25853
26017
  "async": true
25854
26018
  },
@@ -25879,7 +26043,7 @@
25879
26043
  "docsTags": [
25880
26044
  {
25881
26045
  "name": "example",
25882
- "text": "const arcgisHome = document.createElement(\"arcgis-home\");\ndocument.body.append(arcgisHome);\narcgisHome.componentOnReady().then(() => {\n console.log(\"arcgis-home is ready to go!\");\n});"
26046
+ "text": "```js\nconst arcgisHome = document.createElement(\"arcgis-home\");\ndocument.body.append(arcgisHome);\narcgisHome.componentOnReady().then(() => {\n console.log(\"arcgis-home is ready to go!\");\n});\n```"
25883
26047
  }
25884
26048
  ]
25885
26049
  },
@@ -25971,7 +26135,7 @@
25971
26135
  {
25972
26136
  "kind": "field",
25973
26137
  "name": "messageOverrides",
25974
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
26138
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
25975
26139
  "type": {
25976
26140
  "text": "Record<string, unknown>"
25977
26141
  }
@@ -26099,7 +26263,7 @@
26099
26263
  {
26100
26264
  "kind": "field",
26101
26265
  "name": "viewpoint",
26102
- "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.",
26266
+ "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).",
26103
26267
  "type": {
26104
26268
  "text": "Viewpoint",
26105
26269
  "references": [
@@ -26117,7 +26281,7 @@
26117
26281
  "docsTags": [
26118
26282
  {
26119
26283
  "name": "example",
26120
- "text": "// Creates a viewpoint centered on the extent of a polygon geometry\nlet vp = new Viewpoint({\n targetGeometry: geom.extent\n});\n\n// Sets the model's viewpoint to the Viewpoint based on a polygon geometry\nhome.viewpoint = vp;"
26284
+ "text": " ```js\n// Create viewpoint centered on extent of a polygon geometry\n\nlet vp = new Viewpoint({\n targetGeometry: geom.extent\n});\n\n// Sets the Home's viewpoint to that Viewpoint\nhome.viewpoint = vp;\n```"
26121
26285
  }
26122
26286
  ]
26123
26287
  }
@@ -26265,7 +26429,7 @@
26265
26429
  "docsTags": [
26266
26430
  {
26267
26431
  "name": "example",
26268
- "text": "home.addEventListener(\"go\", (event) => {\n console.log(\"updating viewpoint\");\n});"
26432
+ "text": "```js\nhome.addEventListener(\"arcgisGo\", (event) => {\n console.log(\"updating viewpoint\");\n});\n```"
26269
26433
  }
26270
26434
  ]
26271
26435
  },
@@ -26441,7 +26605,7 @@
26441
26605
  "docsTags": [
26442
26606
  {
26443
26607
  "name": "example",
26444
- "text": "const arcgisLayerList = document.createElement(\"arcgis-layer-list\");\ndocument.body.append(arcgisLayerList);\narcgisLayerList.componentOnReady().then(() => {\n console.log(\"arcgis-layer-list is ready to go!\");\n});"
26608
+ "text": "```js\nconst arcgisLayerList = document.createElement(\"arcgis-layer-list\");\ndocument.body.append(arcgisLayerList);\narcgisLayerList.componentOnReady().then(() => {\n console.log(\"arcgis-layer-list is ready to go!\");\n});\n```"
26445
26609
  }
26446
26610
  ]
26447
26611
  },
@@ -27660,7 +27824,7 @@
27660
27824
  "docsTags": [
27661
27825
  {
27662
27826
  "name": "example",
27663
- "text": "const arcgisLegend = document.createElement(\"arcgis-legend\");\ndocument.body.append(arcgisLegend);\narcgisLegend.componentOnReady().then(() => {\n console.log(\"arcgis-legend is ready to go!\");\n});"
27827
+ "text": "```js\nconst arcgisLegend = document.createElement(\"arcgis-legend\");\ndocument.body.append(arcgisLegend);\narcgisLegend.componentOnReady().then(() => {\n console.log(\"arcgis-legend is ready to go!\");\n});\n```"
27664
27828
  }
27665
27829
  ]
27666
27830
  },
@@ -28224,8 +28388,7 @@
28224
28388
  "end": 19
28225
28389
  }
28226
28390
  ]
28227
- },
28228
- "readonly": true
28391
+ }
28229
28392
  },
28230
28393
  {
28231
28394
  "kind": "field",
@@ -28290,7 +28453,7 @@
28290
28453
  "docsTags": [
28291
28454
  {
28292
28455
  "name": "example",
28293
- "text": "const arcgisLineOfSight = document.createElement(\"arcgis-line-of-sight\");\ndocument.body.append(arcgisLineOfSight);\narcgisLineOfSight.componentOnReady().then(() => {\n console.log(\"arcgis-line-of-sight is ready to go!\");\n});"
28456
+ "text": "```js\nconst arcgisLineOfSight = document.createElement(\"arcgis-line-of-sight\");\ndocument.body.append(arcgisLineOfSight);\narcgisLineOfSight.componentOnReady().then(() => {\n console.log(\"arcgis-line-of-sight is ready to go!\");\n});\n```"
28294
28457
  }
28295
28458
  ]
28296
28459
  },
@@ -28375,7 +28538,7 @@
28375
28538
  {
28376
28539
  "kind": "field",
28377
28540
  "name": "messageOverrides",
28378
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
28541
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
28379
28542
  "type": {
28380
28543
  "text": "Record<string, unknown>"
28381
28544
  }
@@ -29025,7 +29188,7 @@
29025
29188
  "docsTags": [
29026
29189
  {
29027
29190
  "name": "example",
29028
- "text": "const arcgisLinkChart = document.createElement(\"arcgis-link-chart\");\ndocument.body.append(arcgisLinkChart);\narcgisLinkChart.componentOnReady().then(() => {\n console.log(\"arcgis-link-chart is ready to go!\");\n});"
29191
+ "text": "```js\nconst arcgisLinkChart = document.createElement(\"arcgis-link-chart\");\ndocument.body.append(arcgisLinkChart);\narcgisLinkChart.componentOnReady().then(() => {\n console.log(\"arcgis-link-chart is ready to go!\");\n});\n```"
29029
29192
  }
29030
29193
  ]
29031
29194
  },
@@ -29118,6 +29281,24 @@
29118
29281
  ]
29119
29282
  }
29120
29283
  },
29284
+ {
29285
+ "kind": "field",
29286
+ "name": "focusAreas",
29287
+ "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)",
29288
+ "type": {
29289
+ "text": "FocusAreas",
29290
+ "references": [
29291
+ {
29292
+ "name": "FocusAreas",
29293
+ "package": "@arcgis/core",
29294
+ "module": "interfaces.d.ts",
29295
+ "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-effects-FocusAreas.html",
29296
+ "start": 0,
29297
+ "end": 10
29298
+ }
29299
+ ]
29300
+ }
29301
+ },
29121
29302
  {
29122
29303
  "kind": "method",
29123
29304
  "name": "goTo",
@@ -29180,7 +29361,7 @@
29180
29361
  {
29181
29362
  "kind": "field",
29182
29363
  "name": "graphics",
29183
- "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```",
29364
+ "description": "Allows for adding graphics directly to the default graphics in the View.",
29184
29365
  "type": {
29185
29366
  "text": "Collection<Graphic>",
29186
29367
  "references": [
@@ -29201,7 +29382,17 @@
29201
29382
  "end": 18
29202
29383
  }
29203
29384
  ]
29204
- }
29385
+ },
29386
+ "docsTags": [
29387
+ {
29388
+ "name": "example",
29389
+ "text": "```js\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n```"
29390
+ },
29391
+ {
29392
+ "name": "example",
29393
+ "text": "```js\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```"
29394
+ }
29395
+ ]
29205
29396
  },
29206
29397
  {
29207
29398
  "kind": "field",
@@ -29856,7 +30047,7 @@
29856
30047
  {
29857
30048
  "kind": "method",
29858
30049
  "name": "viewOnReady",
29859
- "description": "`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.",
30050
+ "description": "`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.",
29860
30051
  "parameters": [
29861
30052
  {
29862
30053
  "name": "callback",
@@ -29912,6 +30103,20 @@
29912
30103
  ]
29913
30104
  }
29914
30105
  },
30106
+ "docsTags": [
30107
+ {
30108
+ "name": "since",
30109
+ "text": "4.33"
30110
+ },
30111
+ {
30112
+ "name": "see",
30113
+ "text": "[Watch for changes - waiting for components or views to be ready](https://next.gha.afd.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
30114
+ },
30115
+ {
30116
+ "name": "example",
30117
+ "text": "```js\nconst viewElement = document.querySelector(\"arcgis-link-chart\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\n```"
30118
+ }
30119
+ ],
29915
30120
  "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
29916
30121
  "async": true
29917
30122
  },
@@ -30625,7 +30830,7 @@
30625
30830
  "docsTags": [
30626
30831
  {
30627
30832
  "name": "example",
30628
- "text": "const arcgisLinkChartLayoutSwitcher = document.createElement(\"arcgis-link-chart-layout-switcher\");\ndocument.body.append(arcgisLinkChartLayoutSwitcher);\narcgisLinkChartLayoutSwitcher.componentOnReady().then(() => {\n console.log(\"arcgis-link-chart-layout-switcher is ready to go!\");\n});"
30833
+ "text": "```js\nconst arcgisLinkChartLayoutSwitcher = document.createElement(\"arcgis-link-chart-layout-switcher\");\ndocument.body.append(arcgisLinkChartLayoutSwitcher);\narcgisLinkChartLayoutSwitcher.componentOnReady().then(() => {\n console.log(\"arcgis-link-chart-layout-switcher is ready to go!\");\n});\n```"
30629
30834
  }
30630
30835
  ]
30631
30836
  },
@@ -30667,11 +30872,7 @@
30667
30872
  "docsTags": [
30668
30873
  {
30669
30874
  "name": "see",
30670
- "text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
30671
- },
30672
- {
30673
- "name": "since",
30674
- "text": "4.28"
30875
+ "text": "[Calcite Icon Search](https://next.gha.afd.arcgis.com/calcite-design-system/icons/)"
30675
30876
  }
30676
30877
  ]
30677
30878
  },
@@ -30740,7 +30941,7 @@
30740
30941
  {
30741
30942
  "kind": "field",
30742
30943
  "name": "messageOverrides",
30743
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
30944
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
30744
30945
  "type": {
30745
30946
  "text": "Record<string, unknown>"
30746
30947
  }
@@ -31152,7 +31353,7 @@
31152
31353
  "docsTags": [
31153
31354
  {
31154
31355
  "name": "example",
31155
- "text": "layoutswitcher.addEventListener(\"arcgisSwitchLayout\", (event) => {\n console.log(\"Layout Switched\");\n});"
31356
+ "text": "```js\nlayoutswitcher.addEventListener(\"arcgisSwitchLayout\", (event) => {\n console.log(\"Layout Switched\");\n});\n```"
31156
31357
  }
31157
31358
  ]
31158
31359
  }
@@ -31261,7 +31462,7 @@
31261
31462
  "docsTags": [
31262
31463
  {
31263
31464
  "name": "example",
31264
- "text": "const arcgisLocate = document.createElement(\"arcgis-locate\");\ndocument.body.append(arcgisLocate);\narcgisLocate.componentOnReady().then(() => {\n console.log(\"arcgis-locate is ready to go!\");\n});"
31465
+ "text": "```js\nconst arcgisLocate = document.createElement(\"arcgis-locate\");\ndocument.body.append(arcgisLocate);\narcgisLocate.componentOnReady().then(() => {\n console.log(\"arcgis-locate is ready to go!\");\n});\n```"
31265
31466
  }
31266
31467
  ]
31267
31468
  },
@@ -31402,7 +31603,7 @@
31402
31603
  {
31403
31604
  "kind": "field",
31404
31605
  "name": "messageOverrides",
31405
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
31606
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
31406
31607
  "type": {
31407
31608
  "text": "Record<string, unknown>"
31408
31609
  }
@@ -31783,7 +31984,7 @@
31783
31984
  "customElement": true,
31784
31985
  "name": "ArcgisMap",
31785
31986
  "tagName": "arcgis-map",
31786
- "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/)",
31987
+ "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/)",
31787
31988
  "demos": [
31788
31989
  {
31789
31990
  "description": "Docs",
@@ -32227,7 +32428,7 @@
32227
32428
  "docsTags": [
32228
32429
  {
32229
32430
  "name": "example",
32230
- "text": "const arcgisMap = document.createElement(\"arcgis-map\");\ndocument.body.append(arcgisMap);\narcgisMap.componentOnReady().then(() => {\n console.log(\"arcgis-map is ready to go!\");\n});"
32431
+ "text": "```js\nconst arcgisMap = document.createElement(\"arcgis-map\");\ndocument.body.append(arcgisMap);\narcgisMap.componentOnReady().then(() => {\n console.log(\"arcgis-map is ready to go!\");\n});\n```"
32231
32432
  }
32232
32433
  ]
32233
32434
  },
@@ -32338,6 +32539,24 @@
32338
32539
  ]
32339
32540
  }
32340
32541
  },
32542
+ {
32543
+ "kind": "field",
32544
+ "name": "focusAreas",
32545
+ "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)",
32546
+ "type": {
32547
+ "text": "FocusAreas",
32548
+ "references": [
32549
+ {
32550
+ "name": "FocusAreas",
32551
+ "package": "@arcgis/core",
32552
+ "module": "interfaces.d.ts",
32553
+ "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-effects-FocusAreas.html",
32554
+ "start": 0,
32555
+ "end": 10
32556
+ }
32557
+ ]
32558
+ }
32559
+ },
32341
32560
  {
32342
32561
  "kind": "field",
32343
32562
  "name": "gamepad",
@@ -32419,7 +32638,7 @@
32419
32638
  {
32420
32639
  "kind": "field",
32421
32640
  "name": "graphics",
32422
- "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```",
32641
+ "description": "Allows for adding graphics directly to the default graphics in the View.",
32423
32642
  "type": {
32424
32643
  "text": "Collection<Graphic>",
32425
32644
  "references": [
@@ -32440,7 +32659,17 @@
32440
32659
  "end": 18
32441
32660
  }
32442
32661
  ]
32443
- }
32662
+ },
32663
+ "docsTags": [
32664
+ {
32665
+ "name": "example",
32666
+ "text": "```js\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n```"
32667
+ },
32668
+ {
32669
+ "name": "example",
32670
+ "text": "```js\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```"
32671
+ }
32672
+ ]
32444
32673
  },
32445
32674
  {
32446
32675
  "kind": "field",
@@ -33304,7 +33533,7 @@
33304
33533
  {
33305
33534
  "kind": "method",
33306
33535
  "name": "viewOnReady",
33307
- "description": "`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.",
33536
+ "description": "`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.",
33308
33537
  "parameters": [
33309
33538
  {
33310
33539
  "name": "callback",
@@ -33360,6 +33589,20 @@
33360
33589
  ]
33361
33590
  }
33362
33591
  },
33592
+ "docsTags": [
33593
+ {
33594
+ "name": "since",
33595
+ "text": "4.33"
33596
+ },
33597
+ {
33598
+ "name": "see",
33599
+ "text": "[Watch for changes - waiting for components or views to be ready](https://next.gha.afd.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
33600
+ },
33601
+ {
33602
+ "name": "example",
33603
+ "text": "```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nviewElement.map.add(new FeatureLayer({...}));\n```"
33604
+ }
33605
+ ],
33363
33606
  "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
33364
33607
  "async": true
33365
33608
  },
@@ -34237,7 +34480,7 @@
34237
34480
  "docsTags": [
34238
34481
  {
34239
34482
  "name": "example",
34240
- "text": "const arcgisMeasurement = document.createElement(\"arcgis-measurement\");\ndocument.body.append(arcgisMeasurement);\narcgisMeasurement.componentOnReady().then(() => {\n console.log(\"arcgis-measurement is ready to go!\");\n});"
34483
+ "text": "```js\nconst arcgisMeasurement = document.createElement(\"arcgis-measurement\");\ndocument.body.append(arcgisMeasurement);\narcgisMeasurement.componentOnReady().then(() => {\n console.log(\"arcgis-measurement is ready to go!\");\n});\n```"
34241
34484
  }
34242
34485
  ]
34243
34486
  },
@@ -34875,7 +35118,7 @@
34875
35118
  "docsTags": [
34876
35119
  {
34877
35120
  "name": "example",
34878
- "text": "const arcgisNavigationToggle = document.createElement(\"arcgis-navigation-toggle\");\ndocument.body.append(arcgisNavigationToggle);\narcgisNavigationToggle.componentOnReady().then(() => {\n console.log(\"arcgis-navigation-toggle is ready to go!\");\n});"
35121
+ "text": "```js\nconst arcgisNavigationToggle = document.createElement(\"arcgis-navigation-toggle\");\ndocument.body.append(arcgisNavigationToggle);\narcgisNavigationToggle.componentOnReady().then(() => {\n console.log(\"arcgis-navigation-toggle is ready to go!\");\n});\n```"
34879
35122
  }
34880
35123
  ]
34881
35124
  },
@@ -34937,7 +35180,7 @@
34937
35180
  {
34938
35181
  "kind": "field",
34939
35182
  "name": "messageOverrides",
34940
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
35183
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
34941
35184
  "type": {
34942
35185
  "text": "Record<string, unknown>"
34943
35186
  }
@@ -35339,7 +35582,7 @@
35339
35582
  "docsTags": [
35340
35583
  {
35341
35584
  "name": "example",
35342
- "text": "const arcgisOrientedImageryViewer = document.createElement(\"arcgis-oriented-imagery-viewer\");\ndocument.body.append(arcgisOrientedImageryViewer);\narcgisOrientedImageryViewer.componentOnReady().then(() => {\n console.log(\"arcgis-oriented-imagery-viewer is ready to go!\");\n});"
35585
+ "text": "```js\nconst arcgisOrientedImageryViewer = document.createElement(\"arcgis-oriented-imagery-viewer\");\ndocument.body.append(arcgisOrientedImageryViewer);\narcgisOrientedImageryViewer.componentOnReady().then(() => {\n console.log(\"arcgis-oriented-imagery-viewer is ready to go!\");\n});\n```"
35343
35586
  }
35344
35587
  ]
35345
35588
  },
@@ -36046,7 +36289,7 @@
36046
36289
  "docsTags": [
36047
36290
  {
36048
36291
  "name": "example",
36049
- "text": "const arcgisPlacement = document.createElement(\"arcgis-placement\");\ndocument.body.append(arcgisPlacement);\narcgisPlacement.componentOnReady().then(() => {\n console.log(\"arcgis-placement is ready to go!\");\n});"
36292
+ "text": "```js\nconst arcgisPlacement = document.createElement(\"arcgis-placement\");\ndocument.body.append(arcgisPlacement);\narcgisPlacement.componentOnReady().then(() => {\n console.log(\"arcgis-placement is ready to go!\");\n});\n```"
36050
36293
  }
36051
36294
  ]
36052
36295
  },
@@ -36234,7 +36477,7 @@
36234
36477
  "customElement": true,
36235
36478
  "name": "ArcgisPrint",
36236
36479
  "tagName": "arcgis-print",
36237
- "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```",
36480
+ "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```",
36238
36481
  "demos": [
36239
36482
  {
36240
36483
  "description": "Docs",
@@ -36283,6 +36526,7 @@
36283
36526
  {
36284
36527
  "kind": "field",
36285
36528
  "name": "allowedFormatsForSaving",
36529
+ "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.",
36286
36530
  "type": {
36287
36531
  "text": "\"all\" | Array<string>",
36288
36532
  "references": [
@@ -36353,7 +36597,12 @@
36353
36597
  "name": "browseTemplateButtonOnClick",
36354
36598
  "type": {
36355
36599
  "text": "((() => void))"
36356
- }
36600
+ },
36601
+ "docsTags": [
36602
+ {
36603
+ "name": "internal"
36604
+ }
36605
+ ]
36357
36606
  },
36358
36607
  {
36359
36608
  "kind": "method",
@@ -36382,7 +36631,7 @@
36382
36631
  "docsTags": [
36383
36632
  {
36384
36633
  "name": "example",
36385
- "text": "const arcgisPrint = document.createElement(\"arcgis-print\");\ndocument.body.append(arcgisPrint);\narcgisPrint.componentOnReady().then(() => {\n console.log(\"arcgis-print is ready to go!\");\n});"
36634
+ "text": "```js\nconst arcgisPrint = document.createElement(\"arcgis-print\");\ndocument.body.append(arcgisPrint);\narcgisPrint.componentOnReady().then(() => {\n console.log(\"arcgis-print is ready to go!\");\n});\n```"
36386
36635
  }
36387
36636
  ]
36388
36637
  },
@@ -36440,7 +36689,7 @@
36440
36689
  {
36441
36690
  "kind": "field",
36442
36691
  "name": "exportedLinks",
36443
- "description": "The collection of links exported from the Print widget.",
36692
+ "description": "The collection of links exported from the Print component.",
36444
36693
  "type": {
36445
36694
  "text": "Collection<FileLink>",
36446
36695
  "references": [
@@ -36480,7 +36729,7 @@
36480
36729
  {
36481
36730
  "kind": "field",
36482
36731
  "name": "headingLevel",
36483
- "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.",
36732
+ "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.",
36484
36733
  "type": {
36485
36734
  "text": "1 | 2 | 3 | 4 | 5 | 6",
36486
36735
  "values": [
@@ -36516,6 +36765,7 @@
36516
36765
  {
36517
36766
  "kind": "field",
36518
36767
  "name": "hideHeader",
36768
+ "description": "Indicates whether the component's header is hidden.",
36519
36769
  "type": {
36520
36770
  "text": "boolean",
36521
36771
  "values": [
@@ -36565,7 +36815,7 @@
36565
36815
  {
36566
36816
  "kind": "field",
36567
36817
  "name": "messageOverrides",
36568
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
36818
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
36569
36819
  "type": {
36570
36820
  "text": "Record<string, unknown>"
36571
36821
  }
@@ -36573,7 +36823,7 @@
36573
36823
  {
36574
36824
  "kind": "field",
36575
36825
  "name": "outSpatialReference",
36576
- "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)",
36826
+ "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.",
36577
36827
  "type": {
36578
36828
  "text": "SpatialReference",
36579
36829
  "references": [
@@ -36591,7 +36841,7 @@
36591
36841
  {
36592
36842
  "kind": "field",
36593
36843
  "name": "portal",
36594
- "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.",
36844
+ "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.",
36595
36845
  "type": {
36596
36846
  "text": "Portal",
36597
36847
  "references": [
@@ -36609,6 +36859,7 @@
36609
36859
  {
36610
36860
  "kind": "field",
36611
36861
  "name": "position",
36862
+ "description": "The UI position of a component.",
36612
36863
  "type": {
36613
36864
  "text": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
36614
36865
  "values": [
@@ -36657,7 +36908,7 @@
36657
36908
  {
36658
36909
  "kind": "field",
36659
36910
  "name": "printServiceUrl",
36660
- "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.",
36911
+ "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.",
36661
36912
  "type": {
36662
36913
  "text": "string",
36663
36914
  "values": [
@@ -36671,6 +36922,7 @@
36671
36922
  {
36672
36923
  "kind": "field",
36673
36924
  "name": "referenceElement",
36925
+ "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).",
36674
36926
  "type": {
36675
36927
  "text": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string",
36676
36928
  "references": [
@@ -36743,12 +36995,17 @@
36743
36995
  "end": 48
36744
36996
  }
36745
36997
  ]
36746
- }
36998
+ },
36999
+ "docsTags": [
37000
+ {
37001
+ "name": "internal"
37002
+ }
37003
+ ]
36747
37004
  },
36748
37005
  {
36749
37006
  "kind": "field",
36750
37007
  "name": "showPrintAreaEnabled",
36751
- "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.",
37008
+ "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.",
36752
37009
  "type": {
36753
37010
  "text": "boolean",
36754
37011
  "values": [
@@ -36763,7 +37020,7 @@
36763
37020
  {
36764
37021
  "kind": "field",
36765
37022
  "name": "state",
36766
- "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#state)",
37023
+ "description": "The state of the Print component.",
36767
37024
  "type": {
36768
37025
  "text": "\"disabled\" | \"error\" | \"initializing\" | \"ready\"",
36769
37026
  "values": [
@@ -36794,7 +37051,7 @@
36794
37051
  {
36795
37052
  "kind": "field",
36796
37053
  "name": "templateCustomTextElements",
36797
- "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.",
37054
+ "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.",
36798
37055
  "type": {
36799
37056
  "text": "{\n [x: string]: Array<HashMap<string>> | undefined;\n}",
36800
37057
  "references": [
@@ -36811,7 +37068,7 @@
36811
37068
  {
36812
37069
  "kind": "field",
36813
37070
  "name": "templateOptions",
36814
- "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.",
37071
+ "description": "Defines the layout template options used by the Print component to generate the print page.",
36815
37072
  "type": {
36816
37073
  "text": "TemplateOptions",
36817
37074
  "references": [
@@ -36844,6 +37101,7 @@
36844
37101
  },
36845
37102
  {
36846
37103
  "name": "allowed-formats-for-saving",
37104
+ "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.",
36847
37105
  "type": {
36848
37106
  "text": "\"all\"",
36849
37107
  "values": [
@@ -36926,7 +37184,7 @@
36926
37184
  },
36927
37185
  {
36928
37186
  "name": "heading-level",
36929
- "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.",
37187
+ "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.",
36930
37188
  "type": {
36931
37189
  "text": "1 | 2 | 3 | 4 | 5 | 6",
36932
37190
  "values": [
@@ -36961,6 +37219,7 @@
36961
37219
  },
36962
37220
  {
36963
37221
  "name": "hide-header",
37222
+ "description": "Indicates whether the component's header is hidden.",
36964
37223
  "type": {
36965
37224
  "text": "boolean",
36966
37225
  "values": [
@@ -37001,6 +37260,7 @@
37001
37260
  },
37002
37261
  {
37003
37262
  "name": "position",
37263
+ "description": "The UI position of a component.",
37004
37264
  "type": {
37005
37265
  "text": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"",
37006
37266
  "values": [
@@ -37047,7 +37307,7 @@
37047
37307
  },
37048
37308
  {
37049
37309
  "name": "print-service-url",
37050
- "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.",
37310
+ "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.",
37051
37311
  "type": {
37052
37312
  "text": "string",
37053
37313
  "values": [
@@ -37060,6 +37320,7 @@
37060
37320
  },
37061
37321
  {
37062
37322
  "name": "reference-element",
37323
+ "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).",
37063
37324
  "type": {
37064
37325
  "text": "string",
37065
37326
  "values": [
@@ -37072,7 +37333,7 @@
37072
37333
  },
37073
37334
  {
37074
37335
  "name": "show-print-area-enabled",
37075
- "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.",
37336
+ "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.",
37076
37337
  "type": {
37077
37338
  "text": "boolean",
37078
37339
  "values": [
@@ -37086,7 +37347,7 @@
37086
37347
  },
37087
37348
  {
37088
37349
  "name": "state",
37089
- "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#state)",
37350
+ "description": "The state of the Print component.",
37090
37351
  "type": {
37091
37352
  "text": "\"disabled\" | \"error\" | \"initializing\" | \"ready\"",
37092
37353
  "values": [
@@ -37115,6 +37376,7 @@
37115
37376
  "events": [
37116
37377
  {
37117
37378
  "name": "arcgisComplete",
37379
+ "description": "Emitted when the component is complete.",
37118
37380
  "type": {
37119
37381
  "text": "{ link: FileLink; }"
37120
37382
  }
@@ -37135,6 +37397,7 @@
37135
37397
  },
37136
37398
  {
37137
37399
  "name": "arcgisSubmit",
37400
+ "description": "Emitted when the component is submitted.",
37138
37401
  "type": {
37139
37402
  "text": "{ link: FileLink; }"
37140
37403
  }
@@ -37162,7 +37425,7 @@
37162
37425
  "customElement": true,
37163
37426
  "name": "ArcgisScaleBar",
37164
37427
  "tagName": "arcgis-scale-bar",
37165
- "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.",
37428
+ "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.",
37166
37429
  "demos": [
37167
37430
  {
37168
37431
  "description": "Docs",
@@ -37243,7 +37506,7 @@
37243
37506
  "docsTags": [
37244
37507
  {
37245
37508
  "name": "example",
37246
- "text": "const arcgisScaleBar = document.createElement(\"arcgis-scale-bar\");\ndocument.body.append(arcgisScaleBar);\narcgisScaleBar.componentOnReady().then(() => {\n console.log(\"arcgis-scale-bar is ready to go!\");\n});"
37509
+ "text": "```js\nconst arcgisScaleBar = document.createElement(\"arcgis-scale-bar\");\ndocument.body.append(arcgisScaleBar);\narcgisScaleBar.componentOnReady().then(() => {\n console.log(\"arcgis-scale-bar is ready to go!\");\n});\n```"
37247
37510
  }
37248
37511
  ]
37249
37512
  },
@@ -37306,7 +37569,7 @@
37306
37569
  {
37307
37570
  "kind": "field",
37308
37571
  "name": "messageOverrides",
37309
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
37572
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
37310
37573
  "type": {
37311
37574
  "text": "Record<string, unknown>"
37312
37575
  }
@@ -37662,7 +37925,7 @@
37662
37925
  "docsTags": [
37663
37926
  {
37664
37927
  "name": "example",
37665
- "text": "const arcgisScaleRangeSlider = document.createElement(\"arcgis-scale-range-slider\");\ndocument.body.append(arcgisScaleRangeSlider);\narcgisScaleRangeSlider.componentOnReady().then(() => {\n console.log(\"arcgis-scale-range-slider is ready to go!\");\n});"
37928
+ "text": "```js\nconst arcgisScaleRangeSlider = document.createElement(\"arcgis-scale-range-slider\");\ndocument.body.append(arcgisScaleRangeSlider);\narcgisScaleRangeSlider.componentOnReady().then(() => {\n console.log(\"arcgis-scale-range-slider is ready to go!\");\n});\n```"
37666
37929
  }
37667
37930
  ]
37668
37931
  },
@@ -38936,7 +39199,7 @@
38936
39199
  "docsTags": [
38937
39200
  {
38938
39201
  "name": "example",
38939
- "text": "const arcgisScene = document.createElement(\"arcgis-scene\");\ndocument.body.append(arcgisScene);\narcgisScene.componentOnReady().then(() => {\n console.log(\"arcgis-scene is ready to go!\");\n});"
39202
+ "text": "```js\nconst arcgisScene = document.createElement(\"arcgis-scene\");\ndocument.body.append(arcgisScene);\narcgisScene.componentOnReady().then(() => {\n console.log(\"arcgis-scene is ready to go!\");\n});\n```"
38940
39203
  }
38941
39204
  ]
38942
39205
  },
@@ -39064,6 +39327,30 @@
39064
39327
  ]
39065
39328
  }
39066
39329
  },
39330
+ {
39331
+ "kind": "field",
39332
+ "name": "focusAreas",
39333
+ "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)",
39334
+ "type": {
39335
+ "text": "FocusAreas",
39336
+ "references": [
39337
+ {
39338
+ "name": "FocusAreas",
39339
+ "package": "@arcgis/core",
39340
+ "module": "interfaces.d.ts",
39341
+ "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-effects-FocusAreas.html",
39342
+ "start": 0,
39343
+ "end": 10
39344
+ }
39345
+ ]
39346
+ },
39347
+ "docsTags": [
39348
+ {
39349
+ "name": "since",
39350
+ "text": "4.33"
39351
+ }
39352
+ ]
39353
+ },
39067
39354
  {
39068
39355
  "kind": "field",
39069
39356
  "name": "gamepad",
@@ -39145,7 +39432,7 @@
39145
39432
  {
39146
39433
  "kind": "field",
39147
39434
  "name": "graphics",
39148
- "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```",
39435
+ "description": "Allows for adding graphics directly to the default graphics in the view.",
39149
39436
  "type": {
39150
39437
  "text": "Collection<Graphic>",
39151
39438
  "references": [
@@ -39166,7 +39453,13 @@
39166
39453
  "end": 18
39167
39454
  }
39168
39455
  ]
39169
- }
39456
+ },
39457
+ "docsTags": [
39458
+ {
39459
+ "name": "example",
39460
+ "text": "```js\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```"
39461
+ }
39462
+ ]
39170
39463
  },
39171
39464
  {
39172
39465
  "kind": "field",
@@ -39266,7 +39559,7 @@
39266
39559
  {
39267
39560
  "kind": "method",
39268
39561
  "name": "hitTest",
39269
- "description": "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)",
39562
+ "description": "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)",
39270
39563
  "parameters": [
39271
39564
  {
39272
39565
  "name": "screenPoint",
@@ -40016,7 +40309,7 @@
40016
40309
  {
40017
40310
  "kind": "method",
40018
40311
  "name": "viewOnReady",
40019
- "description": "`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.",
40312
+ "description": "`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.",
40020
40313
  "parameters": [
40021
40314
  {
40022
40315
  "name": "callback",
@@ -40072,6 +40365,20 @@
40072
40365
  ]
40073
40366
  }
40074
40367
  },
40368
+ "docsTags": [
40369
+ {
40370
+ "name": "since",
40371
+ "text": "4.33"
40372
+ },
40373
+ {
40374
+ "name": "see",
40375
+ "text": "[Watch for changes - waiting for components or views to be ready](https://next.gha.afd.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
40376
+ },
40377
+ {
40378
+ "name": "example",
40379
+ "text": "```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nviewElement.map.add(new FeatureLayer({...}));\n```"
40380
+ }
40381
+ ],
40075
40382
  "signature": "(callback?: (): void, errback?: (error: Error) => void): Promise<void>",
40076
40383
  "async": true
40077
40384
  },
@@ -40575,7 +40882,7 @@
40575
40882
  },
40576
40883
  {
40577
40884
  "name": "arcgisViewClick",
40578
- "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)",
40885
+ "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)",
40579
40886
  "type": {
40580
40887
  "text": "ViewClickEvent",
40581
40888
  "references": [
@@ -40861,7 +41168,7 @@
40861
41168
  },
40862
41169
  {
40863
41170
  "name": "arcgisViewReadyChange",
40864
- "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```",
41171
+ "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```",
40865
41172
  "type": {
40866
41173
  "text": "void"
40867
41174
  }
@@ -41051,7 +41358,7 @@
41051
41358
  },
41052
41359
  {
41053
41360
  "kind": "field",
41054
- "name": "autoSelect",
41361
+ "name": "autoSelectDisabled",
41055
41362
  "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.",
41056
41363
  "type": {
41057
41364
  "text": "boolean",
@@ -41061,8 +41368,19 @@
41061
41368
  }
41062
41369
  ]
41063
41370
  },
41064
- "default": "true",
41065
- "attribute": "auto-select"
41371
+ "default": "false",
41372
+ "attribute": "auto-select-disabled"
41373
+ },
41374
+ {
41375
+ "kind": "method",
41376
+ "name": "clear",
41377
+ "description": "Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.\nIt also hides any open menus.",
41378
+ "return": {
41379
+ "type": {
41380
+ "text": "void"
41381
+ }
41382
+ },
41383
+ "signature": "(): void"
41066
41384
  },
41067
41385
  {
41068
41386
  "kind": "method",
@@ -41091,7 +41409,7 @@
41091
41409
  "docsTags": [
41092
41410
  {
41093
41411
  "name": "example",
41094
- "text": "const arcgisSearch = document.createElement(\"arcgis-search\");\ndocument.body.append(arcgisSearch);\narcgisSearch.componentOnReady().then(() => {\n console.log(\"arcgis-search is ready to go!\");\n});"
41412
+ "text": "```js\nconst arcgisSearch = document.createElement(\"arcgis-search\");\ndocument.body.append(arcgisSearch);\narcgisSearch.componentOnReady().then(() => {\n console.log(\"arcgis-search is ready to go!\");\n});\n```"
41095
41413
  }
41096
41414
  ]
41097
41415
  },
@@ -41204,7 +41522,7 @@
41204
41522
  },
41205
41523
  {
41206
41524
  "kind": "field",
41207
- "name": "includeDefaultSources",
41525
+ "name": "includeDefaultSourcesDisabled",
41208
41526
  "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).",
41209
41527
  "type": {
41210
41528
  "text": "Function | boolean",
@@ -41226,8 +41544,8 @@
41226
41544
  }
41227
41545
  ]
41228
41546
  },
41229
- "default": "true",
41230
- "attribute": "include-default-sources"
41547
+ "default": "false",
41548
+ "attribute": "include-default-sources-disabled"
41231
41549
  },
41232
41550
  {
41233
41551
  "kind": "field",
@@ -41245,7 +41563,7 @@
41245
41563
  },
41246
41564
  {
41247
41565
  "kind": "field",
41248
- "name": "locationEnabled",
41566
+ "name": "locationDisabled",
41249
41567
  "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:::",
41250
41568
  "type": {
41251
41569
  "text": "boolean",
@@ -41255,8 +41573,8 @@
41255
41573
  }
41256
41574
  ]
41257
41575
  },
41258
- "default": "true",
41259
- "attribute": "location-enabled"
41576
+ "default": "false",
41577
+ "attribute": "location-disabled"
41260
41578
  },
41261
41579
  {
41262
41580
  "kind": "field",
@@ -41291,7 +41609,7 @@
41291
41609
  {
41292
41610
  "kind": "field",
41293
41611
  "name": "messageOverrides",
41294
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
41612
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
41295
41613
  "type": {
41296
41614
  "text": "Record<string, unknown>"
41297
41615
  }
@@ -41313,7 +41631,7 @@
41313
41631
  },
41314
41632
  {
41315
41633
  "kind": "field",
41316
- "name": "popupEnabled",
41634
+ "name": "popupDisabled",
41317
41635
  "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).",
41318
41636
  "type": {
41319
41637
  "text": "boolean",
@@ -41323,8 +41641,8 @@
41323
41641
  }
41324
41642
  ]
41325
41643
  },
41326
- "default": "true",
41327
- "attribute": "popup-enabled"
41644
+ "default": "false",
41645
+ "attribute": "popup-disabled"
41328
41646
  },
41329
41647
  {
41330
41648
  "kind": "field",
@@ -41484,7 +41802,7 @@
41484
41802
  },
41485
41803
  {
41486
41804
  "kind": "field",
41487
- "name": "resultGraphicEnabled",
41805
+ "name": "resultGraphicDisabled",
41488
41806
  "description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
41489
41807
  "type": {
41490
41808
  "text": "boolean",
@@ -41494,8 +41812,8 @@
41494
41812
  }
41495
41813
  ]
41496
41814
  },
41497
- "default": "true",
41498
- "attribute": "result-graphic-enabled"
41815
+ "default": "false",
41816
+ "attribute": "result-graphic-disabled"
41499
41817
  },
41500
41818
  {
41501
41819
  "kind": "field",
@@ -41525,9 +41843,103 @@
41525
41843
  "readonly": true,
41526
41844
  "docsOnlyReadonly": true
41527
41845
  },
41846
+ {
41847
+ "kind": "method",
41848
+ "name": "search",
41849
+ "description": "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.",
41850
+ "parameters": [
41851
+ {
41852
+ "name": "searchItem",
41853
+ "optional": true,
41854
+ "type": {
41855
+ "text": "Array<number> | Graphic | Point | SuggestResult | null | string | undefined",
41856
+ "references": [
41857
+ {
41858
+ "name": "Array",
41859
+ "package": "typescript",
41860
+ "module": "lib/lib.es5.d.ts",
41861
+ "start": 0,
41862
+ "end": 5
41863
+ },
41864
+ {
41865
+ "name": "Graphic",
41866
+ "package": "@arcgis/core",
41867
+ "module": "interfaces.d.ts",
41868
+ "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html",
41869
+ "start": 16,
41870
+ "end": 23
41871
+ },
41872
+ {
41873
+ "name": "Point",
41874
+ "package": "@arcgis/core",
41875
+ "module": "interfaces.d.ts",
41876
+ "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html",
41877
+ "start": 26,
41878
+ "end": 31
41879
+ },
41880
+ {
41881
+ "name": "SuggestResult",
41882
+ "package": "@arcgis/core",
41883
+ "module": "interfaces.d.ts",
41884
+ "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-types.html#SuggestResult",
41885
+ "start": 34,
41886
+ "end": 47
41887
+ }
41888
+ ],
41889
+ "values": [
41890
+ {
41891
+ "type": "Array<number>"
41892
+ },
41893
+ {
41894
+ "type": "Graphic"
41895
+ },
41896
+ {
41897
+ "type": "Point"
41898
+ },
41899
+ {
41900
+ "type": "SuggestResult"
41901
+ },
41902
+ {
41903
+ "type": "null"
41904
+ },
41905
+ {
41906
+ "type": "string"
41907
+ },
41908
+ {
41909
+ "type": "undefined"
41910
+ }
41911
+ ]
41912
+ }
41913
+ }
41914
+ ],
41915
+ "return": {
41916
+ "type": {
41917
+ "text": "Promise<SearchResponse | null | undefined>",
41918
+ "references": [
41919
+ {
41920
+ "name": "Promise",
41921
+ "package": "typescript",
41922
+ "module": "lib/lib.es5.d.ts",
41923
+ "start": 0,
41924
+ "end": 7
41925
+ },
41926
+ {
41927
+ "name": "SearchResponse",
41928
+ "package": "@arcgis/core",
41929
+ "module": "interfaces.d.ts",
41930
+ "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-types.html#SearchResponse",
41931
+ "start": 8,
41932
+ "end": 22
41933
+ }
41934
+ ]
41935
+ }
41936
+ },
41937
+ "signature": "(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | Nil | number[] | string): Promise<__esri.SearchResponse | Nil>",
41938
+ "async": true
41939
+ },
41528
41940
  {
41529
41941
  "kind": "field",
41530
- "name": "searchAllEnabled",
41942
+ "name": "searchAllDisabled",
41531
41943
  "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)",
41532
41944
  "type": {
41533
41945
  "text": "boolean",
@@ -41537,8 +41949,8 @@
41537
41949
  }
41538
41950
  ]
41539
41951
  },
41540
- "default": "true",
41541
- "attribute": "search-all-enabled"
41952
+ "default": "false",
41953
+ "attribute": "search-all-disabled"
41542
41954
  },
41543
41955
  {
41544
41956
  "kind": "field",
@@ -41677,6 +42089,52 @@
41677
42089
  "reflects": true,
41678
42090
  "docsOnlyReadonly": true
41679
42091
  },
42092
+ {
42093
+ "kind": "method",
42094
+ "name": "suggest",
42095
+ "description": "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`.",
42096
+ "parameters": [
42097
+ {
42098
+ "name": "query",
42099
+ "optional": true,
42100
+ "type": {
42101
+ "text": "string | undefined",
42102
+ "values": [
42103
+ {
42104
+ "type": "string"
42105
+ },
42106
+ {
42107
+ "type": "undefined"
42108
+ }
42109
+ ]
42110
+ }
42111
+ }
42112
+ ],
42113
+ "return": {
42114
+ "type": {
42115
+ "text": "Promise<SuggestResponse | null | undefined>",
42116
+ "references": [
42117
+ {
42118
+ "name": "Promise",
42119
+ "package": "typescript",
42120
+ "module": "lib/lib.es5.d.ts",
42121
+ "start": 0,
42122
+ "end": 7
42123
+ },
42124
+ {
42125
+ "name": "SuggestResponse",
42126
+ "package": "@arcgis/core",
42127
+ "module": "interfaces.d.ts",
42128
+ "viewUrl": "https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-types.html#SuggestResponse",
42129
+ "start": 8,
42130
+ "end": 23
42131
+ }
42132
+ ]
42133
+ }
42134
+ },
42135
+ "signature": "(query?: string): Promise<__esri.SuggestResponse | Nil>",
42136
+ "async": true
42137
+ },
41680
42138
  {
41681
42139
  "kind": "field",
41682
42140
  "name": "suggestions",
@@ -41707,7 +42165,7 @@
41707
42165
  },
41708
42166
  {
41709
42167
  "kind": "field",
41710
- "name": "suggestionsEnabled",
42168
+ "name": "suggestionsDisabled",
41711
42169
  "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`.",
41712
42170
  "type": {
41713
42171
  "text": "boolean",
@@ -41717,8 +42175,8 @@
41717
42175
  }
41718
42176
  ]
41719
42177
  },
41720
- "default": "true",
41721
- "attribute": "suggestions-enabled"
42178
+ "default": "false",
42179
+ "attribute": "suggestions-disabled"
41722
42180
  }
41723
42181
  ],
41724
42182
  "attributes": [
@@ -41788,7 +42246,7 @@
41788
42246
  "fieldName": "autoDestroyDisabled"
41789
42247
  },
41790
42248
  {
41791
- "name": "auto-select",
42249
+ "name": "auto-select-disabled",
41792
42250
  "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.",
41793
42251
  "type": {
41794
42252
  "text": "boolean",
@@ -41798,8 +42256,8 @@
41798
42256
  }
41799
42257
  ]
41800
42258
  },
41801
- "default": "true",
41802
- "fieldName": "autoSelect"
42259
+ "default": "false",
42260
+ "fieldName": "autoSelectDisabled"
41803
42261
  },
41804
42262
  {
41805
42263
  "name": "disabled",
@@ -41830,7 +42288,7 @@
41830
42288
  "fieldName": "icon"
41831
42289
  },
41832
42290
  {
41833
- "name": "include-default-sources",
42291
+ "name": "include-default-sources-disabled",
41834
42292
  "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).",
41835
42293
  "type": {
41836
42294
  "text": "boolean",
@@ -41840,8 +42298,8 @@
41840
42298
  }
41841
42299
  ]
41842
42300
  },
41843
- "default": "true",
41844
- "fieldName": "includeDefaultSources"
42301
+ "default": "false",
42302
+ "fieldName": "includeDefaultSourcesDisabled"
41845
42303
  },
41846
42304
  {
41847
42305
  "name": "label",
@@ -41857,7 +42315,7 @@
41857
42315
  "fieldName": "label"
41858
42316
  },
41859
42317
  {
41860
- "name": "location-enabled",
42318
+ "name": "location-disabled",
41861
42319
  "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:::",
41862
42320
  "type": {
41863
42321
  "text": "boolean",
@@ -41867,8 +42325,8 @@
41867
42325
  }
41868
42326
  ]
41869
42327
  },
41870
- "default": "true",
41871
- "fieldName": "locationEnabled"
42328
+ "default": "false",
42329
+ "fieldName": "locationDisabled"
41872
42330
  },
41873
42331
  {
41874
42332
  "name": "max-results",
@@ -41913,7 +42371,7 @@
41913
42371
  "fieldName": "minSuggestCharacters"
41914
42372
  },
41915
42373
  {
41916
- "name": "popup-enabled",
42374
+ "name": "popup-disabled",
41917
42375
  "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).",
41918
42376
  "type": {
41919
42377
  "text": "boolean",
@@ -41923,8 +42381,8 @@
41923
42381
  }
41924
42382
  ]
41925
42383
  },
41926
- "default": "true",
41927
- "fieldName": "popupEnabled"
42384
+ "default": "false",
42385
+ "fieldName": "popupDisabled"
41928
42386
  },
41929
42387
  {
41930
42388
  "name": "position",
@@ -41985,7 +42443,7 @@
41985
42443
  "fieldName": "referenceElement"
41986
42444
  },
41987
42445
  {
41988
- "name": "result-graphic-enabled",
42446
+ "name": "result-graphic-disabled",
41989
42447
  "description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
41990
42448
  "type": {
41991
42449
  "text": "boolean",
@@ -41995,11 +42453,11 @@
41995
42453
  }
41996
42454
  ]
41997
42455
  },
41998
- "default": "true",
41999
- "fieldName": "resultGraphicEnabled"
42456
+ "default": "false",
42457
+ "fieldName": "resultGraphicDisabled"
42000
42458
  },
42001
42459
  {
42002
- "name": "search-all-enabled",
42460
+ "name": "search-all-disabled",
42003
42461
  "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)",
42004
42462
  "type": {
42005
42463
  "text": "boolean",
@@ -42009,8 +42467,8 @@
42009
42467
  }
42010
42468
  ]
42011
42469
  },
42012
- "default": "true",
42013
- "fieldName": "searchAllEnabled"
42470
+ "default": "false",
42471
+ "fieldName": "searchAllDisabled"
42014
42472
  },
42015
42473
  {
42016
42474
  "name": "search-term",
@@ -42053,7 +42511,7 @@
42053
42511
  "fieldName": "state"
42054
42512
  },
42055
42513
  {
42056
- "name": "suggestions-enabled",
42514
+ "name": "suggestions-disabled",
42057
42515
  "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`.",
42058
42516
  "type": {
42059
42517
  "text": "boolean",
@@ -42063,8 +42521,8 @@
42063
42521
  }
42064
42522
  ]
42065
42523
  },
42066
- "default": "true",
42067
- "fieldName": "suggestionsEnabled"
42524
+ "default": "false",
42525
+ "fieldName": "suggestionsDisabled"
42068
42526
  }
42069
42527
  ],
42070
42528
  "events": [
@@ -42258,7 +42716,7 @@
42258
42716
  "docsTags": [
42259
42717
  {
42260
42718
  "name": "example",
42261
- "text": "const arcgisSearchResultRenderer = document.createElement(\"arcgis-search-result-renderer\");\ndocument.body.append(arcgisSearchResultRenderer);\narcgisSearchResultRenderer.componentOnReady().then(() => {\n console.log(\"arcgis-search-result-renderer is ready to go!\");\n});"
42719
+ "text": "```js\nconst arcgisSearchResultRenderer = document.createElement(\"arcgis-search-result-renderer\");\ndocument.body.append(arcgisSearchResultRenderer);\narcgisSearchResultRenderer.componentOnReady().then(() => {\n console.log(\"arcgis-search-result-renderer is ready to go!\");\n});\n```"
42262
42720
  }
42263
42721
  ]
42264
42722
  },
@@ -42416,7 +42874,7 @@
42416
42874
  "docsTags": [
42417
42875
  {
42418
42876
  "name": "example",
42419
- "text": "const arcgisShadowCast = document.createElement(\"arcgis-shadow-cast\");\ndocument.body.append(arcgisShadowCast);\narcgisShadowCast.componentOnReady().then(() => {\n console.log(\"arcgis-shadow-cast is ready to go!\");\n});"
42877
+ "text": "```js\nconst arcgisShadowCast = document.createElement(\"arcgis-shadow-cast\");\ndocument.body.append(arcgisShadowCast);\narcgisShadowCast.componentOnReady().then(() => {\n console.log(\"arcgis-shadow-cast is ready to go!\");\n});\n```"
42420
42878
  }
42421
42879
  ]
42422
42880
  },
@@ -43552,7 +44010,7 @@
43552
44010
  "docsTags": [
43553
44011
  {
43554
44012
  "name": "example",
43555
- "text": "const arcgisSketch = document.createElement(\"arcgis-sketch\");\ndocument.body.append(arcgisSketch);\narcgisSketch.componentOnReady().then(() => {\n console.log(\"arcgis-sketch is ready to go!\");\n});"
44013
+ "text": "```js\nconst arcgisSketch = document.createElement(\"arcgis-sketch\");\ndocument.body.append(arcgisSketch);\narcgisSketch.componentOnReady().then(() => {\n console.log(\"arcgis-sketch is ready to go!\");\n});\n```"
43556
44014
  }
43557
44015
  ]
43558
44016
  },
@@ -45439,7 +45897,7 @@
45439
45897
  "docsTags": [
45440
45898
  {
45441
45899
  "name": "example",
45442
- "text": "const arcgisSlice = document.createElement(\"arcgis-slice\");\ndocument.body.append(arcgisSlice);\narcgisSlice.componentOnReady().then(() => {\n console.log(\"arcgis-slice is ready to go!\");\n});"
45900
+ "text": "```js\nconst arcgisSlice = document.createElement(\"arcgis-slice\");\ndocument.body.append(arcgisSlice);\narcgisSlice.componentOnReady().then(() => {\n console.log(\"arcgis-slice is ready to go!\");\n});\n```"
45443
45901
  }
45444
45902
  ]
45445
45903
  },
@@ -45587,7 +46045,7 @@
45587
46045
  {
45588
46046
  "kind": "field",
45589
46047
  "name": "messageOverrides",
45590
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
46048
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
45591
46049
  "type": {
45592
46050
  "text": "Record<string, unknown>"
45593
46051
  }
@@ -45687,7 +46145,7 @@
45687
46145
  {
45688
46146
  "kind": "field",
45689
46147
  "name": "shape",
45690
- "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```",
46148
+ "description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a plane.",
45691
46149
  "type": {
45692
46150
  "text": "SlicePlane",
45693
46151
  "references": [
@@ -45700,7 +46158,13 @@
45700
46158
  "end": 10
45701
46159
  }
45702
46160
  ]
45703
- }
46161
+ },
46162
+ "docsTags": [
46163
+ {
46164
+ "name": "example",
46165
+ "text": "```js\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```"
46166
+ }
46167
+ ]
45704
46168
  },
45705
46169
  {
45706
46170
  "kind": "method",
@@ -46063,7 +46527,7 @@
46063
46527
  "docsTags": [
46064
46528
  {
46065
46529
  "name": "example",
46066
- "text": "const arcgisSlider = document.createElement(\"arcgis-slider\");\ndocument.body.append(arcgisSlider);\narcgisSlider.componentOnReady().then(() => {\n console.log(\"arcgis-slider is ready to go!\");\n});"
46530
+ "text": "```js\nconst arcgisSlider = document.createElement(\"arcgis-slider\");\ndocument.body.append(arcgisSlider);\narcgisSlider.componentOnReady().then(() => {\n console.log(\"arcgis-slider is ready to go!\");\n});\n```"
46067
46531
  }
46068
46532
  ]
46069
46533
  },
@@ -47269,7 +47733,7 @@
47269
47733
  "customElement": true,
47270
47734
  "name": "ArcgisSwipe",
47271
47735
  "tagName": "arcgis-swipe",
47272
- "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.",
47736
+ "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.",
47273
47737
  "demos": [
47274
47738
  {
47275
47739
  "description": "Docs",
@@ -47330,7 +47794,7 @@
47330
47794
  "docsTags": [
47331
47795
  {
47332
47796
  "name": "example",
47333
- "text": "const arcgisSwipe = document.createElement(\"arcgis-swipe\");\ndocument.body.append(arcgisSwipe);\narcgisSwipe.componentOnReady().then(() => {\n console.log(\"arcgis-swipe is ready to go!\");\n});"
47797
+ "text": "```js\nconst arcgisSwipe = document.createElement(\"arcgis-swipe\");\ndocument.body.append(arcgisSwipe);\narcgisSwipe.componentOnReady().then(() => {\n console.log(\"arcgis-swipe is ready to go!\");\n});\n```"
47334
47798
  }
47335
47799
  ]
47336
47800
  },
@@ -47489,7 +47953,7 @@
47489
47953
  {
47490
47954
  "kind": "field",
47491
47955
  "name": "messageOverrides",
47492
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
47956
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
47493
47957
  "type": {
47494
47958
  "text": "Record<string, unknown>"
47495
47959
  }
@@ -47984,7 +48448,7 @@
47984
48448
  "docsTags": [
47985
48449
  {
47986
48450
  "name": "example",
47987
- "text": "const arcgisTableList = document.createElement(\"arcgis-table-list\");\ndocument.body.append(arcgisTableList);\narcgisTableList.componentOnReady().then(() => {\n console.log(\"arcgis-table-list is ready to go!\");\n});"
48451
+ "text": "```js\nconst arcgisTableList = document.createElement(\"arcgis-table-list\");\ndocument.body.append(arcgisTableList);\narcgisTableList.componentOnReady().then(() => {\n console.log(\"arcgis-table-list is ready to go!\");\n});\n```"
47988
48452
  }
47989
48453
  ]
47990
48454
  },
@@ -48984,7 +49448,7 @@
48984
49448
  "docsTags": [
48985
49449
  {
48986
49450
  "name": "example",
48987
- "text": "const arcgisTimeSlider = document.createElement(\"arcgis-time-slider\");\ndocument.body.append(arcgisTimeSlider);\narcgisTimeSlider.componentOnReady().then(() => {\n console.log(\"arcgis-time-slider is ready to go!\");\n});"
49451
+ "text": "```js\nconst arcgisTimeSlider = document.createElement(\"arcgis-time-slider\");\ndocument.body.append(arcgisTimeSlider);\narcgisTimeSlider.componentOnReady().then(() => {\n console.log(\"arcgis-time-slider is ready to go!\");\n});\n```"
48988
49452
  }
48989
49453
  ]
48990
49454
  },
@@ -49888,7 +50352,7 @@
49888
50352
  "docsTags": [
49889
50353
  {
49890
50354
  "name": "example",
49891
- "text": "const arcgisTimeZoneLabel = document.createElement(\"arcgis-time-zone-label\");\ndocument.body.append(arcgisTimeZoneLabel);\narcgisTimeZoneLabel.componentOnReady().then(() => {\n console.log(\"arcgis-time-zone-label is ready to go!\");\n});"
50355
+ "text": "```js\nconst arcgisTimeZoneLabel = document.createElement(\"arcgis-time-zone-label\");\ndocument.body.append(arcgisTimeZoneLabel);\narcgisTimeZoneLabel.componentOnReady().then(() => {\n console.log(\"arcgis-time-zone-label is ready to go!\");\n});\n```"
49892
50356
  }
49893
50357
  ]
49894
50358
  },
@@ -49964,7 +50428,7 @@
49964
50428
  {
49965
50429
  "kind": "field",
49966
50430
  "name": "messageOverrides",
49967
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
50431
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
49968
50432
  "type": {
49969
50433
  "text": "Record<string, unknown>"
49970
50434
  },
@@ -50271,7 +50735,7 @@
50271
50735
  "customElement": true,
50272
50736
  "name": "ArcgisTrack",
50273
50737
  "tagName": "arcgis-track",
50274
- "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.",
50738
+ "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.",
50275
50739
  "demos": [
50276
50740
  {
50277
50741
  "description": "Docs",
@@ -50332,7 +50796,7 @@
50332
50796
  "docsTags": [
50333
50797
  {
50334
50798
  "name": "example",
50335
- "text": "const arcgisTrack = document.createElement(\"arcgis-track\");\ndocument.body.append(arcgisTrack);\narcgisTrack.componentOnReady().then(() => {\n console.log(\"arcgis-track is ready to go!\");\n});"
50799
+ "text": "```js\nconst arcgisTrack = document.createElement(\"arcgis-track\");\ndocument.body.append(arcgisTrack);\narcgisTrack.componentOnReady().then(() => {\n console.log(\"arcgis-track is ready to go!\");\n});\n```"
50336
50800
  }
50337
50801
  ]
50338
50802
  },
@@ -50460,7 +50924,7 @@
50460
50924
  {
50461
50925
  "kind": "field",
50462
50926
  "name": "messageOverrides",
50463
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
50927
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
50464
50928
  "type": {
50465
50929
  "text": "Record<string, unknown>"
50466
50930
  }
@@ -51051,7 +51515,7 @@
51051
51515
  "docsTags": [
51052
51516
  {
51053
51517
  "name": "example",
51054
- "text": "const arcgisUtilityNetworkAssociations = document.createElement(\"arcgis-utility-network-associations\");\ndocument.body.append(arcgisUtilityNetworkAssociations);\narcgisUtilityNetworkAssociations.componentOnReady().then(() => {\n console.log(\"arcgis-utility-network-associations is ready to go!\");\n});"
51518
+ "text": "```js\nconst arcgisUtilityNetworkAssociations = document.createElement(\"arcgis-utility-network-associations\");\ndocument.body.append(arcgisUtilityNetworkAssociations);\narcgisUtilityNetworkAssociations.componentOnReady().then(() => {\n console.log(\"arcgis-utility-network-associations is ready to go!\");\n});\n```"
51055
51519
  }
51056
51520
  ]
51057
51521
  },
@@ -52356,7 +52820,7 @@
52356
52820
  "docsTags": [
52357
52821
  {
52358
52822
  "name": "example",
52359
- "text": "const arcgisUtilityNetworkTrace = document.createElement(\"arcgis-utility-network-trace\");\ndocument.body.append(arcgisUtilityNetworkTrace);\narcgisUtilityNetworkTrace.componentOnReady().then(() => {\n console.log(\"arcgis-utility-network-trace is ready to go!\");\n});"
52823
+ "text": "```js\nconst arcgisUtilityNetworkTrace = document.createElement(\"arcgis-utility-network-trace\");\ndocument.body.append(arcgisUtilityNetworkTrace);\narcgisUtilityNetworkTrace.componentOnReady().then(() => {\n console.log(\"arcgis-utility-network-trace is ready to go!\");\n});\n```"
52360
52824
  }
52361
52825
  ]
52362
52826
  },
@@ -53130,7 +53594,7 @@
53130
53594
  "docsTags": [
53131
53595
  {
53132
53596
  "name": "example",
53133
- "text": "const arcgisUtilityNetworkValidateTopology = document.createElement(\"arcgis-utility-network-validate-topology\");\ndocument.body.append(arcgisUtilityNetworkValidateTopology);\narcgisUtilityNetworkValidateTopology.componentOnReady().then(() => {\n console.log(\"arcgis-utility-network-validate-topology is ready to go!\");\n});"
53597
+ "text": "```js\nconst arcgisUtilityNetworkValidateTopology = document.createElement(\"arcgis-utility-network-validate-topology\");\ndocument.body.append(arcgisUtilityNetworkValidateTopology);\narcgisUtilityNetworkValidateTopology.componentOnReady().then(() => {\n console.log(\"arcgis-utility-network-validate-topology is ready to go!\");\n});\n```"
53134
53598
  }
53135
53599
  ]
53136
53600
  },
@@ -53734,7 +54198,7 @@
53734
54198
  "docsTags": [
53735
54199
  {
53736
54200
  "name": "example",
53737
- "text": "const arcgisValuePicker = document.createElement(\"arcgis-value-picker\");\ndocument.body.append(arcgisValuePicker);\narcgisValuePicker.componentOnReady().then(() => {\n console.log(\"arcgis-value-picker is ready to go!\");\n});"
54201
+ "text": "```js\nconst arcgisValuePicker = document.createElement(\"arcgis-value-picker\");\ndocument.body.append(arcgisValuePicker);\narcgisValuePicker.componentOnReady().then(() => {\n console.log(\"arcgis-value-picker is ready to go!\");\n});\n```"
53738
54202
  }
53739
54203
  ]
53740
54204
  },
@@ -54548,7 +55012,7 @@
54548
55012
  "docsTags": [
54549
55013
  {
54550
55014
  "name": "example",
54551
- "text": "const arcgisVersionManagement = document.createElement(\"arcgis-version-management\");\ndocument.body.append(arcgisVersionManagement);\narcgisVersionManagement.componentOnReady().then(() => {\n console.log(\"arcgis-version-management is ready to go!\");\n});"
55015
+ "text": "```js\nconst arcgisVersionManagement = document.createElement(\"arcgis-version-management\");\ndocument.body.append(arcgisVersionManagement);\narcgisVersionManagement.componentOnReady().then(() => {\n console.log(\"arcgis-version-management is ready to go!\");\n});\n```"
54552
55016
  }
54553
55017
  ]
54554
55018
  },
@@ -54589,7 +55053,7 @@
54589
55053
  {
54590
55054
  "kind": "field",
54591
55055
  "name": "initialVersionInfos",
54592
- "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.",
55056
+ "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.",
54593
55057
  "type": {
54594
55058
  "text": "Array<{\n url: string;\n name: string;\n}>",
54595
55059
  "references": [
@@ -54620,7 +55084,7 @@
54620
55084
  {
54621
55085
  "kind": "field",
54622
55086
  "name": "messageOverrides",
54623
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
55087
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
54624
55088
  "type": {
54625
55089
  "text": "Record<string, unknown>"
54626
55090
  }
@@ -54641,7 +55105,7 @@
54641
55105
  {
54642
55106
  "kind": "field",
54643
55107
  "name": "pageSize",
54644
- "description": "Specifies the number of versions displayed on each page of the Version Management Component.",
55108
+ "description": "Specifies the number of versions displayed on each page of the Version Management component.",
54645
55109
  "type": {
54646
55110
  "text": "number",
54647
55111
  "values": [
@@ -54786,7 +55250,7 @@
54786
55250
  {
54787
55251
  "kind": "field",
54788
55252
  "name": "versioningStates",
54789
- "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.",
55253
+ "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.",
54790
55254
  "type": {
54791
55255
  "text": "Collection<VersioningState>",
54792
55256
  "references": [
@@ -54889,7 +55353,7 @@
54889
55353
  },
54890
55354
  {
54891
55355
  "name": "page-size",
54892
- "description": "Specifies the number of versions displayed on each page of the Version Management Component.",
55356
+ "description": "Specifies the number of versions displayed on each page of the Version Management component.",
54893
55357
  "type": {
54894
55358
  "text": "number",
54895
55359
  "values": [
@@ -55039,13 +55503,23 @@
55039
55503
  "customElement": true,
55040
55504
  "name": "ArcgisVideo",
55041
55505
  "tagName": "arcgis-video",
55042
- "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```",
55506
+ "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.",
55043
55507
  "demos": [
55044
55508
  {
55045
55509
  "description": "Docs",
55046
55510
  "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/"
55047
55511
  }
55048
55512
  ],
55513
+ "docsTags": [
55514
+ {
55515
+ "name": "example",
55516
+ "text": "```html\n<arcgis-video></arcgis-video>\n```\n\n```js\nconst VideoLayer = await $arcgis.import(\"@arcgis/core/layers/VideoLayer.js\");\nconst videoElement = document.querySelector(\"arcgis-video\");\n\nconst videoLayer = new VideoLayer({\n url: \"YOUR_VIDEO_LAYER_URL\",\n});\n\nawait videoLayer.load();\nif (videoLayer.loaded) {\n videoElement.layer = videoLayer;\n}\n```"
55517
+ },
55518
+ {
55519
+ "name": "since",
55520
+ "text": "4.33"
55521
+ }
55522
+ ],
55049
55523
  "superclass": {
55050
55524
  "name": "LitElement",
55051
55525
  "package": "@arcgis/lumina"
@@ -55095,7 +55569,7 @@
55095
55569
  "docsTags": [
55096
55570
  {
55097
55571
  "name": "example",
55098
- "text": "const arcgisVideo = document.createElement(\"arcgis-video\");\ndocument.body.append(arcgisVideo);\narcgisVideo.componentOnReady().then(() => {\n console.log(\"arcgis-video is ready to go!\");\n});"
55572
+ "text": "```js\nconst arcgisVideo = document.createElement(\"arcgis-video\");\ndocument.body.append(arcgisVideo);\narcgisVideo.componentOnReady().then(() => {\n console.log(\"arcgis-video is ready to go!\");\n});\n```"
55099
55573
  }
55100
55574
  ]
55101
55575
  },
@@ -55138,20 +55612,6 @@
55138
55612
  ]
55139
55613
  }
55140
55614
  },
55141
- {
55142
- "kind": "field",
55143
- "name": "layerUrl",
55144
- "type": {
55145
- "text": "string",
55146
- "values": [
55147
- {
55148
- "type": "string"
55149
- }
55150
- ]
55151
- },
55152
- "attribute": "layer-url",
55153
- "reflects": true
55154
- },
55155
55615
  {
55156
55616
  "kind": "field",
55157
55617
  "name": "ready",
@@ -55201,18 +55661,6 @@
55201
55661
  },
55202
55662
  "default": "false",
55203
55663
  "fieldName": "autoDestroyDisabled"
55204
- },
55205
- {
55206
- "name": "layer-url",
55207
- "type": {
55208
- "text": "string",
55209
- "values": [
55210
- {
55211
- "type": "string"
55212
- }
55213
- ]
55214
- },
55215
- "fieldName": "layerUrl"
55216
55664
  }
55217
55665
  ],
55218
55666
  "events": [
@@ -55245,13 +55693,23 @@
55245
55693
  "customElement": true,
55246
55694
  "name": "ArcgisVideoPlayer",
55247
55695
  "tagName": "arcgis-video-player",
55248
- "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```",
55696
+ "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)",
55249
55697
  "demos": [
55250
55698
  {
55251
55699
  "description": "Docs",
55252
55700
  "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/"
55253
55701
  }
55254
55702
  ],
55703
+ "docsTags": [
55704
+ {
55705
+ "name": "example",
55706
+ "text": "```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```"
55707
+ },
55708
+ {
55709
+ "name": "since",
55710
+ "text": "4.33"
55711
+ }
55712
+ ],
55255
55713
  "superclass": {
55256
55714
  "name": "LitElement",
55257
55715
  "package": "@arcgis/lumina"
@@ -55302,7 +55760,7 @@
55302
55760
  "docsTags": [
55303
55761
  {
55304
55762
  "name": "example",
55305
- "text": "const arcgisVideoPlayer = document.createElement(\"arcgis-video-player\");\ndocument.body.append(arcgisVideoPlayer);\narcgisVideoPlayer.componentOnReady().then(() => {\n console.log(\"arcgis-video-player is ready to go!\");\n});"
55763
+ "text": "```js\nconst arcgisVideoPlayer = document.createElement(\"arcgis-video-player\");\ndocument.body.append(arcgisVideoPlayer);\narcgisVideoPlayer.componentOnReady().then(() => {\n console.log(\"arcgis-video-player is ready to go!\");\n});\n```"
55306
55764
  }
55307
55765
  ]
55308
55766
  },
@@ -55327,6 +55785,34 @@
55327
55785
  "signature": "(): Promise<void>",
55328
55786
  "async": true
55329
55787
  },
55788
+ {
55789
+ "kind": "field",
55790
+ "name": "followingMode",
55791
+ "description": "Determines which telemetry elements to follow when the video layer is playing.",
55792
+ "type": {
55793
+ "text": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\"",
55794
+ "values": [
55795
+ {
55796
+ "value": "follow-both",
55797
+ "type": "string"
55798
+ },
55799
+ {
55800
+ "value": "follow-frame",
55801
+ "type": "string"
55802
+ },
55803
+ {
55804
+ "value": "follow-sensor",
55805
+ "type": "string"
55806
+ },
55807
+ {
55808
+ "value": "none",
55809
+ "type": "string"
55810
+ }
55811
+ ]
55812
+ },
55813
+ "default": "\"follow-both\"",
55814
+ "attribute": "following-mode"
55815
+ },
55330
55816
  {
55331
55817
  "kind": "field",
55332
55818
  "name": "hideHeader",
@@ -55415,14 +55901,14 @@
55415
55901
  },
55416
55902
  {
55417
55903
  "name": "example",
55418
- "text": "// Create a new Video Player with a VideoLayer\nvideoPlayer.layer = videoLayer;"
55904
+ "text": "```js\n// Create a new Video Player with a VideoLayer\nvideoPlayer.layer = videoLayer;\n```"
55419
55905
  }
55420
55906
  ]
55421
55907
  },
55422
55908
  {
55423
55909
  "kind": "field",
55424
55910
  "name": "messageOverrides",
55425
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
55911
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
55426
55912
  "type": {
55427
55913
  "text": "Record<string, unknown>"
55428
55914
  }
@@ -55582,6 +56068,33 @@
55582
56068
  "default": "false",
55583
56069
  "fieldName": "autoDestroyDisabled"
55584
56070
  },
56071
+ {
56072
+ "name": "following-mode",
56073
+ "description": "Determines which telemetry elements to follow when the video layer is playing.",
56074
+ "type": {
56075
+ "text": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\"",
56076
+ "values": [
56077
+ {
56078
+ "value": "follow-both",
56079
+ "type": "string"
56080
+ },
56081
+ {
56082
+ "value": "follow-frame",
56083
+ "type": "string"
56084
+ },
56085
+ {
56086
+ "value": "follow-sensor",
56087
+ "type": "string"
56088
+ },
56089
+ {
56090
+ "value": "none",
56091
+ "type": "string"
56092
+ }
56093
+ ]
56094
+ },
56095
+ "default": "\"follow-both\"",
56096
+ "fieldName": "followingMode"
56097
+ },
55585
56098
  {
55586
56099
  "name": "hide-header",
55587
56100
  "description": "Indicates whether to display the video player's header information.",
@@ -55829,7 +56342,7 @@
55829
56342
  "docsTags": [
55830
56343
  {
55831
56344
  "name": "example",
55832
- "text": "const arcgisWeather = document.createElement(\"arcgis-weather\");\ndocument.body.append(arcgisWeather);\narcgisWeather.componentOnReady().then(() => {\n console.log(\"arcgis-weather is ready to go!\");\n});"
56345
+ "text": "```js\nconst arcgisWeather = document.createElement(\"arcgis-weather\");\ndocument.body.append(arcgisWeather);\narcgisWeather.componentOnReady().then(() => {\n console.log(\"arcgis-weather is ready to go!\");\n});\n```"
55833
56346
  }
55834
56347
  ]
55835
56348
  },
@@ -55957,7 +56470,7 @@
55957
56470
  {
55958
56471
  "kind": "field",
55959
56472
  "name": "messageOverrides",
55960
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
56473
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
55961
56474
  "type": {
55962
56475
  "text": "Record<string, unknown>"
55963
56476
  }
@@ -56351,7 +56864,7 @@
56351
56864
  "docsTags": [
56352
56865
  {
56353
56866
  "name": "example",
56354
- "text": "const arcgisZoom = document.createElement(\"arcgis-zoom\");\ndocument.body.append(arcgisZoom);\narcgisZoom.componentOnReady().then(() => {\n console.log(\"arcgis-zoom is ready to go!\");\n});"
56867
+ "text": "```js\nconst arcgisZoom = document.createElement(\"arcgis-zoom\");\ndocument.body.append(arcgisZoom);\narcgisZoom.componentOnReady().then(() => {\n console.log(\"arcgis-zoom is ready to go!\");\n});\n```"
56355
56868
  }
56356
56869
  ]
56357
56870
  },
@@ -56435,7 +56948,7 @@
56435
56948
  {
56436
56949
  "kind": "field",
56437
56950
  "name": "messageOverrides",
56438
- "description": "Replace localized message strings with your own strings. **Warning**: individual message keys may change between releases.",
56951
+ "description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
56439
56952
  "type": {
56440
56953
  "text": "Record<string, unknown>"
56441
56954
  }