@arcgis/map-components 4.34.0-next.27 → 4.34.0-next.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cdn/24FPDZV7.js +4 -0
- package/dist/cdn/{LZPMLHP5.js → 26XWWC3S.js} +1 -1
- package/dist/cdn/276NHELU.js +4 -0
- package/dist/cdn/2BJA5MAU.js +4 -0
- package/dist/cdn/{YL4Y7JDE.js → 2EY5DO6Z.js} +1 -1
- package/dist/cdn/2KQJAHFP.js +4 -0
- package/dist/cdn/2P5Y3JRX.js +4 -0
- package/dist/cdn/2QPG3Q5P.js +4 -0
- package/dist/cdn/333MLOEH.js +4 -0
- package/dist/cdn/3JXRNHYR.js +4 -0
- package/dist/cdn/3KJZD7XN.js +4 -0
- package/dist/cdn/3M7KXP3Y.js +4 -0
- package/dist/cdn/3VW5LUCC.js +4 -0
- package/dist/cdn/44SA7HBW.js +4 -0
- package/dist/cdn/{ADDXVLXB.js → 45NPFIDE.js} +2 -2
- package/dist/cdn/{W3EYO5UZ.js → 45Q7VZOP.js} +2 -2
- package/dist/cdn/4DDH3ZJH.js +4 -0
- package/dist/cdn/4QBQCBD4.js +4 -0
- package/dist/cdn/{HQM4GIEH.js → 4VKU2EN4.js} +2 -2
- package/dist/cdn/5GOWQESW.js +4 -0
- package/dist/cdn/5IRNCV2N.js +4 -0
- package/dist/cdn/{VGEGLFUF.js → 5RDN3KFY.js} +2 -2
- package/dist/cdn/5RGTIRD7.js +4 -0
- package/dist/cdn/64APJKJA.js +4 -0
- package/dist/cdn/67RADHJ5.js +4 -0
- package/dist/cdn/{VIIGISB5.js → 6BKFKF7L.js} +1 -1
- package/dist/cdn/6DQXWYTE.js +4 -0
- package/dist/cdn/6K4PUBPP.js +4 -0
- package/dist/cdn/77DYAMA4.js +4 -0
- package/dist/cdn/7MTQS6K4.js +4 -0
- package/dist/cdn/7NMO7PDZ.js +4 -0
- package/dist/cdn/7S7V7W4D.js +4 -0
- package/dist/cdn/A7GQLK3I.js +4 -0
- package/dist/cdn/AMKFHZKY.js +4 -0
- package/dist/cdn/AYSS2UKJ.js +4 -0
- package/dist/cdn/AZCQUEEH.js +4 -0
- package/dist/cdn/B2KDMQ32.js +4 -0
- package/dist/cdn/B7YDMWF3.js +4 -0
- package/dist/cdn/BCBWIUBN.js +4 -0
- package/dist/cdn/BH2L5E72.js +4 -0
- package/dist/cdn/{XRCECLKQ.js → BHJMRERP.js} +2 -2
- package/dist/cdn/BN2HWRFH.js +4 -0
- package/dist/cdn/BPWVETWS.js +4 -0
- package/dist/cdn/BR4HST2V.js +4 -0
- package/dist/cdn/BRDLKHRY.js +4 -0
- package/dist/cdn/C4DO43NZ.js +4 -0
- package/dist/cdn/CDNUWNTM.js +4 -0
- package/dist/cdn/CRC32NKX.js +4 -0
- package/dist/cdn/CXSGFVZY.js +4 -0
- package/dist/cdn/D2RAH2FQ.js +4 -0
- package/dist/cdn/DHT24TD4.js +4 -0
- package/dist/cdn/E5I42L5X.js +4 -0
- package/dist/cdn/EC5YDWM5.js +4 -0
- package/dist/cdn/EFKIIUPG.js +4 -0
- package/dist/cdn/EGMCUKGO.js +4 -0
- package/dist/cdn/EMSE4SVU.js +4 -0
- package/dist/cdn/EQMI35F3.js +4 -0
- package/dist/cdn/F3HIUXO4.js +4 -0
- package/dist/cdn/F3VWFEIS.js +4 -0
- package/dist/cdn/F5433SPL.js +5 -0
- package/dist/cdn/FEDUC27Q.js +4 -0
- package/dist/cdn/FFVCLRFL.js +4 -0
- package/dist/cdn/FIAUIGJF.js +4 -0
- package/dist/cdn/G225AQXC.js +4 -0
- package/dist/cdn/G5LXZPGJ.js +4 -0
- package/dist/cdn/GAAYFJMP.js +4 -0
- package/dist/cdn/GEAJBOHU.js +4 -0
- package/dist/cdn/GGYGFSWG.js +4 -0
- package/dist/cdn/GK6AGJOQ.js +4 -0
- package/dist/cdn/GRTPQKD7.js +4 -0
- package/dist/cdn/GSEJQWEO.js +4 -0
- package/dist/cdn/GSLXVNUW.js +4 -0
- package/dist/cdn/HCLXQLUS.js +4 -0
- package/dist/cdn/HH76E2KD.js +4 -0
- package/dist/cdn/HWEJ5PT4.js +4 -0
- package/dist/cdn/HXMIL5AS.js +4 -0
- package/dist/cdn/HZ3EXHUM.js +4 -0
- package/dist/cdn/I2BZBDGD.js +4 -0
- package/dist/cdn/IAE4FOSC.js +4 -0
- package/dist/cdn/{UVR72ML4.js → IGL636IF.js} +1 -1
- package/dist/cdn/{EIOO5KHB.js → II4QJS4H.js} +2 -2
- package/dist/cdn/IJ4ROTL2.js +4 -0
- package/dist/cdn/J45Q67DX.js +4 -0
- package/dist/cdn/JJJWQZ7B.js +4 -0
- package/dist/cdn/JK6QTLOY.js +4 -0
- package/dist/cdn/JWQ52MP3.js +4 -0
- package/dist/cdn/JZYEYITJ.js +4 -0
- package/dist/cdn/KBJEHKCV.js +4 -0
- package/dist/cdn/KMO2Z6GG.js +4 -0
- package/dist/cdn/KRFYROYD.js +4 -0
- package/dist/cdn/KZ627ULY.js +4 -0
- package/dist/cdn/LAT2L32P.js +4 -0
- package/dist/cdn/LBTPWLNU.js +4 -0
- package/dist/cdn/LHERQF5S.js +4 -0
- package/dist/cdn/LJNBJG6J.js +4 -0
- package/dist/cdn/{PRQUVNCS.js → LOGHXN7W.js} +2 -2
- package/dist/cdn/LPYOZH47.js +4 -0
- package/dist/cdn/LXYGDPJX.js +4 -0
- package/dist/cdn/M43BI3QS.js +4 -0
- package/dist/cdn/MBITBB7M.js +4 -0
- package/dist/cdn/MHR4JVHS.js +4 -0
- package/dist/cdn/MKQXYSV7.js +4 -0
- package/dist/cdn/MME4V5UK.js +4 -0
- package/dist/cdn/MTTG4OB7.js +4 -0
- package/dist/cdn/MY2P3UKP.js +4 -0
- package/dist/cdn/MZEQBXJK.js +4 -0
- package/dist/cdn/N23VKPUM.js +4 -0
- package/dist/cdn/NACZDUUS.js +4 -0
- package/dist/cdn/NEIKHJUX.js +4 -0
- package/dist/cdn/NQCQTTL6.js +4 -0
- package/dist/cdn/NQGENYHI.js +4 -0
- package/dist/cdn/{3LMJCARQ.js → NWIGIUWJ.js} +2 -2
- package/dist/cdn/O4AUG6US.js +4 -0
- package/dist/cdn/OATFCBMW.js +4 -0
- package/dist/cdn/OGDXW57I.js +4 -0
- package/dist/cdn/OTMAAIG2.js +4 -0
- package/dist/cdn/OW6PGWSE.js +4 -0
- package/dist/cdn/OYD26KOZ.js +4 -0
- package/dist/cdn/P7PBJZCJ.js +4 -0
- package/dist/cdn/PLOCXDRL.js +4 -0
- package/dist/cdn/PNTZUJFY.js +4 -0
- package/dist/cdn/PPR7VJU5.js +4 -0
- package/dist/cdn/{2C2K5SPI.js → PSASMXDX.js} +2 -2
- package/dist/cdn/{CU4TWFZG.js → PUC7RUDW.js} +2 -2
- package/dist/cdn/Q4M2I3RE.js +4 -0
- package/dist/cdn/QA5B3JID.js +4 -0
- package/dist/cdn/QBCWEZVV.js +4 -0
- package/dist/cdn/QHFV4JKZ.js +4 -0
- package/dist/cdn/QKLKQYOY.js +4 -0
- package/dist/cdn/QPVWPM6E.js +4 -0
- package/dist/cdn/QT62ZAMZ.js +4 -0
- package/dist/cdn/QXLX4UL2.js +4 -0
- package/dist/cdn/RFBJ2OQC.js +4 -0
- package/dist/cdn/RFEZMAH3.js +4 -0
- package/dist/cdn/RFZ6LUVE.js +4 -0
- package/dist/cdn/RHLHBK4X.js +4 -0
- package/dist/cdn/RSMEMK6H.js +4 -0
- package/dist/cdn/S2YYAX4L.js +4 -0
- package/dist/cdn/SFEPVBQG.js +4 -0
- package/dist/cdn/SLWV42LP.js +4 -0
- package/dist/cdn/{5RJWIKWJ.js → SNJIA2RL.js} +1 -1
- package/dist/cdn/SQRD5AFX.js +4 -0
- package/dist/cdn/SRMODQG3.js +4 -0
- package/dist/cdn/T47YWDAU.js +4 -0
- package/dist/cdn/TTNCHBOO.js +4 -0
- package/dist/cdn/UH3MUYKL.js +4 -0
- package/dist/cdn/{5UVWLILC.js → UIPGHC7V.js} +2 -2
- package/dist/cdn/UNFGKH7G.js +4 -0
- package/dist/cdn/UOFDD23J.js +4 -0
- package/dist/cdn/UQYLORO7.js +4 -0
- package/dist/cdn/UU3SGRXZ.js +4 -0
- package/dist/cdn/UWDQA43B.js +4 -0
- package/dist/cdn/VGE6ZQV7.js +4 -0
- package/dist/cdn/VNCV763X.js +4 -0
- package/dist/cdn/VXBQGFGR.js +4 -0
- package/dist/cdn/{RAUNBZJ5.js → W2H7TOIL.js} +2 -2
- package/dist/cdn/W47E7SI7.js +4 -0
- package/dist/cdn/WAZIOM5Q.js +4 -0
- package/dist/cdn/WDSPHTTU.js +4 -0
- package/dist/cdn/{KKLXQ7UW.js → WHGLKTKZ.js} +2 -2
- package/dist/cdn/WII5UDMW.js +4 -0
- package/dist/cdn/WJFPEGBW.js +4 -0
- package/dist/cdn/WP56S75Y.js +4 -0
- package/dist/cdn/WT6GPDJ6.js +4 -0
- package/dist/cdn/WTUZGTCF.js +4 -0
- package/dist/cdn/{BHZONQFS.js → WUKA3PA2.js} +1 -1
- package/dist/cdn/WYDDPEQG.js +4 -0
- package/dist/cdn/X2ZARLSE.js +4 -0
- package/dist/cdn/X3AXOZH3.js +4 -0
- package/dist/cdn/{LE47SWLK.js → XIIS6IXK.js} +4 -4
- package/dist/cdn/{WII5DWBX.js → XRE4YCRR.js} +2 -2
- package/dist/cdn/YBK7NHPE.js +4 -0
- package/dist/cdn/YIJUWSQM.js +4 -0
- package/dist/cdn/YUMK75EJ.js +4 -0
- package/dist/cdn/YYPKTLS7.js +4 -0
- package/dist/cdn/YZXCCFKT.js +4 -0
- package/dist/cdn/Z4A6TUSH.js +4 -0
- package/dist/cdn/ZDN7XC4F.js +4 -0
- package/dist/cdn/ZGOVJI2V.js +4 -0
- package/dist/cdn/ZOTGL3WY.js +4 -0
- package/dist/cdn/ZYFJLBBS.js +4 -0
- package/dist/cdn/assets/feature/t9n/messages.ar.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.bg.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.bs.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ca.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.cs.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.da.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.de.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.el.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.en.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.es.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.et.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.fi.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.fr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.he.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.hr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.hu.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.id.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.it.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ja.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ko.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.lt.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.lv.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.nl.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.no.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.pl.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.pt-BR.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.pt-PT.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ro.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ru.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sk.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sl.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sv.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.th.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.tr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.uk.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.vi.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.zh-CN.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.zh-HK.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.zh-TW.json +1 -0
- package/dist/cdn/index.js +2 -2
- package/dist/cdn/main.css +1 -1
- package/dist/chunks/AnalysisViewModel.js +1 -1
- package/dist/chunks/async-utils.js +1 -1
- package/dist/chunks/basemap-gallery-resources.js +1 -1
- package/dist/chunks/chart-utils.js +66 -0
- package/dist/chunks/chartCommon.js +19 -0
- package/dist/chunks/component-utils.js +1 -1
- package/dist/chunks/createCloseEvent.js +1 -1
- package/dist/chunks/feature-utils.js +145 -0
- package/dist/chunks/globalCss.js +2 -1
- package/dist/chunks/heading.js +1 -1
- package/dist/chunks/layer-list.js +1 -1
- package/dist/chunks/legacyIcon.js +1 -1
- package/dist/chunks/maybe.js +1 -1
- package/dist/chunks/measurementUtils.js +1 -1
- package/dist/chunks/runtime.js +1 -1
- package/dist/chunks/useHandles.js +1 -1
- package/dist/chunks/useT9n.js +1 -1
- package/dist/chunks/useView.js +1 -1
- package/dist/chunks/useViewModel.js +1 -1
- package/dist/chunks/useWidget.js +1 -1
- package/dist/chunks/utils.js +1 -1
- package/dist/components/arcgis-area-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-area-measurement-3d/customElement.d.ts +105 -7
- package/dist/components/arcgis-area-measurement-3d/customElement.js +1 -1
- package/dist/components/arcgis-attachments/customElement.js +1 -1
- package/dist/components/arcgis-basemap-gallery/customElement.js +1 -1
- package/dist/components/arcgis-basemap-gallery-item/customElement.js +1 -1
- package/dist/components/arcgis-basemap-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-basemap-toggle/customElement.js +1 -1
- package/dist/components/arcgis-bookmarks/customElement.js +1 -1
- package/dist/components/arcgis-building-explorer/customElement.d.ts +20 -15
- package/dist/components/arcgis-building-explorer/customElement.js +1 -1
- package/dist/components/arcgis-catalog-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-compass/customElement.js +1 -1
- package/dist/components/arcgis-coordinate-conversion/customElement.js +1 -1
- package/dist/components/arcgis-daylight/customElement.d.ts +16 -11
- package/dist/components/arcgis-daylight/customElement.js +1 -1
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.d.ts +106 -7
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.js +1 -1
- package/dist/components/arcgis-directional-pad/customElement.js +1 -1
- package/dist/components/arcgis-directions/customElement.d.ts +1 -1
- package/dist/components/arcgis-directions/customElement.js +1 -1
- package/dist/components/arcgis-distance-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-editor/customElement.js +1 -1
- package/dist/components/arcgis-elevation-profile/customElement.d.ts +18 -23
- package/dist/components/arcgis-elevation-profile/customElement.js +1 -1
- package/dist/components/arcgis-expand/customElement.js +1 -1
- package/dist/components/arcgis-feature/customElement.js +10 -9
- package/dist/components/arcgis-feature-content/customElement.d.ts +1 -15
- package/dist/components/arcgis-feature-content/customElement.js +28 -54
- package/dist/components/arcgis-feature-element-info/customElement.d.ts +11 -0
- package/dist/components/arcgis-feature-element-info/customElement.js +39 -0
- package/dist/components/arcgis-feature-element-info/index.d.ts +1 -0
- package/dist/components/arcgis-feature-element-info/index.js +1 -0
- package/dist/components/arcgis-feature-fields/customElement.d.ts +16 -0
- package/dist/components/arcgis-feature-fields/customElement.js +141 -0
- package/dist/components/arcgis-feature-fields/index.d.ts +2 -0
- package/dist/components/arcgis-feature-fields/index.js +2 -0
- package/dist/components/arcgis-feature-form/customElement.js +1 -1
- package/dist/components/arcgis-feature-media/chartCommon.d.ts +1 -0
- package/dist/components/arcgis-feature-media/customElement.d.ts +37 -0
- package/dist/components/arcgis-feature-media/customElement.js +575 -0
- package/dist/components/arcgis-feature-media/index.d.ts +3 -0
- package/dist/components/arcgis-feature-media/index.js +3 -0
- package/dist/components/arcgis-feature-table/customElement.js +1 -1
- package/dist/components/arcgis-feature-templates/customElement.js +1 -1
- package/dist/components/arcgis-features/customElement.js +1 -1
- package/dist/components/arcgis-floor-filter/customElement.js +1 -1
- package/dist/components/arcgis-fullscreen/customElement.js +1 -1
- package/dist/components/arcgis-grid-controls/customElement.js +1 -1
- package/dist/components/arcgis-histogram-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-home/customElement.js +1 -1
- package/dist/components/arcgis-labeled-switch/customElement.js +1 -1
- package/dist/components/arcgis-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-layer-list-item/customElement.js +1 -1
- package/dist/components/arcgis-legend/customElement.js +1 -1
- package/dist/components/arcgis-line-of-sight/customElement.d.ts +63 -15
- package/dist/components/arcgis-line-of-sight/customElement.js +2 -2
- package/dist/components/arcgis-link-chart/customElement.js +1 -1
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.js +25 -26
- package/dist/components/arcgis-link-chart-layout-switcher/index.d.ts +1 -2
- package/dist/components/arcgis-link-chart-layout-switcher/index.js +1 -2
- package/dist/components/arcgis-locate/customElement.js +1 -1
- package/dist/components/arcgis-map/customElement.js +1 -1
- package/dist/components/arcgis-measurement/customElement.js +1 -1
- package/dist/components/arcgis-measurement-content/customElement.js +1 -1
- package/dist/components/arcgis-navigation-toggle/customElement.d.ts +6 -7
- package/dist/components/arcgis-navigation-toggle/customElement.js +1 -1
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.js +1 -1
- package/dist/components/arcgis-placement/customElement.js +1 -1
- package/dist/components/arcgis-print/customElement.d.ts +2 -6
- package/dist/components/arcgis-print/customElement.js +39 -33
- package/dist/components/arcgis-print-custom-text-elements/customElement.js +1 -1
- package/dist/components/arcgis-print-dpi-input/customElement.js +18 -23
- package/dist/components/arcgis-print-export-button/customElement.d.ts +1 -7
- package/dist/components/arcgis-print-export-button/customElement.js +3 -4
- package/dist/components/arcgis-print-exported-link/customElement.js +1 -1
- package/dist/components/arcgis-print-exports-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-format-select/customElement.js +1 -1
- package/dist/components/arcgis-print-layout-advanced-options/customElement.js +1 -1
- package/dist/components/arcgis-print-layout-panel/customElement.d.ts +1 -7
- package/dist/components/arcgis-print-layout-panel/customElement.js +8 -8
- package/dist/components/arcgis-print-main-panel/customElement.d.ts +1 -7
- package/dist/components/arcgis-print-main-panel/customElement.js +8 -8
- package/dist/components/arcgis-print-map-only-advanced-options/customElement.js +1 -1
- package/dist/components/arcgis-print-map-only-panel/customElement.d.ts +1 -7
- package/dist/components/arcgis-print-map-only-panel/customElement.js +28 -22
- package/dist/components/arcgis-print-out-spatial-reference-input/customElement.js +23 -18
- package/dist/components/arcgis-print-preview-input/customElement.js +1 -1
- package/dist/components/arcgis-print-scale-section/customElement.js +26 -19
- package/dist/components/arcgis-print-template-select/customElement.js +1 -1
- package/dist/components/arcgis-print-template-selector/customElement.js +1 -1
- package/dist/components/arcgis-scale-bar/customElement.js +1 -1
- package/dist/components/arcgis-scale-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-scene/customElement.d.ts +82 -58
- package/dist/components/arcgis-scene/customElement.js +2 -2
- package/dist/components/arcgis-search/customElement.d.ts +1 -1
- package/dist/components/arcgis-search/customElement.js +1 -1
- package/dist/components/arcgis-search-result-renderer/customElement.js +1 -1
- package/dist/components/arcgis-shadow-cast/customElement.d.ts +83 -25
- package/dist/components/arcgis-shadow-cast/customElement.js +1 -1
- package/dist/components/arcgis-sketch/customElement.js +1 -1
- package/dist/components/arcgis-slice/customElement.d.ts +63 -14
- package/dist/components/arcgis-slice/customElement.js +1 -1
- package/dist/components/arcgis-slider/customElement.js +1 -1
- package/dist/components/arcgis-swipe/customElement.js +1 -1
- package/dist/components/arcgis-table-list/customElement.js +1 -1
- package/dist/components/arcgis-time-slider/customElement.js +1 -1
- package/dist/components/arcgis-time-zone-label/customElement.js +1 -1
- package/dist/components/arcgis-track/customElement.js +1 -1
- package/dist/components/arcgis-unit-select/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-associations/customElement.d.ts +0 -2
- package/dist/components/arcgis-utility-network-associations/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-trace/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-validate-topology/customElement.js +1 -1
- package/dist/components/arcgis-value-picker/customElement.js +1 -1
- package/dist/components/arcgis-version-management/customElement.js +1 -1
- package/dist/components/arcgis-version-management-service-item/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-item/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-list/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-properties/customElement.js +1 -1
- package/dist/components/arcgis-video/customElement.js +1 -1
- package/dist/components/arcgis-video-player/customElement.js +1 -1
- package/dist/components/arcgis-video-player-action-bar/customElement.js +1 -1
- package/dist/components/arcgis-video-player-actions-group/customElement.js +1 -1
- package/dist/components/arcgis-video-player-controls-group/customElement.js +1 -1
- package/dist/components/arcgis-video-player-metadata/customElement.js +1 -1
- package/dist/components/arcgis-video-player-settings/customElement.js +1 -1
- package/dist/components/arcgis-video-player-slider/customElement.js +1 -1
- package/dist/components/arcgis-weather/customElement.d.ts +41 -1
- package/dist/components/arcgis-weather/customElement.js +1 -1
- package/dist/components/arcgis-zoom/customElement.js +1 -1
- package/dist/docs/api.json +150 -309
- package/dist/docs/docs.json +119 -300
- package/dist/docs/vscode.html-custom-data.json +46 -68
- package/dist/docs/web-types.json +120 -164
- package/dist/index.d.ts +3 -22
- package/dist/index.js +1 -1
- package/dist/loader.js +11 -8
- package/dist/types/lumina.d.ts +3 -9
- package/dist/types/preact.d.ts +3 -10
- package/dist/types/react.d.ts +3 -11
- package/dist/types/stencil.d.ts +3 -9
- package/dist/utils/chart-utils.d.ts +6 -0
- package/dist/utils/feature-utils.d.ts +20 -0
- package/dist/utils/related-feature-utils.d.ts +17 -0
- package/dist/utils/uri-utils.d.ts +4 -0
- package/package.json +4 -3
- package/dist/cdn/2U6HOP3Z.js +0 -4
- package/dist/cdn/333YBQXV.js +0 -4
- package/dist/cdn/3O65OLU5.js +0 -4
- package/dist/cdn/3QFTHNX4.js +0 -4
- package/dist/cdn/3XTH4QWQ.js +0 -4
- package/dist/cdn/42KRQYCM.js +0 -4
- package/dist/cdn/42LZE7I2.js +0 -4
- package/dist/cdn/4RUEXX2Z.js +0 -4
- package/dist/cdn/5OJPKBWK.js +0 -4
- package/dist/cdn/5RRATYNL.js +0 -4
- package/dist/cdn/66J3J2SY.js +0 -4
- package/dist/cdn/6BJUHDTO.js +0 -4
- package/dist/cdn/6MB6M64L.js +0 -4
- package/dist/cdn/6RT6JBOP.js +0 -4
- package/dist/cdn/7QZRNM7N.js +0 -4
- package/dist/cdn/A4VYJ2P7.js +0 -4
- package/dist/cdn/A5QTQ7P4.js +0 -4
- package/dist/cdn/AECHB3I5.js +0 -4
- package/dist/cdn/B3JFEBBM.js +0 -4
- package/dist/cdn/B6JXXUQL.js +0 -4
- package/dist/cdn/BCB7BLFF.js +0 -4
- package/dist/cdn/BCXEJTPD.js +0 -4
- package/dist/cdn/BJZTLQSB.js +0 -4
- package/dist/cdn/BLVA5PBO.js +0 -4
- package/dist/cdn/CG3E5YWJ.js +0 -4
- package/dist/cdn/CH4XWHFR.js +0 -4
- package/dist/cdn/CKSXZ6EE.js +0 -4
- package/dist/cdn/D64Q4JT6.js +0 -4
- package/dist/cdn/DMHP4N5T.js +0 -4
- package/dist/cdn/DOLHDAA3.js +0 -4
- package/dist/cdn/DSMTI6TV.js +0 -4
- package/dist/cdn/EQL2MFTP.js +0 -4
- package/dist/cdn/EXJ3RUZ2.js +0 -4
- package/dist/cdn/G4F7ZGSN.js +0 -4
- package/dist/cdn/GVH67NSB.js +0 -4
- package/dist/cdn/H7M54WHB.js +0 -4
- package/dist/cdn/HRCTS634.js +0 -4
- package/dist/cdn/I7B4NZNH.js +0 -4
- package/dist/cdn/ILB7FV4U.js +0 -4
- package/dist/cdn/ILS6JRJH.js +0 -4
- package/dist/cdn/IPWHI4Y7.js +0 -4
- package/dist/cdn/IXFC6ELJ.js +0 -4
- package/dist/cdn/JEZJUXYK.js +0 -4
- package/dist/cdn/K5ODVBEF.js +0 -4
- package/dist/cdn/K65XE53D.js +0 -4
- package/dist/cdn/KN3UXCYY.js +0 -4
- package/dist/cdn/KSG35E2O.js +0 -4
- package/dist/cdn/KV7FWIG6.js +0 -4
- package/dist/cdn/LCFCW764.js +0 -4
- package/dist/cdn/LCMIW5LY.js +0 -4
- package/dist/cdn/LEZPBXYE.js +0 -4
- package/dist/cdn/LJQ34F6U.js +0 -4
- package/dist/cdn/M6RA45RU.js +0 -4
- package/dist/cdn/MBIVD5QP.js +0 -4
- package/dist/cdn/MCA346TA.js +0 -4
- package/dist/cdn/MID4XN32.js +0 -4
- package/dist/cdn/MIKLFSBE.js +0 -4
- package/dist/cdn/MJXVELFH.js +0 -4
- package/dist/cdn/MZSKUUN7.js +0 -4
- package/dist/cdn/N532SFQW.js +0 -4
- package/dist/cdn/N6NM7HGW.js +0 -4
- package/dist/cdn/NA36CJYX.js +0 -4
- package/dist/cdn/NBQ2I7QY.js +0 -4
- package/dist/cdn/ND3L4C7A.js +0 -4
- package/dist/cdn/NIURPH5F.js +0 -4
- package/dist/cdn/NPMJ74VU.js +0 -4
- package/dist/cdn/NQRGDV3R.js +0 -4
- package/dist/cdn/NXEUUXZD.js +0 -4
- package/dist/cdn/ODZI2VHW.js +0 -4
- package/dist/cdn/OKQNM3BC.js +0 -4
- package/dist/cdn/ONEFUPNT.js +0 -4
- package/dist/cdn/PRNITCHN.js +0 -4
- package/dist/cdn/Q3SGVJXR.js +0 -4
- package/dist/cdn/Q4FM7KYI.js +0 -4
- package/dist/cdn/Q5ZT2C3G.js +0 -4
- package/dist/cdn/RAF4I3YA.js +0 -4
- package/dist/cdn/RQIA5JLR.js +0 -4
- package/dist/cdn/RSLVUXIV.js +0 -4
- package/dist/cdn/RYU6333R.js +0 -4
- package/dist/cdn/RYWUMTWQ.js +0 -4
- package/dist/cdn/RZSFQLIZ.js +0 -4
- package/dist/cdn/SG44OS5F.js +0 -4
- package/dist/cdn/SYNFYP4D.js +0 -4
- package/dist/cdn/T7UXTD6H.js +0 -4
- package/dist/cdn/TI5Y3HLI.js +0 -4
- package/dist/cdn/TLWO6SJL.js +0 -4
- package/dist/cdn/UGVMFLMD.js +0 -4
- package/dist/cdn/UZMEMSOT.js +0 -4
- package/dist/cdn/WGGQZIAZ.js +0 -4
- package/dist/cdn/WREJU2AE.js +0 -4
- package/dist/cdn/WSNK3QOM.js +0 -4
- package/dist/cdn/WTOJCQP5.js +0 -4
- package/dist/cdn/X4WMYNNV.js +0 -4
- package/dist/cdn/XELMLRDX.js +0 -4
- package/dist/cdn/XTCDEOLD.js +0 -4
- package/dist/cdn/Y4MHIXP7.js +0 -4
- package/dist/cdn/Y7DL7NNE.js +0 -4
- package/dist/cdn/Z2KPDNNL.js +0 -4
- package/dist/cdn/ZVCLRASV.js +0 -4
package/dist/docs/web-types.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
|
|
3
3
|
"name": "@arcgis/map-components",
|
|
4
|
-
"version": "4.34.0-next.
|
|
4
|
+
"version": "4.34.0-next.29",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -171,7 +171,7 @@
|
|
|
171
171
|
},
|
|
172
172
|
{
|
|
173
173
|
"name": "arcgis-area-measurement-3d",
|
|
174
|
-
"description": "The Area Measurement 3D component
|
|
174
|
+
"description": "The Area Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent to calculate and display area and perimeter of polygons.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow the area and perimeter are computed depends on the scene's spatial reference and the length of the measured perimeter.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- If the measurement's perimeter is below 100 km, they are computed in a Euclidean manner,\n in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets).\n- If the perimeter is above 100 km, they are computed geodetically, and the visualization takes\n the curvature of the planet into consideration.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, the area and perimeter\nare always calculated in a Euclidean manner (in their respective PCS).\n\nThe area may be visualized and calculated in two ways:\n1. If all the vertices are mostly coplanar (lying on the same plane),\n the measurement polygon is formed on that plane, and area and perimeter are calculated from its geometry.\n2. If the vertices don't form a planar surface, the measurement polygon\n is projected to a horizontal plane, and area and perimeter are calculated from its geometry.\n\n\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\n\n**Things to consider**\n\n* Area Measurement 3D is designed to work in the Scene component. For measurements in the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Area Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/).\n* Snapping is enabled by default. Holding the `CTRL` key disables it.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
|
|
175
175
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/",
|
|
176
176
|
"attributes": [
|
|
177
177
|
{
|
|
@@ -223,7 +223,7 @@
|
|
|
223
223
|
},
|
|
224
224
|
{
|
|
225
225
|
"name": "state",
|
|
226
|
-
"description": "The
|
|
226
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
227
227
|
"value": {
|
|
228
228
|
"type": [
|
|
229
229
|
"\"disabled\"",
|
|
@@ -235,7 +235,7 @@
|
|
|
235
235
|
},
|
|
236
236
|
{
|
|
237
237
|
"name": "unit",
|
|
238
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the
|
|
238
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
239
239
|
"value": {
|
|
240
240
|
"type": [
|
|
241
241
|
"\"acres\"",
|
|
@@ -274,7 +274,7 @@
|
|
|
274
274
|
"properties": [
|
|
275
275
|
{
|
|
276
276
|
"name": "analysis",
|
|
277
|
-
"description": "
|
|
277
|
+
"description": "The [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Area Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst areaMeasurementAnalysis = new AreaMeasurementAnalysis({\n geometry: new Polygon({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n rings: [\n [\n [-13624861.22274897, 4550346.5519295, 63.378210234455764],\n [-13624935.305160372, 4550273.144585712, 63.37829629518092],\n [-13624995.61798748, 4550334.030096778, 63.37819860037416],\n [-13624921.53589075, 4550407.42357004, 63.3783810287714],\n [-13624861.22274897, 4550346.5519295, 63.378210234455764]\n ]\n ]\n })\n});\n// Get the Scene and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst areaMeasurement3d = document.querySelector(\"arcgis-area-measurement-3d\");\nawait areaMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(areaMeasurementAnalysis);\n// Connect the analysis to the measurement component:\nareaMeasurement3d.analysis = areaMeasurementAnalysis;\n```",
|
|
278
278
|
"type": "AreaMeasurementAnalysis"
|
|
279
279
|
},
|
|
280
280
|
{
|
|
@@ -303,17 +303,17 @@
|
|
|
303
303
|
},
|
|
304
304
|
{
|
|
305
305
|
"name": "state",
|
|
306
|
-
"description": "The
|
|
306
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
307
307
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
308
308
|
},
|
|
309
309
|
{
|
|
310
310
|
"name": "unit",
|
|
311
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the
|
|
311
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
312
312
|
"type": "\"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\" | \"square-centimeters\" | \"square-decimeters\" | \"square-feet\" | \"square-inches\" | \"square-kilometers\" | \"square-meters\" | \"square-miles\" | \"square-millimeters\" | \"square-nautical-miles\" | \"square-us-feet\" | \"square-yards\""
|
|
313
313
|
},
|
|
314
314
|
{
|
|
315
315
|
"name": "unitOptions",
|
|
316
|
-
"description": "List of unit systems (imperial, metric)
|
|
316
|
+
"description": "List of available units and unit systems (imperial, metric) for displaying the area values.\nBy default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [unit](#unit) values can only be a subset of this list.\nWith this, it is possible to limit which options are shown in the component's dropdown.",
|
|
317
317
|
"type": "Array<\"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\">"
|
|
318
318
|
}
|
|
319
319
|
],
|
|
@@ -1717,7 +1717,7 @@
|
|
|
1717
1717
|
},
|
|
1718
1718
|
{
|
|
1719
1719
|
"name": "arcgis-building-explorer",
|
|
1720
|
-
"description": "The Building Explorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
1720
|
+
"description": "The Building Explorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.\n\n**Known limitations**\n\nBuilding Explorer is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
1721
1721
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/",
|
|
1722
1722
|
"attributes": [
|
|
1723
1723
|
{
|
|
@@ -1730,7 +1730,7 @@
|
|
|
1730
1730
|
},
|
|
1731
1731
|
{
|
|
1732
1732
|
"name": "heading-level",
|
|
1733
|
-
"description": "Indicates the heading level to use for the
|
|
1733
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1734
1734
|
"default": "3",
|
|
1735
1735
|
"value": {
|
|
1736
1736
|
"type": "number"
|
|
@@ -1759,7 +1759,7 @@
|
|
|
1759
1759
|
},
|
|
1760
1760
|
{
|
|
1761
1761
|
"name": "icon",
|
|
1762
|
-
"description": "Icon which represents the
|
|
1762
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
1763
1763
|
"default": "\"organization\"",
|
|
1764
1764
|
"value": {
|
|
1765
1765
|
"type": "string"
|
|
@@ -1767,7 +1767,7 @@
|
|
|
1767
1767
|
},
|
|
1768
1768
|
{
|
|
1769
1769
|
"name": "label",
|
|
1770
|
-
"description": "The
|
|
1770
|
+
"description": "The component's default label.",
|
|
1771
1771
|
"value": {
|
|
1772
1772
|
"type": "string"
|
|
1773
1773
|
}
|
|
@@ -1798,7 +1798,7 @@
|
|
|
1798
1798
|
},
|
|
1799
1799
|
{
|
|
1800
1800
|
"name": "state",
|
|
1801
|
-
"description": "The
|
|
1801
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - \tcomponent is being created\n* `loading` - layers and statistics are loading\n* `ready` - component is ready\n* `failed` - component failed to load data",
|
|
1802
1802
|
"default": "\"disabled\"",
|
|
1803
1803
|
"value": {
|
|
1804
1804
|
"type": [
|
|
@@ -1831,7 +1831,7 @@
|
|
|
1831
1831
|
},
|
|
1832
1832
|
{
|
|
1833
1833
|
"name": "headingLevel",
|
|
1834
|
-
"description": "Indicates the heading level to use for the
|
|
1834
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1835
1835
|
"type": "number"
|
|
1836
1836
|
},
|
|
1837
1837
|
{
|
|
@@ -1848,17 +1848,17 @@
|
|
|
1848
1848
|
},
|
|
1849
1849
|
{
|
|
1850
1850
|
"name": "icon",
|
|
1851
|
-
"description": "Icon which represents the
|
|
1851
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
1852
1852
|
"type": "string"
|
|
1853
1853
|
},
|
|
1854
1854
|
{
|
|
1855
1855
|
"name": "label",
|
|
1856
|
-
"description": "The
|
|
1856
|
+
"description": "The component's default label.",
|
|
1857
1857
|
"type": "string"
|
|
1858
1858
|
},
|
|
1859
1859
|
{
|
|
1860
1860
|
"name": "layers",
|
|
1861
|
-
"description": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)
|
|
1861
|
+
"description": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)\nof layers of type [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html)\nthat are added to the componen for exploration.",
|
|
1862
1862
|
"type": "Collection<BuildingSceneLayer>"
|
|
1863
1863
|
},
|
|
1864
1864
|
{
|
|
@@ -1882,7 +1882,7 @@
|
|
|
1882
1882
|
},
|
|
1883
1883
|
{
|
|
1884
1884
|
"name": "state",
|
|
1885
|
-
"description": "The
|
|
1885
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - \tcomponent is being created\n* `loading` - layers and statistics are loading\n* `ready` - component is ready\n* `failed` - component failed to load data",
|
|
1886
1886
|
"type": "\"disabled\" | \"failed\" | \"loading\" | \"ready\""
|
|
1887
1887
|
}
|
|
1888
1888
|
],
|
|
@@ -2687,7 +2687,7 @@
|
|
|
2687
2687
|
},
|
|
2688
2688
|
{
|
|
2689
2689
|
"name": "arcgis-daylight",
|
|
2690
|
-
"description": "The Daylight component can be used to manipulate the lighting conditions of a [
|
|
2690
|
+
"description": "The Daylight component can be used to manipulate the lighting conditions of a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\n**Known limitations**\n\nDaylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisUserDateTimeChange** - Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
2691
2691
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/",
|
|
2692
2692
|
"attributes": [
|
|
2693
2693
|
{
|
|
@@ -2712,7 +2712,7 @@
|
|
|
2712
2712
|
},
|
|
2713
2713
|
{
|
|
2714
2714
|
"name": "date-or-season",
|
|
2715
|
-
"description": "Controls whether the
|
|
2715
|
+
"description": "Controls whether the component displays a date or a season picker.",
|
|
2716
2716
|
"default": "\"date\"",
|
|
2717
2717
|
"value": {
|
|
2718
2718
|
"type": [
|
|
@@ -2731,7 +2731,7 @@
|
|
|
2731
2731
|
},
|
|
2732
2732
|
{
|
|
2733
2733
|
"name": "heading-level",
|
|
2734
|
-
"description": "Indicates the heading level to use for the
|
|
2734
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
2735
2735
|
"default": "3",
|
|
2736
2736
|
"value": {
|
|
2737
2737
|
"type": "number"
|
|
@@ -2781,7 +2781,7 @@
|
|
|
2781
2781
|
},
|
|
2782
2782
|
{
|
|
2783
2783
|
"name": "icon",
|
|
2784
|
-
"description": "Icon which represents the
|
|
2784
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
2785
2785
|
"default": "\"brightness\"",
|
|
2786
2786
|
"value": {
|
|
2787
2787
|
"type": "string"
|
|
@@ -2789,7 +2789,7 @@
|
|
|
2789
2789
|
},
|
|
2790
2790
|
{
|
|
2791
2791
|
"name": "label",
|
|
2792
|
-
"description": "The
|
|
2792
|
+
"description": "The component's default label.",
|
|
2793
2793
|
"value": {
|
|
2794
2794
|
"type": "string"
|
|
2795
2795
|
}
|
|
@@ -2852,7 +2852,7 @@
|
|
|
2852
2852
|
{
|
|
2853
2853
|
"name": "arcgisUserDateTimeChange",
|
|
2854
2854
|
"type": "void",
|
|
2855
|
-
"description": "Fires when the user changes the date or time in the
|
|
2855
|
+
"description": "Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons."
|
|
2856
2856
|
}
|
|
2857
2857
|
],
|
|
2858
2858
|
"js": {
|
|
@@ -2869,7 +2869,7 @@
|
|
|
2869
2869
|
},
|
|
2870
2870
|
{
|
|
2871
2871
|
"name": "dateOrSeason",
|
|
2872
|
-
"description": "Controls whether the
|
|
2872
|
+
"description": "Controls whether the component displays a date or a season picker.",
|
|
2873
2873
|
"type": "\"date\" | \"season\""
|
|
2874
2874
|
},
|
|
2875
2875
|
{
|
|
@@ -2879,7 +2879,7 @@
|
|
|
2879
2879
|
},
|
|
2880
2880
|
{
|
|
2881
2881
|
"name": "headingLevel",
|
|
2882
|
-
"description": "Indicates the heading level to use for the
|
|
2882
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
2883
2883
|
"type": "number"
|
|
2884
2884
|
},
|
|
2885
2885
|
{
|
|
@@ -2908,12 +2908,12 @@
|
|
|
2908
2908
|
},
|
|
2909
2909
|
{
|
|
2910
2910
|
"name": "icon",
|
|
2911
|
-
"description": "Icon which represents the
|
|
2911
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
2912
2912
|
"type": "string"
|
|
2913
2913
|
},
|
|
2914
2914
|
{
|
|
2915
2915
|
"name": "label",
|
|
2916
|
-
"description": "The
|
|
2916
|
+
"description": "The component's default label.",
|
|
2917
2917
|
"type": "string"
|
|
2918
2918
|
},
|
|
2919
2919
|
{
|
|
@@ -2950,7 +2950,7 @@
|
|
|
2950
2950
|
{
|
|
2951
2951
|
"name": "arcgisUserDateTimeChange",
|
|
2952
2952
|
"type": "void",
|
|
2953
|
-
"description": "Fires when the user changes the date or time in the
|
|
2953
|
+
"description": "Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons."
|
|
2954
2954
|
}
|
|
2955
2955
|
]
|
|
2956
2956
|
}
|
|
@@ -3383,7 +3383,7 @@
|
|
|
3383
3383
|
},
|
|
3384
3384
|
{
|
|
3385
3385
|
"name": "searchProperties",
|
|
3386
|
-
"description": "Controls the default properties used when
|
|
3386
|
+
"description": "Controls the default properties used when searching.",
|
|
3387
3387
|
"type": "DirectionsSearchProperties"
|
|
3388
3388
|
},
|
|
3389
3389
|
{
|
|
@@ -3417,7 +3417,7 @@
|
|
|
3417
3417
|
},
|
|
3418
3418
|
{
|
|
3419
3419
|
"name": "arcgis-direct-line-measurement-3d",
|
|
3420
|
-
"description": "The Direct Line Measurement 3D component
|
|
3420
|
+
"description": "The Direct Line Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent to calculate and display vertical, horizontal, and direct distances between two points.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow distances are computed depends on the scene's spatial reference.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- Direct distance is computed in a Euclidean manner, in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets);\n- Horizontal distance is computed geodetically, taking into consideration the curvature of the planet;\n- Vertical distance is computed as an elevation difference.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, all three distances (direct, horizontal, and vertical)\n are computed in a Euclidean manner (in their respective PCS).\n\nDirect Line Measurement 3D component visualizes and labels the direct, horizontal, and vertical distances and displays the same values\nin the UI panel. When the distance between the points is greater than 100 kilometers,\nthe measurement visualization is simplified, and only the horizontal and vertical distances are calculated.\nThe direct distance option becomes unavailable.\n\n\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\nA second laser line shows the intersection of the scene with the vertical plane that passes through the checkered line.\n\n**Things to consider**\n\n* Direct Line Measurement 3D is designed to work in the Scene component. For measurements in the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Distance Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/).\n* Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n- [Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
|
|
3421
3421
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/",
|
|
3422
3422
|
"attributes": [
|
|
3423
3423
|
{
|
|
@@ -3469,6 +3469,7 @@
|
|
|
3469
3469
|
},
|
|
3470
3470
|
{
|
|
3471
3471
|
"name": "state",
|
|
3472
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3472
3473
|
"value": {
|
|
3473
3474
|
"type": [
|
|
3474
3475
|
"\"disabled\"",
|
|
@@ -3480,7 +3481,7 @@
|
|
|
3480
3481
|
},
|
|
3481
3482
|
{
|
|
3482
3483
|
"name": "unit",
|
|
3483
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3484
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3484
3485
|
"value": {
|
|
3485
3486
|
"type": [
|
|
3486
3487
|
"\"centimeters\"",
|
|
@@ -3516,7 +3517,7 @@
|
|
|
3516
3517
|
"properties": [
|
|
3517
3518
|
{
|
|
3518
3519
|
"name": "analysis",
|
|
3519
|
-
"description": "
|
|
3520
|
+
"description": "The [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Direct Line Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst directLineAnalysis = new DirectLineMeasurementAnalysis({\n startPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624995.61798748,\n y: 4550334.030096778,\n z: 63.378210234455764\n }),\n endPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624921.53589075,\n y: 4550407.42357004,\n z: 63.3783810287714\n }),\n});\n// Get the Scene and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst directLineMeasurement3d = document.querySelector(\"arcgis-direct-line-measurement-3d\");\nawait directLineMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(directLineAnalysis);\n// Connect the analysis to the measurement component:\ndirectLineMeasurement3d.analysis = directLineAnalysis;\n```",
|
|
3520
3521
|
"type": "DirectLineMeasurementAnalysis"
|
|
3521
3522
|
},
|
|
3522
3523
|
{
|
|
@@ -3545,16 +3546,17 @@
|
|
|
3545
3546
|
},
|
|
3546
3547
|
{
|
|
3547
3548
|
"name": "state",
|
|
3549
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3548
3550
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
3549
3551
|
},
|
|
3550
3552
|
{
|
|
3551
3553
|
"name": "unit",
|
|
3552
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3554
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3553
3555
|
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
3554
3556
|
},
|
|
3555
3557
|
{
|
|
3556
3558
|
"name": "unitOptions",
|
|
3557
|
-
"description": "List of unit systems (imperial, metric)
|
|
3559
|
+
"description": "List of available units and unit systems (imperial, metric) for displaying the distance values.\nBy default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [unit](#unit) values can only be a subset of this list.\nWith this, it is possible to limit which options are shown in the component's dropdown.",
|
|
3558
3560
|
"type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
|
|
3559
3561
|
}
|
|
3560
3562
|
],
|
|
@@ -3574,7 +3576,7 @@
|
|
|
3574
3576
|
},
|
|
3575
3577
|
{
|
|
3576
3578
|
"name": "arcgis-directline-measurement-3d",
|
|
3577
|
-
"description": "**Deprecated**. The
|
|
3579
|
+
"description": "**Deprecated**. The Directline Measurement 3D component calculates and displays the 3D distance between two points. It can be used in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component to measure the vertical, horizontal, and direct distance between two points.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
|
|
3578
3580
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directline-measurement-3d/",
|
|
3579
3581
|
"attributes": [
|
|
3580
3582
|
{
|
|
@@ -3626,6 +3628,7 @@
|
|
|
3626
3628
|
},
|
|
3627
3629
|
{
|
|
3628
3630
|
"name": "state",
|
|
3631
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3629
3632
|
"value": {
|
|
3630
3633
|
"type": [
|
|
3631
3634
|
"\"disabled\"",
|
|
@@ -3637,7 +3640,7 @@
|
|
|
3637
3640
|
},
|
|
3638
3641
|
{
|
|
3639
3642
|
"name": "unit",
|
|
3640
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3643
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3641
3644
|
"value": {
|
|
3642
3645
|
"type": [
|
|
3643
3646
|
"\"centimeters\"",
|
|
@@ -3673,7 +3676,7 @@
|
|
|
3673
3676
|
"properties": [
|
|
3674
3677
|
{
|
|
3675
3678
|
"name": "analysis",
|
|
3676
|
-
"description": "
|
|
3679
|
+
"description": "The [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Direct Line Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst directLineAnalysis = new DirectLineMeasurementAnalysis({\n startPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624995.61798748,\n y: 4550334.030096778,\n z: 63.378210234455764\n }),\n endPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624921.53589075,\n y: 4550407.42357004,\n z: 63.3783810287714\n }),\n});\n// Get the Scene and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst directLineMeasurement3d = document.querySelector(\"arcgis-direct-line-measurement-3d\");\nawait directLineMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(directLineAnalysis);\n// Connect the analysis to the measurement component:\ndirectLineMeasurement3d.analysis = directLineAnalysis;\n```",
|
|
3677
3680
|
"type": "DirectLineMeasurementAnalysis"
|
|
3678
3681
|
},
|
|
3679
3682
|
{
|
|
@@ -3702,16 +3705,17 @@
|
|
|
3702
3705
|
},
|
|
3703
3706
|
{
|
|
3704
3707
|
"name": "state",
|
|
3708
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3705
3709
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
3706
3710
|
},
|
|
3707
3711
|
{
|
|
3708
3712
|
"name": "unit",
|
|
3709
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3713
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3710
3714
|
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
3711
3715
|
},
|
|
3712
3716
|
{
|
|
3713
3717
|
"name": "unitOptions",
|
|
3714
|
-
"description": "List of unit systems (imperial, metric)
|
|
3718
|
+
"description": "List of available units and unit systems (imperial, metric) for displaying the distance values.\nBy default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [unit](#unit) values can only be a subset of this list.\nWith this, it is possible to limit which options are shown in the component's dropdown.",
|
|
3715
3719
|
"type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
|
|
3716
3720
|
}
|
|
3717
3721
|
],
|
|
@@ -4169,7 +4173,7 @@
|
|
|
4169
4173
|
},
|
|
4170
4174
|
{
|
|
4171
4175
|
"name": "arcgis-elevation-profile",
|
|
4172
|
-
"description": "The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`\n- `stop(): Promise<void>`",
|
|
4176
|
+
"description": "The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).\n\n**See also**\n\n- [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>`\n- `stop(): Promise<void>`",
|
|
4173
4177
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/",
|
|
4174
4178
|
"attributes": [
|
|
4175
4179
|
{
|
|
@@ -4253,7 +4257,7 @@
|
|
|
4253
4257
|
},
|
|
4254
4258
|
{
|
|
4255
4259
|
"name": "icon",
|
|
4256
|
-
"description": "Icon which represents the
|
|
4260
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
4257
4261
|
"default": "\"altitude\"",
|
|
4258
4262
|
"value": {
|
|
4259
4263
|
"type": "string"
|
|
@@ -4261,7 +4265,7 @@
|
|
|
4261
4265
|
},
|
|
4262
4266
|
{
|
|
4263
4267
|
"name": "label",
|
|
4264
|
-
"description": "The
|
|
4268
|
+
"description": "The component's default label.",
|
|
4265
4269
|
"value": {
|
|
4266
4270
|
"type": "string"
|
|
4267
4271
|
}
|
|
@@ -4292,7 +4296,7 @@
|
|
|
4292
4296
|
},
|
|
4293
4297
|
{
|
|
4294
4298
|
"name": "state",
|
|
4295
|
-
"description": "The
|
|
4299
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready; no path configured and no interactive operation ongoing\n* `creating` - user is creating a new input path\n* `created` - input path is configured but no interactive operation is ongoing\n* `selecting` - user is selecting an existing input path\n* `selected` - user selected an existing input path",
|
|
4296
4300
|
"default": "\"disabled\"",
|
|
4297
4301
|
"value": {
|
|
4298
4302
|
"type": [
|
|
@@ -4356,7 +4360,7 @@
|
|
|
4356
4360
|
},
|
|
4357
4361
|
{
|
|
4358
4362
|
"name": "effectiveUnits",
|
|
4359
|
-
"description": "Units which have been selected according to the magnitude of the elevations and distances
|
|
4363
|
+
"description": "Units which have been selected according to the magnitude of the elevations and distances that are to be displayed in the component, according to the selected unit or unit system.",
|
|
4360
4364
|
"type": "EffectiveUnits"
|
|
4361
4365
|
},
|
|
4362
4366
|
{
|
|
@@ -4403,7 +4407,7 @@
|
|
|
4403
4407
|
},
|
|
4404
4408
|
{
|
|
4405
4409
|
"name": "icon",
|
|
4406
|
-
"description": "Icon which represents the
|
|
4410
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
4407
4411
|
"type": "string"
|
|
4408
4412
|
},
|
|
4409
4413
|
{
|
|
@@ -4413,7 +4417,7 @@
|
|
|
4413
4417
|
},
|
|
4414
4418
|
{
|
|
4415
4419
|
"name": "label",
|
|
4416
|
-
"description": "The
|
|
4420
|
+
"description": "The component's default label.",
|
|
4417
4421
|
"type": "string"
|
|
4418
4422
|
},
|
|
4419
4423
|
{
|
|
@@ -4422,7 +4426,7 @@
|
|
|
4422
4426
|
},
|
|
4423
4427
|
{
|
|
4424
4428
|
"name": "profiles",
|
|
4425
|
-
"description": "Collection of elevation profile lines which are to be generated and displayed in the
|
|
4429
|
+
"description": "Collection of elevation profile lines which are to be generated and displayed in the component's chart.",
|
|
4426
4430
|
"type": "Collection<ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineView>"
|
|
4427
4431
|
},
|
|
4428
4432
|
{
|
|
@@ -4437,7 +4441,7 @@
|
|
|
4437
4441
|
},
|
|
4438
4442
|
{
|
|
4439
4443
|
"name": "state",
|
|
4440
|
-
"description": "The
|
|
4444
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready; no path configured and no interactive operation ongoing\n* `creating` - user is creating a new input path\n* `created` - input path is configured but no interactive operation is ongoing\n* `selecting` - user is selecting an existing input path\n* `selected` - user selected an existing input path",
|
|
4441
4445
|
"type": "\"created\" | \"creating\" | \"disabled\" | \"ready\" | \"selected\" | \"selecting\""
|
|
4442
4446
|
},
|
|
4443
4447
|
{
|
|
@@ -5031,56 +5035,6 @@
|
|
|
5031
5035
|
]
|
|
5032
5036
|
}
|
|
5033
5037
|
},
|
|
5034
|
-
{
|
|
5035
|
-
"name": "arcgis-feature-content",
|
|
5036
|
-
"description": "### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
5037
|
-
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-content/",
|
|
5038
|
-
"attributes": [
|
|
5039
|
-
{
|
|
5040
|
-
"name": "auto-destroy-disabled",
|
|
5041
|
-
"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.",
|
|
5042
|
-
"default": "false",
|
|
5043
|
-
"value": {
|
|
5044
|
-
"type": "boolean"
|
|
5045
|
-
}
|
|
5046
|
-
}
|
|
5047
|
-
],
|
|
5048
|
-
"events": [
|
|
5049
|
-
{
|
|
5050
|
-
"name": "arcgisReady",
|
|
5051
|
-
"type": "void",
|
|
5052
|
-
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
|
|
5053
|
-
}
|
|
5054
|
-
],
|
|
5055
|
-
"js": {
|
|
5056
|
-
"properties": [
|
|
5057
|
-
{
|
|
5058
|
-
"name": "autoDestroyDisabled",
|
|
5059
|
-
"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.",
|
|
5060
|
-
"type": "boolean"
|
|
5061
|
-
},
|
|
5062
|
-
{
|
|
5063
|
-
"name": "creator",
|
|
5064
|
-
"type": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))"
|
|
5065
|
-
},
|
|
5066
|
-
{
|
|
5067
|
-
"name": "destroyer",
|
|
5068
|
-
"type": "(((event?: PopupTemplateCreatorEvent | undefined) => PopupTemplateContent | Promise<PopupTemplateContent>))"
|
|
5069
|
-
},
|
|
5070
|
-
{
|
|
5071
|
-
"name": "graphic",
|
|
5072
|
-
"type": "Graphic"
|
|
5073
|
-
}
|
|
5074
|
-
],
|
|
5075
|
-
"events": [
|
|
5076
|
-
{
|
|
5077
|
-
"name": "arcgisReady",
|
|
5078
|
-
"type": "void",
|
|
5079
|
-
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
|
|
5080
|
-
}
|
|
5081
|
-
]
|
|
5082
|
-
}
|
|
5083
|
-
},
|
|
5084
5038
|
{
|
|
5085
5039
|
"name": "arcgis-feature-form",
|
|
5086
5040
|
"description": "### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSubmit**\n- **arcgisValueChange** - Fires when a field value is updated.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getValues(): Promise<any>` - Returns all of the field values, regardless of update status.\n- `submit(): Promise<void>` - Fires the submit event.",
|
|
@@ -8675,7 +8629,7 @@
|
|
|
8675
8629
|
},
|
|
8676
8630
|
{
|
|
8677
8631
|
"name": "arcgis-line-of-sight",
|
|
8678
|
-
"description": "The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a
|
|
8632
|
+
"description": "The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including ground, integrated meshes, and 3D objects such as buildings or trees.\n\n\n\nThe analysis results are displayed as colored lines, where areas visible to the observer are\nshown green and occluded parts are marked red. Also, the color of the target points indicates their visibility.\nWhen the line of sight cannot be calculated, it will be displayed with a gray color. This may happen if either\nthe target or the observer is not in the view.\n\nWhen creating a new line of sight analysis, the first click in the Scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html)\nand subsequent clicks place the [targets](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html).\nBoth, the observer and target points can be moved by dragging. Additionally, the target points can be removed with a right click.\n\n**Known limitation**\n\nLine Of Sight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\n- [Sample - Line of sight component](https://developers.arcgis.com/javascript/latest/sample-code/line-of-sight/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current analysis results. After calling this method, the user can set a new observer and targets.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `continue(): Promise<void>` - After [stop()](#stop) was called, this method allows to continue the line of sight analysis and add more targets.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start a new line of sight analysis.\n- `stop(): Promise<void>` - Stop the current placing of line of sight analysis. Any lines added this far are kept in the view.\nUsers can still interact with existing targets and the observer, but they cannot place new target points.",
|
|
8679
8633
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-line-of-sight/",
|
|
8680
8634
|
"attributes": [
|
|
8681
8635
|
{
|
|
@@ -8754,7 +8708,7 @@
|
|
|
8754
8708
|
"properties": [
|
|
8755
8709
|
{
|
|
8756
8710
|
"name": "analysis",
|
|
8757
|
-
"description": "The [
|
|
8711
|
+
"description": "The [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Line Of Sight component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n//Create the analysis.\nconst lineOfSightAnalysis = new LineOfSightAnalysis({\n observer: new LineOfSightAnalysisObserver({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624828.3377593,\n y: 4550305.319405007,\n z: 105.55410975124687\n }),\n }),\n targets: [ new LineOfSightAnalysisTarget({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624944.17687458,\n y: 4550420.577689567,\n z: 0\n }),\n })\n]\n});\n// Get the Scene and Line Of Sight component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst lineOfSight = document.querySelector(\"arcgis-line-of-sight\");\nawait lineOfSight.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(lineOfSightAnalysis);\n// Connect the analysis to the component:\nlineOfSight.analysis = lineOfSightAnalysis;\n```",
|
|
8758
8712
|
"type": "LineOfSightAnalysis"
|
|
8759
8713
|
},
|
|
8760
8714
|
{
|
|
@@ -10406,7 +10360,7 @@
|
|
|
10406
10360
|
},
|
|
10407
10361
|
{
|
|
10408
10362
|
"name": "arcgis-navigation-toggle",
|
|
10409
|
-
"description": "The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\
|
|
10363
|
+
"description": "The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\n**Known limitations**\n\nNavigation Toggle is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `toggle(): Promise<void>`",
|
|
10410
10364
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-navigation-toggle/",
|
|
10411
10365
|
"attributes": [
|
|
10412
10366
|
{
|
|
@@ -10436,7 +10390,7 @@
|
|
|
10436
10390
|
},
|
|
10437
10391
|
{
|
|
10438
10392
|
"name": "navigation-mode",
|
|
10439
|
-
"description": "The navigation mode of the view.
|
|
10393
|
+
"description": "The navigation mode of the view. The possible values:\n\n* `pan` - The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\n* `rotate` - The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.",
|
|
10440
10394
|
"default": "\"pan\"",
|
|
10441
10395
|
"value": {
|
|
10442
10396
|
"type": [
|
|
@@ -10516,7 +10470,7 @@
|
|
|
10516
10470
|
},
|
|
10517
10471
|
{
|
|
10518
10472
|
"name": "navigationMode",
|
|
10519
|
-
"description": "The navigation mode of the view.
|
|
10473
|
+
"description": "The navigation mode of the view. The possible values:\n\n* `pan` - The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\n* `rotate` - The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.",
|
|
10520
10474
|
"type": "\"pan\" | \"rotate\""
|
|
10521
10475
|
},
|
|
10522
10476
|
{
|
|
@@ -11021,7 +10975,7 @@
|
|
|
11021
10975
|
"events": [
|
|
11022
10976
|
{
|
|
11023
10977
|
"name": "arcgisComplete",
|
|
11024
|
-
"type": "
|
|
10978
|
+
"type": "PrintCompleteEvent",
|
|
11025
10979
|
"description": "Emitted when the component is complete."
|
|
11026
10980
|
},
|
|
11027
10981
|
{
|
|
@@ -11036,7 +10990,7 @@
|
|
|
11036
10990
|
},
|
|
11037
10991
|
{
|
|
11038
10992
|
"name": "arcgisSubmit",
|
|
11039
|
-
"type": "
|
|
10993
|
+
"type": "PrintSubmitEvent",
|
|
11040
10994
|
"description": "Emitted when the component is submitted."
|
|
11041
10995
|
}
|
|
11042
10996
|
],
|
|
@@ -11164,7 +11118,7 @@
|
|
|
11164
11118
|
"events": [
|
|
11165
11119
|
{
|
|
11166
11120
|
"name": "arcgisComplete",
|
|
11167
|
-
"type": "
|
|
11121
|
+
"type": "PrintCompleteEvent",
|
|
11168
11122
|
"description": "Emitted when the component is complete."
|
|
11169
11123
|
},
|
|
11170
11124
|
{
|
|
@@ -11179,7 +11133,7 @@
|
|
|
11179
11133
|
},
|
|
11180
11134
|
{
|
|
11181
11135
|
"name": "arcgisSubmit",
|
|
11182
|
-
"type": "
|
|
11136
|
+
"type": "PrintSubmitEvent",
|
|
11183
11137
|
"description": "Emitted when the component is submitted."
|
|
11184
11138
|
}
|
|
11185
11139
|
]
|
|
@@ -11563,7 +11517,7 @@
|
|
|
11563
11517
|
},
|
|
11564
11518
|
{
|
|
11565
11519
|
"name": "arcgis-scene",
|
|
11566
|
-
"description": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create)\n- **arcgisAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)\n- **arcgisAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes:\n[zoom](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#zoom),\n[scale](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#scale),\n[center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center),\n[rotation](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#rotation),\n[extent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#camera),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewpoint).\nThis event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#stationary)\ntoggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n```js\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup).\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its\n[map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map),\n[popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView(analysis: __esri.AreaMeasurementAnalysis | __esri.DimensionAnalysis | __esri.DirectLineMeasurementAnalysis | __esri.LineOfSightAnalysis | __esri.SliceAnalysis | __esri.ViewshedAnalysis): Promise<__esri.AreaMeasurementAnalysisView3D | __esri.DimensionAnalysisView3D | __esri.DirectLineMeasurementAnalysisView3D | __esri.LineOfSightAnalysisView3D | __esri.SliceAnalysisView3D | __esri.ViewshedAnalysisView3D>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)",
|
|
11520
|
+
"description": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nconst layer = new GraphicsLayer({ title: \"My layer\"});\nviewElement.map.add(layer);\n```\n\n**See also**\n\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create)\n- **arcgisViewAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes: [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[camera](#camera), [viewpoint](#viewpoint). This event will also emit if [stationary](#stationary) toggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](#popup).\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its [map](#map), [popup](#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView(analysis: __esri.AreaMeasurementAnalysis | __esri.DimensionAnalysis | __esri.DirectLineMeasurementAnalysis | __esri.LineOfSightAnalysis | __esri.SliceAnalysis | __esri.ViewshedAnalysis): Promise<__esri.AreaMeasurementAnalysisView3D | __esri.DimensionAnalysisView3D | __esri.DirectLineMeasurementAnalysisView3D | __esri.LineOfSightAnalysisView3D | __esri.SliceAnalysisView3D | __esri.ViewshedAnalysisView3D>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)",
|
|
11567
11521
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/",
|
|
11568
11522
|
"attributes": [
|
|
11569
11523
|
{
|
|
@@ -11591,35 +11545,35 @@
|
|
|
11591
11545
|
},
|
|
11592
11546
|
{
|
|
11593
11547
|
"name": "camera-fov",
|
|
11594
|
-
"description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11548
|
+
"description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov)",
|
|
11595
11549
|
"value": {
|
|
11596
11550
|
"type": "number"
|
|
11597
11551
|
}
|
|
11598
11552
|
},
|
|
11599
11553
|
{
|
|
11600
11554
|
"name": "camera-heading",
|
|
11601
|
-
"description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11555
|
+
"description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading)",
|
|
11602
11556
|
"value": {
|
|
11603
11557
|
"type": "number"
|
|
11604
11558
|
}
|
|
11605
11559
|
},
|
|
11606
11560
|
{
|
|
11607
11561
|
"name": "camera-position",
|
|
11608
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
11562
|
+
"description": "The position of the camera defined by a map point. It can either be set with a\n[Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)",
|
|
11609
11563
|
"value": {
|
|
11610
11564
|
"type": "string"
|
|
11611
11565
|
}
|
|
11612
11566
|
},
|
|
11613
11567
|
{
|
|
11614
11568
|
"name": "camera-tilt",
|
|
11615
|
-
"description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11569
|
+
"description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt)",
|
|
11616
11570
|
"value": {
|
|
11617
11571
|
"type": "number"
|
|
11618
11572
|
}
|
|
11619
11573
|
},
|
|
11620
11574
|
{
|
|
11621
11575
|
"name": "center",
|
|
11622
|
-
"description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11576
|
+
"description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)",
|
|
11623
11577
|
"value": {
|
|
11624
11578
|
"type": "string"
|
|
11625
11579
|
}
|
|
@@ -11656,7 +11610,7 @@
|
|
|
11656
11610
|
},
|
|
11657
11611
|
{
|
|
11658
11612
|
"name": "quality-profile",
|
|
11659
|
-
"description": "
|
|
11613
|
+
"description": "Scenes can be drawn in three different quality modes: `high`, `medium` and `low`.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile)",
|
|
11660
11614
|
"value": {
|
|
11661
11615
|
"type": [
|
|
11662
11616
|
"\"high\"",
|
|
@@ -11667,7 +11621,7 @@
|
|
|
11667
11621
|
},
|
|
11668
11622
|
{
|
|
11669
11623
|
"name": "scale",
|
|
11670
|
-
"description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](
|
|
11624
|
+
"description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)",
|
|
11671
11625
|
"value": {
|
|
11672
11626
|
"type": "number"
|
|
11673
11627
|
}
|
|
@@ -11693,7 +11647,7 @@
|
|
|
11693
11647
|
},
|
|
11694
11648
|
{
|
|
11695
11649
|
"name": "zoom",
|
|
11696
|
-
"description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](
|
|
11650
|
+
"description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\nSetting this property in conjunction with [center](#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom)",
|
|
11697
11651
|
"value": {
|
|
11698
11652
|
"type": "number"
|
|
11699
11653
|
}
|
|
@@ -11701,24 +11655,24 @@
|
|
|
11701
11655
|
],
|
|
11702
11656
|
"events": [
|
|
11703
11657
|
{
|
|
11704
|
-
"name": "
|
|
11658
|
+
"name": "arcgisViewAnalysisViewCreate",
|
|
11705
11659
|
"type": "ViewAnalysisViewCreateEvent",
|
|
11706
11660
|
"description": "Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create)"
|
|
11707
11661
|
},
|
|
11708
11662
|
{
|
|
11709
|
-
"name": "
|
|
11663
|
+
"name": "arcgisViewAnalysisViewCreateError",
|
|
11710
11664
|
"type": "ViewAnalysisViewCreateErrorEvent",
|
|
11711
11665
|
"description": "Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)"
|
|
11712
11666
|
},
|
|
11713
11667
|
{
|
|
11714
|
-
"name": "
|
|
11668
|
+
"name": "arcgisViewAnalysisViewDestroy",
|
|
11715
11669
|
"type": "ViewAnalysisViewDestroyEvent",
|
|
11716
11670
|
"description": "Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)"
|
|
11717
11671
|
},
|
|
11718
11672
|
{
|
|
11719
11673
|
"name": "arcgisViewChange",
|
|
11720
11674
|
"type": "void",
|
|
11721
|
-
"description": "This event is for view related property changes
|
|
11675
|
+
"description": "This event is for view related property changes: [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[camera](#camera), [viewpoint](#viewpoint). This event will also emit if [stationary](#stationary) toggles from `true` to `false`."
|
|
11722
11676
|
},
|
|
11723
11677
|
{
|
|
11724
11678
|
"name": "arcgisViewClick",
|
|
@@ -11808,7 +11762,7 @@
|
|
|
11808
11762
|
{
|
|
11809
11763
|
"name": "arcgisViewReadyChange",
|
|
11810
11764
|
"type": "void",
|
|
11811
|
-
"description": "This event is for the [ready](
|
|
11765
|
+
"description": "This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed."
|
|
11812
11766
|
}
|
|
11813
11767
|
],
|
|
11814
11768
|
"js": {
|
|
@@ -11845,37 +11799,37 @@
|
|
|
11845
11799
|
},
|
|
11846
11800
|
{
|
|
11847
11801
|
"name": "camera",
|
|
11848
|
-
"description": "The [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html) allows to set the observation point from which the visible portion (or perspective)\nof the view is determined. When set in the constructor, this property overrides the
|
|
11802
|
+
"description": "The [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html) allows to set the observation point from which the visible portion (or perspective)\nof the view is determined. When set in the constructor, this property overrides the [center](#center), [extent](#extent), [scale](#scale), [viewpoint](#viewpoint), and [zoom](#zoom) properties.\n\nSetting the camera immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.",
|
|
11849
11803
|
"type": "Camera"
|
|
11850
11804
|
},
|
|
11851
11805
|
{
|
|
11852
11806
|
"name": "cameraFov",
|
|
11853
|
-
"description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11807
|
+
"description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov)",
|
|
11854
11808
|
"type": "number"
|
|
11855
11809
|
},
|
|
11856
11810
|
{
|
|
11857
11811
|
"name": "cameraHeading",
|
|
11858
|
-
"description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11812
|
+
"description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading)",
|
|
11859
11813
|
"type": "number"
|
|
11860
11814
|
},
|
|
11861
11815
|
{
|
|
11862
11816
|
"name": "cameraPosition",
|
|
11863
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
11817
|
+
"description": "The position of the camera defined by a map point. It can either be set with a\n[Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)",
|
|
11864
11818
|
"type": "Array<number> | Point | string"
|
|
11865
11819
|
},
|
|
11866
11820
|
{
|
|
11867
11821
|
"name": "cameraTilt",
|
|
11868
|
-
"description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11822
|
+
"description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt)",
|
|
11869
11823
|
"type": "number"
|
|
11870
11824
|
},
|
|
11871
11825
|
{
|
|
11872
11826
|
"name": "center",
|
|
11873
|
-
"description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11827
|
+
"description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)",
|
|
11874
11828
|
"type": "Array<number> | Point | string"
|
|
11875
11829
|
},
|
|
11876
11830
|
{
|
|
11877
11831
|
"name": "clippingArea",
|
|
11878
|
-
"description": "Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html)\nof a [local scene](
|
|
11832
|
+
"description": "Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html)\nof a [local scene](#viewingMode).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea)",
|
|
11879
11833
|
"type": "Extent"
|
|
11880
11834
|
},
|
|
11881
11835
|
{
|
|
@@ -11890,12 +11844,12 @@
|
|
|
11890
11844
|
},
|
|
11891
11845
|
{
|
|
11892
11846
|
"name": "environment",
|
|
11893
|
-
"description": "Specifies various properties of the environment's visualization
|
|
11847
|
+
"description": "Specifies various properties of the environment's visualization within the view, including lighting, background, weather, and more.\nThe Scene will redraw automatically when any property of environment changes.\n\nModifying the lighting:\n\n```js\nviewElement.environment.lighting = {\n type: \"sun\", // autocasts as new SunLighting()\n date: new Date(), // sets the lighting to reflect the current time of day\n directShadowsEnabled: true,\n};\n```\n\nSetting the background:\n\n```js\nviewElement.environment = {\n background: {\n type: \"color\",\n color: [255, 252, 244, 1]\n },\n starsEnabled: false,\n atmosphereEnabled: false\n};\n```\n\nChanging the weather in the scene:\n\n```js\nviewElement.environment.weather = {\n type: \"rainy\", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })\n cloudCover: 0.7,\n precipitation: 0.3\n};\n```\n\n**See also**\n\n- [SunLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)\n- [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html)\n- [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n- [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment)",
|
|
11894
11848
|
"type": "SceneViewEnvironment"
|
|
11895
11849
|
},
|
|
11896
11850
|
{
|
|
11897
11851
|
"name": "extent",
|
|
11898
|
-
"description": "The extent represents the visible portion of a map within the view as an instance of\n[Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html).\n\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's [goTo()](
|
|
11852
|
+
"description": "The extent represents the visible portion of a map within the view as an instance of\n[Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html).\n\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's [goTo()](#goTo) method.\nWhen the view is rotated, the extent does not update to include the newly visible portions of the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent)",
|
|
11899
11853
|
"type": "Extent"
|
|
11900
11854
|
},
|
|
11901
11855
|
{
|
|
@@ -12000,7 +11954,7 @@
|
|
|
12000
11954
|
},
|
|
12001
11955
|
{
|
|
12002
11956
|
"name": "qualityProfile",
|
|
12003
|
-
"description": "
|
|
11957
|
+
"description": "Scenes can be drawn in three different quality modes: `high`, `medium` and `low`.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile)",
|
|
12004
11958
|
"type": "\"high\" | \"low\" | \"medium\""
|
|
12005
11959
|
},
|
|
12006
11960
|
{
|
|
@@ -12010,12 +11964,12 @@
|
|
|
12010
11964
|
},
|
|
12011
11965
|
{
|
|
12012
11966
|
"name": "resolution",
|
|
12013
|
-
"description": "Represents the current value of one pixel in the unit of the view's\n[spatialReference](
|
|
11967
|
+
"description": "Represents the current value of one pixel in the unit of the view's\n[spatialReference](#spatialReference).\nThe resolution is calculated by dividing the view's [extent width](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#width)\nby [its width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#width).",
|
|
12014
11968
|
"type": "number"
|
|
12015
11969
|
},
|
|
12016
11970
|
{
|
|
12017
11971
|
"name": "scale",
|
|
12018
|
-
"description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](
|
|
11972
|
+
"description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)",
|
|
12019
11973
|
"type": "number"
|
|
12020
11974
|
},
|
|
12021
11975
|
{
|
|
@@ -12035,7 +11989,7 @@
|
|
|
12035
11989
|
},
|
|
12036
11990
|
{
|
|
12037
11991
|
"name": "theme",
|
|
12038
|
-
"description": "This property specifies the base colors used by some
|
|
11992
|
+
"description": "This property specifies the base colors used by some components to render graphics and labels.\nThis only affects those elements that would otherwise use the default orange pattern.",
|
|
12039
11993
|
"type": "Theme"
|
|
12040
11994
|
},
|
|
12041
11995
|
{
|
|
@@ -12060,7 +12014,7 @@
|
|
|
12060
12014
|
},
|
|
12061
12015
|
{
|
|
12062
12016
|
"name": "viewpoint",
|
|
12063
|
-
"description": "Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nor point of observation on the view.\n\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's [goTo()](
|
|
12017
|
+
"description": "Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nor point of observation on the view.\n\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's [goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint)",
|
|
12064
12018
|
"type": "Viewpoint"
|
|
12065
12019
|
},
|
|
12066
12020
|
{
|
|
@@ -12070,30 +12024,30 @@
|
|
|
12070
12024
|
},
|
|
12071
12025
|
{
|
|
12072
12026
|
"name": "zoom",
|
|
12073
|
-
"description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](
|
|
12027
|
+
"description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\nSetting this property in conjunction with [center](#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom)",
|
|
12074
12028
|
"type": "number"
|
|
12075
12029
|
}
|
|
12076
12030
|
],
|
|
12077
12031
|
"events": [
|
|
12078
12032
|
{
|
|
12079
|
-
"name": "
|
|
12033
|
+
"name": "arcgisViewAnalysisViewCreate",
|
|
12080
12034
|
"type": "ViewAnalysisViewCreateEvent",
|
|
12081
12035
|
"description": "Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create)"
|
|
12082
12036
|
},
|
|
12083
12037
|
{
|
|
12084
|
-
"name": "
|
|
12038
|
+
"name": "arcgisViewAnalysisViewCreateError",
|
|
12085
12039
|
"type": "ViewAnalysisViewCreateErrorEvent",
|
|
12086
12040
|
"description": "Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)"
|
|
12087
12041
|
},
|
|
12088
12042
|
{
|
|
12089
|
-
"name": "
|
|
12043
|
+
"name": "arcgisViewAnalysisViewDestroy",
|
|
12090
12044
|
"type": "ViewAnalysisViewDestroyEvent",
|
|
12091
12045
|
"description": "Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)"
|
|
12092
12046
|
},
|
|
12093
12047
|
{
|
|
12094
12048
|
"name": "arcgisViewChange",
|
|
12095
12049
|
"type": "void",
|
|
12096
|
-
"description": "This event is for view related property changes
|
|
12050
|
+
"description": "This event is for view related property changes: [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[camera](#camera), [viewpoint](#viewpoint). This event will also emit if [stationary](#stationary) toggles from `true` to `false`."
|
|
12097
12051
|
},
|
|
12098
12052
|
{
|
|
12099
12053
|
"name": "arcgisViewClick",
|
|
@@ -12183,7 +12137,7 @@
|
|
|
12183
12137
|
{
|
|
12184
12138
|
"name": "arcgisViewReadyChange",
|
|
12185
12139
|
"type": "void",
|
|
12186
|
-
"description": "This event is for the [ready](
|
|
12140
|
+
"description": "This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed."
|
|
12187
12141
|
}
|
|
12188
12142
|
]
|
|
12189
12143
|
}
|
|
@@ -12357,7 +12311,7 @@
|
|
|
12357
12311
|
},
|
|
12358
12312
|
{
|
|
12359
12313
|
"name": "state",
|
|
12360
|
-
"description": "The current state
|
|
12314
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
12361
12315
|
"default": "\"ready\"",
|
|
12362
12316
|
"value": {
|
|
12363
12317
|
"type": [
|
|
@@ -12572,7 +12526,7 @@
|
|
|
12572
12526
|
},
|
|
12573
12527
|
{
|
|
12574
12528
|
"name": "state",
|
|
12575
|
-
"description": "The current state
|
|
12529
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
12576
12530
|
"type": "\"disabled\" | \"loading\" | \"ready\" | \"searching\""
|
|
12577
12531
|
},
|
|
12578
12532
|
{
|
|
@@ -12660,7 +12614,7 @@
|
|
|
12660
12614
|
},
|
|
12661
12615
|
{
|
|
12662
12616
|
"name": "messages",
|
|
12663
|
-
"type": "({\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n} & {\n _lang: string;\n _t9nLocale: \"id\" | \"el\" | \"hr\" | \"th\" | \"tr\" | \"sl\" | \"it\" | \"ca\" | \"de\" | \"fi\" | \"ar\" | \"da\" | \"vi\" | \"pl\" | \"et\" | \"bs\" | \"sk\" | \"es\" | \"en\" | \"ru\" | \"ro\" | \"no\" | \"lt\" | \"cs\" | \"
|
|
12617
|
+
"type": "({\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n} & {\n _lang: string;\n _t9nLocale: \"id\" | \"el\" | \"hr\" | \"th\" | \"tr\" | \"sl\" | \"it\" | \"ca\" | \"de\" | \"fi\" | \"ar\" | \"da\" | \"vi\" | \"pl\" | \"he\" | \"et\" | \"bs\" | \"sk\" | \"es\" | \"en\" | \"ru\" | \"ro\" | \"no\" | \"lt\" | \"cs\" | \"fr\" | \"sv\" | \"bg\" | \"lv\" | \"nl\" | \"sr\" | \"hu\" | \"ja\" | \"ko\" | \"nb\" | \"pt-BR\" | \"pt-PT\" | \"uk\" | \"zh-CN\" | \"zh-HK\" | \"zh-TW\";\n _loading: boolean;\n _overrides: {\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n };\n _original?: {\n componentLabel: string;\n searchButtonTitle: string;\n placeholder: string;\n searchIn: string;\n all: string;\n allPlaceholder: string;\n locateError: string;\n untitledResult: string;\n untitledSource: string;\n noResults: string;\n noResultsFound: string;\n noResultsFoundForValue: string;\n showMoreResults: string;\n hideMoreResults: string;\n searchResult: string;\n moreResultsHeader: string;\n useCurrentLocation: string;\n } | undefined;\n})"
|
|
12664
12618
|
},
|
|
12665
12619
|
{
|
|
12666
12620
|
"name": "viewModel",
|
|
@@ -12678,7 +12632,7 @@
|
|
|
12678
12632
|
},
|
|
12679
12633
|
{
|
|
12680
12634
|
"name": "arcgis-shadow-cast",
|
|
12681
|
-
"description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [
|
|
12635
|
+
"description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nThis type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.\n\nThe component calculates the cumulative shadows for a time range during a single day. The user can\nconfigure the time range and select a calendar date. This time range and calendar date are only used\nfor the shadow analysis and are not connected to the lighting in the scene.\nTo control the lighting in the scene, the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component can be used.\nChanging the timezone in the component updates the visualization by interpreting the time range as being\nin that timezone. This behavior is different from the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component,\nwhere selecting a timezone updates the [environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) date and time according to the camera position.\n\nThe component provides three [visualization modes](#visualizationType): threshold, duration, and discrete mode.\n\nIn the **threshold** mode, only the areas that receive\nshadows for more than a certain amount of time are displayed. In the image below, on May 1, 2021 the red areas receive\nshadow for more than 4 hours within the time interval of 10AM to 4PM.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Total shadow duration** mode displays the duration of the cumulative shadow using opacity: areas that don't\nreceive any shadow are fully transparent and areas that receive a maximum amount of shadow have a default opacity\nof 0.7. The values in between are interpolated. Hovering over the Scene will display a tooltip showing the\namount of time that location is in shadow, rounded to 15 minute intervals. In this mode, the visualization\ncan display shadow cast in a continuous way or in 1 hour intervals.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Discrete shadows** is a third visualization mode which displays individual shadows at a given time interval.\nFor example, setting the time range to 10AM-11AM and the visualization time interval to 30 minutes will display\nshadows for 10AM, 10:30AM and 11:00AM.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\nThe defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay), [endTimeOfDay](#endTimeOfDay), and [visualizationType](#visualizationType) properties.\n\n**Known limitations**\n\n* Shadow Cast is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* Terrain does not cast shadows and it is therefore not taken into account in this analysis.\n* The component does not take into account the daylight savings.\nUse the timezone dropdown to adjust the offset from the Coordinated Universal Time (UTC) and account for the daylight saving time.\n* The timezone is automatically detected by the component based on the camera location. In some situations, this might not be accurate.\nIn case of an inaccurate timezone, users can set it manually using the timezone dropdown.\n\n**See also**\n\n- [Sample - Shadow cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getDuration(point: __esri.Point): Promise<number>` - Returns the time (in milliseconds) spent in shadow for a certain point on the screen.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#getDuration)\n- `start(): Promise<void>` - Starts the component. While running, it will automatically perform shadow accumulation.\n- `stop(): Promise<void>` - Stops the component.",
|
|
12682
12636
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/",
|
|
12683
12637
|
"attributes": [
|
|
12684
12638
|
{
|
|
@@ -12691,6 +12645,7 @@
|
|
|
12691
12645
|
},
|
|
12692
12646
|
{
|
|
12693
12647
|
"name": "date",
|
|
12648
|
+
"description": "The calendar date used to calculate the shadow cast. This date excludes the time. If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.\nIf no date is set, then it defaults to the current date in local system time.\n\n_See also_\n\n* [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)",
|
|
12694
12649
|
"value": {
|
|
12695
12650
|
"type": [
|
|
12696
12651
|
"number",
|
|
@@ -12786,7 +12741,7 @@
|
|
|
12786
12741
|
},
|
|
12787
12742
|
{
|
|
12788
12743
|
"name": "icon",
|
|
12789
|
-
"description": "Icon which represents the
|
|
12744
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
12790
12745
|
"default": "\"measure-building-height-shadow\"",
|
|
12791
12746
|
"value": {
|
|
12792
12747
|
"type": "string"
|
|
@@ -12794,7 +12749,7 @@
|
|
|
12794
12749
|
},
|
|
12795
12750
|
{
|
|
12796
12751
|
"name": "label",
|
|
12797
|
-
"description": "The
|
|
12752
|
+
"description": "The component's default label.",
|
|
12798
12753
|
"value": {
|
|
12799
12754
|
"type": "string"
|
|
12800
12755
|
}
|
|
@@ -12833,7 +12788,7 @@
|
|
|
12833
12788
|
},
|
|
12834
12789
|
{
|
|
12835
12790
|
"name": "state",
|
|
12836
|
-
"description": "The
|
|
12791
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
12837
12792
|
"default": "\"disabled\"",
|
|
12838
12793
|
"value": {
|
|
12839
12794
|
"type": [
|
|
@@ -12844,14 +12799,14 @@
|
|
|
12844
12799
|
},
|
|
12845
12800
|
{
|
|
12846
12801
|
"name": "utc-offset",
|
|
12847
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
12802
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
12848
12803
|
"value": {
|
|
12849
12804
|
"type": "number"
|
|
12850
12805
|
}
|
|
12851
12806
|
},
|
|
12852
12807
|
{
|
|
12853
12808
|
"name": "visualization-type",
|
|
12854
|
-
"description": "Type of visualization to use when showing the shadows
|
|
12809
|
+
"description": "Type of visualization to use when showing the shadows. There are 3 types of visualization:\n* `threshold` - only displays areas that receive shadows for a period longer than a given threshold value\n* `duration` - displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals\n* `discrete` - displays individual shadows cast at a given time interval",
|
|
12855
12810
|
"default": "\"threshold\"",
|
|
12856
12811
|
"value": {
|
|
12857
12812
|
"type": [
|
|
@@ -12883,16 +12838,17 @@
|
|
|
12883
12838
|
},
|
|
12884
12839
|
{
|
|
12885
12840
|
"name": "date",
|
|
12841
|
+
"description": "The calendar date used to calculate the shadow cast. This date excludes the time. If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.\nIf no date is set, then it defaults to the current date in local system time.\n\n_See also_\n\n* [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)",
|
|
12886
12842
|
"type": "Date | number | string"
|
|
12887
12843
|
},
|
|
12888
12844
|
{
|
|
12889
12845
|
"name": "discreteOptions",
|
|
12890
|
-
"description": "The configuration used when the
|
|
12846
|
+
"description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"discrete\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DiscreteOptions.html)",
|
|
12891
12847
|
"type": "DiscreteOptions"
|
|
12892
12848
|
},
|
|
12893
12849
|
{
|
|
12894
12850
|
"name": "durationOptions",
|
|
12895
|
-
"description": "The configuration used when the
|
|
12851
|
+
"description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"duration\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DurationOptions.html)",
|
|
12896
12852
|
"type": "DurationOptions"
|
|
12897
12853
|
},
|
|
12898
12854
|
{
|
|
@@ -12947,12 +12903,12 @@
|
|
|
12947
12903
|
},
|
|
12948
12904
|
{
|
|
12949
12905
|
"name": "icon",
|
|
12950
|
-
"description": "Icon which represents the
|
|
12906
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
12951
12907
|
"type": "string"
|
|
12952
12908
|
},
|
|
12953
12909
|
{
|
|
12954
12910
|
"name": "label",
|
|
12955
|
-
"description": "The
|
|
12911
|
+
"description": "The component's default label.",
|
|
12956
12912
|
"type": "string"
|
|
12957
12913
|
},
|
|
12958
12914
|
{
|
|
@@ -12971,22 +12927,22 @@
|
|
|
12971
12927
|
},
|
|
12972
12928
|
{
|
|
12973
12929
|
"name": "state",
|
|
12974
|
-
"description": "The
|
|
12930
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
12975
12931
|
"type": "\"disabled\" | \"ready\""
|
|
12976
12932
|
},
|
|
12977
12933
|
{
|
|
12978
12934
|
"name": "thresholdOptions",
|
|
12979
|
-
"description": "The configuration used when the
|
|
12935
|
+
"description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"threshold\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ThresholdOptions.html)",
|
|
12980
12936
|
"type": "ThresholdOptions"
|
|
12981
12937
|
},
|
|
12982
12938
|
{
|
|
12983
12939
|
"name": "utcOffset",
|
|
12984
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
12940
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
12985
12941
|
"type": "number"
|
|
12986
12942
|
},
|
|
12987
12943
|
{
|
|
12988
12944
|
"name": "visualizationType",
|
|
12989
|
-
"description": "Type of visualization to use when showing the shadows
|
|
12945
|
+
"description": "Type of visualization to use when showing the shadows. There are 3 types of visualization:\n* `threshold` - only displays areas that receive shadows for a period longer than a given threshold value\n* `duration` - displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals\n* `discrete` - displays individual shadows cast at a given time interval",
|
|
12990
12946
|
"type": "\"discrete\" | \"duration\" | \"threshold\""
|
|
12991
12947
|
}
|
|
12992
12948
|
],
|
|
@@ -13555,7 +13511,7 @@
|
|
|
13555
13511
|
},
|
|
13556
13512
|
{
|
|
13557
13513
|
"name": "arcgis-slice",
|
|
13558
|
-
"description": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a
|
|
13514
|
+
"description": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). It applies\n[slice analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\nto any layer type, making it possible to see inside buildings or to explore geological surfaces.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nThe slicing [shape](#shape)\nis always a [plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).\nBy default, the plane is either horizontal or vertical. To allow a tilt angle for the plane, set\n[tiltEnabled](#tiltEnabled)\nto `true`. The slice hides any content in front of the surface. The handles on the sides of the plane can be used to adjust\nthe size, heading, tilt, and position of the slice plane.\nThe [SlicePlane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html)\ncan be set or retrieved using the [shape](#shape) property.\n\nOnce the slice plane is applied, layers can be excluded from the slicing. For example, by excluding the sublayers which include\ncolumns and floor slabs, the inner structure of a building can investigated.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nHolding the `Shift` key while creating a new slice applies it vertically.\n\n**Known limitation**\n\nSlice is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the [shape](#shape) of the slice, effectively removing it from the view. Other properties like [excludedLayers](#excludedLayers)\nand [excludeGroundSurface](#excludeGroundSurface) are not modified.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start the interactive creation of a new slice, clearing the previous [shape](#shape).",
|
|
13559
13515
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/",
|
|
13560
13516
|
"attributes": [
|
|
13561
13517
|
{
|
|
@@ -13665,7 +13621,7 @@
|
|
|
13665
13621
|
"properties": [
|
|
13666
13622
|
{
|
|
13667
13623
|
"name": "analysis",
|
|
13668
|
-
"description": "The [
|
|
13624
|
+
"description": "The [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Slice component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst sliceAnalysis = new SliceAnalysis({\n shape: new SlicePlane({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624925.727820931,\n y: 4550341.695170021,\n z: 56\n }),\n tilt: 270,\n width: 310,\n height: 190,\n heading: 45\n })\n});\n// Get the Scene and Slice component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst slice = document.querySelector(\"arcgis-slice\");\nawait slice.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(sliceAnalysis);\n// Connect the analysis to the slice component:\nslice.analysis = sliceAnalysis;\n```",
|
|
13669
13625
|
"type": "SliceAnalysis"
|
|
13670
13626
|
},
|
|
13671
13627
|
{
|
|
@@ -13713,7 +13669,7 @@
|
|
|
13713
13669
|
},
|
|
13714
13670
|
{
|
|
13715
13671
|
"name": "shape",
|
|
13716
|
-
"description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a
|
|
13672
|
+
"description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a\n[plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).",
|
|
13717
13673
|
"type": "SlicePlane"
|
|
13718
13674
|
},
|
|
13719
13675
|
{
|
|
@@ -15381,7 +15337,7 @@
|
|
|
15381
15337
|
},
|
|
15382
15338
|
{
|
|
15383
15339
|
"name": "arcgis-utility-network-associations",
|
|
15384
|
-
"description": "The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials.\n
|
|
15340
|
+
"description": "The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
15385
15341
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-associations/",
|
|
15386
15342
|
"attributes": [
|
|
15387
15343
|
{
|
|
@@ -16970,7 +16926,7 @@
|
|
|
16970
16926
|
},
|
|
16971
16927
|
{
|
|
16972
16928
|
"name": "arcgis-weather",
|
|
16973
|
-
"description": "The Weather component
|
|
16929
|
+
"description": "The Weather component allows easy selection and configuration of weather effects in a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThe available weather types are:\n[sunny](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html),\n[cloudy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html),\n[rainy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html),\n[snowy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html), and\n[foggy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html).\n\nTo set the weather programmatically, apply the desired weather type to the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) property of the Scene component.\n\n```js\n// Access the Scene component.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// Specify the weather settings.\nviewElement.environment.weather = {\n type: \"rainy\", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })\n cloudCover: 0.7,\n precipitation: 0.3\n};\n```\n\nTo determine if the weather visualization is available, check the boolean value of `viewElement.environment.weatherAvailable`. The weather is only available:\n * in [global viewing mode](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewingMode),\n * when `atmosphereEnabled` property on [environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) is `true`,\n * at lower altitudes, near the ground.\n\n**Known limitations**\n\nWeather is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html)\n- [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
16974
16930
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-weather/",
|
|
16975
16931
|
"attributes": [
|
|
16976
16932
|
{
|