@arcgis/map-components 4.34.0-next.8 → 4.34.0-next.81
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/23OCSAG5.js +4 -0
- package/dist/cdn/{DVAYIM4A.js → 24EPWR4F.js} +1 -1
- package/dist/cdn/2F6OH7HE.js +4 -0
- package/dist/cdn/2H67PIJD.js +4 -0
- package/dist/cdn/2OW6WLXY.js +4 -0
- package/dist/cdn/2PUOSCNR.js +4 -0
- package/dist/cdn/{PRI3F4JY.js → 2SHE6NVJ.js} +2 -2
- package/dist/cdn/2ZUFKR5G.js +4 -0
- package/dist/cdn/{656YU7YM.js → 32UR2AXE.js} +2 -2
- package/dist/cdn/3ISSGQV7.js +4 -0
- package/dist/cdn/3J75KYHU.js +4 -0
- package/dist/cdn/{GIDFUOKW.js → 3MSI27QA.js} +2 -2
- package/dist/cdn/{5WAM5HGJ.js → 3VULUDYF.js} +2 -2
- package/dist/cdn/{MYW7GAD7.js → 42BUGF4M.js} +2 -2
- package/dist/cdn/44LDHPYD.js +4 -0
- package/dist/cdn/4D3BDJBK.js +4 -0
- package/dist/cdn/4JV6Q56A.js +4 -0
- package/dist/cdn/4MLK7BFQ.js +4 -0
- package/dist/cdn/4SUEUVQG.js +4 -0
- package/dist/cdn/4SUHKLCU.js +4 -0
- package/dist/cdn/4UENUWNO.js +4 -0
- package/dist/cdn/4ZDITJW2.js +4 -0
- package/dist/cdn/5CSOLOIZ.js +4 -0
- package/dist/cdn/5DEKYRIB.js +4 -0
- package/dist/cdn/5GWWQ6ZF.js +4 -0
- package/dist/cdn/5GXEKA65.js +4 -0
- package/dist/cdn/5HJVFX5Y.js +4 -0
- package/dist/cdn/5WHGPQL6.js +4 -0
- package/dist/cdn/5ZKWTFPB.js +4 -0
- package/dist/cdn/5ZL7G53H.js +4 -0
- package/dist/cdn/6C7VAU64.js +4 -0
- package/dist/cdn/6DI5SQQL.js +4 -0
- package/dist/cdn/6LCVNRNT.js +4 -0
- package/dist/cdn/6OFXILIA.js +4 -0
- package/dist/cdn/6R7TRBKP.js +4 -0
- package/dist/cdn/76YI7KAK.js +4 -0
- package/dist/cdn/7GLXNYFB.js +4 -0
- package/dist/cdn/{V6KYONBE.js → 7QPHKEGX.js} +1 -1
- package/dist/cdn/A42RIF4H.js +4 -0
- package/dist/cdn/{MR2LMEXV.js → AAGRZTV4.js} +2 -2
- package/dist/cdn/ADKRFQZQ.js +4 -0
- package/dist/cdn/AUVLFUJP.js +4 -0
- package/dist/cdn/B4L5AWZ3.js +4 -0
- package/dist/cdn/B4ZYJXBP.js +4 -0
- package/dist/cdn/B7FYCD5M.js +4 -0
- package/dist/cdn/BBSCFOE6.js +4 -0
- package/dist/cdn/BCKW5RQ7.js +4 -0
- package/dist/cdn/BK5MOKJA.js +4 -0
- package/dist/cdn/BR7YBLQ7.js +4 -0
- package/dist/cdn/BSITATMS.js +4 -0
- package/dist/cdn/BWCIFNCV.js +4 -0
- package/dist/cdn/C3WOXUGQ.js +4 -0
- package/dist/cdn/CE7R6GRG.js +4 -0
- package/dist/cdn/CLDJS7EU.js +4 -0
- package/dist/cdn/CPBVXGWY.js +4 -0
- package/dist/cdn/CPK6RRC6.js +4 -0
- package/dist/cdn/CQSXNTHT.js +4 -0
- package/dist/cdn/CSSECQO6.js +4 -0
- package/dist/cdn/CYKLDNBR.js +4 -0
- package/dist/cdn/CZWROVPE.js +4 -0
- package/dist/cdn/CZXQPSLL.js +4 -0
- package/dist/cdn/DC2YUXBL.js +4 -0
- package/dist/cdn/DIE22EGP.js +4 -0
- package/dist/cdn/DJPDJXB7.js +4 -0
- package/dist/cdn/DP7ABMMD.js +4 -0
- package/dist/cdn/DRKXTCQX.js +4 -0
- package/dist/cdn/E6P7ZG4P.js +4 -0
- package/dist/cdn/EENHI7AR.js +4 -0
- package/dist/cdn/EHNDVK7O.js +4 -0
- package/dist/cdn/EMSE2U42.js +4 -0
- package/dist/cdn/EY4OWI6G.js +4 -0
- package/dist/cdn/F22YXKVZ.js +4 -0
- package/dist/cdn/F26EBVFT.js +4 -0
- package/dist/cdn/FFW44GVX.js +4 -0
- package/dist/cdn/FGEJYS2F.js +4 -0
- package/dist/cdn/{GYVHCFLW.js → FOQCH2PX.js} +1 -1
- package/dist/cdn/FPE72S56.js +4 -0
- package/dist/cdn/FPFHERBB.js +4 -0
- package/dist/cdn/FWWD7RGQ.js +4 -0
- package/dist/cdn/FZIU6VYH.js +4 -0
- package/dist/cdn/G4NB3OBK.js +4 -0
- package/dist/cdn/G6QMUECA.js +4 -0
- package/dist/cdn/G72CJSL6.js +4 -0
- package/dist/cdn/G7X7K2UL.js +4 -0
- package/dist/cdn/GC4J7G4C.js +4 -0
- package/dist/cdn/GDWNYL5B.js +4 -0
- package/dist/cdn/GMX54YZ4.js +4 -0
- package/dist/cdn/H5NNP6LB.js +4 -0
- package/dist/cdn/H6T222RQ.js +5 -0
- package/dist/cdn/H6Z3ZMYK.js +4 -0
- package/dist/cdn/HBMFEDVC.js +4 -0
- package/dist/cdn/HDSRL4BN.js +4 -0
- package/dist/cdn/HGPPIJ23.js +4 -0
- package/dist/cdn/HNAVONOB.js +4 -0
- package/dist/cdn/HNOFMFUK.js +4 -0
- package/dist/cdn/IAXXGMZY.js +4 -0
- package/dist/cdn/IDVVE5ZA.js +4 -0
- package/dist/cdn/IKIVYXDG.js +4 -0
- package/dist/cdn/{ILNZINO3.js → IPIUF5EE.js} +2 -2
- package/dist/cdn/IZGGJ67V.js +4 -0
- package/dist/cdn/J62DFIJJ.js +4 -0
- package/dist/cdn/JCS6LRTO.js +4 -0
- package/dist/cdn/JMFDP3N2.js +4 -0
- package/dist/cdn/K2K3SVNK.js +4 -0
- package/dist/cdn/K37JPFII.js +4 -0
- package/dist/cdn/KZBZKETJ.js +4 -0
- package/dist/cdn/{4C2AMRV3.js → LB6FAZU4.js} +2 -2
- package/dist/cdn/LEHWSDCC.js +4 -0
- package/dist/cdn/LEO5UHUH.js +4 -0
- package/dist/cdn/LF55VSRE.js +4 -0
- package/dist/cdn/LJ744YWJ.js +4 -0
- package/dist/cdn/M5SO6PLC.js +4 -0
- package/dist/cdn/MAS5X3MU.js +4 -0
- package/dist/cdn/MJ3ACHUI.js +4 -0
- package/dist/cdn/MMADJXSK.js +4 -0
- package/dist/cdn/NAVN5I7A.js +4 -0
- package/dist/cdn/NDSWSODW.js +4 -0
- package/dist/cdn/NFFUHC5T.js +6 -0
- package/dist/cdn/NHIQZMCA.js +4 -0
- package/dist/cdn/NJPA55HA.js +4 -0
- package/dist/cdn/{IEE3ZBWU.js → NNQ7U5L3.js} +2 -2
- package/dist/cdn/NOXG5ABY.js +4 -0
- package/dist/cdn/O25RXIMT.js +4 -0
- package/dist/cdn/{F4R4AZMX.js → OBTK7W4L.js} +2 -2
- package/dist/cdn/OHE5TOAS.js +4 -0
- package/dist/cdn/OIKQKCBV.js +4 -0
- package/dist/cdn/P66H32HI.js +4 -0
- package/dist/cdn/PLDCG3H6.js +4 -0
- package/dist/cdn/PTJOS2WT.js +4 -0
- package/dist/cdn/PVOYC6A7.js +4 -0
- package/dist/cdn/Q3M37QLC.js +4 -0
- package/dist/cdn/Q3NKX5DK.js +4 -0
- package/dist/cdn/Q5FMRTPX.js +4 -0
- package/dist/cdn/QBLWBZGZ.js +4 -0
- package/dist/cdn/QDKRGZK5.js +4 -0
- package/dist/cdn/QLPUS5UA.js +4 -0
- package/dist/cdn/QN3A5UFK.js +4 -0
- package/dist/cdn/QTCH7CHW.js +4 -0
- package/dist/cdn/QTUI5BY6.js +4 -0
- package/dist/cdn/RBNDEOYG.js +4 -0
- package/dist/cdn/RIOMUX5A.js +4 -0
- package/dist/cdn/RIZ75NK6.js +4 -0
- package/dist/cdn/ROM4VGCT.js +4 -0
- package/dist/cdn/RTEFQICF.js +4 -0
- package/dist/cdn/S44FDCAW.js +4 -0
- package/dist/cdn/S67MOIPZ.js +4 -0
- package/dist/cdn/SAY5WAD3.js +4 -0
- package/dist/cdn/{VTS7NWDH.js → SE2RA67A.js} +1 -1
- package/dist/cdn/STJMKAD6.js +4 -0
- package/dist/cdn/SZUDGI7B.js +4 -0
- package/dist/cdn/TKCEU6XO.js +4 -0
- package/dist/cdn/TR4KWA5R.js +4 -0
- package/dist/cdn/TZXVMMXS.js +4 -0
- package/dist/cdn/U2N3WF6Q.js +4 -0
- package/dist/cdn/{X7BQVP4K.js → U3S2TCQT.js} +1 -1
- package/dist/cdn/U4WFE3TW.js +4 -0
- package/dist/cdn/UGOOEZ4B.js +4 -0
- package/dist/cdn/UY7OFWID.js +4 -0
- package/dist/cdn/V5QCGNEW.js +4 -0
- package/dist/cdn/VLLLHH6H.js +4 -0
- package/dist/cdn/VN7LBYZD.js +4 -0
- package/dist/cdn/VTPVQVMN.js +4 -0
- package/dist/cdn/VTW77JEL.js +4 -0
- package/dist/cdn/WPPMO4E7.js +4 -0
- package/dist/cdn/{PI7H5GRX.js → WR76T2FN.js} +1 -1
- package/dist/cdn/WWHR666E.js +4 -0
- package/dist/cdn/X4GGVQDN.js +4 -0
- package/dist/cdn/X6H2X73K.js +4 -0
- package/dist/cdn/X6WZ5FCI.js +4 -0
- package/dist/cdn/{OM2N2SN3.js → X7A5HLHM.js} +1 -1
- package/dist/cdn/XC5BMLZU.js +4 -0
- package/dist/cdn/XGPA7OC3.js +4 -0
- package/dist/cdn/XHGEGY63.js +4 -0
- package/dist/cdn/XIKIHICD.js +4 -0
- package/dist/cdn/XSY7VTZ4.js +4 -0
- package/dist/cdn/Y4SXZ2OL.js +4 -0
- package/dist/cdn/{RVL24YAQ.js → Y645YIWB.js} +2 -2
- package/dist/cdn/Y6PN2L2V.js +4 -0
- package/dist/cdn/YAT472IU.js +4 -0
- package/dist/cdn/YBCFYT23.js +4 -0
- package/dist/cdn/{YLPU64QT.js → YHZF53T3.js} +2 -2
- package/dist/cdn/YLQKDJRZ.js +4 -0
- package/dist/cdn/YN7BBQOM.js +4 -0
- package/dist/cdn/YQPUPWKL.js +4 -0
- package/dist/cdn/Z5SJQMYF.js +4 -0
- package/dist/cdn/ZJE5JM5Z.js +4 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ar.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.bg.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.bs.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ca.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.cs.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.da.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.de.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.el.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.en.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.es.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.et.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.fi.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.fr.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.he.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.hr.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.hu.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.id.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.it.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ja.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ko.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.lt.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.lv.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.nl.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.no.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.pl.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.pt-BR.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.pt-PT.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ro.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ru.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.sk.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.sl.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.sr.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.sv.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.th.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.tr.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.uk.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.vi.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.zh-CN.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.zh-HK.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.zh-TW.json +1 -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/assets/version-management/t9n/messages.en.json +1 -1
- package/dist/cdn/assets/weather/t9n/messages.en.json +1 -1
- package/dist/cdn/index.js +2 -2
- package/dist/cdn/main.css +1 -1
- package/dist/chunks/AnalysisViewModel.js +4 -4
- package/dist/chunks/async-utils.js +3 -3
- 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 +178 -0
- package/dist/chunks/globalCss.js +1 -1
- package/dist/chunks/heading.js +13 -13
- package/dist/chunks/index.js +17 -0
- package/dist/chunks/layer-list.js +2 -2
- 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 +4 -4
- package/dist/chunks/useT9n.js +1 -1
- package/dist/chunks/useView.js +1 -1
- package/dist/chunks/useViewModel.js +2 -2
- package/dist/chunks/useWidget.js +2 -2
- package/dist/chunks/utils.js +1 -1
- package/dist/components/arcgis-area-measurement-2d/customElement.d.ts +10 -5
- package/dist/components/arcgis-area-measurement-2d/customElement.js +2 -2
- package/dist/components/arcgis-area-measurement-3d/customElement.d.ts +113 -11
- package/dist/components/arcgis-area-measurement-3d/customElement.js +19 -23
- package/dist/components/arcgis-attachments/customElement.d.ts +16 -5
- package/dist/components/arcgis-attachments/customElement.js +8 -8
- package/dist/components/arcgis-basemap-gallery/customElement.d.ts +13 -4
- package/dist/components/arcgis-basemap-gallery/customElement.js +31 -29
- package/dist/components/arcgis-basemap-gallery-item/customElement.d.ts +1 -1
- package/dist/components/arcgis-basemap-gallery-item/customElement.js +10 -7
- package/dist/components/arcgis-basemap-layer-list/customElement.d.ts +10 -5
- package/dist/components/arcgis-basemap-layer-list/customElement.js +2 -2
- package/dist/components/arcgis-basemap-toggle/customElement.d.ts +13 -4
- package/dist/components/arcgis-basemap-toggle/customElement.js +17 -18
- package/dist/components/arcgis-bookmarks/css.d.ts +22 -0
- package/dist/components/arcgis-bookmarks/customElement.d.ts +241 -84
- package/dist/components/arcgis-bookmarks/customElement.js +457 -17
- package/dist/components/arcgis-bookmarks/index.d.ts +21 -0
- package/dist/components/arcgis-bookmarks/index.js +21 -0
- package/dist/components/arcgis-bookmarks/interfaces.d.ts +12 -0
- package/dist/components/arcgis-bookmarks/user-state.d.ts +26 -0
- package/dist/components/arcgis-building-explorer/customElement.d.ts +30 -18
- package/dist/components/arcgis-building-explorer/customElement.js +2 -2
- package/dist/components/arcgis-catalog-layer-list/customElement.d.ts +10 -5
- package/dist/components/arcgis-catalog-layer-list/customElement.js +2 -2
- package/dist/components/arcgis-compass/customElement.d.ts +12 -3
- package/dist/components/arcgis-compass/customElement.js +15 -16
- package/dist/components/arcgis-coordinate-conversion/customElement.d.ts +10 -5
- package/dist/components/arcgis-coordinate-conversion/customElement.js +4 -4
- package/dist/components/arcgis-daylight/customElement.d.ts +36 -18
- package/dist/components/arcgis-daylight/customElement.js +2 -2
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.d.ts +114 -11
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.js +13 -17
- package/dist/components/arcgis-directional-pad/customElement.d.ts +12 -3
- package/dist/components/arcgis-directional-pad/customElement.js +20 -21
- package/dist/components/arcgis-directional-pad/utils.d.ts +2 -2
- package/dist/components/arcgis-directions/customElement.d.ts +11 -6
- package/dist/components/arcgis-directions/customElement.js +2 -2
- package/dist/components/arcgis-distance-measurement-2d/customElement.d.ts +10 -5
- package/dist/components/arcgis-distance-measurement-2d/customElement.js +2 -2
- package/dist/components/arcgis-editor/customElement.d.ts +10 -5
- package/dist/components/arcgis-editor/customElement.js +2 -2
- package/dist/components/arcgis-elevation-profile/customElement.d.ts +33 -25
- package/dist/components/arcgis-elevation-profile/customElement.js +2 -2
- package/dist/components/arcgis-expand/customElement.d.ts +14 -8
- package/dist/components/arcgis-expand/customElement.js +2 -2
- package/dist/components/arcgis-feature/customElement.d.ts +200 -86
- package/dist/components/arcgis-feature/customElement.js +208 -21
- package/dist/components/arcgis-feature/index.d.ts +8 -0
- package/dist/components/arcgis-feature/index.js +8 -0
- package/dist/components/arcgis-feature-attachments/customElement.d.ts +17 -0
- package/dist/components/arcgis-feature-attachments/customElement.js +37 -0
- package/dist/components/arcgis-feature-attachments/index.d.ts +3 -0
- package/dist/components/arcgis-feature-attachments/index.js +3 -0
- package/dist/components/arcgis-feature-content/customElement.d.ts +11 -0
- package/dist/components/arcgis-feature-content/customElement.js +65 -0
- package/dist/components/arcgis-feature-content/index.d.ts +2 -0
- package/dist/components/arcgis-feature-content/index.js +2 -0
- package/dist/components/arcgis-feature-element-info/customElement.d.ts +11 -0
- package/dist/components/arcgis-feature-element-info/customElement.js +42 -0
- package/dist/components/arcgis-feature-expression/customElement.d.ts +21 -0
- package/dist/components/arcgis-feature-expression/customElement.js +248 -0
- package/dist/components/arcgis-feature-expression/index.d.ts +5 -0
- package/dist/components/arcgis-feature-expression/index.js +5 -0
- package/dist/components/arcgis-feature-fields/customElement.d.ts +17 -0
- package/dist/components/arcgis-feature-fields/customElement.js +142 -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.d.ts +11 -6
- package/dist/components/arcgis-feature-form/customElement.js +2 -2
- package/dist/components/arcgis-feature-media/chartCommon.d.ts +1 -0
- package/dist/components/arcgis-feature-media/customElement.d.ts +36 -0
- package/dist/components/arcgis-feature-media/customElement.js +571 -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-relationship/customElement.d.ts +86 -0
- package/dist/components/arcgis-feature-relationship/customElement.js +394 -0
- package/dist/components/arcgis-feature-relationship/index.d.ts +10 -0
- package/dist/components/arcgis-feature-relationship/index.js +10 -0
- package/dist/components/arcgis-feature-table/customElement.d.ts +11 -5
- package/dist/components/arcgis-feature-table/customElement.js +2 -2
- package/dist/components/arcgis-feature-templates/customElement.d.ts +12 -5
- package/dist/components/arcgis-feature-templates/customElement.js +2 -2
- package/dist/components/arcgis-features/customElement.d.ts +9 -4
- package/dist/components/arcgis-features/customElement.js +2 -2
- package/dist/components/arcgis-floor-filter/customElement.d.ts +13 -6
- package/dist/components/arcgis-floor-filter/customElement.js +2 -2
- package/dist/components/arcgis-fullscreen/customElement.d.ts +23 -4
- package/dist/components/arcgis-fullscreen/customElement.js +32 -19
- package/dist/components/arcgis-grid-controls/customElement.d.ts +16 -7
- package/dist/components/arcgis-grid-controls/customElement.js +16 -16
- package/dist/components/arcgis-grid-controls/gridUtils.d.ts +6 -6
- package/dist/components/arcgis-histogram-range-slider/customElement.d.ts +10 -5
- package/dist/components/arcgis-histogram-range-slider/customElement.js +2 -2
- package/dist/components/arcgis-home/customElement.d.ts +31 -10
- package/dist/components/arcgis-home/customElement.js +14 -15
- package/dist/components/arcgis-labeled-switch/customElement.d.ts +1 -1
- package/dist/components/arcgis-labeled-switch/customElement.js +10 -11
- package/dist/components/arcgis-layer-list/customElement.d.ts +14 -6
- package/dist/components/arcgis-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-layer-list-item/customElement.d.ts +1 -1
- package/dist/components/arcgis-layer-list-item/customElement.js +3 -3
- package/dist/components/arcgis-legend/customElement.d.ts +9 -4
- package/dist/components/arcgis-legend/customElement.js +2 -2
- package/dist/components/arcgis-line-of-sight/customElement.d.ts +77 -21
- package/dist/components/arcgis-line-of-sight/customElement.js +19 -23
- package/dist/components/arcgis-link-chart/customElement.d.ts +26 -16
- package/dist/components/arcgis-link-chart/customElement.js +20 -9
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.d.ts +13 -3
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.js +25 -27
- 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/LocateViewModel.d.ts +4 -5
- package/dist/components/arcgis-locate/customElement.d.ts +19 -7
- package/dist/components/arcgis-locate/customElement.js +115 -113
- package/dist/components/arcgis-locate/index.d.ts +0 -1
- package/dist/components/arcgis-locate/index.js +0 -1
- package/dist/components/arcgis-map/customElement.d.ts +33 -20
- package/dist/components/arcgis-map/customElement.js +26 -15
- package/dist/components/arcgis-measurement/customElement.d.ts +11 -6
- package/dist/components/arcgis-measurement/customElement.js +2 -2
- package/dist/components/arcgis-measurement-content/customElement.d.ts +1 -1
- package/dist/components/arcgis-measurement-content/customElement.js +12 -13
- package/dist/components/arcgis-navigation-toggle/customElement.d.ts +19 -15
- package/dist/components/arcgis-navigation-toggle/customElement.js +17 -15
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.d.ts +9 -4
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.js +2 -2
- package/dist/components/arcgis-placement/customElement.d.ts +7 -2
- package/dist/components/arcgis-placement/customElement.js +2 -2
- package/dist/components/arcgis-print/customElement.d.ts +57 -43
- package/dist/components/arcgis-print/customElement.js +38 -33
- package/dist/components/arcgis-print/types.d.ts +40 -0
- package/dist/components/arcgis-print/utils.d.ts +6 -6
- package/dist/components/arcgis-print-custom-text-elements/customElement.d.ts +1 -1
- package/dist/components/arcgis-print-custom-text-elements/customElement.js +2 -2
- package/dist/components/arcgis-print-dpi-input/customElement.d.ts +1 -1
- package/dist/components/arcgis-print-dpi-input/customElement.js +18 -23
- package/dist/components/arcgis-print-export-button/customElement.d.ts +2 -8
- package/dist/components/arcgis-print-export-button/customElement.js +4 -5
- package/dist/components/arcgis-print-exported-link/customElement.d.ts +2 -2
- package/dist/components/arcgis-print-exported-link/customElement.js +24 -25
- package/dist/components/arcgis-print-exports-panel/customElement.d.ts +2 -2
- package/dist/components/arcgis-print-exports-panel/customElement.js +10 -11
- package/dist/components/arcgis-print-format-select/customElement.d.ts +2 -2
- package/dist/components/arcgis-print-format-select/customElement.js +3 -3
- package/dist/components/arcgis-print-layout-advanced-options/customElement.d.ts +1 -1
- package/dist/components/arcgis-print-layout-advanced-options/customElement.js +9 -10
- package/dist/components/arcgis-print-layout-panel/customElement.d.ts +2 -8
- package/dist/components/arcgis-print-layout-panel/customElement.js +14 -15
- package/dist/components/arcgis-print-main-panel/customElement.d.ts +3 -9
- package/dist/components/arcgis-print-main-panel/customElement.js +12 -13
- package/dist/components/arcgis-print-map-only-advanced-options/customElement.d.ts +1 -1
- package/dist/components/arcgis-print-map-only-advanced-options/customElement.js +6 -7
- package/dist/components/arcgis-print-map-only-panel/customElement.d.ts +2 -8
- package/dist/components/arcgis-print-map-only-panel/customElement.js +28 -23
- package/dist/components/arcgis-print-out-spatial-reference-input/customElement.d.ts +1 -1
- package/dist/components/arcgis-print-out-spatial-reference-input/customElement.js +26 -22
- package/dist/components/arcgis-print-preview-input/customElement.d.ts +1 -1
- package/dist/components/arcgis-print-preview-input/customElement.js +2 -2
- package/dist/components/arcgis-print-scale-section/customElement.d.ts +2 -2
- package/dist/components/arcgis-print-scale-section/customElement.js +26 -20
- package/dist/components/arcgis-print-template-select/customElement.d.ts +1 -1
- package/dist/components/arcgis-print-template-select/customElement.js +11 -12
- package/dist/components/arcgis-print-template-selector/customElement.d.ts +1 -1
- package/dist/components/arcgis-print-template-selector/customElement.js +9 -10
- package/dist/components/arcgis-scale-bar/customElement.d.ts +13 -4
- package/dist/components/arcgis-scale-bar/customElement.js +66 -65
- package/dist/components/arcgis-scale-range-slider/customElement.d.ts +9 -4
- package/dist/components/arcgis-scale-range-slider/customElement.js +2 -2
- package/dist/components/arcgis-scene/customElement.d.ts +158 -95
- package/dist/components/arcgis-scene/customElement.js +28 -17
- package/dist/components/arcgis-search/css.d.ts +1 -0
- package/dist/components/arcgis-search/customElement.d.ts +40 -29
- package/dist/components/arcgis-search/customElement.js +38 -34
- package/dist/components/arcgis-search-result-renderer/customElement.d.ts +2 -2
- package/dist/components/arcgis-search-result-renderer/customElement.js +14 -15
- package/dist/components/arcgis-shadow-cast/customElement.d.ts +97 -34
- package/dist/components/arcgis-shadow-cast/customElement.js +2 -2
- package/dist/components/arcgis-sketch/customElement.d.ts +13 -8
- package/dist/components/arcgis-sketch/customElement.js +27 -19
- package/dist/components/arcgis-slice/SliceViewModel.d.ts +0 -1
- package/dist/components/arcgis-slice/customElement.d.ts +109 -23
- package/dist/components/arcgis-slice/customElement.js +32 -41
- package/dist/components/arcgis-swipe/customElement.d.ts +31 -5
- package/dist/components/arcgis-swipe/customElement.js +44 -45
- package/dist/components/arcgis-table-list/customElement.d.ts +10 -5
- package/dist/components/arcgis-table-list/customElement.js +2 -2
- package/dist/components/arcgis-time-slider/customElement.d.ts +9 -4
- package/dist/components/arcgis-time-slider/customElement.js +2 -2
- package/dist/components/arcgis-time-zone-label/customElement.d.ts +5 -3
- package/dist/components/arcgis-time-zone-label/customElement.js +11 -12
- package/dist/components/arcgis-track/customElement.d.ts +28 -11
- package/dist/components/arcgis-track/customElement.js +14 -15
- package/dist/components/arcgis-unit-select/customElement.d.ts +7 -3
- package/dist/components/arcgis-unit-select/customElement.js +22 -16
- package/dist/components/arcgis-utility-network-associations/customElement.d.ts +20 -17
- package/dist/components/arcgis-utility-network-associations/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-trace/customElement.d.ts +10 -5
- package/dist/components/arcgis-utility-network-trace/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-validate-topology/customElement.d.ts +12 -5
- package/dist/components/arcgis-utility-network-validate-topology/customElement.js +1 -1
- package/dist/components/arcgis-value-picker/customElement.d.ts +10 -5
- package/dist/components/arcgis-value-picker/customElement.js +2 -2
- package/dist/components/arcgis-version-management/customElement.d.ts +16 -9
- package/dist/components/arcgis-version-management/customElement.js +49 -51
- package/dist/components/arcgis-version-management-service-item/customElement.d.ts +3 -4
- package/dist/components/arcgis-version-management-service-item/customElement.js +19 -20
- package/dist/components/arcgis-version-management-version-item/customElement.d.ts +1 -2
- package/dist/components/arcgis-version-management-version-item/customElement.js +12 -12
- package/dist/components/arcgis-version-management-version-list/customElement.d.ts +1 -2
- package/dist/components/arcgis-version-management-version-list/customElement.js +18 -22
- package/dist/components/arcgis-version-management-version-properties/customElement.d.ts +1 -2
- package/dist/components/arcgis-version-management-version-properties/customElement.js +43 -44
- package/dist/components/arcgis-video/customElement.d.ts +28 -11
- package/dist/components/arcgis-video/customElement.js +15 -24
- package/dist/components/arcgis-video-player/customElement.d.ts +23 -7
- package/dist/components/arcgis-video-player/customElement.js +43 -34
- package/dist/components/arcgis-video-player-action-bar/customElement.d.ts +1 -1
- package/dist/components/arcgis-video-player-action-bar/customElement.js +30 -19
- package/dist/components/arcgis-video-player-action-bar/index.d.ts +1 -0
- package/dist/components/arcgis-video-player-action-bar/index.js +1 -0
- package/dist/components/arcgis-video-player-actions-group/customElement.d.ts +1 -1
- package/dist/components/arcgis-video-player-actions-group/customElement.js +18 -15
- package/dist/components/arcgis-video-player-controls-group/customElement.d.ts +1 -1
- package/dist/components/arcgis-video-player-controls-group/customElement.js +13 -13
- package/dist/components/arcgis-video-player-metadata/customElement.d.ts +1 -1
- package/dist/components/arcgis-video-player-metadata/customElement.js +10 -11
- package/dist/components/arcgis-video-player-settings/customElement.d.ts +1 -1
- package/dist/components/arcgis-video-player-settings/customElement.js +8 -9
- package/dist/components/arcgis-video-player-slider/customElement.d.ts +1 -1
- package/dist/components/arcgis-video-player-slider/customElement.js +6 -7
- package/dist/components/arcgis-weather/WeatherViewModel.d.ts +1 -1
- package/dist/components/arcgis-weather/css.d.ts +1 -1
- package/dist/components/arcgis-weather/customElement.d.ts +56 -5
- package/dist/components/arcgis-weather/customElement.js +60 -65
- package/dist/components/arcgis-weather/index.d.ts +1 -1
- package/dist/components/arcgis-weather/index.js +1 -1
- package/dist/components/arcgis-zoom/customElement.d.ts +12 -3
- package/dist/components/arcgis-zoom/customElement.js +12 -13
- package/dist/controllers/Handles.d.ts +4 -4
- package/dist/controllers/useHandles.d.ts +5 -5
- package/dist/controllers/useView.d.ts +3 -3
- package/dist/controllers/useViewModel.d.ts +4 -4
- package/dist/controllers/useWidget.d.ts +9 -9
- package/dist/docs/api.json +4149 -2897
- package/dist/docs/docs.json +6567 -5925
- package/dist/docs/vscode.html-custom-data.json +465 -337
- package/dist/docs/web-types.json +1157 -1009
- package/dist/geolocation/GeolocationPositioning.d.ts +5 -6
- package/dist/index.d.ts +12 -34
- package/dist/index.js +1 -1
- package/dist/loader.js +27 -21
- package/dist/support/heading.d.ts +2 -1
- package/dist/support/maybe.d.ts +3 -3
- package/dist/types/lumina.d.ts +28 -36
- package/dist/types/preact.d.ts +29 -37
- package/dist/types/react.d.ts +30 -38
- package/dist/types/stencil.d.ts +28 -36
- package/dist/utils/async-utils.d.ts +7 -7
- package/dist/utils/chart-utils.d.ts +6 -0
- package/dist/utils/component-utils.d.ts +9 -9
- package/dist/utils/feature-form-utils.d.ts +6 -0
- package/dist/utils/feature-utils.d.ts +33 -0
- package/dist/utils/layer-list-utils.d.ts +17 -17
- package/dist/utils/related-feature-utils.d.ts +6 -0
- package/dist/utils/uri-utils.d.ts +4 -0
- package/package.json +7 -5
- package/dist/cdn/2EL47YSQ.js +0 -4
- package/dist/cdn/2FWGOWFO.js +0 -4
- package/dist/cdn/2SULQ4KK.js +0 -4
- package/dist/cdn/3HSBCQKG.js +0 -4
- package/dist/cdn/4LS5QGQY.js +0 -4
- package/dist/cdn/4RPSRSY4.js +0 -4
- package/dist/cdn/4ZBYDBG2.js +0 -4
- package/dist/cdn/5C3EOKNR.js +0 -4
- package/dist/cdn/5ENOXTFZ.js +0 -4
- package/dist/cdn/5HFZPYQ3.js +0 -4
- package/dist/cdn/65FZ5SI5.js +0 -4
- package/dist/cdn/6OHNJ5KH.js +0 -4
- package/dist/cdn/6ZFIJSJE.js +0 -4
- package/dist/cdn/75Y5MUUW.js +0 -4
- package/dist/cdn/7HHVU46D.js +0 -4
- package/dist/cdn/7IUDGNHM.js +0 -4
- package/dist/cdn/7KFXGXRZ.js +0 -4
- package/dist/cdn/7TIBJRHQ.js +0 -4
- package/dist/cdn/7TOSFZBH.js +0 -4
- package/dist/cdn/AFQ3CNBA.js +0 -4
- package/dist/cdn/AGICPYUS.js +0 -4
- package/dist/cdn/APMFVINZ.js +0 -4
- package/dist/cdn/AXVNVZYY.js +0 -4
- package/dist/cdn/BH472V6R.js +0 -4
- package/dist/cdn/BSVQ73BN.js +0 -4
- package/dist/cdn/BXOEGYMC.js +0 -4
- package/dist/cdn/CORDNDJ7.js +0 -4
- package/dist/cdn/CYEXPOL6.js +0 -4
- package/dist/cdn/D3MRITGJ.js +0 -4
- package/dist/cdn/DJPZ44PI.js +0 -4
- package/dist/cdn/DMRETXSG.js +0 -4
- package/dist/cdn/DXY5GBKD.js +0 -6
- package/dist/cdn/E4JWST54.js +0 -4
- package/dist/cdn/E7DAI2OU.js +0 -4
- package/dist/cdn/F4IQXJLJ.js +0 -4
- package/dist/cdn/FCSFUTXJ.js +0 -4
- package/dist/cdn/FDHW3VRA.js +0 -4
- package/dist/cdn/FG7KDZIB.js +0 -4
- package/dist/cdn/FNLXG2W3.js +0 -4
- package/dist/cdn/G3QSNGGG.js +0 -4
- package/dist/cdn/GDWNN6TE.js +0 -4
- package/dist/cdn/GNJ4YNM2.js +0 -4
- package/dist/cdn/GOQV4ZD3.js +0 -4
- package/dist/cdn/HPUACRYC.js +0 -4
- package/dist/cdn/IBNTS6PG.js +0 -4
- package/dist/cdn/IE44CEMQ.js +0 -4
- package/dist/cdn/IL6WFIVO.js +0 -4
- package/dist/cdn/IRIDLSO3.js +0 -4
- package/dist/cdn/KB4RHIMM.js +0 -4
- package/dist/cdn/KNM2L55W.js +0 -4
- package/dist/cdn/L7WHPL3W.js +0 -4
- package/dist/cdn/MKPFXZNG.js +0 -4
- package/dist/cdn/MNRK63NF.js +0 -4
- package/dist/cdn/NAE6KF2V.js +0 -4
- package/dist/cdn/NKEGBDR7.js +0 -4
- package/dist/cdn/NMSW7IAE.js +0 -4
- package/dist/cdn/NRBNSX33.js +0 -4
- package/dist/cdn/OMWLA2K3.js +0 -4
- package/dist/cdn/ON2T4CBB.js +0 -4
- package/dist/cdn/ORMFB243.js +0 -4
- package/dist/cdn/OS7FSXE7.js +0 -4
- package/dist/cdn/OSXV6FXE.js +0 -4
- package/dist/cdn/OZKMAP4Z.js +0 -4
- package/dist/cdn/PIMX4X2G.js +0 -4
- package/dist/cdn/PISMFJUF.js +0 -4
- package/dist/cdn/PNHC4QAI.js +0 -4
- package/dist/cdn/PUSKMZOI.js +0 -4
- package/dist/cdn/PVE4KHDN.js +0 -4
- package/dist/cdn/Q643CZCT.js +0 -4
- package/dist/cdn/RPGEPAXC.js +0 -4
- package/dist/cdn/RSGPVWZC.js +0 -4
- package/dist/cdn/RVKZRZ5X.js +0 -4
- package/dist/cdn/RXJDYF45.js +0 -4
- package/dist/cdn/SN3TAFJA.js +0 -4
- package/dist/cdn/SUJ27253.js +0 -4
- package/dist/cdn/T7MQ5OG2.js +0 -4
- package/dist/cdn/TGAS4E4A.js +0 -4
- package/dist/cdn/TM7AOMFK.js +0 -4
- package/dist/cdn/TU3PDRR3.js +0 -4
- package/dist/cdn/TYGNKCZM.js +0 -4
- package/dist/cdn/U3A4L666.js +0 -4
- package/dist/cdn/U7JHAHCD.js +0 -4
- package/dist/cdn/UIWYLDIB.js +0 -4
- package/dist/cdn/VLYOEVJO.js +0 -4
- package/dist/cdn/WD7GKYC5.js +0 -4
- package/dist/cdn/WGLKRGHM.js +0 -4
- package/dist/cdn/WVMLI2M4.js +0 -4
- package/dist/cdn/WZVHCVXT.js +0 -4
- package/dist/cdn/X3ZXNMN7.js +0 -4
- package/dist/cdn/XHGDPFLO.js +0 -4
- package/dist/cdn/Y4PEPRXU.js +0 -4
- package/dist/cdn/Y4VFLWWQ.js +0 -4
- package/dist/cdn/Y57F7DDG.js +0 -4
- package/dist/cdn/YWOGURYY.js +0 -4
- package/dist/cdn/YZTG72SZ.js +0 -4
- package/dist/cdn/Z73JMBNO.js +0 -4
- package/dist/cdn/ZGVWKWHA.js +0 -4
- package/dist/cdn/ZID6LZJO.js +0 -4
- package/dist/cdn/ZLQ4G2XR.js +0 -4
- package/dist/cdn/ZXKHLRKF.js +0 -4
- package/dist/components/arcgis-slider/customElement.d.ts +0 -240
- package/dist/components/arcgis-slider/customElement.js +0 -32
- /package/dist/components/{arcgis-slider → arcgis-feature-element-info}/index.d.ts +0 -0
- /package/dist/components/{arcgis-slider → arcgis-feature-element-info}/index.js +0 -0
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"tags": [
|
|
5
5
|
{
|
|
6
6
|
"name": "arcgis-area-measurement-2d",
|
|
7
|
-
"description": "The Area Measurement 2D component calculates and displays the area and perimeter of a polygon only in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is
|
|
7
|
+
"description": "The Area Measurement 2D component calculates and displays the area and perimeter of a polygon only in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear 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.",
|
|
8
8
|
"attributes": [
|
|
9
9
|
{
|
|
10
10
|
"name": "auto-destroy-disabled",
|
|
@@ -55,6 +55,7 @@
|
|
|
55
55
|
},
|
|
56
56
|
{
|
|
57
57
|
"name": "reference-element",
|
|
58
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
58
59
|
"values": []
|
|
59
60
|
},
|
|
60
61
|
{
|
|
@@ -143,7 +144,7 @@
|
|
|
143
144
|
},
|
|
144
145
|
{
|
|
145
146
|
"name": "arcgis-area-measurement-3d",
|
|
146
|
-
"description": "The Area Measurement 3D component
|
|
147
|
+
"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 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.",
|
|
147
148
|
"attributes": [
|
|
148
149
|
{
|
|
149
150
|
"name": "auto-destroy-disabled",
|
|
@@ -194,11 +195,12 @@
|
|
|
194
195
|
},
|
|
195
196
|
{
|
|
196
197
|
"name": "reference-element",
|
|
198
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
197
199
|
"values": []
|
|
198
200
|
},
|
|
199
201
|
{
|
|
200
202
|
"name": "state",
|
|
201
|
-
"description": "The
|
|
203
|
+
"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",
|
|
202
204
|
"values": [
|
|
203
205
|
{
|
|
204
206
|
"name": "disabled"
|
|
@@ -216,7 +218,7 @@
|
|
|
216
218
|
},
|
|
217
219
|
{
|
|
218
220
|
"name": "unit",
|
|
219
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the
|
|
221
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
220
222
|
"values": [
|
|
221
223
|
{
|
|
222
224
|
"name": "acres"
|
|
@@ -282,7 +284,7 @@
|
|
|
282
284
|
},
|
|
283
285
|
{
|
|
284
286
|
"name": "arcgis-attachments",
|
|
285
|
-
"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
|
|
287
|
+
"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 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.",
|
|
286
288
|
"attributes": [
|
|
287
289
|
{
|
|
288
290
|
"name": "auto-destroy-disabled",
|
|
@@ -380,6 +382,7 @@
|
|
|
380
382
|
},
|
|
381
383
|
{
|
|
382
384
|
"name": "reference-element",
|
|
385
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
383
386
|
"values": []
|
|
384
387
|
},
|
|
385
388
|
{
|
|
@@ -407,7 +410,7 @@
|
|
|
407
410
|
},
|
|
408
411
|
{
|
|
409
412
|
"name": "arcgis-basemap-gallery",
|
|
410
|
-
"description": "The Basemap Gallery component displays a collection images representing basemaps from [ArcGIS.com](https://www.arcgis.com/index.html) or a user-defined set of map or image services. When a new basemap is selected from the Basemap Gallery, the map's basemap layers are removed and replaced with the basemap layers of the associated basemap selected in the gallery.\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
|
|
413
|
+
"description": "The Basemap Gallery component displays a collection images representing basemaps from [ArcGIS.com](https://www.arcgis.com/index.html) or a user-defined set of map or image services. When a new basemap is selected from the Basemap Gallery, the map's basemap layers are removed and replaced with the basemap layers of the associated basemap selected in the gallery.\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 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.",
|
|
411
414
|
"attributes": [
|
|
412
415
|
{
|
|
413
416
|
"name": "active-basemap",
|
|
@@ -492,6 +495,7 @@
|
|
|
492
495
|
},
|
|
493
496
|
{
|
|
494
497
|
"name": "reference-element",
|
|
498
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
495
499
|
"values": []
|
|
496
500
|
},
|
|
497
501
|
{
|
|
@@ -526,7 +530,7 @@
|
|
|
526
530
|
},
|
|
527
531
|
{
|
|
528
532
|
"name": "arcgis-basemap-layer-list",
|
|
529
|
-
"description": "The Basemap Layer List component provides a way to display a list of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) layers and switch on/off their visibility. [Base layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and [reference layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) are divided into separate sections. When editing is enabled, layers can be reordered by dragging and dropping between the lists and the title can be edited.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\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
|
|
533
|
+
"description": "The Basemap Layer List component provides a way to display a list of [Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html) layers and switch on/off their visibility. [Base layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and [reference layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) are divided into separate sections. When editing is enabled, layers can be reordered by dragging and dropping between the lists and the title can be edited.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\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 ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\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.",
|
|
530
534
|
"attributes": [
|
|
531
535
|
{
|
|
532
536
|
"name": "auto-destroy-disabled",
|
|
@@ -642,6 +646,7 @@
|
|
|
642
646
|
},
|
|
643
647
|
{
|
|
644
648
|
"name": "reference-element",
|
|
649
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
645
650
|
"values": []
|
|
646
651
|
},
|
|
647
652
|
{
|
|
@@ -732,7 +737,7 @@
|
|
|
732
737
|
},
|
|
733
738
|
{
|
|
734
739
|
"name": "arcgis-basemap-toggle",
|
|
735
|
-
"description": "The Basemap Toggle component allows an end-user to switch between two basemaps.\n\nThe basemaps can have different spatial references.\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
|
|
740
|
+
"description": "The Basemap Toggle component allows an end-user to switch between two basemaps.\n\nThe basemaps can have different spatial references.\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 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- `toggle(): Promise<any>` - Toggles to the [next basemap](#nextBasemap).",
|
|
736
741
|
"attributes": [
|
|
737
742
|
{
|
|
738
743
|
"name": "auto-destroy-disabled",
|
|
@@ -788,6 +793,7 @@
|
|
|
788
793
|
},
|
|
789
794
|
{
|
|
790
795
|
"name": "reference-element",
|
|
796
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
791
797
|
"values": []
|
|
792
798
|
},
|
|
793
799
|
{
|
|
@@ -827,7 +833,7 @@
|
|
|
827
833
|
},
|
|
828
834
|
{
|
|
829
835
|
"name": "arcgis-bookmarks",
|
|
830
|
-
"description": "The Bookmarks component
|
|
836
|
+
"description": "The Bookmarks component allows end users to quickly navigate to a particular area of interest.\nIt displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html),\nwhich are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks).\n\nEach bookmark may contain the following properties: `name`, `thumbnail`, `viewpoint` (defines rotation, scale, and target geometry), and `timeExtent`.\nWhen a bookmark with a timeExtent is selected, the [arcgis-map.timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeExtent) of the Map will be set to the timeExtent of the selected bookmark.\nTo disable time capability in the Bookmarks component, set [timeDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#timeDisabled) to `true`.\n\nThe Bookmarks component can be used to create, edit, reorder, and delete bookmarks.\nTo enable these features, set the following properties to `true`:\n[showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showAddBookmarkButton), [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton), and [dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#dragEnabled).\n\n**Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) only if they come from a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks) or are [provided manually](#bookmarks). [Presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html) provides a similar experience for [WebScenes](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html).\n--\n\n### Events\n- **arcgisBookmarkEdit** - \nFires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited.\n- **arcgisBookmarkSelect** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected.\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 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- `goTo(bookmark: __esri.Bookmark): Promise<void>` - Zoom to a specific bookmark.",
|
|
831
837
|
"attributes": [
|
|
832
838
|
{
|
|
833
839
|
"name": "auto-destroy-disabled",
|
|
@@ -841,7 +847,7 @@
|
|
|
841
847
|
},
|
|
842
848
|
{
|
|
843
849
|
"name": "disabled",
|
|
844
|
-
"description": "When true, the
|
|
850
|
+
"description": "When true, the component is visually withdrawn and cannot be interacted with.",
|
|
845
851
|
"values": []
|
|
846
852
|
},
|
|
847
853
|
{
|
|
@@ -851,34 +857,61 @@
|
|
|
851
857
|
},
|
|
852
858
|
{
|
|
853
859
|
"name": "filter-placeholder",
|
|
854
|
-
"description": "Defines the text used as a placeholder when
|
|
860
|
+
"description": "Defines the text used as a placeholder when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.",
|
|
855
861
|
"values": []
|
|
856
862
|
},
|
|
857
863
|
{
|
|
858
864
|
"name": "filter-text",
|
|
859
|
-
"description": "Defines the text used to filter the bookmarks when
|
|
865
|
+
"description": "Defines the text used to filter the bookmarks when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.",
|
|
860
866
|
"values": []
|
|
861
867
|
},
|
|
868
|
+
{
|
|
869
|
+
"name": "heading-level",
|
|
870
|
+
"description": "Indicates the heading level to use for the message \"No bookmarks\" when no bookmarks\nare available. By default, this message is rendered\nas a level 2 heading (e.g. `<h2>No bookmarks</h2>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
|
|
871
|
+
"values": [
|
|
872
|
+
{
|
|
873
|
+
"name": "1"
|
|
874
|
+
},
|
|
875
|
+
{
|
|
876
|
+
"name": "2"
|
|
877
|
+
},
|
|
878
|
+
{
|
|
879
|
+
"name": "3"
|
|
880
|
+
},
|
|
881
|
+
{
|
|
882
|
+
"name": "4"
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"name": "5"
|
|
886
|
+
},
|
|
887
|
+
{
|
|
888
|
+
"name": "6"
|
|
889
|
+
}
|
|
890
|
+
]
|
|
891
|
+
},
|
|
862
892
|
{
|
|
863
893
|
"name": "hide-flow",
|
|
894
|
+
"description": "Determines whether the component should be rendered within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/).",
|
|
864
895
|
"values": []
|
|
865
896
|
},
|
|
866
897
|
{
|
|
867
898
|
"name": "hide-thumbnail",
|
|
899
|
+
"description": "Indicates whether the thumbnail associated with the bookmark is hidden.",
|
|
868
900
|
"values": []
|
|
869
901
|
},
|
|
870
902
|
{
|
|
871
903
|
"name": "hide-time",
|
|
904
|
+
"description": "Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.",
|
|
872
905
|
"values": []
|
|
873
906
|
},
|
|
874
907
|
{
|
|
875
908
|
"name": "icon",
|
|
876
|
-
"description": "Icon which represents the
|
|
909
|
+
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
877
910
|
"values": []
|
|
878
911
|
},
|
|
879
912
|
{
|
|
880
913
|
"name": "label",
|
|
881
|
-
"description": "The
|
|
914
|
+
"description": "The component's default label.",
|
|
882
915
|
"values": []
|
|
883
916
|
},
|
|
884
917
|
{
|
|
@@ -915,30 +948,37 @@
|
|
|
915
948
|
},
|
|
916
949
|
{
|
|
917
950
|
"name": "reference-element",
|
|
951
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
918
952
|
"values": []
|
|
919
953
|
},
|
|
920
954
|
{
|
|
921
955
|
"name": "show-add-bookmark-button",
|
|
956
|
+
"description": "Indicates whether to display the button to add a new bookmark.",
|
|
922
957
|
"values": []
|
|
923
958
|
},
|
|
924
959
|
{
|
|
925
960
|
"name": "show-close-button",
|
|
961
|
+
"description": "Indicates whether to display the close button.",
|
|
926
962
|
"values": []
|
|
927
963
|
},
|
|
928
964
|
{
|
|
929
965
|
"name": "show-collapse-button",
|
|
966
|
+
"description": "Indicates whether to display the collapse button.",
|
|
930
967
|
"values": []
|
|
931
968
|
},
|
|
932
969
|
{
|
|
933
970
|
"name": "show-edit-bookmark-button",
|
|
971
|
+
"description": "Indicates whether to display the button to edit a bookmark.",
|
|
934
972
|
"values": []
|
|
935
973
|
},
|
|
936
974
|
{
|
|
937
975
|
"name": "show-filter",
|
|
976
|
+
"description": "Indicates whether to display the bookmark filter.",
|
|
938
977
|
"values": []
|
|
939
978
|
},
|
|
940
979
|
{
|
|
941
980
|
"name": "show-heading",
|
|
981
|
+
"description": "Indicates whether to display the heading.",
|
|
942
982
|
"values": []
|
|
943
983
|
},
|
|
944
984
|
{
|
|
@@ -952,6 +992,11 @@
|
|
|
952
992
|
"name": "ready"
|
|
953
993
|
}
|
|
954
994
|
]
|
|
995
|
+
},
|
|
996
|
+
{
|
|
997
|
+
"name": "time-disabled",
|
|
998
|
+
"description": "Indicates whether to disable the time capability of the Bookmarks component.",
|
|
999
|
+
"values": []
|
|
955
1000
|
}
|
|
956
1001
|
],
|
|
957
1002
|
"references": [
|
|
@@ -967,7 +1012,7 @@
|
|
|
967
1012
|
},
|
|
968
1013
|
{
|
|
969
1014
|
"name": "arcgis-building-explorer",
|
|
970
|
-
"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
|
|
1015
|
+
"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 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.",
|
|
971
1016
|
"attributes": [
|
|
972
1017
|
{
|
|
973
1018
|
"name": "auto-destroy-disabled",
|
|
@@ -976,7 +1021,7 @@
|
|
|
976
1021
|
},
|
|
977
1022
|
{
|
|
978
1023
|
"name": "heading-level",
|
|
979
|
-
"description": "Indicates the heading level to use for the
|
|
1024
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
980
1025
|
"values": []
|
|
981
1026
|
},
|
|
982
1027
|
{
|
|
@@ -993,12 +1038,12 @@
|
|
|
993
1038
|
},
|
|
994
1039
|
{
|
|
995
1040
|
"name": "icon",
|
|
996
|
-
"description": "Icon which represents the
|
|
1041
|
+
"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/)",
|
|
997
1042
|
"values": []
|
|
998
1043
|
},
|
|
999
1044
|
{
|
|
1000
1045
|
"name": "label",
|
|
1001
|
-
"description": "The
|
|
1046
|
+
"description": "The component's default label.",
|
|
1002
1047
|
"values": []
|
|
1003
1048
|
},
|
|
1004
1049
|
{
|
|
@@ -1035,11 +1080,12 @@
|
|
|
1035
1080
|
},
|
|
1036
1081
|
{
|
|
1037
1082
|
"name": "reference-element",
|
|
1083
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1038
1084
|
"values": []
|
|
1039
1085
|
},
|
|
1040
1086
|
{
|
|
1041
1087
|
"name": "state",
|
|
1042
|
-
"description": "The
|
|
1088
|
+
"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",
|
|
1043
1089
|
"values": [
|
|
1044
1090
|
{
|
|
1045
1091
|
"name": "disabled"
|
|
@@ -1069,7 +1115,7 @@
|
|
|
1069
1115
|
},
|
|
1070
1116
|
{
|
|
1071
1117
|
"name": "arcgis-catalog-layer-list",
|
|
1072
|
-
"description": "The Catalog Layer List component provides a way to display and interact with CatalogLayers.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\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
|
|
1118
|
+
"description": "The Catalog Layer List component provides a way to display and interact with CatalogLayers.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\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 ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\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.",
|
|
1073
1119
|
"attributes": [
|
|
1074
1120
|
{
|
|
1075
1121
|
"name": "auto-destroy-disabled",
|
|
@@ -1158,6 +1204,7 @@
|
|
|
1158
1204
|
},
|
|
1159
1205
|
{
|
|
1160
1206
|
"name": "reference-element",
|
|
1207
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1161
1208
|
"values": []
|
|
1162
1209
|
},
|
|
1163
1210
|
{
|
|
@@ -1243,7 +1290,7 @@
|
|
|
1243
1290
|
},
|
|
1244
1291
|
{
|
|
1245
1292
|
"name": "arcgis-compass",
|
|
1246
|
-
"description": "The Compass component indicates where north is in relation to the current view [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading).\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
|
|
1293
|
+
"description": "The Compass component indicates where north is in relation to the current view [rotation](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading).\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 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>`\n- `reset(): Promise<void>`",
|
|
1247
1294
|
"attributes": [
|
|
1248
1295
|
{
|
|
1249
1296
|
"name": "auto-destroy-disabled",
|
|
@@ -1294,6 +1341,7 @@
|
|
|
1294
1341
|
},
|
|
1295
1342
|
{
|
|
1296
1343
|
"name": "reference-element",
|
|
1344
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1297
1345
|
"values": []
|
|
1298
1346
|
},
|
|
1299
1347
|
{
|
|
@@ -1325,7 +1373,7 @@
|
|
|
1325
1373
|
},
|
|
1326
1374
|
{
|
|
1327
1375
|
"name": "arcgis-coordinate-conversion",
|
|
1328
|
-
"description": "The Coordinate Conversion component provides a way to display user cursor position either as map coordinates or as any of several popular coordinate notations. Additionally, the component provides a way to convert user input coordinates into a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is
|
|
1376
|
+
"description": "The Coordinate Conversion component provides a way to display user cursor position either as map coordinates or as any of several popular coordinate notations. Additionally, the component provides a way to convert user input coordinates into a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is 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- `reverseConvert(coordinate: string, format: __esri.Format): Promise<__esri.Point | nullish>`",
|
|
1329
1377
|
"attributes": [
|
|
1330
1378
|
{
|
|
1331
1379
|
"name": "auto-destroy-disabled",
|
|
@@ -1342,11 +1390,11 @@
|
|
|
1342
1390
|
"values": []
|
|
1343
1391
|
},
|
|
1344
1392
|
{
|
|
1345
|
-
"name": "hide-
|
|
1393
|
+
"name": "hide-expand-button",
|
|
1346
1394
|
"values": []
|
|
1347
1395
|
},
|
|
1348
1396
|
{
|
|
1349
|
-
"name": "hide-
|
|
1397
|
+
"name": "hide-input-button",
|
|
1350
1398
|
"values": []
|
|
1351
1399
|
},
|
|
1352
1400
|
{
|
|
@@ -1429,6 +1477,7 @@
|
|
|
1429
1477
|
},
|
|
1430
1478
|
{
|
|
1431
1479
|
"name": "reference-element",
|
|
1480
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1432
1481
|
"values": []
|
|
1433
1482
|
},
|
|
1434
1483
|
{
|
|
@@ -1477,7 +1526,7 @@
|
|
|
1477
1526
|
},
|
|
1478
1527
|
{
|
|
1479
1528
|
"name": "arcgis-daylight",
|
|
1480
|
-
"description": "The Daylight component can be used to manipulate the lighting conditions of a [
|
|
1529
|
+
"description": "The Daylight component can be used to manipulate the lighting conditions of a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\n**Known limitations**\n\nDaylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [Environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)\n- [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is 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.",
|
|
1481
1530
|
"attributes": [
|
|
1482
1531
|
{
|
|
1483
1532
|
"name": "auto-destroy-disabled",
|
|
@@ -1504,7 +1553,7 @@
|
|
|
1504
1553
|
},
|
|
1505
1554
|
{
|
|
1506
1555
|
"name": "date-or-season",
|
|
1507
|
-
"description": "Controls whether the
|
|
1556
|
+
"description": "Controls whether the component displays a date or a season picker.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason)",
|
|
1508
1557
|
"values": [
|
|
1509
1558
|
{
|
|
1510
1559
|
"name": "date"
|
|
@@ -1521,7 +1570,7 @@
|
|
|
1521
1570
|
},
|
|
1522
1571
|
{
|
|
1523
1572
|
"name": "heading-level",
|
|
1524
|
-
"description": "Indicates the heading level to use for the
|
|
1573
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1525
1574
|
"values": []
|
|
1526
1575
|
},
|
|
1527
1576
|
{
|
|
@@ -1550,12 +1599,12 @@
|
|
|
1550
1599
|
},
|
|
1551
1600
|
{
|
|
1552
1601
|
"name": "icon",
|
|
1553
|
-
"description": "Icon which represents the
|
|
1602
|
+
"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/)",
|
|
1554
1603
|
"values": []
|
|
1555
1604
|
},
|
|
1556
1605
|
{
|
|
1557
1606
|
"name": "label",
|
|
1558
|
-
"description": "The
|
|
1607
|
+
"description": "The component's default label.",
|
|
1559
1608
|
"values": []
|
|
1560
1609
|
},
|
|
1561
1610
|
{
|
|
@@ -1597,11 +1646,12 @@
|
|
|
1597
1646
|
},
|
|
1598
1647
|
{
|
|
1599
1648
|
"name": "reference-element",
|
|
1649
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1600
1650
|
"values": []
|
|
1601
1651
|
},
|
|
1602
1652
|
{
|
|
1603
1653
|
"name": "time-slider-steps",
|
|
1604
|
-
"description": "Sets steps, or intervals, on the time slider to restrict the times
|
|
1654
|
+
"description": "Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#timeSliderSteps)",
|
|
1605
1655
|
"values": []
|
|
1606
1656
|
},
|
|
1607
1657
|
{
|
|
@@ -1623,7 +1673,7 @@
|
|
|
1623
1673
|
},
|
|
1624
1674
|
{
|
|
1625
1675
|
"name": "arcgis-directional-pad",
|
|
1626
|
-
"description": "A directional pad (D-Pad) component can be used to control the position and\nrotation of the map. The D-Pad provides eight directions of movement, a small\ncompass which indicates the current orientation of the map and a slider for\nrotating the map.\n\nIt is also possible to disable the map's rotation controls or change the size\nof the component.\n\nThe Directional Pad component is not supported in 3D.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is
|
|
1676
|
+
"description": "A directional pad (D-Pad) component can be used to control the position and\nrotation of the map. The D-Pad provides eight directions of movement, a small\ncompass which indicates the current orientation of the map and a slider for\nrotating the map.\n\nIt is also possible to disable the map's rotation controls or change the size\nof the component.\n\nThe Directional Pad component is not supported in 3D.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is 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.",
|
|
1627
1677
|
"attributes": [
|
|
1628
1678
|
{
|
|
1629
1679
|
"name": "auto-destroy-disabled",
|
|
@@ -1684,6 +1734,7 @@
|
|
|
1684
1734
|
},
|
|
1685
1735
|
{
|
|
1686
1736
|
"name": "reference-element",
|
|
1737
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1687
1738
|
"values": []
|
|
1688
1739
|
},
|
|
1689
1740
|
{
|
|
@@ -1740,7 +1791,7 @@
|
|
|
1740
1791
|
},
|
|
1741
1792
|
{
|
|
1742
1793
|
"name": "arcgis-directions",
|
|
1743
|
-
"description": "The Directions component provides a way to calculate directions, between two or more input locations with a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html), using ArcGIS Online and custom Network Analysis Route services.\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
|
|
1794
|
+
"description": "The Directions component provides a way to calculate directions, between two or more input locations with a [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html), using ArcGIS Online and custom Network Analysis Route services.\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 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- `getDirections(): Promise<__esri.RouteLayerSolveResult>`\n- `save(): Promise<__esri.PortalItem>`\n- `saveAs(portalItem: __esri.PortalItem, options: { folder: __esri.PortalFolder; }): Promise<__esri.PortalItem>`\n- `zoomToRoute(): Promise<void>`",
|
|
1744
1795
|
"attributes": [
|
|
1745
1796
|
{
|
|
1746
1797
|
"name": "api-key",
|
|
@@ -1818,6 +1869,7 @@
|
|
|
1818
1869
|
},
|
|
1819
1870
|
{
|
|
1820
1871
|
"name": "reference-element",
|
|
1872
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1821
1873
|
"values": []
|
|
1822
1874
|
},
|
|
1823
1875
|
{
|
|
@@ -1911,7 +1963,7 @@
|
|
|
1911
1963
|
},
|
|
1912
1964
|
{
|
|
1913
1965
|
"name": "arcgis-direct-line-measurement-3d",
|
|
1914
|
-
"description": "The Direct Line Measurement 3D component
|
|
1966
|
+
"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 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.",
|
|
1915
1967
|
"attributes": [
|
|
1916
1968
|
{
|
|
1917
1969
|
"name": "auto-destroy-disabled",
|
|
@@ -1962,10 +2014,12 @@
|
|
|
1962
2014
|
},
|
|
1963
2015
|
{
|
|
1964
2016
|
"name": "reference-element",
|
|
2017
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1965
2018
|
"values": []
|
|
1966
2019
|
},
|
|
1967
2020
|
{
|
|
1968
2021
|
"name": "state",
|
|
2022
|
+
"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",
|
|
1969
2023
|
"values": [
|
|
1970
2024
|
{
|
|
1971
2025
|
"name": "disabled"
|
|
@@ -1983,7 +2037,7 @@
|
|
|
1983
2037
|
},
|
|
1984
2038
|
{
|
|
1985
2039
|
"name": "unit",
|
|
1986
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
2040
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
1987
2041
|
"values": [
|
|
1988
2042
|
{
|
|
1989
2043
|
"name": "centimeters"
|
|
@@ -2040,7 +2094,7 @@
|
|
|
2040
2094
|
},
|
|
2041
2095
|
{
|
|
2042
2096
|
"name": "arcgis-directline-measurement-3d",
|
|
2043
|
-
"description": "**Deprecated**. The
|
|
2097
|
+
"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 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.",
|
|
2044
2098
|
"attributes": [
|
|
2045
2099
|
{
|
|
2046
2100
|
"name": "auto-destroy-disabled",
|
|
@@ -2091,10 +2145,12 @@
|
|
|
2091
2145
|
},
|
|
2092
2146
|
{
|
|
2093
2147
|
"name": "reference-element",
|
|
2148
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2094
2149
|
"values": []
|
|
2095
2150
|
},
|
|
2096
2151
|
{
|
|
2097
2152
|
"name": "state",
|
|
2153
|
+
"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",
|
|
2098
2154
|
"values": [
|
|
2099
2155
|
{
|
|
2100
2156
|
"name": "disabled"
|
|
@@ -2112,7 +2168,7 @@
|
|
|
2112
2168
|
},
|
|
2113
2169
|
{
|
|
2114
2170
|
"name": "unit",
|
|
2115
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
2171
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
2116
2172
|
"values": [
|
|
2117
2173
|
{
|
|
2118
2174
|
"name": "centimeters"
|
|
@@ -2165,7 +2221,7 @@
|
|
|
2165
2221
|
},
|
|
2166
2222
|
{
|
|
2167
2223
|
"name": "arcgis-distance-measurement-2d",
|
|
2168
|
-
"description": "The Distance Measurement 2D component calculates and displays the distance between two or more points in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is
|
|
2224
|
+
"description": "The Distance Measurement 2D component calculates and displays the distance between two or more points in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear 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.",
|
|
2169
2225
|
"attributes": [
|
|
2170
2226
|
{
|
|
2171
2227
|
"name": "auto-destroy-disabled",
|
|
@@ -2216,6 +2272,7 @@
|
|
|
2216
2272
|
},
|
|
2217
2273
|
{
|
|
2218
2274
|
"name": "reference-element",
|
|
2275
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2219
2276
|
"values": []
|
|
2220
2277
|
},
|
|
2221
2278
|
{
|
|
@@ -2295,7 +2352,7 @@
|
|
|
2295
2352
|
},
|
|
2296
2353
|
{
|
|
2297
2354
|
"name": "arcgis-editor",
|
|
2298
|
-
"description": "The Editor component provides an out-of-the-box editing experience to help streamline editing within a web application.\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
|
|
2355
|
+
"description": "The Editor component provides an out-of-the-box editing experience to help streamline editing within a web application.\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 ready to be interacted with.\n\n### Methods\n- `cancelWorkflow(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `deleteFeatureFromWorkflow(): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `startCreateFeaturesWorkflowAtFeatureCreation(info: __esri.CreateFeaturesCreationInfo): Promise<void>`\n- `startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise<void>`\n- `startUpdateWorkflowAtFeatureEdit(feature: __esri.Graphic): Promise<void>`\n- `startUpdateWorkflowAtFeatureSelection(): Promise<void>`\n- `startUpdateWorkflowAtMultipleFeatureSelection(candidates: __esri.Graphic[]): Promise<void>`",
|
|
2299
2356
|
"attributes": [
|
|
2300
2357
|
{
|
|
2301
2358
|
"name": "auto-destroy-disabled",
|
|
@@ -2383,6 +2440,7 @@
|
|
|
2383
2440
|
},
|
|
2384
2441
|
{
|
|
2385
2442
|
"name": "reference-element",
|
|
2443
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2386
2444
|
"values": []
|
|
2387
2445
|
},
|
|
2388
2446
|
{
|
|
@@ -2435,9 +2493,6 @@
|
|
|
2435
2493
|
{
|
|
2436
2494
|
"name": "editing-features"
|
|
2437
2495
|
},
|
|
2438
|
-
{
|
|
2439
|
-
"name": "editing-new-feature"
|
|
2440
|
-
},
|
|
2441
2496
|
{
|
|
2442
2497
|
"name": "ready"
|
|
2443
2498
|
},
|
|
@@ -2460,7 +2515,7 @@
|
|
|
2460
2515
|
},
|
|
2461
2516
|
{
|
|
2462
2517
|
"name": "arcgis-elevation-profile",
|
|
2463
|
-
"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
|
|
2518
|
+
"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 ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Switches to the \"creating\" state in which the user can draw a new line.\n- `stop(): Promise<void>` - Stops the creation operation.",
|
|
2464
2519
|
"attributes": [
|
|
2465
2520
|
{
|
|
2466
2521
|
"name": "auto-destroy-disabled",
|
|
@@ -2511,12 +2566,12 @@
|
|
|
2511
2566
|
},
|
|
2512
2567
|
{
|
|
2513
2568
|
"name": "icon",
|
|
2514
|
-
"description": "Icon which represents the
|
|
2569
|
+
"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/)",
|
|
2515
2570
|
"values": []
|
|
2516
2571
|
},
|
|
2517
2572
|
{
|
|
2518
2573
|
"name": "label",
|
|
2519
|
-
"description": "The
|
|
2574
|
+
"description": "The component's default label.",
|
|
2520
2575
|
"values": []
|
|
2521
2576
|
},
|
|
2522
2577
|
{
|
|
@@ -2553,11 +2608,12 @@
|
|
|
2553
2608
|
},
|
|
2554
2609
|
{
|
|
2555
2610
|
"name": "reference-element",
|
|
2611
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2556
2612
|
"values": []
|
|
2557
2613
|
},
|
|
2558
2614
|
{
|
|
2559
2615
|
"name": "state",
|
|
2560
|
-
"description": "The
|
|
2616
|
+
"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",
|
|
2561
2617
|
"values": [
|
|
2562
2618
|
{
|
|
2563
2619
|
"name": "created"
|
|
@@ -2643,7 +2699,7 @@
|
|
|
2643
2699
|
},
|
|
2644
2700
|
{
|
|
2645
2701
|
"name": "arcgis-expand",
|
|
2646
|
-
"description": "The Expand component acts as a clickable button for
|
|
2702
|
+
"description": "The Expand component acts as a clickable button for displaying interactive content, most commonly other components.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `collapse(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `expand(): Promise<void>`\n- `toggle(): Promise<void>`",
|
|
2647
2703
|
"attributes": [
|
|
2648
2704
|
{
|
|
2649
2705
|
"name": "auto-collapse",
|
|
@@ -2667,7 +2723,7 @@
|
|
|
2667
2723
|
},
|
|
2668
2724
|
{
|
|
2669
2725
|
"name": "collapse-tooltip",
|
|
2670
|
-
"description": "Tooltip to display to indicate Expand widget can be collapsed.",
|
|
2726
|
+
"description": "Tooltip to display to indicate Expand widget can be collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseTooltip)",
|
|
2671
2727
|
"values": []
|
|
2672
2728
|
},
|
|
2673
2729
|
{
|
|
@@ -2677,7 +2733,7 @@
|
|
|
2677
2733
|
},
|
|
2678
2734
|
{
|
|
2679
2735
|
"name": "expand-tooltip",
|
|
2680
|
-
"description": "Tooltip to display to indicate Expand widget can be expanded.",
|
|
2736
|
+
"description": "Tooltip to display to indicate Expand widget can be expanded.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandTooltip)",
|
|
2681
2737
|
"values": []
|
|
2682
2738
|
},
|
|
2683
2739
|
{
|
|
@@ -2692,7 +2748,7 @@
|
|
|
2692
2748
|
},
|
|
2693
2749
|
{
|
|
2694
2750
|
"name": "focus-trap-enabled",
|
|
2695
|
-
"description": "**Deprecated**: since 4.33
|
|
2751
|
+
"description": "**Deprecated**: since 4.33, use [`focusTrapDisabled`](#focusTrapDisabled) instead.. Disables focus trapping within the expand widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#focusTrapDisabled)",
|
|
2696
2752
|
"values": []
|
|
2697
2753
|
},
|
|
2698
2754
|
{
|
|
@@ -2828,6 +2884,7 @@
|
|
|
2828
2884
|
},
|
|
2829
2885
|
{
|
|
2830
2886
|
"name": "reference-element",
|
|
2887
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2831
2888
|
"values": []
|
|
2832
2889
|
}
|
|
2833
2890
|
],
|
|
@@ -2837,78 +2894,111 @@
|
|
|
2837
2894
|
"url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/"
|
|
2838
2895
|
},
|
|
2839
2896
|
{
|
|
2840
|
-
"name": "
|
|
2841
|
-
"url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--
|
|
2897
|
+
"name": "Expand with Custom Content\nThe Expand component with custom content. The content must be wrapped in a [Placement](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-placement/) component.",
|
|
2898
|
+
"url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--custom-content&singleStory=true"
|
|
2899
|
+
},
|
|
2900
|
+
{
|
|
2901
|
+
"name": "Expand with Component Content\nThe Expand component with the [Basemap Gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) component.",
|
|
2902
|
+
"url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--component-content&singleStory=true"
|
|
2842
2903
|
}
|
|
2843
2904
|
]
|
|
2844
2905
|
},
|
|
2845
2906
|
{
|
|
2846
2907
|
"name": "arcgis-feature",
|
|
2847
|
-
"description": "The Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html)
|
|
2908
|
+
"description": "The Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).\nThis component is useful in instances where you want to display information about a feature but without\nthe use of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).\n\nIf wanting to show a feature's content with [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#actions), [related](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html), or [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate), etc., then use the [ArcgisFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/) component.\n\nWhen Arcade expressions that use `$map` or [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) are defined in any popup template content or as expression elements,\nthe [map](#map) and [spatialReference](#spatialReference) properties need to be defined in the Feature 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 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- `nextMedia(contentElementIndex: number): Promise<void>` - Paginates to the next [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info.\n- `previousMedia(contentElementIndex: number): Promise<void>` - Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info in the specified\n[media](esri-popup-content-MediaContent.html) content element.\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>` - Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info object. For example,\nyou may have [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) content which contains\nmultiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos`\nyou wish to display.\n\n::: esri-md class=\"warning\"\nPrior to version 4.17, this method was named `goToMedia`.\n:::",
|
|
2848
2909
|
"attributes": [
|
|
2849
2910
|
{
|
|
2850
2911
|
"name": "auto-destroy-disabled",
|
|
2851
2912
|
"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/#destroy) method when you are done to\nprevent memory leaks.",
|
|
2852
2913
|
"values": []
|
|
2853
2914
|
},
|
|
2915
|
+
{
|
|
2916
|
+
"name": "chart-animation-disabled",
|
|
2917
|
+
"description": "Disables chart animation within the component.",
|
|
2918
|
+
"values": []
|
|
2919
|
+
},
|
|
2854
2920
|
{
|
|
2855
2921
|
"name": "default-popup-template-enabled",
|
|
2856
|
-
"description": "Enables automatic creation of a popup template for layers that have popups enabled but no\npopupTemplate defined.",
|
|
2922
|
+
"description": "Enables automatic creation of a popup template for layers that have popups enabled but no\npopupTemplate defined. Automatic popup templates are supported for layers that\nsupport the `createPopupTemplate()` method. (Supported for\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html)\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html), and\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html)).\n\n**Note:**\nStarting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#dateFormat)\nrather than `long-month-day-year` in the default [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.",
|
|
2857
2923
|
"values": []
|
|
2858
2924
|
},
|
|
2859
2925
|
{
|
|
2860
2926
|
"name": "heading-level",
|
|
2861
|
-
"description": "Indicates the heading level to use for the [title](
|
|
2862
|
-
"values": [
|
|
2927
|
+
"description": "Indicates the heading level to use for the [title](#title) of the component.\nBy default, the title is rendered\nas a level 2 heading (e.g. `<h2>Title of content</h2>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
|
|
2928
|
+
"values": [
|
|
2929
|
+
{
|
|
2930
|
+
"name": "1"
|
|
2931
|
+
},
|
|
2932
|
+
{
|
|
2933
|
+
"name": "2"
|
|
2934
|
+
},
|
|
2935
|
+
{
|
|
2936
|
+
"name": "3"
|
|
2937
|
+
},
|
|
2938
|
+
{
|
|
2939
|
+
"name": "4"
|
|
2940
|
+
},
|
|
2941
|
+
{
|
|
2942
|
+
"name": "5"
|
|
2943
|
+
},
|
|
2944
|
+
{
|
|
2945
|
+
"name": "6"
|
|
2946
|
+
}
|
|
2947
|
+
]
|
|
2863
2948
|
},
|
|
2864
2949
|
{
|
|
2865
|
-
"name": "hide-content
|
|
2866
|
-
"description": "
|
|
2950
|
+
"name": "hide-attachments-content",
|
|
2951
|
+
"description": "This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html) within the component.",
|
|
2867
2952
|
"values": []
|
|
2868
2953
|
},
|
|
2869
2954
|
{
|
|
2870
|
-
"name": "hide-content
|
|
2871
|
-
"description": "
|
|
2955
|
+
"name": "hide-content",
|
|
2956
|
+
"description": "This property provides the ability to hide or show content within the component.",
|
|
2872
2957
|
"values": []
|
|
2873
2958
|
},
|
|
2874
2959
|
{
|
|
2875
|
-
"name": "hide-content
|
|
2876
|
-
"description": "
|
|
2960
|
+
"name": "hide-custom-content",
|
|
2961
|
+
"description": "This property provides the ability to hide or show [custom content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-CustomContent.html) within the component.",
|
|
2877
2962
|
"values": []
|
|
2878
2963
|
},
|
|
2879
2964
|
{
|
|
2880
|
-
"name": "hide-content
|
|
2881
|
-
"description": "
|
|
2965
|
+
"name": "hide-expression-content",
|
|
2966
|
+
"description": "This property provides the ability to hide or show [expression content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) within the component.",
|
|
2882
2967
|
"values": []
|
|
2883
2968
|
},
|
|
2884
2969
|
{
|
|
2885
|
-
"name": "hide-content
|
|
2886
|
-
"description": "
|
|
2970
|
+
"name": "hide-fields-content",
|
|
2971
|
+
"description": "This property provides the ability to hide or show [fields content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-FieldsContent.html) within the component.",
|
|
2887
2972
|
"values": []
|
|
2888
2973
|
},
|
|
2889
2974
|
{
|
|
2890
|
-
"name": "hide-
|
|
2891
|
-
"description": "
|
|
2975
|
+
"name": "hide-heading",
|
|
2976
|
+
"description": "This property provides the ability to hide or show the component's [heading](#heading).",
|
|
2892
2977
|
"values": []
|
|
2893
2978
|
},
|
|
2894
2979
|
{
|
|
2895
2980
|
"name": "hide-last-edited-info",
|
|
2896
|
-
"description": "
|
|
2981
|
+
"description": "This property provides the ability to hide or show the last edited info within the component.",
|
|
2982
|
+
"values": []
|
|
2983
|
+
},
|
|
2984
|
+
{
|
|
2985
|
+
"name": "hide-media-content",
|
|
2986
|
+
"description": "This property provides the ability to hide or show [media content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) within the component.",
|
|
2897
2987
|
"values": []
|
|
2898
2988
|
},
|
|
2899
2989
|
{
|
|
2900
|
-
"name": "hide-
|
|
2901
|
-
"description": "
|
|
2990
|
+
"name": "hide-text-content",
|
|
2991
|
+
"description": "This property provides the ability to hide or show [text content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html) within the component.",
|
|
2902
2992
|
"values": []
|
|
2903
2993
|
},
|
|
2904
2994
|
{
|
|
2905
2995
|
"name": "icon",
|
|
2906
|
-
"description": "Icon which represents the
|
|
2996
|
+
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
2907
2997
|
"values": []
|
|
2908
2998
|
},
|
|
2909
2999
|
{
|
|
2910
3000
|
"name": "label",
|
|
2911
|
-
"description": "The
|
|
3001
|
+
"description": "The component's default label.",
|
|
2912
3002
|
"values": []
|
|
2913
3003
|
},
|
|
2914
3004
|
{
|
|
@@ -2945,6 +3035,17 @@
|
|
|
2945
3035
|
},
|
|
2946
3036
|
{
|
|
2947
3037
|
"name": "reference-element",
|
|
3038
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3039
|
+
"values": []
|
|
3040
|
+
},
|
|
3041
|
+
{
|
|
3042
|
+
"name": "show-relationship-content",
|
|
3043
|
+
"description": "This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html) within the component.",
|
|
3044
|
+
"values": []
|
|
3045
|
+
},
|
|
3046
|
+
{
|
|
3047
|
+
"name": "show-utility-network-content",
|
|
3048
|
+
"description": "This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-UtilityNetworkContent.html) within the component.",
|
|
2948
3049
|
"values": []
|
|
2949
3050
|
},
|
|
2950
3051
|
{
|
|
@@ -2967,7 +3068,7 @@
|
|
|
2967
3068
|
},
|
|
2968
3069
|
{
|
|
2969
3070
|
"name": "time-zone",
|
|
2970
|
-
"description": "Dates and times displayed in the
|
|
3071
|
+
"description": "Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from [MapView.timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone). When a MapView is not associated with the component,\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\nsystem | Dates and times will be displayed in the timezone of the device or browser.\nunknown | Dates and time are not adjusted for any timezone.\nSpecified IANA timezone | Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
|
|
2971
3072
|
"values": []
|
|
2972
3073
|
}
|
|
2973
3074
|
],
|
|
@@ -2979,12 +3080,20 @@
|
|
|
2979
3080
|
{
|
|
2980
3081
|
"name": "Feature",
|
|
2981
3082
|
"url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-feature--demo&singleStory=true"
|
|
3083
|
+
},
|
|
3084
|
+
{
|
|
3085
|
+
"name": "Generic",
|
|
3086
|
+
"url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-feature--generic&singleStory=true"
|
|
3087
|
+
},
|
|
3088
|
+
{
|
|
3089
|
+
"name": "Expression",
|
|
3090
|
+
"url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-feature--expression&singleStory=true"
|
|
2982
3091
|
}
|
|
2983
3092
|
]
|
|
2984
3093
|
},
|
|
2985
3094
|
{
|
|
2986
3095
|
"name": "arcgis-feature-form",
|
|
2987
|
-
"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
|
|
3096
|
+
"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 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.",
|
|
2988
3097
|
"attributes": [
|
|
2989
3098
|
{
|
|
2990
3099
|
"name": "auto-destroy-disabled",
|
|
@@ -3052,6 +3161,7 @@
|
|
|
3052
3161
|
},
|
|
3053
3162
|
{
|
|
3054
3163
|
"name": "reference-element",
|
|
3164
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3055
3165
|
"values": []
|
|
3056
3166
|
},
|
|
3057
3167
|
{
|
|
@@ -3083,9 +3193,116 @@
|
|
|
3083
3193
|
}
|
|
3084
3194
|
]
|
|
3085
3195
|
},
|
|
3196
|
+
{
|
|
3197
|
+
"name": "arcgis-feature-relationship",
|
|
3198
|
+
"description": "### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
3199
|
+
"attributes": [
|
|
3200
|
+
{
|
|
3201
|
+
"name": "auto-destroy-disabled",
|
|
3202
|
+
"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-relationship/#destroy) method when you are done to\nprevent memory leaks.",
|
|
3203
|
+
"values": []
|
|
3204
|
+
},
|
|
3205
|
+
{
|
|
3206
|
+
"name": "description",
|
|
3207
|
+
"values": []
|
|
3208
|
+
},
|
|
3209
|
+
{
|
|
3210
|
+
"name": "display-count",
|
|
3211
|
+
"values": []
|
|
3212
|
+
},
|
|
3213
|
+
{
|
|
3214
|
+
"name": "feature-page",
|
|
3215
|
+
"values": []
|
|
3216
|
+
},
|
|
3217
|
+
{
|
|
3218
|
+
"name": "features-per-page",
|
|
3219
|
+
"values": []
|
|
3220
|
+
},
|
|
3221
|
+
{
|
|
3222
|
+
"name": "flow-type",
|
|
3223
|
+
"values": [
|
|
3224
|
+
{
|
|
3225
|
+
"name": "feature"
|
|
3226
|
+
},
|
|
3227
|
+
{
|
|
3228
|
+
"name": "feature-association"
|
|
3229
|
+
},
|
|
3230
|
+
{
|
|
3231
|
+
"name": "feature-relationship"
|
|
3232
|
+
},
|
|
3233
|
+
{
|
|
3234
|
+
"name": "feature-utility-network-association-type"
|
|
3235
|
+
},
|
|
3236
|
+
{
|
|
3237
|
+
"name": "feature-utility-network-associations"
|
|
3238
|
+
}
|
|
3239
|
+
]
|
|
3240
|
+
},
|
|
3241
|
+
{
|
|
3242
|
+
"name": "heading",
|
|
3243
|
+
"values": []
|
|
3244
|
+
},
|
|
3245
|
+
{
|
|
3246
|
+
"name": "heading-level",
|
|
3247
|
+
"values": [
|
|
3248
|
+
{
|
|
3249
|
+
"name": "1"
|
|
3250
|
+
},
|
|
3251
|
+
{
|
|
3252
|
+
"name": "2"
|
|
3253
|
+
},
|
|
3254
|
+
{
|
|
3255
|
+
"name": "3"
|
|
3256
|
+
},
|
|
3257
|
+
{
|
|
3258
|
+
"name": "4"
|
|
3259
|
+
},
|
|
3260
|
+
{
|
|
3261
|
+
"name": "5"
|
|
3262
|
+
},
|
|
3263
|
+
{
|
|
3264
|
+
"name": "6"
|
|
3265
|
+
}
|
|
3266
|
+
]
|
|
3267
|
+
},
|
|
3268
|
+
{
|
|
3269
|
+
"name": "hide-description",
|
|
3270
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
3271
|
+
"values": []
|
|
3272
|
+
},
|
|
3273
|
+
{
|
|
3274
|
+
"name": "hide-heading",
|
|
3275
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
3276
|
+
"values": []
|
|
3277
|
+
},
|
|
3278
|
+
{
|
|
3279
|
+
"name": "label",
|
|
3280
|
+
"description": "The component's default label.",
|
|
3281
|
+
"values": []
|
|
3282
|
+
},
|
|
3283
|
+
{
|
|
3284
|
+
"name": "relationship-id",
|
|
3285
|
+
"values": []
|
|
3286
|
+
},
|
|
3287
|
+
{
|
|
3288
|
+
"name": "show-all-enabled",
|
|
3289
|
+
"values": []
|
|
3290
|
+
},
|
|
3291
|
+
{
|
|
3292
|
+
"name": "time-zone",
|
|
3293
|
+
"values": []
|
|
3294
|
+
}
|
|
3295
|
+
],
|
|
3296
|
+
"references": [
|
|
3297
|
+
{
|
|
3298
|
+
"name": "Docs",
|
|
3299
|
+
"url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-relationship/"
|
|
3300
|
+
}
|
|
3301
|
+
]
|
|
3302
|
+
},
|
|
3086
3303
|
{
|
|
3087
3304
|
"name": "arcgis-feature-table",
|
|
3088
|
-
"description": "The Feature Table component provides an interactive tabular view of each feature's attributes in a feature layer.\n--\n\n### Events\n- **arcgisCellClick**\n- **arcgisCellKeydown**\n- **arcgisCellPointerout**\n- **arcgisCellPointerover**\n- **arcgisColumnReorder**\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
|
|
3305
|
+
"description": "The Feature Table component provides an interactive tabular view of each feature's attributes in a feature layer.\n--\n\n### Events\n- **arcgisCellClick**\n- **arcgisCellKeydown**\n- **arcgisCellPointerout**\n- **arcgisCellPointerover**\n- **arcgisColumnReorder**\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 ready to be interacted with.\n- **arcgisSelectionChange**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `deleteSelection(showWarningPrompt?: boolean): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `exportSelectionToCSV(includeGeometry?: boolean): Promise<void>`\n- `findColumn(fieldName: string): Promise<__esri.ActionColumn | __esri.AttachmentsColumn | __esri.Column | __esri.GroupColumn | __esri.RelationshipColumn | nullish>`\n- `goToPage(index: number): Promise<void>`\n- `hideColumn(fieldName: string): Promise<void>`\n- `nextPage(): Promise<void>`\n- `previousPage(): Promise<void>`\n- `refresh(): Promise<void>`\n- `scrollToBottom(): Promise<void>`\n- `scrollToIndex(index: number): Promise<void>`\n- `scrollToLeft(): Promise<void>`\n- `scrollToRow(objectId: number): Promise<void>`\n- `scrollToTop(): Promise<void>`\n- `showAllColumns(): Promise<void>`\n- `showColumn(fieldName: string): Promise<void>`\n- `sortColumn(path: string, direction: \"asc\" | \"desc\"): Promise<void>`\n- `zoomToSelection(): Promise<void>`",
|
|
3089
3306
|
"attributes": [
|
|
3090
3307
|
{
|
|
3091
3308
|
"name": "attachments-enabled",
|
|
@@ -3348,6 +3565,7 @@
|
|
|
3348
3565
|
},
|
|
3349
3566
|
{
|
|
3350
3567
|
"name": "reference-element",
|
|
3568
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3351
3569
|
"values": []
|
|
3352
3570
|
},
|
|
3353
3571
|
{
|
|
@@ -3425,7 +3643,7 @@
|
|
|
3425
3643
|
},
|
|
3426
3644
|
{
|
|
3427
3645
|
"name": "arcgis-feature-templates",
|
|
3428
|
-
"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
|
|
3646
|
+
"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 ready to be interacted with.\n- **arcgisSelect**\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.",
|
|
3429
3647
|
"attributes": [
|
|
3430
3648
|
{
|
|
3431
3649
|
"name": "auto-destroy-disabled",
|
|
@@ -3500,6 +3718,7 @@
|
|
|
3500
3718
|
},
|
|
3501
3719
|
{
|
|
3502
3720
|
"name": "reference-element",
|
|
3721
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3503
3722
|
"values": []
|
|
3504
3723
|
},
|
|
3505
3724
|
{
|
|
@@ -3539,7 +3758,7 @@
|
|
|
3539
3758
|
},
|
|
3540
3759
|
{
|
|
3541
3760
|
"name": "arcgis-features",
|
|
3542
|
-
"description": "The Features component allows users to view a feature's popupTemplate content such as attributes, actions, related records, etc., without having to be tied to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html).\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\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
|
|
3761
|
+
"description": "The Features component allows users to view a feature's popupTemplate content such as attributes, actions, related records, etc., without having to be tied to the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html).\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\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 ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `clear(): Promise<void>`\n- `close(): Promise<void>` - Closes the component.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `fetchFeatures(screenPoint: __esri.FeaturesFetchFeaturesScreenPoint, options?: __esri.FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>` - Use this method to return feature(s) at a given screen location.\nThese features are fetched from all of the [layer views](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html).\nIn order to use this, a layer must already have an associated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).\nThis method allows a developer to control how the input location is handled.\n- `next(): Promise<__esri.FeaturesViewModel>`\n- `open(options?: __esri.FeaturesOpenOptions): Promise<void>` - Opens Features with content defined either explicitly or driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features.\n- `previous(): Promise<__esri.FeaturesViewModel>`\n- `triggerAction(actionIndex: number): Promise<void>`",
|
|
3543
3762
|
"attributes": [
|
|
3544
3763
|
{
|
|
3545
3764
|
"name": "active",
|
|
@@ -3682,6 +3901,7 @@
|
|
|
3682
3901
|
},
|
|
3683
3902
|
{
|
|
3684
3903
|
"name": "reference-element",
|
|
3904
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3685
3905
|
"values": []
|
|
3686
3906
|
},
|
|
3687
3907
|
{
|
|
@@ -3724,7 +3944,7 @@
|
|
|
3724
3944
|
},
|
|
3725
3945
|
{
|
|
3726
3946
|
"name": "arcgis-floor-filter",
|
|
3727
|
-
"description": "The Floor Filter component simplifies visualization of GIS data for a specific floor of a building in your application.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is
|
|
3947
|
+
"description": "The Floor Filter component simplifies visualization of GIS data for a specific floor of a building in your application.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view 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- `updateWebDocument(webMap: __esri.WebMap): Promise<void>`",
|
|
3728
3948
|
"attributes": [
|
|
3729
3949
|
{
|
|
3730
3950
|
"name": "auto-destroy-disabled",
|
|
@@ -3795,6 +4015,7 @@
|
|
|
3795
4015
|
},
|
|
3796
4016
|
{
|
|
3797
4017
|
"name": "reference-element",
|
|
4018
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3798
4019
|
"values": []
|
|
3799
4020
|
},
|
|
3800
4021
|
{
|
|
@@ -3816,8 +4037,13 @@
|
|
|
3816
4037
|
},
|
|
3817
4038
|
{
|
|
3818
4039
|
"name": "arcgis-fullscreen",
|
|
3819
|
-
"description": "The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is
|
|
4040
|
+
"description": "The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\nUse the escape key (`esc`) to exit fullscreen mode.\n\n**Known limitations**\n\n* The Fullscreen widget only works with browsers that implement the [Fullscreen](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API) API.\n Thus, iOS Safari is not supported.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
|
|
3820
4041
|
"attributes": [
|
|
4042
|
+
{
|
|
4043
|
+
"name": "element",
|
|
4044
|
+
"description": "The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode.",
|
|
4045
|
+
"values": []
|
|
4046
|
+
},
|
|
3821
4047
|
{
|
|
3822
4048
|
"name": "label",
|
|
3823
4049
|
"description": "The component's default label.",
|
|
@@ -3857,6 +4083,7 @@
|
|
|
3857
4083
|
},
|
|
3858
4084
|
{
|
|
3859
4085
|
"name": "reference-element",
|
|
4086
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3860
4087
|
"values": []
|
|
3861
4088
|
},
|
|
3862
4089
|
{
|
|
@@ -3890,7 +4117,7 @@
|
|
|
3890
4117
|
},
|
|
3891
4118
|
{
|
|
3892
4119
|
"name": "arcgis-grid-controls",
|
|
3893
|
-
"description": "The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- Grid Controls is only supported in a 2D Map component.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.\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
|
|
4120
|
+
"description": "The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- Grid Controls is only supported in a 2D Map component.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.\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 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- `trySetDisplayEnabled(enabled: boolean): void` - Call this to turn the grid on/off.",
|
|
3894
4121
|
"attributes": [
|
|
3895
4122
|
{
|
|
3896
4123
|
"name": "auto-destroy-disabled",
|
|
@@ -4036,6 +4263,7 @@
|
|
|
4036
4263
|
},
|
|
4037
4264
|
{
|
|
4038
4265
|
"name": "reference-element",
|
|
4266
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4039
4267
|
"values": []
|
|
4040
4268
|
},
|
|
4041
4269
|
{
|
|
@@ -4126,7 +4354,7 @@
|
|
|
4126
4354
|
},
|
|
4127
4355
|
{
|
|
4128
4356
|
"name": "arcgis-histogram-range-slider",
|
|
4129
|
-
"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
|
|
4357
|
+
"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 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- `generateWhereClause(field: string): Promise<nullish | string>` - Generates a SQL where clause based on a given field and the slider's\nrangeType",
|
|
4130
4358
|
"attributes": [
|
|
4131
4359
|
{
|
|
4132
4360
|
"name": "auto-destroy-disabled",
|
|
@@ -4237,6 +4465,7 @@
|
|
|
4237
4465
|
},
|
|
4238
4466
|
{
|
|
4239
4467
|
"name": "reference-element",
|
|
4468
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4240
4469
|
"values": []
|
|
4241
4470
|
},
|
|
4242
4471
|
{
|
|
@@ -4271,7 +4500,7 @@
|
|
|
4271
4500
|
},
|
|
4272
4501
|
{
|
|
4273
4502
|
"name": "arcgis-home",
|
|
4274
|
-
"description": "The Home component is a button that
|
|
4503
|
+
"description": "The Home component is a button that navigates back to the\ninitial [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nor a previously defined `viewpoint`.\n--\n\n### Events\n- **arcgisGo** - Fires when the go() method is called.\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 ready to be interacted with.\n\n### Methods\n- `cancelGo(): Promise<void>` - This function provides the ability to interrupt and cancel the process\nof navigating back to the initial extent.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `go(): Promise<void>` - Animates the map or scene to its initial Viewpoint or the\nvalue of `viewpoint`.",
|
|
4275
4504
|
"attributes": [
|
|
4276
4505
|
{
|
|
4277
4506
|
"name": "auto-destroy-disabled",
|
|
@@ -4322,6 +4551,7 @@
|
|
|
4322
4551
|
},
|
|
4323
4552
|
{
|
|
4324
4553
|
"name": "reference-element",
|
|
4554
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4325
4555
|
"values": []
|
|
4326
4556
|
},
|
|
4327
4557
|
{
|
|
@@ -4353,7 +4583,7 @@
|
|
|
4353
4583
|
},
|
|
4354
4584
|
{
|
|
4355
4585
|
"name": "arcgis-layer-list",
|
|
4356
|
-
"description": "The Layer List component provides a way to display a list of layers, and switch on/off their visibility.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\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
|
|
4586
|
+
"description": "The Layer List component provides a way to display a list of layers, and switch on/off their visibility.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\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 ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\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- `triggerAction(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.ListItem): Promise<void>`",
|
|
4357
4587
|
"attributes": [
|
|
4358
4588
|
{
|
|
4359
4589
|
"name": "auto-destroy-disabled",
|
|
@@ -4456,6 +4686,7 @@
|
|
|
4456
4686
|
},
|
|
4457
4687
|
{
|
|
4458
4688
|
"name": "reference-element",
|
|
4689
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4459
4690
|
"values": []
|
|
4460
4691
|
},
|
|
4461
4692
|
{
|
|
@@ -4541,7 +4772,7 @@
|
|
|
4541
4772
|
},
|
|
4542
4773
|
{
|
|
4543
4774
|
"name": "arcgis-legend",
|
|
4544
|
-
"description": "The Legend component describes the symbols used to represent layers in a map.\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
|
|
4775
|
+
"description": "The Legend component describes the symbols used to represent layers in a map.\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 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.",
|
|
4545
4776
|
"attributes": [
|
|
4546
4777
|
{
|
|
4547
4778
|
"name": "auto-destroy-disabled",
|
|
@@ -4612,6 +4843,7 @@
|
|
|
4612
4843
|
},
|
|
4613
4844
|
{
|
|
4614
4845
|
"name": "reference-element",
|
|
4846
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4615
4847
|
"values": []
|
|
4616
4848
|
},
|
|
4617
4849
|
{
|
|
@@ -4650,7 +4882,7 @@
|
|
|
4650
4882
|
},
|
|
4651
4883
|
{
|
|
4652
4884
|
"name": "arcgis-line-of-sight",
|
|
4653
|
-
"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
|
|
4885
|
+
"description": "The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including the ground, integrated meshes, and 3D objects such as buildings or trees.\n\n\n\nThe analysis results are displayed as colored lines, where areas visible to the observer are\nshown green and occluded parts are marked in red. Also, the color of the target points indicates their visibility.\nWhen the line of sight cannot be calculated, it will be displayed with a gray color. This may happen if either\nthe target or the observer is not in the view.\n\nWhen creating a new line of sight analysis, the first click in the Scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html)\nand subsequent clicks place the [targets](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html).\nBoth the observer and target points can be moved by dragging. Additionally, the target points can be removed with a right click.\n\n**Known limitation**\n\nLine Of Sight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\n- [Sample - Line of sight component](https://developers.arcgis.com/javascript/latest/sample-code/line-of-sight/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is 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.",
|
|
4654
4886
|
"attributes": [
|
|
4655
4887
|
{
|
|
4656
4888
|
"name": "auto-destroy-disabled",
|
|
@@ -4701,7 +4933,26 @@
|
|
|
4701
4933
|
},
|
|
4702
4934
|
{
|
|
4703
4935
|
"name": "reference-element",
|
|
4936
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4704
4937
|
"values": []
|
|
4938
|
+
},
|
|
4939
|
+
{
|
|
4940
|
+
"name": "state",
|
|
4941
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for analysis\n* `creating` - observer/target points are being placed\n* `created` - finished analysis",
|
|
4942
|
+
"values": [
|
|
4943
|
+
{
|
|
4944
|
+
"name": "created"
|
|
4945
|
+
},
|
|
4946
|
+
{
|
|
4947
|
+
"name": "creating"
|
|
4948
|
+
},
|
|
4949
|
+
{
|
|
4950
|
+
"name": "disabled"
|
|
4951
|
+
},
|
|
4952
|
+
{
|
|
4953
|
+
"name": "ready"
|
|
4954
|
+
}
|
|
4955
|
+
]
|
|
4705
4956
|
}
|
|
4706
4957
|
],
|
|
4707
4958
|
"references": [
|
|
@@ -4717,7 +4968,7 @@
|
|
|
4717
4968
|
},
|
|
4718
4969
|
{
|
|
4719
4970
|
"name": "arcgis-link-chart",
|
|
4720
|
-
"description": "Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html) from an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html).\n\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the link chart has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the link chart.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33
|
|
4971
|
+
"description": "Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html) from an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html).\n\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the link chart has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the link chart.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.",
|
|
4721
4972
|
"attributes": [
|
|
4722
4973
|
{
|
|
4723
4974
|
"name": "auto-destroy-disabled",
|
|
@@ -4821,7 +5072,7 @@
|
|
|
4821
5072
|
},
|
|
4822
5073
|
{
|
|
4823
5074
|
"name": "arcgis-link-chart-layout-switcher",
|
|
4824
|
-
"description": "A component for use in link charts that allows users to switch between different layouts. See [documentation on layouts](https://enterprise.arcgis.com/en/knowledge/latest/knowledge-studio/change-the-layout-applied-to-a-link-chart.htm) for more details.\n\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\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
|
|
5075
|
+
"description": "A component for use in link charts that allows users to switch between different layouts. See [documentation on layouts](https://enterprise.arcgis.com/en/knowledge/latest/knowledge-studio/change-the-layout-applied-to-a-link-chart.htm) for more details.\n\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\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 ready to be interacted with.\n- **arcgisSwitchLayout** - Fires when component has completed the layout switch\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- `switchLayout(newLayout: \"basic-grid\" | \"chronological-mono-timeline\" | \"chronological-multi-timeline\" | \"geographic-organic-standard\" | \"hierarchical-bottom-to-top\" | \"organic-community\" | \"organic-standard\" | \"radial-root-centric\" | \"tree-left-to-right\"): Promise<void>` - Switches the layout of the link chart to the value provided.",
|
|
4825
5076
|
"attributes": [
|
|
4826
5077
|
{
|
|
4827
5078
|
"name": "appearance",
|
|
@@ -4894,6 +5145,7 @@
|
|
|
4894
5145
|
},
|
|
4895
5146
|
{
|
|
4896
5147
|
"name": "reference-element",
|
|
5148
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)",
|
|
4897
5149
|
"values": []
|
|
4898
5150
|
},
|
|
4899
5151
|
{
|
|
@@ -4925,7 +5177,7 @@
|
|
|
4925
5177
|
},
|
|
4926
5178
|
{
|
|
4927
5179
|
"name": "arcgis-locate",
|
|
4928
|
-
"description": "The Locate component animates the Map or Scene to the user's current location.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is
|
|
5180
|
+
"description": "The Locate component animates the Map or Scene to the user's current location.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that support\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility).\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`",
|
|
4929
5181
|
"attributes": [
|
|
4930
5182
|
{
|
|
4931
5183
|
"name": "auto-destroy-disabled",
|
|
@@ -4984,6 +5236,7 @@
|
|
|
4984
5236
|
},
|
|
4985
5237
|
{
|
|
4986
5238
|
"name": "reference-element",
|
|
5239
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4987
5240
|
"values": []
|
|
4988
5241
|
},
|
|
4989
5242
|
{
|
|
@@ -5026,7 +5279,7 @@
|
|
|
5026
5279
|
},
|
|
5027
5280
|
{
|
|
5028
5281
|
"name": "arcgis-map",
|
|
5029
|
-
"description": "The ArcGIS Map
|
|
5282
|
+
"description": "The ArcGIS Map component is used to add 2D maps to web applications. For 3D maps, use the\n[ArcGIS Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and loads a WebMap from either [ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\"></arcgis-map>\n```\n\nAlternatively, the Map component can be initialized without a WebMap item.\n\n```html\n<arcgis-map basemap=\"satellite\" center=\"-154.88, 19.46\" zoom=\"15\"></arcgis-map>\n```\n\nOther components can be added and connected to the Map component.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\">\n <arcgis-zoom position=\"top-left\"></arcgis-zoom>\n <arcgis-legend position=\"bottom-left\"></arcgis-legend>\n</arcgis-map>\n```\n\nThe Map component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/) of the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My Layer\" });\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Map component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-map)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the map tables collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the map tables collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `hitTest(screenPoint: __esri.MapViewScreenPoint | MouseEvent, options?: __esri.MapViewHitTestOptions): Promise<__esri.HitTestResult>` - Returns hit test results from each layer that intersects the specified screen coordinates.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `takeScreenshot(options?: __esri.MapViewTakeScreenshotOptions): Promise<__esri.Screenshot>` - Create a screenshot of the current view.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.",
|
|
5030
5283
|
"attributes": [
|
|
5031
5284
|
{
|
|
5032
5285
|
"name": "auto-destroy-disabled",
|
|
@@ -5135,7 +5388,7 @@
|
|
|
5135
5388
|
},
|
|
5136
5389
|
{
|
|
5137
5390
|
"name": "arcgis-measurement",
|
|
5138
|
-
"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
|
|
5391
|
+
"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 ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `startMeasurement(): Promise<void>`",
|
|
5139
5392
|
"attributes": [
|
|
5140
5393
|
{
|
|
5141
5394
|
"name": "active-tool",
|
|
@@ -5300,6 +5553,7 @@
|
|
|
5300
5553
|
},
|
|
5301
5554
|
{
|
|
5302
5555
|
"name": "reference-element",
|
|
5556
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
5303
5557
|
"values": []
|
|
5304
5558
|
},
|
|
5305
5559
|
{
|
|
@@ -5330,7 +5584,7 @@
|
|
|
5330
5584
|
},
|
|
5331
5585
|
{
|
|
5332
5586
|
"name": "arcgis-navigation-toggle",
|
|
5333
|
-
"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\
|
|
5587
|
+
"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 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>`",
|
|
5334
5588
|
"attributes": [
|
|
5335
5589
|
{
|
|
5336
5590
|
"name": "icon",
|
|
@@ -5356,7 +5610,7 @@
|
|
|
5356
5610
|
},
|
|
5357
5611
|
{
|
|
5358
5612
|
"name": "navigation-mode",
|
|
5359
|
-
"description": "The navigation mode of the view.
|
|
5613
|
+
"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.",
|
|
5360
5614
|
"values": [
|
|
5361
5615
|
{
|
|
5362
5616
|
"name": "pan"
|
|
@@ -5400,6 +5654,7 @@
|
|
|
5400
5654
|
},
|
|
5401
5655
|
{
|
|
5402
5656
|
"name": "reference-element",
|
|
5657
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
5403
5658
|
"values": []
|
|
5404
5659
|
},
|
|
5405
5660
|
{
|
|
@@ -5428,7 +5683,7 @@
|
|
|
5428
5683
|
},
|
|
5429
5684
|
{
|
|
5430
5685
|
"name": "arcgis-oriented-imagery-viewer",
|
|
5431
|
-
"description": "The Oriented Imagery Viewer component allows the user to explore and use their oriented images.\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
|
|
5686
|
+
"description": "The Oriented Imagery Viewer component allows the user to explore and use their oriented images.\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 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.",
|
|
5432
5687
|
"attributes": [
|
|
5433
5688
|
{
|
|
5434
5689
|
"name": "auto-destroy-disabled",
|
|
@@ -5533,6 +5788,7 @@
|
|
|
5533
5788
|
},
|
|
5534
5789
|
{
|
|
5535
5790
|
"name": "reference-element",
|
|
5791
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
5536
5792
|
"values": []
|
|
5537
5793
|
}
|
|
5538
5794
|
],
|
|
@@ -5549,7 +5805,7 @@
|
|
|
5549
5805
|
},
|
|
5550
5806
|
{
|
|
5551
5807
|
"name": "arcgis-placement",
|
|
5552
|
-
"description": "The placement component is used to position content relative to the map. This component may be **temporary** until we offer a more robust solution.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is
|
|
5808
|
+
"description": "The placement component is used to position content relative to the map. This component may be **temporary** until we offer a more robust solution.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
|
|
5553
5809
|
"attributes": [
|
|
5554
5810
|
{
|
|
5555
5811
|
"name": "position",
|
|
@@ -5585,6 +5841,7 @@
|
|
|
5585
5841
|
},
|
|
5586
5842
|
{
|
|
5587
5843
|
"name": "reference-element",
|
|
5844
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
5588
5845
|
"values": []
|
|
5589
5846
|
}
|
|
5590
5847
|
],
|
|
@@ -5601,7 +5858,7 @@
|
|
|
5601
5858
|
},
|
|
5602
5859
|
{
|
|
5603
5860
|
"name": "arcgis-print",
|
|
5604
|
-
"description": "The Print
|
|
5861
|
+
"description": "The Print component connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed.\nIt takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS,\nwhich can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc.\nThe Print component works with the [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) module, which generates a printer-ready version of the map.\n\nThe Print component uses the ArcGIS Online print service by default, but it can be configured to use a custom print service with the [printServiceUrl](#printServiceUrl) property.\nThe component can preserve map scale or map extent in the printout. By default, the map extent is preserved. Use\n[TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) to preserve scale instead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layout)\nexcept `map-only`. If using a custom print service, then `customTextElements` are supported for each print\ntemplate. Values found there will be populated in the Print component under `Advanced options`. These values can\nbe overwritten in the Print component UI, or programmatically using the\n[templateCustomTextElements](#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions).\n\n**Known limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) for a detailed list of known limitations.\n\n```html\n<arcgis-map item-id=\"45725ba7d9fb47a0925398919b13d1fa\">\n <arcgis-print position=\"top-right\"></arcgis-print>\n</arcgis-map>\n```\n\n```js\n// get a reference to the component\nconst components = document.querySelectorAll(\"arcgis-print\");\n\nconst portal = new Portal({\n url: \"https://user.maps.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://user.maps.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```\n--\n\n### Events\n- **arcgisComplete** - Emitted when the component is complete.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisSubmit** - Emitted when the component is submitted.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
5605
5862
|
"attributes": [
|
|
5606
5863
|
{
|
|
5607
5864
|
"name": "allowed-formats",
|
|
@@ -5610,6 +5867,7 @@
|
|
|
5610
5867
|
},
|
|
5611
5868
|
{
|
|
5612
5869
|
"name": "allowed-formats-for-saving",
|
|
5870
|
+
"description": "Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.",
|
|
5613
5871
|
"values": [
|
|
5614
5872
|
{
|
|
5615
5873
|
"name": "all"
|
|
@@ -5643,7 +5901,7 @@
|
|
|
5643
5901
|
},
|
|
5644
5902
|
{
|
|
5645
5903
|
"name": "heading-level",
|
|
5646
|
-
"description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the
|
|
5904
|
+
"description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
|
|
5647
5905
|
"values": [
|
|
5648
5906
|
{
|
|
5649
5907
|
"name": "1"
|
|
@@ -5667,6 +5925,7 @@
|
|
|
5667
5925
|
},
|
|
5668
5926
|
{
|
|
5669
5927
|
"name": "hide-header",
|
|
5928
|
+
"description": "Indicates whether the component's header is hidden.",
|
|
5670
5929
|
"values": []
|
|
5671
5930
|
},
|
|
5672
5931
|
{
|
|
@@ -5681,6 +5940,7 @@
|
|
|
5681
5940
|
},
|
|
5682
5941
|
{
|
|
5683
5942
|
"name": "position",
|
|
5943
|
+
"description": "The UI position of a component.",
|
|
5684
5944
|
"values": [
|
|
5685
5945
|
{
|
|
5686
5946
|
"name": "bottom-leading"
|
|
@@ -5713,21 +5973,22 @@
|
|
|
5713
5973
|
},
|
|
5714
5974
|
{
|
|
5715
5975
|
"name": "print-service-url",
|
|
5716
|
-
"description": "The URL of the REST endpoint of the Export Web Map Task.\nIf the [portal](#portal) property is set,
|
|
5976
|
+
"description": "The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](#portal) property is set, this property will use the portal's print service URL.",
|
|
5717
5977
|
"values": []
|
|
5718
5978
|
},
|
|
5719
5979
|
{
|
|
5720
5980
|
"name": "reference-element",
|
|
5981
|
+
"description": "By passing the `id` of the Map or Scene component into this property, you can position components from the `@arcgis/map-components`\npackage anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component).",
|
|
5721
5982
|
"values": []
|
|
5722
5983
|
},
|
|
5723
5984
|
{
|
|
5724
5985
|
"name": "show-print-area-enabled",
|
|
5725
|
-
"description": "The initial state of the print area toggle in the Print
|
|
5986
|
+
"description": "The initial state of the print area toggle in the Print component UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.",
|
|
5726
5987
|
"values": []
|
|
5727
5988
|
},
|
|
5728
5989
|
{
|
|
5729
5990
|
"name": "state",
|
|
5730
|
-
"description": "The
|
|
5991
|
+
"description": "The state of the Print component.",
|
|
5731
5992
|
"values": [
|
|
5732
5993
|
{
|
|
5733
5994
|
"name": "disabled"
|
|
@@ -5757,7 +6018,7 @@
|
|
|
5757
6018
|
},
|
|
5758
6019
|
{
|
|
5759
6020
|
"name": "arcgis-scale-bar",
|
|
5760
|
-
"description": "The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known
|
|
6021
|
+
"description": "The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is 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.",
|
|
5761
6022
|
"attributes": [
|
|
5762
6023
|
{
|
|
5763
6024
|
"name": "auto-destroy-disabled",
|
|
@@ -5820,6 +6081,7 @@
|
|
|
5820
6081
|
},
|
|
5821
6082
|
{
|
|
5822
6083
|
"name": "reference-element",
|
|
6084
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
5823
6085
|
"values": []
|
|
5824
6086
|
},
|
|
5825
6087
|
{
|
|
@@ -5851,7 +6113,7 @@
|
|
|
5851
6113
|
},
|
|
5852
6114
|
{
|
|
5853
6115
|
"name": "arcgis-scale-range-slider",
|
|
5854
|
-
"description": "The Scale Range Slider component allows the user to set a minimum and maximum scale based on named scale ranges.\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
|
|
6116
|
+
"description": "The Scale Range Slider component allows the user to set a minimum and maximum scale based on named scale ranges.\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 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.",
|
|
5855
6117
|
"attributes": [
|
|
5856
6118
|
{
|
|
5857
6119
|
"name": "auto-destroy-disabled",
|
|
@@ -5954,6 +6216,7 @@
|
|
|
5954
6216
|
},
|
|
5955
6217
|
{
|
|
5956
6218
|
"name": "reference-element",
|
|
6219
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
5957
6220
|
"values": []
|
|
5958
6221
|
},
|
|
5959
6222
|
{
|
|
@@ -5982,7 +6245,7 @@
|
|
|
5982
6245
|
},
|
|
5983
6246
|
{
|
|
5984
6247
|
"name": "arcgis-scene",
|
|
5985
|
-
"description": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes:\n[zoom](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#zoom),\n[scale](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#scale),\n[center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center),\n[rotation](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#rotation),\n[extent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#camera),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewpoint).\nThis event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#stationary)\ntoggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n```\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup).\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its\n[map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map),\n[popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.\n- `whenAnalysisView(analysis: __esri.AreaMeasurementAnalysis | __esri.DimensionAnalysis | __esri.DirectLineMeasurementAnalysis | __esri.LineOfSightAnalysis | __esri.SliceAnalysis | __esri.ViewshedAnalysis): Promise<__esri.AreaMeasurementAnalysisView3D | __esri.DimensionAnalysisView3D | __esri.DirectLineMeasurementAnalysisView3D | __esri.LineOfSightAnalysisView3D | __esri.SliceAnalysisView3D | __esri.ViewshedAnalysisView3D>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)",
|
|
6248
|
+
"description": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nconst layer = new GraphicsLayer({ title: \"My layer\"});\nviewElement.map.add(layer);\n```\n\n**See also**\n\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create)\n- **arcgisViewAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes: [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[camera](#camera), [viewpoint](#viewpoint). This event will also emit if [stationary](#stationary) toggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](#popup).\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its [map](#map), [popup](#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView(analysis: __esri.AnalysisUnion): Promise<__esri.AnalysisViewUnion>` - 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)",
|
|
5986
6249
|
"attributes": [
|
|
5987
6250
|
{
|
|
5988
6251
|
"name": "alpha-compositing-enabled",
|
|
@@ -6001,27 +6264,27 @@
|
|
|
6001
6264
|
},
|
|
6002
6265
|
{
|
|
6003
6266
|
"name": "camera-fov",
|
|
6004
|
-
"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()](
|
|
6267
|
+
"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)",
|
|
6005
6268
|
"values": []
|
|
6006
6269
|
},
|
|
6007
6270
|
{
|
|
6008
6271
|
"name": "camera-heading",
|
|
6009
|
-
"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()](
|
|
6272
|
+
"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)",
|
|
6010
6273
|
"values": []
|
|
6011
6274
|
},
|
|
6012
6275
|
{
|
|
6013
6276
|
"name": "camera-position",
|
|
6014
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
6277
|
+
"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)",
|
|
6015
6278
|
"values": []
|
|
6016
6279
|
},
|
|
6017
6280
|
{
|
|
6018
6281
|
"name": "camera-tilt",
|
|
6019
|
-
"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()](
|
|
6282
|
+
"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)",
|
|
6020
6283
|
"values": []
|
|
6021
6284
|
},
|
|
6022
6285
|
{
|
|
6023
6286
|
"name": "center",
|
|
6024
|
-
"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()](
|
|
6287
|
+
"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)",
|
|
6025
6288
|
"values": []
|
|
6026
6289
|
},
|
|
6027
6290
|
{
|
|
@@ -6031,7 +6294,7 @@
|
|
|
6031
6294
|
},
|
|
6032
6295
|
{
|
|
6033
6296
|
"name": "ground",
|
|
6034
|
-
"description": "Specifies the surface properties for the map. It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
|
|
6297
|
+
"description": "Specifies the surface properties for the [map](#map). It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
|
|
6035
6298
|
"values": []
|
|
6036
6299
|
},
|
|
6037
6300
|
{
|
|
@@ -6046,7 +6309,7 @@
|
|
|
6046
6309
|
},
|
|
6047
6310
|
{
|
|
6048
6311
|
"name": "quality-profile",
|
|
6049
|
-
"description": "
|
|
6312
|
+
"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)",
|
|
6050
6313
|
"values": [
|
|
6051
6314
|
{
|
|
6052
6315
|
"name": "high"
|
|
@@ -6061,7 +6324,7 @@
|
|
|
6061
6324
|
},
|
|
6062
6325
|
{
|
|
6063
6326
|
"name": "scale",
|
|
6064
|
-
"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()](
|
|
6327
|
+
"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)",
|
|
6065
6328
|
"values": []
|
|
6066
6329
|
},
|
|
6067
6330
|
{
|
|
@@ -6083,7 +6346,7 @@
|
|
|
6083
6346
|
},
|
|
6084
6347
|
{
|
|
6085
6348
|
"name": "zoom",
|
|
6086
|
-
"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()](
|
|
6349
|
+
"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)",
|
|
6087
6350
|
"values": []
|
|
6088
6351
|
}
|
|
6089
6352
|
],
|
|
@@ -6100,7 +6363,7 @@
|
|
|
6100
6363
|
},
|
|
6101
6364
|
{
|
|
6102
6365
|
"name": "arcgis-search",
|
|
6103
|
-
"description": "The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,\nBuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the\nfindAddressCandidates operation is used, whereas queries are used on feature layers.\n\nBy default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.\nIf a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey\nis present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property.\n\nThe Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data\nsources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property\nof the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.\nHowever, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a\nspecified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.\nThis behavior can be changed by using the localSearchDisabled property.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is
|
|
6366
|
+
"description": "The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,\nBuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the\nfindAddressCandidates operation is used, whereas queries are used on feature layers.\n\nBy default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.\nIf a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey\nis present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property.\n\nThe Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data\nsources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property\nof the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.\nHowever, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a\nspecified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.\nThis behavior can be changed by using the localSearchDisabled property.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisSearchClear** - Fires when a result is cleared from the input box or a new result is selected.\n- **arcgisSearchComplete** - Fires when the [search()](#search) method is called and returns its results.\n- **arcgisSearchStart** - Fires when the [search()](#search) method starts.\n- **arcgisSelectResult** - Fires when a search result is selected.\n- **arcgisSuggestComplete** - Fires when the [suggest](#suggest) method is called and returns its results.\n- **arcgisSuggestStart** - Fires when the [suggest()](#suggest) method starts.\n\n### Methods\n- `clear(): void` - Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.\nIt also hides any open menus.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `search(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | nil | number[] | string): Promise<__esri.SearchResponse | nil>` - Depending on the sources specified, search() queries the feature layer(s) and/or performs\naddress matching using any specified [locator(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) and\nreturns any applicable results.\n- `setFocus(): Promise<void>` - Brings focus to the component's text input.\n- `suggest(query?: string): Promise<__esri.SuggestResponse | nil>` - Performs a suggest() request on the active Locator. It also uses the current value of\nthe component or one that is passed in.\n\nSuggestions are available if working with a 10.3 or greater geocoding service that has\n[suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e.\n`supportsPagination = true`.",
|
|
6104
6367
|
"attributes": [
|
|
6105
6368
|
{
|
|
6106
6369
|
"name": "active-menu",
|
|
@@ -6133,7 +6396,12 @@
|
|
|
6133
6396
|
"values": []
|
|
6134
6397
|
},
|
|
6135
6398
|
{
|
|
6136
|
-
"name": "auto-
|
|
6399
|
+
"name": "auto-navigate-disabled",
|
|
6400
|
+
"description": "Indicates whether to automatically navigate to the selected result.",
|
|
6401
|
+
"values": []
|
|
6402
|
+
},
|
|
6403
|
+
{
|
|
6404
|
+
"name": "auto-select-disabled",
|
|
6137
6405
|
"description": "Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
|
|
6138
6406
|
"values": []
|
|
6139
6407
|
},
|
|
@@ -6148,7 +6416,7 @@
|
|
|
6148
6416
|
"values": []
|
|
6149
6417
|
},
|
|
6150
6418
|
{
|
|
6151
|
-
"name": "include-default-sources",
|
|
6419
|
+
"name": "include-default-sources-disabled",
|
|
6152
6420
|
"description": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).",
|
|
6153
6421
|
"values": []
|
|
6154
6422
|
},
|
|
@@ -6158,8 +6426,8 @@
|
|
|
6158
6426
|
"values": []
|
|
6159
6427
|
},
|
|
6160
6428
|
{
|
|
6161
|
-
"name": "location-
|
|
6162
|
-
"description": "Enables location services within the component.\n\n\n\n
|
|
6429
|
+
"name": "location-disabled",
|
|
6430
|
+
"description": "Enables location services within the component.\n\n\n\n**Note:**\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that supports\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).",
|
|
6163
6431
|
"values": []
|
|
6164
6432
|
},
|
|
6165
6433
|
{
|
|
@@ -6178,7 +6446,7 @@
|
|
|
6178
6446
|
"values": []
|
|
6179
6447
|
},
|
|
6180
6448
|
{
|
|
6181
|
-
"name": "popup-
|
|
6449
|
+
"name": "popup-disabled",
|
|
6182
6450
|
"description": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can\nbe clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).",
|
|
6183
6451
|
"values": []
|
|
6184
6452
|
},
|
|
@@ -6216,15 +6484,16 @@
|
|
|
6216
6484
|
},
|
|
6217
6485
|
{
|
|
6218
6486
|
"name": "reference-element",
|
|
6487
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
6219
6488
|
"values": []
|
|
6220
6489
|
},
|
|
6221
6490
|
{
|
|
6222
|
-
"name": "result-graphic-
|
|
6491
|
+
"name": "result-graphic-disabled",
|
|
6223
6492
|
"description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
|
|
6224
6493
|
"values": []
|
|
6225
6494
|
},
|
|
6226
6495
|
{
|
|
6227
|
-
"name": "search-all-
|
|
6496
|
+
"name": "search-all-disabled",
|
|
6228
6497
|
"description": "Indicates whether to display the option to search all sources. When `true`, the \"All\" option\nis displayed by default:\n\n\n\nWhen `false`, no option to search all sources at once is available:\n\n",
|
|
6229
6498
|
"values": []
|
|
6230
6499
|
},
|
|
@@ -6235,7 +6504,7 @@
|
|
|
6235
6504
|
},
|
|
6236
6505
|
{
|
|
6237
6506
|
"name": "state",
|
|
6238
|
-
"description": "The current state
|
|
6507
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
6239
6508
|
"values": [
|
|
6240
6509
|
{
|
|
6241
6510
|
"name": "disabled"
|
|
@@ -6252,7 +6521,7 @@
|
|
|
6252
6521
|
]
|
|
6253
6522
|
},
|
|
6254
6523
|
{
|
|
6255
|
-
"name": "suggestions-
|
|
6524
|
+
"name": "suggestions-disabled",
|
|
6256
6525
|
"description": "Enable suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
|
|
6257
6526
|
"values": []
|
|
6258
6527
|
}
|
|
@@ -6270,7 +6539,7 @@
|
|
|
6270
6539
|
},
|
|
6271
6540
|
{
|
|
6272
6541
|
"name": "arcgis-search-result-renderer",
|
|
6273
|
-
"description": "The Search Result Renderer renders the Search component results and allows expanding a DOM element to show alternative matches.\nThese alternative matches appear in the Show more results link.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is
|
|
6542
|
+
"description": "The Search Result Renderer renders the Search component results and allows expanding a DOM element to show alternative matches.\nThese alternative matches appear in the Show more results link.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view 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.",
|
|
6274
6543
|
"attributes": [
|
|
6275
6544
|
{
|
|
6276
6545
|
"name": "auto-destroy-disabled",
|
|
@@ -6287,7 +6556,7 @@
|
|
|
6287
6556
|
},
|
|
6288
6557
|
{
|
|
6289
6558
|
"name": "arcgis-shadow-cast",
|
|
6290
|
-
"description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [
|
|
6559
|
+
"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.\nThis influences the results when the start time of the range is before sunrise or when the end time is after the sunset.\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 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.",
|
|
6291
6560
|
"attributes": [
|
|
6292
6561
|
{
|
|
6293
6562
|
"name": "auto-destroy-disabled",
|
|
@@ -6296,11 +6565,12 @@
|
|
|
6296
6565
|
},
|
|
6297
6566
|
{
|
|
6298
6567
|
"name": "date",
|
|
6568
|
+
"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)",
|
|
6299
6569
|
"values": []
|
|
6300
6570
|
},
|
|
6301
6571
|
{
|
|
6302
6572
|
"name": "end-time-of-day",
|
|
6303
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
6573
|
+
"description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)",
|
|
6304
6574
|
"values": []
|
|
6305
6575
|
},
|
|
6306
6576
|
{
|
|
@@ -6350,12 +6620,12 @@
|
|
|
6350
6620
|
},
|
|
6351
6621
|
{
|
|
6352
6622
|
"name": "icon",
|
|
6353
|
-
"description": "Icon which represents the
|
|
6623
|
+
"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/)",
|
|
6354
6624
|
"values": []
|
|
6355
6625
|
},
|
|
6356
6626
|
{
|
|
6357
6627
|
"name": "label",
|
|
6358
|
-
"description": "The
|
|
6628
|
+
"description": "The component's default label.",
|
|
6359
6629
|
"values": []
|
|
6360
6630
|
},
|
|
6361
6631
|
{
|
|
@@ -6392,16 +6662,17 @@
|
|
|
6392
6662
|
},
|
|
6393
6663
|
{
|
|
6394
6664
|
"name": "reference-element",
|
|
6665
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
6395
6666
|
"values": []
|
|
6396
6667
|
},
|
|
6397
6668
|
{
|
|
6398
6669
|
"name": "start-time-of-day",
|
|
6399
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
6670
|
+
"description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)",
|
|
6400
6671
|
"values": []
|
|
6401
6672
|
},
|
|
6402
6673
|
{
|
|
6403
6674
|
"name": "state",
|
|
6404
|
-
"description": "The
|
|
6675
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
6405
6676
|
"values": [
|
|
6406
6677
|
{
|
|
6407
6678
|
"name": "disabled"
|
|
@@ -6413,12 +6684,12 @@
|
|
|
6413
6684
|
},
|
|
6414
6685
|
{
|
|
6415
6686
|
"name": "utc-offset",
|
|
6416
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
6687
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
6417
6688
|
"values": []
|
|
6418
6689
|
},
|
|
6419
6690
|
{
|
|
6420
6691
|
"name": "visualization-type",
|
|
6421
|
-
"description": "Type of visualization to use when showing the shadows
|
|
6692
|
+
"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",
|
|
6422
6693
|
"values": [
|
|
6423
6694
|
{
|
|
6424
6695
|
"name": "discrete"
|
|
@@ -6445,7 +6716,7 @@
|
|
|
6445
6716
|
},
|
|
6446
6717
|
{
|
|
6447
6718
|
"name": "arcgis-sketch",
|
|
6448
|
-
"description": "The Sketch component provides a simple UI for creating and updating graphics on a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).\n--\n\n### Events\n- **arcgisCreate**\n- **arcgisDelete**\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
|
|
6719
|
+
"description": "The Sketch component provides a simple UI for creating and updating graphics on a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).\n--\n\n### Events\n- **arcgisCreate**\n- **arcgisDelete**\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 ready to be interacted with.\n- **arcgisRedo**\n- **arcgisUndo**\n- **arcgisUpdate**\n\n### Methods\n- `cancel(): Promise<void>`\n- `complete(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `create(tool: \"circle\" | \"point\" | \"polygon\" | \"polyline\" | \"rectangle\", createOptions?: __esri.SketchViewModelCreateCreateOptions): Promise<void>`\n- `delete(): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `duplicate(): Promise<void>`\n- `redo(): Promise<void>`\n- `triggerUpdate(graphic: __esri.Graphic | __esri.Graphic[], updateOptions?: __esri.SketchViewModelUpdateUpdateOptions): Promise<void>`\n- `undo(): Promise<void>`",
|
|
6449
6720
|
"attributes": [
|
|
6450
6721
|
{
|
|
6451
6722
|
"name": "active-tool",
|
|
@@ -6655,6 +6926,7 @@
|
|
|
6655
6926
|
},
|
|
6656
6927
|
{
|
|
6657
6928
|
"name": "reference-element",
|
|
6929
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
6658
6930
|
"values": []
|
|
6659
6931
|
},
|
|
6660
6932
|
{
|
|
@@ -6717,7 +6989,7 @@
|
|
|
6717
6989
|
},
|
|
6718
6990
|
{
|
|
6719
6991
|
"name": "arcgis-slice",
|
|
6720
|
-
"description": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a
|
|
6992
|
+
"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 placing 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 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.\nCalling this method changes the [state](#state) to `ready`.\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 placement of a new slice, clearing the previous [shape](#shape).\nCalling this method changes the [state](#state) to `slicing`.",
|
|
6721
6993
|
"attributes": [
|
|
6722
6994
|
{
|
|
6723
6995
|
"name": "auto-destroy-disabled",
|
|
@@ -6731,6 +7003,7 @@
|
|
|
6731
7003
|
},
|
|
6732
7004
|
{
|
|
6733
7005
|
"name": "heading-level",
|
|
7006
|
+
"description": "Indicates the heading level to use for the \"Excluded layers\" heading.",
|
|
6734
7007
|
"values": [
|
|
6735
7008
|
{
|
|
6736
7009
|
"name": "1"
|
|
@@ -6796,11 +7069,12 @@
|
|
|
6796
7069
|
},
|
|
6797
7070
|
{
|
|
6798
7071
|
"name": "reference-element",
|
|
7072
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
6799
7073
|
"values": []
|
|
6800
7074
|
},
|
|
6801
7075
|
{
|
|
6802
7076
|
"name": "state",
|
|
6803
|
-
"description": "The component's state. The values mean the following:\n\n* `disabled` -
|
|
7077
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `excludingLayer` - currently excluding a layer from the slice\n* `ready` - ready for slicing\n* `slicing` - currently slicing\n* `sliced` - finished slicing and a valid shape is available",
|
|
6804
7078
|
"values": [
|
|
6805
7079
|
{
|
|
6806
7080
|
"name": "disabled"
|
|
@@ -6836,173 +7110,9 @@
|
|
|
6836
7110
|
}
|
|
6837
7111
|
]
|
|
6838
7112
|
},
|
|
6839
|
-
{
|
|
6840
|
-
"name": "arcgis-slider",
|
|
6841
|
-
"description": "### Events\n- **arcgisMaxChange**\n- **arcgisMaxClick**\n- **arcgisMinChange**\n- **arcgisMinClick**\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- **arcgisSegmentClick**\n- **arcgisSegmentDrag**\n- **arcgisThumbChange**\n- **arcgisThumbClick**\n- **arcgisThumbDrag**\n- **arcgisTickClick**\n- **arcgisTrackClick**\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.",
|
|
6842
|
-
"attributes": [
|
|
6843
|
-
{
|
|
6844
|
-
"name": "auto-destroy-disabled",
|
|
6845
|
-
"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-slider/#destroy) method when you are done to\nprevent memory leaks.",
|
|
6846
|
-
"values": []
|
|
6847
|
-
},
|
|
6848
|
-
{
|
|
6849
|
-
"name": "draggable-segments-enabled",
|
|
6850
|
-
"description": "Indicates if the user can drag the segment between thumbs\nto update thumb positions.",
|
|
6851
|
-
"values": []
|
|
6852
|
-
},
|
|
6853
|
-
{
|
|
6854
|
-
"name": "effective-max",
|
|
6855
|
-
"description": "When set, the user is restricted from moving slider thumbs to positions higher than\nthis value.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMax)",
|
|
6856
|
-
"values": []
|
|
6857
|
-
},
|
|
6858
|
-
{
|
|
6859
|
-
"name": "effective-min",
|
|
6860
|
-
"description": "When set, the user is restricted from moving slider thumbs to positions less than\nthis value.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#effectiveMin)",
|
|
6861
|
-
"values": []
|
|
6862
|
-
},
|
|
6863
|
-
{
|
|
6864
|
-
"name": "icon",
|
|
6865
|
-
"description": "Icon displayed in the widget's button.",
|
|
6866
|
-
"values": []
|
|
6867
|
-
},
|
|
6868
|
-
{
|
|
6869
|
-
"name": "label",
|
|
6870
|
-
"description": "The widget's default label.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#label)",
|
|
6871
|
-
"values": []
|
|
6872
|
-
},
|
|
6873
|
-
{
|
|
6874
|
-
"name": "label-inputs-enabled",
|
|
6875
|
-
"description": "Indicates whether to enable editing input values via keyboard input\nwhen the user clicks a label.",
|
|
6876
|
-
"values": []
|
|
6877
|
-
},
|
|
6878
|
-
{
|
|
6879
|
-
"name": "layout",
|
|
6880
|
-
"description": "Determines the layout/orientation of the Slider widget.",
|
|
6881
|
-
"values": [
|
|
6882
|
-
{
|
|
6883
|
-
"name": "horizontal"
|
|
6884
|
-
},
|
|
6885
|
-
{
|
|
6886
|
-
"name": "horizontal-reversed"
|
|
6887
|
-
},
|
|
6888
|
-
{
|
|
6889
|
-
"name": "vertical"
|
|
6890
|
-
},
|
|
6891
|
-
{
|
|
6892
|
-
"name": "vertical-reversed"
|
|
6893
|
-
}
|
|
6894
|
-
]
|
|
6895
|
-
},
|
|
6896
|
-
{
|
|
6897
|
-
"name": "max",
|
|
6898
|
-
"description": "The maximum possible data/thumb value of the slider.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max)",
|
|
6899
|
-
"values": []
|
|
6900
|
-
},
|
|
6901
|
-
{
|
|
6902
|
-
"name": "min",
|
|
6903
|
-
"description": "The minimum possible data/thumb value of the slider.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min)",
|
|
6904
|
-
"values": []
|
|
6905
|
-
},
|
|
6906
|
-
{
|
|
6907
|
-
"name": "position",
|
|
6908
|
-
"values": [
|
|
6909
|
-
{
|
|
6910
|
-
"name": "bottom-leading"
|
|
6911
|
-
},
|
|
6912
|
-
{
|
|
6913
|
-
"name": "bottom-left"
|
|
6914
|
-
},
|
|
6915
|
-
{
|
|
6916
|
-
"name": "bottom-right"
|
|
6917
|
-
},
|
|
6918
|
-
{
|
|
6919
|
-
"name": "bottom-trailing"
|
|
6920
|
-
},
|
|
6921
|
-
{
|
|
6922
|
-
"name": "manual"
|
|
6923
|
-
},
|
|
6924
|
-
{
|
|
6925
|
-
"name": "top-leading"
|
|
6926
|
-
},
|
|
6927
|
-
{
|
|
6928
|
-
"name": "top-left"
|
|
6929
|
-
},
|
|
6930
|
-
{
|
|
6931
|
-
"name": "top-right"
|
|
6932
|
-
},
|
|
6933
|
-
{
|
|
6934
|
-
"name": "top-trailing"
|
|
6935
|
-
}
|
|
6936
|
-
]
|
|
6937
|
-
},
|
|
6938
|
-
{
|
|
6939
|
-
"name": "precision",
|
|
6940
|
-
"description": "Defines how slider thumb values should be rounded.",
|
|
6941
|
-
"values": []
|
|
6942
|
-
},
|
|
6943
|
-
{
|
|
6944
|
-
"name": "range-label-inputs-enabled",
|
|
6945
|
-
"description": "Indicates whether to enable editing range values via keyboard input\nwhen the user clicks a [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#min) or [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#max) label.",
|
|
6946
|
-
"values": []
|
|
6947
|
-
},
|
|
6948
|
-
{
|
|
6949
|
-
"name": "reference-element",
|
|
6950
|
-
"values": []
|
|
6951
|
-
},
|
|
6952
|
-
{
|
|
6953
|
-
"name": "snap-on-click-enabled",
|
|
6954
|
-
"description": "Indicates if the closest thumb will snap to the clicked location on the track.",
|
|
6955
|
-
"values": []
|
|
6956
|
-
},
|
|
6957
|
-
{
|
|
6958
|
-
"name": "state",
|
|
6959
|
-
"description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#state)",
|
|
6960
|
-
"values": [
|
|
6961
|
-
{
|
|
6962
|
-
"name": "disabled"
|
|
6963
|
-
},
|
|
6964
|
-
{
|
|
6965
|
-
"name": "dragging"
|
|
6966
|
-
},
|
|
6967
|
-
{
|
|
6968
|
-
"name": "editing"
|
|
6969
|
-
},
|
|
6970
|
-
{
|
|
6971
|
-
"name": "ready"
|
|
6972
|
-
}
|
|
6973
|
-
]
|
|
6974
|
-
},
|
|
6975
|
-
{
|
|
6976
|
-
"name": "steps",
|
|
6977
|
-
"description": "Sets steps, or intervals, on the slider that restrict user\ninput to specific values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#steps)",
|
|
6978
|
-
"values": []
|
|
6979
|
-
},
|
|
6980
|
-
{
|
|
6981
|
-
"name": "synced-segments-enabled",
|
|
6982
|
-
"description": "When `true`, all segments will sync together in updating thumb values when the user drags any segment.",
|
|
6983
|
-
"values": []
|
|
6984
|
-
},
|
|
6985
|
-
{
|
|
6986
|
-
"name": "thumbs-constrained",
|
|
6987
|
-
"description": "When `false`, the user can freely move any slider thumb to any\nposition along the track.",
|
|
6988
|
-
"values": []
|
|
6989
|
-
},
|
|
6990
|
-
{
|
|
6991
|
-
"name": "values",
|
|
6992
|
-
"description": "An array of numbers representing absolute thumb positions on the slider.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#values)",
|
|
6993
|
-
"values": []
|
|
6994
|
-
}
|
|
6995
|
-
],
|
|
6996
|
-
"references": [
|
|
6997
|
-
{
|
|
6998
|
-
"name": "Docs",
|
|
6999
|
-
"url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slider/"
|
|
7000
|
-
}
|
|
7001
|
-
]
|
|
7002
|
-
},
|
|
7003
7113
|
{
|
|
7004
7114
|
"name": "arcgis-swipe",
|
|
7005
|
-
"description": "The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known
|
|
7115
|
+
"description": "The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisSwipeChange** - Fires when the swipe position changes and the drag handle is released on the component.\n\n**Note:** To constantly listen to changes while dragging, use the `arcgisSwipeInput` event instead.\n- **arcgisSwipeInput** - Fires when the swipe position is updated.\nThis event is fired continuously while dragging the handle.\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.",
|
|
7006
7116
|
"attributes": [
|
|
7007
7117
|
{
|
|
7008
7118
|
"name": "auto-destroy-disabled",
|
|
@@ -7080,6 +7190,7 @@
|
|
|
7080
7190
|
},
|
|
7081
7191
|
{
|
|
7082
7192
|
"name": "reference-element",
|
|
7193
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7083
7194
|
"values": []
|
|
7084
7195
|
},
|
|
7085
7196
|
{
|
|
@@ -7113,7 +7224,7 @@
|
|
|
7113
7224
|
},
|
|
7114
7225
|
{
|
|
7115
7226
|
"name": "arcgis-table-list",
|
|
7116
|
-
"description": "The Table List component provides a way to display a list of tables associated with a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html).\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\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
|
|
7227
|
+
"description": "The Table List component provides a way to display a list of tables associated with a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html).\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\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 ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\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.",
|
|
7117
7228
|
"attributes": [
|
|
7118
7229
|
{
|
|
7119
7230
|
"name": "auto-destroy-disabled",
|
|
@@ -7207,6 +7318,7 @@
|
|
|
7207
7318
|
},
|
|
7208
7319
|
{
|
|
7209
7320
|
"name": "reference-element",
|
|
7321
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7210
7322
|
"values": []
|
|
7211
7323
|
},
|
|
7212
7324
|
{
|
|
@@ -7280,7 +7392,7 @@
|
|
|
7280
7392
|
},
|
|
7281
7393
|
{
|
|
7282
7394
|
"name": "arcgis-time-slider",
|
|
7283
|
-
"description": "The Time Slider component simplifies visualization of temporal data in your application.\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
|
|
7395
|
+
"description": "The Time Slider component simplifies visualization of temporal data in your application.\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 ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `applyTimeSliderSettings(settings: Pick<__esri.TimeSliderProperties, \"fullTimeExtent\" | \"loop\" | \"stops\">): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): Promise<void>`\n- `play(): Promise<void>`\n- `previous(): Promise<void>`\n- `stop(): Promise<void>`\n- `updateWebDocument(webmap: __esri.WebMap): Promise<void>`",
|
|
7284
7396
|
"attributes": [
|
|
7285
7397
|
{
|
|
7286
7398
|
"name": "auto-destroy-disabled",
|
|
@@ -7379,6 +7491,7 @@
|
|
|
7379
7491
|
},
|
|
7380
7492
|
{
|
|
7381
7493
|
"name": "reference-element",
|
|
7494
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7382
7495
|
"values": []
|
|
7383
7496
|
},
|
|
7384
7497
|
{
|
|
@@ -7420,7 +7533,7 @@
|
|
|
7420
7533
|
},
|
|
7421
7534
|
{
|
|
7422
7535
|
"name": "arcgis-time-zone-label",
|
|
7423
|
-
"description": "Time Zone Label is a component for displaying the current [time zone](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeZone) of a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\nThe component has two states, collapsed as a small button and expanded displaying the internationalized name of the Map's time zone.\nUsers can toggle between these states by clicking the component's expand/collapse button.\nBy default the component is collapsed.\n\nWhen expanding, the component will lengthen inwards when [positioned](#position) within a Map.\nThis behavior can be overridden by setting the [expandDirection](#expandDirection) property to either `\"start\"` or `\"end\"`.\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
|
|
7536
|
+
"description": "Time Zone Label is a component for displaying the current [time zone](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeZone) of a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\nThe component has two states, collapsed as a small button and expanded displaying the internationalized name of the Map's time zone.\nUsers can toggle between these states by clicking the component's expand/collapse button.\nBy default the component is collapsed.\n\nWhen expanding, the component will lengthen inwards when [positioned](#position) within a Map.\nThis behavior can be overridden by setting the [expandDirection](#expandDirection) property to either `\"start\"` or `\"end\"`.\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 ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
|
|
7424
7537
|
"attributes": [
|
|
7425
7538
|
{
|
|
7426
7539
|
"name": "disabled",
|
|
@@ -7511,7 +7624,7 @@
|
|
|
7511
7624
|
},
|
|
7512
7625
|
{
|
|
7513
7626
|
"name": "arcgis-track",
|
|
7514
|
-
"description": "The Track component is a button that animates the
|
|
7627
|
+
"description": "The Track component is a button that when activated continuously animates the Map or Scene\nto the user's location as the user moves.\nThe view rotates based on device heading, and the default heading symbol will display\nwhen speed is greater than zero and the browser provides heading information.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that support\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility).\n\n**Known limitations**\n\n- The heading symbol is not currently supported within a [Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start tracking the user's location. Only start the component on a user gesture such as a click event.\n- `stop(): Promise<void>` - Stop tracking the user's location.",
|
|
7515
7628
|
"attributes": [
|
|
7516
7629
|
{
|
|
7517
7630
|
"name": "auto-destroy-disabled",
|
|
@@ -7576,6 +7689,7 @@
|
|
|
7576
7689
|
},
|
|
7577
7690
|
{
|
|
7578
7691
|
"name": "reference-element",
|
|
7692
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7579
7693
|
"values": []
|
|
7580
7694
|
},
|
|
7581
7695
|
{
|
|
@@ -7590,7 +7704,7 @@
|
|
|
7590
7704
|
},
|
|
7591
7705
|
{
|
|
7592
7706
|
"name": "state",
|
|
7593
|
-
"description": "The current state of the
|
|
7707
|
+
"description": "The current state of the component.",
|
|
7594
7708
|
"values": [
|
|
7595
7709
|
{
|
|
7596
7710
|
"name": "disabled"
|
|
@@ -7626,7 +7740,7 @@
|
|
|
7626
7740
|
},
|
|
7627
7741
|
{
|
|
7628
7742
|
"name": "arcgis-utility-network-associations",
|
|
7629
|
-
"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
|
|
7743
|
+
"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 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.",
|
|
7630
7744
|
"attributes": [
|
|
7631
7745
|
{
|
|
7632
7746
|
"name": "auto-destroy-disabled",
|
|
@@ -7736,6 +7850,7 @@
|
|
|
7736
7850
|
},
|
|
7737
7851
|
{
|
|
7738
7852
|
"name": "reference-element",
|
|
7853
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7739
7854
|
"values": []
|
|
7740
7855
|
},
|
|
7741
7856
|
{
|
|
@@ -7775,57 +7890,57 @@
|
|
|
7775
7890
|
},
|
|
7776
7891
|
{
|
|
7777
7892
|
"name": "visible-elements-connectivity-associations-settings-arrows-toggle",
|
|
7778
|
-
"description": "**Deprecated**: since 4.32
|
|
7893
|
+
"description": "**Deprecated**: since 4.32, showConnectivityAssociationsSettingsArrowsToggle instead. ",
|
|
7779
7894
|
"values": []
|
|
7780
7895
|
},
|
|
7781
7896
|
{
|
|
7782
7897
|
"name": "visible-elements-connectivity-associations-settings-cap-select",
|
|
7783
|
-
"description": "**Deprecated**: since 4.32
|
|
7898
|
+
"description": "**Deprecated**: since 4.32, use showConnectivityAssociationsSettingsCapSelect instead. ",
|
|
7784
7899
|
"values": []
|
|
7785
7900
|
},
|
|
7786
7901
|
{
|
|
7787
7902
|
"name": "visible-elements-connectivity-associations-settings-color-picker",
|
|
7788
|
-
"description": "**Deprecated**: since 4.32
|
|
7903
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsColorPicker instead. ",
|
|
7789
7904
|
"values": []
|
|
7790
7905
|
},
|
|
7791
7906
|
{
|
|
7792
7907
|
"name": "visible-elements-connectivity-associations-settings-style-picker",
|
|
7793
|
-
"description": "**Deprecated**: since 4.32
|
|
7908
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsStylePicker instead. ",
|
|
7794
7909
|
"values": []
|
|
7795
7910
|
},
|
|
7796
7911
|
{
|
|
7797
7912
|
"name": "visible-elements-connectivity-associations-settings-width-input",
|
|
7798
|
-
"description": "**Deprecated**: since 4.32
|
|
7913
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsWidthInput instead. ",
|
|
7799
7914
|
"values": []
|
|
7800
7915
|
},
|
|
7801
7916
|
{
|
|
7802
7917
|
"name": "visible-elements-max-allowable-associations-slider",
|
|
7803
|
-
"description": "**Deprecated**: since 4.32
|
|
7918
|
+
"description": "**Deprecated**: since 4.32, use showMaxAllowableAssociationsSlider instead. ",
|
|
7804
7919
|
"values": []
|
|
7805
7920
|
},
|
|
7806
7921
|
{
|
|
7807
7922
|
"name": "visible-elements-structural-attachment-associations-settings-arrows-toggle",
|
|
7808
|
-
"description": "**Deprecated**: since 4.32
|
|
7923
|
+
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsArrowsToggle instead. ",
|
|
7809
7924
|
"values": []
|
|
7810
7925
|
},
|
|
7811
7926
|
{
|
|
7812
7927
|
"name": "visible-elements-structural-attachment-associations-settings-cap-select",
|
|
7813
|
-
"description": "**Deprecated**: since 4.32
|
|
7928
|
+
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsCapSelect instead. ",
|
|
7814
7929
|
"values": []
|
|
7815
7930
|
},
|
|
7816
7931
|
{
|
|
7817
7932
|
"name": "visible-elements-structural-attachment-associations-settings-color-picker",
|
|
7818
|
-
"description": "**Deprecated**: since 4.32
|
|
7933
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsColorPicker instead. ",
|
|
7819
7934
|
"values": []
|
|
7820
7935
|
},
|
|
7821
7936
|
{
|
|
7822
7937
|
"name": "visible-elements-structural-attachment-associations-settings-style-picker",
|
|
7823
|
-
"description": "**Deprecated**: since 4.32
|
|
7938
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsStylePicker instead. ",
|
|
7824
7939
|
"values": []
|
|
7825
7940
|
},
|
|
7826
7941
|
{
|
|
7827
7942
|
"name": "visible-elements-structural-attachment-associations-settings-width-input",
|
|
7828
|
-
"description": "**Deprecated**: since 4.32
|
|
7943
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsWidthInput instead. ",
|
|
7829
7944
|
"values": []
|
|
7830
7945
|
}
|
|
7831
7946
|
],
|
|
@@ -7833,16 +7948,12 @@
|
|
|
7833
7948
|
{
|
|
7834
7949
|
"name": "Docs",
|
|
7835
7950
|
"url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-associations/"
|
|
7836
|
-
},
|
|
7837
|
-
{
|
|
7838
|
-
"name": "Utility Network Associations",
|
|
7839
|
-
"url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-utility-network-associations--demo&singleStory=true"
|
|
7840
7951
|
}
|
|
7841
7952
|
]
|
|
7842
7953
|
},
|
|
7843
7954
|
{
|
|
7844
7955
|
"name": "arcgis-utility-network-trace",
|
|
7845
|
-
"description": "Utility Network Trace component provides a way to run traces in a Utility Network based on connectivity or traversability from set input flags. Input flags (starting points and barriers) can be set by clicking the view.\n\n> The Utility Network Trace component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisAddFlag**\n- **arcgisAddFlagComplete**\n- **arcgisAddFlagError**\n- **arcgisAddResultArea**\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
|
|
7956
|
+
"description": "Utility Network Trace component provides a way to run traces in a Utility Network based on connectivity or traversability from set input flags. Input flags (starting points and barriers) can be set by clicking the view.\n\n> The Utility Network Trace component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisAddFlag**\n- **arcgisAddFlagComplete**\n- **arcgisAddFlagError**\n- **arcgisAddResultArea**\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 ready to be interacted with.\n- **arcgisRemoveResultArea**\n\n### Methods\n- `checkCanTrace(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `confirmReset(): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
7846
7957
|
"attributes": [
|
|
7847
7958
|
{
|
|
7848
7959
|
"name": "auto-destroy-disabled",
|
|
@@ -7861,7 +7972,7 @@
|
|
|
7861
7972
|
},
|
|
7862
7973
|
{
|
|
7863
7974
|
"name": "gdb-version",
|
|
7864
|
-
"description": "**Deprecated**: since version 4.31
|
|
7975
|
+
"description": "**Deprecated**: `gdbVersion` is deprecated since version 4.31.. The Geodatabase version to pass into the trace.",
|
|
7865
7976
|
"values": []
|
|
7866
7977
|
},
|
|
7867
7978
|
{
|
|
@@ -7908,6 +8019,7 @@
|
|
|
7908
8019
|
},
|
|
7909
8020
|
{
|
|
7910
8021
|
"name": "reference-element",
|
|
8022
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7911
8023
|
"values": []
|
|
7912
8024
|
},
|
|
7913
8025
|
{
|
|
@@ -7951,7 +8063,7 @@
|
|
|
7951
8063
|
},
|
|
7952
8064
|
{
|
|
7953
8065
|
"name": "arcgis-utility-network-validate-topology",
|
|
7954
|
-
"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
|
|
8066
|
+
"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 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.",
|
|
7955
8067
|
"attributes": [
|
|
7956
8068
|
{
|
|
7957
8069
|
"name": "auto-destroy-disabled",
|
|
@@ -8014,6 +8126,7 @@
|
|
|
8014
8126
|
},
|
|
8015
8127
|
{
|
|
8016
8128
|
"name": "reference-element",
|
|
8129
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8017
8130
|
"values": []
|
|
8018
8131
|
},
|
|
8019
8132
|
{
|
|
@@ -8045,16 +8158,12 @@
|
|
|
8045
8158
|
{
|
|
8046
8159
|
"name": "Docs",
|
|
8047
8160
|
"url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-validate-topology/"
|
|
8048
|
-
},
|
|
8049
|
-
{
|
|
8050
|
-
"name": "Utility Network Validate Topology",
|
|
8051
|
-
"url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-utility-network-validate-topology--demo&singleStory=true"
|
|
8052
8161
|
}
|
|
8053
8162
|
]
|
|
8054
8163
|
},
|
|
8055
8164
|
{
|
|
8056
8165
|
"name": "arcgis-value-picker",
|
|
8057
|
-
"description": "### Events\n- **arcgisAnimate**\n- **arcgisNext**\n- **arcgisPause**\n- **arcgisPlay**\n- **arcgisPrevious**\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
|
|
8166
|
+
"description": "### Events\n- **arcgisAnimate**\n- **arcgisNext**\n- **arcgisPause**\n- **arcgisPlay**\n- **arcgisPrevious**\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 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- `next(): Promise<void>`\n- `pause(): Promise<void>`\n- `play(): Promise<void>`\n- `previous(): Promise<void>`",
|
|
8058
8167
|
"attributes": [
|
|
8059
8168
|
{
|
|
8060
8169
|
"name": "auto-destroy-disabled",
|
|
@@ -8159,6 +8268,7 @@
|
|
|
8159
8268
|
},
|
|
8160
8269
|
{
|
|
8161
8270
|
"name": "reference-element",
|
|
8271
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8162
8272
|
"values": []
|
|
8163
8273
|
}
|
|
8164
8274
|
],
|
|
@@ -8171,7 +8281,7 @@
|
|
|
8171
8281
|
},
|
|
8172
8282
|
{
|
|
8173
8283
|
"name": "arcgis-version-management",
|
|
8174
|
-
"description": "The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.\nThe [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) will update to match the features on the selected version.\nTo learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).\n\n> The Version Management component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is
|
|
8284
|
+
"description": "The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.\nThe [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) will update to match the features on the selected version.\nTo learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).\n\n> The Version Management component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisVersioningStateChanged**\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.",
|
|
8175
8285
|
"attributes": [
|
|
8176
8286
|
{
|
|
8177
8287
|
"name": "allow-editing-disabled",
|
|
@@ -8200,7 +8310,7 @@
|
|
|
8200
8310
|
},
|
|
8201
8311
|
{
|
|
8202
8312
|
"name": "page-size",
|
|
8203
|
-
"description": "Specifies the number of versions displayed on each page of the Version Management
|
|
8313
|
+
"description": "Specifies the number of versions displayed on each page of the Version Management component.",
|
|
8204
8314
|
"values": []
|
|
8205
8315
|
},
|
|
8206
8316
|
{
|
|
@@ -8237,6 +8347,7 @@
|
|
|
8237
8347
|
},
|
|
8238
8348
|
{
|
|
8239
8349
|
"name": "reference-element",
|
|
8350
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8240
8351
|
"values": []
|
|
8241
8352
|
},
|
|
8242
8353
|
{
|
|
@@ -8277,15 +8388,11 @@
|
|
|
8277
8388
|
},
|
|
8278
8389
|
{
|
|
8279
8390
|
"name": "arcgis-video",
|
|
8280
|
-
"description": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid
|
|
8391
|
+
"description": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid VideoLayer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n--\n\n### Events\n- **arcgisViewReadyChange**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.",
|
|
8281
8392
|
"attributes": [
|
|
8282
8393
|
{
|
|
8283
8394
|
"name": "auto-destroy-disabled",
|
|
8284
8395
|
"values": []
|
|
8285
|
-
},
|
|
8286
|
-
{
|
|
8287
|
-
"name": "layer-url",
|
|
8288
|
-
"values": []
|
|
8289
8396
|
}
|
|
8290
8397
|
],
|
|
8291
8398
|
"references": [
|
|
@@ -8297,13 +8404,31 @@
|
|
|
8297
8404
|
},
|
|
8298
8405
|
{
|
|
8299
8406
|
"name": "arcgis-video-player",
|
|
8300
|
-
"description": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known
|
|
8407
|
+
"description": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[](https://mediaspace.esri.com/media/1_ctc3psfr)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisVideoReady**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
8301
8408
|
"attributes": [
|
|
8302
8409
|
{
|
|
8303
8410
|
"name": "auto-destroy-disabled",
|
|
8304
8411
|
"description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/#destroy) method when you are done to\nprevent memory leaks.",
|
|
8305
8412
|
"values": []
|
|
8306
8413
|
},
|
|
8414
|
+
{
|
|
8415
|
+
"name": "following-mode",
|
|
8416
|
+
"description": "Determines which telemetry elements to follow when the video layer is playing.",
|
|
8417
|
+
"values": [
|
|
8418
|
+
{
|
|
8419
|
+
"name": "follow-both"
|
|
8420
|
+
},
|
|
8421
|
+
{
|
|
8422
|
+
"name": "follow-frame"
|
|
8423
|
+
},
|
|
8424
|
+
{
|
|
8425
|
+
"name": "follow-sensor"
|
|
8426
|
+
},
|
|
8427
|
+
{
|
|
8428
|
+
"name": "none"
|
|
8429
|
+
}
|
|
8430
|
+
]
|
|
8431
|
+
},
|
|
8307
8432
|
{
|
|
8308
8433
|
"name": "hide-header",
|
|
8309
8434
|
"description": "Indicates whether to display the video player's header information.",
|
|
@@ -8353,6 +8478,7 @@
|
|
|
8353
8478
|
},
|
|
8354
8479
|
{
|
|
8355
8480
|
"name": "reference-element",
|
|
8481
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8356
8482
|
"values": []
|
|
8357
8483
|
},
|
|
8358
8484
|
{
|
|
@@ -8395,7 +8521,7 @@
|
|
|
8395
8521
|
},
|
|
8396
8522
|
{
|
|
8397
8523
|
"name": "arcgis-weather",
|
|
8398
|
-
"description": "The Weather component
|
|
8524
|
+
"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 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.",
|
|
8399
8525
|
"attributes": [
|
|
8400
8526
|
{
|
|
8401
8527
|
"name": "auto-destroy-disabled",
|
|
@@ -8475,6 +8601,7 @@
|
|
|
8475
8601
|
},
|
|
8476
8602
|
{
|
|
8477
8603
|
"name": "reference-element",
|
|
8604
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8478
8605
|
"values": []
|
|
8479
8606
|
},
|
|
8480
8607
|
{
|
|
@@ -8506,7 +8633,7 @@
|
|
|
8506
8633
|
},
|
|
8507
8634
|
{
|
|
8508
8635
|
"name": "arcgis-zoom",
|
|
8509
|
-
"description": "The Zoom component allows users to zoom in/out within a map or scene.\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
|
|
8636
|
+
"description": "The Zoom component allows users to zoom in/out within a map or scene.\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 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- `zoomIn(): Promise<void>` - Zooms the view in by an LOD factor of 0.5.\n- `zoomOut(): Promise<void>` - Zooms the view out by an LOD factor of 2.",
|
|
8510
8637
|
"attributes": [
|
|
8511
8638
|
{
|
|
8512
8639
|
"name": "auto-destroy-disabled",
|
|
@@ -8569,6 +8696,7 @@
|
|
|
8569
8696
|
},
|
|
8570
8697
|
{
|
|
8571
8698
|
"name": "reference-element",
|
|
8699
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8572
8700
|
"values": []
|
|
8573
8701
|
},
|
|
8574
8702
|
{
|