@arcgis/map-components 5.0.0-next.117 → 5.0.0-next.118
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/{LL5RFOAN.js → 2C6VJMPT.js} +2 -2
- package/dist/cdn/{MX5P76FC.js → 2HWOA3FX.js} +2 -2
- package/dist/cdn/{TB3BB5BP.js → 2I65FTXJ.js} +2 -2
- package/dist/cdn/{VJGF5D2J.js → 2IPFTZCM.js} +2 -2
- package/dist/cdn/{6CUDFN2I.js → 2KUQ3BL7.js} +2 -2
- package/dist/cdn/{WINB66K4.js → 2SCCOB7L.js} +2 -2
- package/dist/cdn/{VVLZTYO4.js → 2ZWPNOAY.js} +2 -2
- package/dist/cdn/{PHRAUR5Y.js → 37O4V7IX.js} +1 -1
- package/dist/cdn/{O7KJLCAY.js → 3CMKHRPP.js} +2 -2
- package/dist/cdn/{EMX3SLBS.js → 3ELRTZOZ.js} +2 -2
- package/dist/cdn/{5CEV4IFF.js → 3IEVN25A.js} +2 -2
- package/dist/cdn/{PQXUCPUD.js → 3IK2WX6O.js} +2 -2
- package/dist/cdn/{MVWNZS77.js → 3IQZRABY.js} +2 -2
- package/dist/cdn/{QHBZTUWK.js → 3NLUIM5M.js} +2 -2
- package/dist/cdn/{6N76DOKY.js → 3NX5P7IZ.js} +2 -2
- package/dist/cdn/{GQDPMP6H.js → 3P4IQGNB.js} +2 -2
- package/dist/cdn/{EVDLZTUO.js → 44GOMI6N.js} +2 -2
- package/dist/cdn/{FXAPWM5U.js → 45IMGM24.js} +2 -2
- package/dist/cdn/{UK2HI4WV.js → 46JAFFPO.js} +2 -2
- package/dist/cdn/{ABY77MYY.js → 4CWJIQKC.js} +2 -2
- package/dist/cdn/{KZJ7DYBA.js → 4DBM44OI.js} +2 -2
- package/dist/cdn/{OG4QSOW2.js → 4IF6O35C.js} +2 -2
- package/dist/cdn/{74R5SKBV.js → 4KZGFK46.js} +2 -2
- package/dist/cdn/{S5OXRCLT.js → 4R3FO5X6.js} +1 -1
- package/dist/cdn/{4U4QQSCV.js → 4RPGUA5P.js} +2 -2
- package/dist/cdn/{I24JKSH6.js → 4TMT67RB.js} +2 -2
- package/dist/cdn/{YAIQWSWN.js → 4XKZZQWJ.js} +2 -2
- package/dist/cdn/{DVNY7ZYH.js → 53FLKZNF.js} +2 -2
- package/dist/cdn/{QVKKABG5.js → 5BIHZSZI.js} +2 -2
- package/dist/cdn/{L5CKYMQ2.js → 5EFGDM5F.js} +1 -1
- package/dist/cdn/{GH6APBHN.js → 5EQEEBB4.js} +2 -2
- package/dist/cdn/{7HIBHM6T.js → 5PWV4PN4.js} +2 -2
- package/dist/cdn/{WRTKJJGI.js → 5PZGMJBE.js} +3 -3
- package/dist/cdn/{G7LCUAUI.js → 5UD65RXC.js} +2 -2
- package/dist/cdn/{ZFGLOJKR.js → 5UFX5PVW.js} +2 -2
- package/dist/cdn/{Z3SABTJL.js → 5XTXMXBZ.js} +2 -2
- package/dist/cdn/{6RYATUTC.js → 6PKIPLXE.js} +2 -2
- package/dist/cdn/{A45FDN75.js → 6PXJLJD6.js} +2 -2
- package/dist/cdn/{HXRX62NT.js → 6R5YZVCL.js} +2 -2
- package/dist/cdn/{WYEDVDPU.js → 6SBIIW3H.js} +2 -2
- package/dist/cdn/{ZGWDTNOR.js → 6TTWFKFF.js} +2 -2
- package/dist/cdn/{XC4T5YLV.js → 6UFNCBCF.js} +2 -2
- package/dist/cdn/{IGPKPVMD.js → 6XO2NZ2B.js} +2 -2
- package/dist/cdn/{634X3DFC.js → 76NIO4HH.js} +2 -2
- package/dist/cdn/{YPWIJ2DW.js → 7CPSSUEN.js} +2 -2
- package/dist/cdn/{OI4TZ364.js → 7GWQUVCH.js} +2 -2
- package/dist/cdn/{JOFQ6HJ4.js → 7J4BH4SJ.js} +2 -2
- package/dist/cdn/{33F2RTNH.js → A5N6WIFD.js} +2 -2
- package/dist/cdn/{S55CXZVC.js → A6PBGN3U.js} +2 -2
- package/dist/cdn/{X6SHTCOX.js → ABAY754S.js} +2 -2
- package/dist/cdn/{4WKCG4CQ.js → AM2RXOSH.js} +1 -1
- package/dist/cdn/{UJWPNKZY.js → ANV4EP5K.js} +2 -2
- package/dist/cdn/{BUAQ34XH.js → APJERP7S.js} +2 -2
- package/dist/cdn/{VTCKKPYN.js → AXEIJP4Q.js} +2 -2
- package/dist/cdn/{ZI6I5M4G.js → AZFDGPRF.js} +2 -2
- package/dist/cdn/{VELOH75H.js → B2BQUTGC.js} +2 -2
- package/dist/cdn/{4D57333A.js → B3BRXNF3.js} +2 -2
- package/dist/cdn/{AUPO2UY6.js → B3GVMYA3.js} +2 -2
- package/dist/cdn/{JQFKS2ML.js → BE6IAEEJ.js} +2 -2
- package/dist/cdn/{F35LV6RT.js → BMJTGGUM.js} +2 -2
- package/dist/cdn/{D45LFCA6.js → BN37APGI.js} +2 -2
- package/dist/cdn/{MH6YS5SI.js → BQPH2DXU.js} +2 -2
- package/dist/cdn/{ZTG5BEGM.js → BSUMMCQO.js} +2 -2
- package/dist/cdn/{Y7NZN64U.js → C6PMEB4C.js} +2 -2
- package/dist/cdn/{QJ5LXAQL.js → CA2SWJ73.js} +2 -2
- package/dist/cdn/{D4DXZS67.js → CFLBQKBR.js} +2 -2
- package/dist/cdn/{R642AFSW.js → CIMA7S6X.js} +2 -2
- package/dist/cdn/{KYEEZ3FA.js → D7C735ZH.js} +2 -2
- package/dist/cdn/{2TMHFF7X.js → DCLTXQDJ.js} +2 -2
- package/dist/cdn/{EZG2JLJ5.js → DDDAINAM.js} +2 -2
- package/dist/cdn/{DIUEHJTX.js → DEL5ZCU4.js} +2 -2
- package/dist/cdn/{Z7SQO7BJ.js → DFABPUJ2.js} +2 -2
- package/dist/cdn/{O5I6MLQP.js → DITR46QS.js} +2 -2
- package/dist/cdn/{VHHML3NK.js → DJ7NHIZH.js} +2 -2
- package/dist/cdn/{FFXWQSGQ.js → DJTVTXUI.js} +2 -2
- package/dist/cdn/{6ELJEOKR.js → DK523M4T.js} +2 -2
- package/dist/cdn/{Q3GHRH6Y.js → DKG26AQH.js} +2 -2
- package/dist/cdn/{UJ6IKQEX.js → DTBOLH2S.js} +2 -2
- package/dist/cdn/{GSOYGM72.js → DYLI2DGL.js} +2 -2
- package/dist/cdn/{FBASF2NZ.js → ECBO7KK6.js} +2 -2
- package/dist/cdn/{TOR6Z7KC.js → EDGU6FOO.js} +2 -2
- package/dist/cdn/{IDIZ4JMO.js → EDMQKA5S.js} +2 -2
- package/dist/cdn/{GP4HSM3D.js → ENCGADVY.js} +2 -2
- package/dist/cdn/{FXIN5HPP.js → EX5QJ2QV.js} +2 -2
- package/dist/cdn/{TIKICXS2.js → F27VCLE3.js} +2 -2
- package/dist/cdn/{EGVO7MZT.js → F4KPXUNK.js} +2 -2
- package/dist/cdn/{KZSJG647.js → F5AKYQI3.js} +2 -2
- package/dist/cdn/{VWCO67WW.js → F65EK3Q4.js} +2 -2
- package/dist/cdn/{I7MYCZQE.js → FCLG6BHG.js} +2 -2
- package/dist/cdn/{ELGM55WB.js → FHJHJACQ.js} +2 -2
- package/dist/cdn/FQ7ODI7S.js +4 -0
- package/dist/cdn/{NJXH7B47.js → FZ47MOPF.js} +2 -2
- package/dist/cdn/{PNPMFV63.js → GEXMM6KH.js} +2 -2
- package/dist/cdn/{ZQXLTKLG.js → GGZWAR3W.js} +2 -2
- package/dist/cdn/{5MWLLJZO.js → GIK5OZIS.js} +2 -2
- package/dist/cdn/{GY3AHAJD.js → GM3ALHL5.js} +2 -2
- package/dist/cdn/{5PNTB7ZZ.js → GNX4I22M.js} +2 -2
- package/dist/cdn/{YWKEMWHL.js → GUA64H6M.js} +2 -2
- package/dist/cdn/{6MLKKLJF.js → GVKFQEA2.js} +1 -1
- package/dist/cdn/{PH7HOLNC.js → GVSOYV56.js} +2 -2
- package/dist/cdn/{LLR7PSY5.js → GXINI4MN.js} +2 -2
- package/dist/cdn/{UO3XM775.js → H3CJ2MAU.js} +2 -2
- package/dist/cdn/{N5JN4P6J.js → H5LIEP62.js} +2 -2
- package/dist/cdn/{YN2GB3BN.js → H5W6LNNC.js} +2 -2
- package/dist/cdn/{4OT2UDF7.js → HEZEJ6QZ.js} +2 -2
- package/dist/cdn/{65ETFPTS.js → HHV6O2DG.js} +2 -2
- package/dist/cdn/{NN4UPZ3P.js → HJCPJLLE.js} +2 -2
- package/dist/cdn/{HLIVP7TV.js → HKDHVMCT.js} +1 -1
- package/dist/cdn/{K7K5YKDA.js → HMIDCSWP.js} +1 -1
- package/dist/cdn/{PW6OKPXP.js → HOH22F7A.js} +2 -2
- package/dist/cdn/{QARMZUIY.js → HP4AUSXX.js} +2 -2
- package/dist/cdn/{NXB2E74U.js → HUK6MMUX.js} +2 -2
- package/dist/cdn/{YY5H22ZZ.js → HUNXV7DO.js} +2 -2
- package/dist/cdn/{WYYLLTQD.js → HUR2YS23.js} +2 -2
- package/dist/cdn/{GBOEU2SP.js → HWVKTGLU.js} +2 -2
- package/dist/cdn/{2NIX656N.js → HY6LSZ3L.js} +2 -2
- package/dist/cdn/{YUKIVONY.js → HYEOKULF.js} +2 -2
- package/dist/cdn/{5V6Z52KY.js → ICSH6J5O.js} +2 -2
- package/dist/cdn/{4RAPCIFN.js → ICTIO6P3.js} +1 -1
- package/dist/cdn/{RFT3IQPM.js → IQ7M7MVG.js} +2 -2
- package/dist/cdn/{6GRBFJ7K.js → ISZKU7F3.js} +2 -2
- package/dist/cdn/{XXG4FGQL.js → ITSHYNKP.js} +2 -2
- package/dist/cdn/{TB7QAKFC.js → ITVZEYGA.js} +2 -2
- package/dist/cdn/{CPOMUAYH.js → J2PMQVCA.js} +2 -2
- package/dist/cdn/J3HRJNJ6.js +4 -0
- package/dist/cdn/{S3B4YGDF.js → J4QJQPEX.js} +2 -2
- package/dist/cdn/{W4UPOFT4.js → JARCL3SE.js} +1 -1
- package/dist/cdn/{JQ5HNLXU.js → JAXEQQ7N.js} +2 -2
- package/dist/cdn/{2B7TUO35.js → JBLNCMEY.js} +2 -2
- package/dist/cdn/{22Z2A43D.js → JJ5PLYIJ.js} +2 -2
- package/dist/cdn/{WVQOYSJ3.js → JJH5KYEW.js} +2 -2
- package/dist/cdn/{JAHAUOJU.js → JKEDLI2L.js} +2 -2
- package/dist/cdn/{5TIV7XFU.js → JNL42UTE.js} +2 -2
- package/dist/cdn/{KOIOYZI3.js → JSAE2NSO.js} +2 -2
- package/dist/cdn/{6KJGI6TF.js → JUF3AQNM.js} +2 -2
- package/dist/cdn/{NM6MBSXJ.js → JYJBI5RV.js} +2 -2
- package/dist/cdn/{KKHUQEG4.js → JZNS5KQF.js} +2 -2
- package/dist/cdn/{4W47VKQ6.js → K2224LC4.js} +2 -2
- package/dist/cdn/{KLQYMKVU.js → K5COKOJS.js} +2 -2
- package/dist/cdn/{MMB3HMO7.js → KBBV74BZ.js} +2 -2
- package/dist/cdn/{6SBRP3TG.js → KD2HWH2Q.js} +1 -1
- package/dist/cdn/{WGIKXWTU.js → KJV3G43Y.js} +2 -2
- package/dist/cdn/{HCCI3TC2.js → KM7EFMTR.js} +1 -1
- package/dist/cdn/{7XSNFPYE.js → KQ3QPADR.js} +2 -2
- package/dist/cdn/{NLXKGIEQ.js → KVHU3NPR.js} +2 -2
- package/dist/cdn/{UE4DJPOO.js → KXLOT2TZ.js} +2 -2
- package/dist/cdn/{SI53UM55.js → KZXLF2BE.js} +2 -2
- package/dist/cdn/{FRDXZ7YR.js → LLMR5IFN.js} +2 -2
- package/dist/cdn/{UTVCMK4V.js → LXQMHYH5.js} +2 -2
- package/dist/cdn/{FXMY3YWF.js → LZ3GK4UY.js} +2 -2
- package/dist/cdn/{IKIGOGMT.js → M5KXFEPP.js} +2 -2
- package/dist/cdn/{LS3KCYEJ.js → MHS7S2U7.js} +1 -1
- package/dist/cdn/{M4D3ERTB.js → MKTAGEHI.js} +2 -2
- package/dist/cdn/{UU43MMV7.js → MMTAYL3S.js} +1 -1
- package/dist/cdn/{CRICPIJ2.js → MO3BCHML.js} +2 -2
- package/dist/cdn/{HPR4E5IX.js → MO5RQMX2.js} +2 -2
- package/dist/cdn/{D6AAXZCM.js → MSQJDAIC.js} +2 -2
- package/dist/cdn/{BSC245Z6.js → N7GLRM6G.js} +2 -2
- package/dist/cdn/{JRXKJXCQ.js → NA6MAS4D.js} +2 -2
- package/dist/cdn/{L5XLGUHF.js → NUQ5T2XO.js} +1 -1
- package/dist/cdn/{WR6SXGSW.js → NZJGR5I7.js} +2 -2
- package/dist/cdn/{EKG6Z7OQ.js → ODIBGTSR.js} +2 -2
- package/dist/cdn/{AV27DVRG.js → OFELIXD3.js} +2 -2
- package/dist/cdn/OFURCYRN.js +4 -0
- package/dist/cdn/{XHUETWAX.js → OIIEZYSH.js} +2 -2
- package/dist/cdn/{73NVFE2Z.js → OLT4G3YD.js} +2 -2
- package/dist/cdn/{C5WQE2MR.js → OQMHQHAD.js} +2 -2
- package/dist/cdn/{PS24GUJN.js → OX2ONC4R.js} +1 -1
- package/dist/cdn/{BT72OOO3.js → PECGNCGL.js} +2 -2
- package/dist/cdn/{Y4DV4SJT.js → PETDJYSJ.js} +2 -2
- package/dist/cdn/{NCWVGO2C.js → PFUJRVC5.js} +2 -2
- package/dist/cdn/{K5IRZO6N.js → PK2HSK5J.js} +2 -2
- package/dist/cdn/{6DJPOS7O.js → POJ5QX4T.js} +2 -2
- package/dist/cdn/{DSKBCPB5.js → Q3HJV2C4.js} +2 -2
- package/dist/cdn/{3F4LAGGP.js → QD7CHJYC.js} +2 -2
- package/dist/cdn/{2Z3ZKAM3.js → QDUOMXEB.js} +2 -2
- package/dist/cdn/{CNEZ7JNS.js → QGYKGI2B.js} +2 -2
- package/dist/cdn/{CMGFZ35W.js → QJRVJYEQ.js} +2 -2
- package/dist/cdn/{TVHKYDGC.js → QKW5V5HX.js} +2 -2
- package/dist/cdn/{5PBRBMTF.js → QPGYFZXL.js} +2 -2
- package/dist/cdn/{FXE7NJ3O.js → QVMBWNST.js} +2 -2
- package/dist/cdn/{RQWCWTBL.js → QXKCR6PT.js} +2 -2
- package/dist/cdn/{WIUEAY5G.js → RDLMG7U6.js} +2 -2
- package/dist/cdn/{CCMGFPYF.js → RF3QXKXK.js} +2 -2
- package/dist/cdn/{XYXVKOTT.js → RGXMEXJY.js} +2 -2
- package/dist/cdn/{D6I5E3HW.js → RSZFBIDH.js} +2 -2
- package/dist/cdn/{Q5VNCT2U.js → RUY4HRAE.js} +2 -2
- package/dist/cdn/{FNANODZI.js → RXWKEZTK.js} +2 -2
- package/dist/cdn/{JTMI4NO3.js → S77UYDKU.js} +2 -2
- package/dist/cdn/{NJEPPA6M.js → S7J3G6ZY.js} +2 -2
- package/dist/cdn/{VXBXF2ON.js → SQMACEDJ.js} +2 -2
- package/dist/cdn/{ILP4AOCV.js → SSNEZ7ML.js} +2 -2
- package/dist/cdn/{CJYSSMSS.js → SSYNFIHT.js} +2 -2
- package/dist/cdn/{CS33HHUX.js → SVAO6JAV.js} +2 -2
- package/dist/cdn/{GFWEWDMW.js → SXCBIZN3.js} +2 -2
- package/dist/cdn/{XAEBSETO.js → T57UAZUE.js} +2 -2
- package/dist/cdn/{WEXK2UJJ.js → TFOB7RLD.js} +2 -2
- package/dist/cdn/{R4HFJHNR.js → TGJIMSBZ.js} +2 -2
- package/dist/cdn/{R4FJ4RCP.js → TGR67UED.js} +2 -2
- package/dist/cdn/{OYBULXX6.js → TJXDEM6Q.js} +2 -2
- package/dist/cdn/{WHYRDPN5.js → TSF2ZBCT.js} +2 -2
- package/dist/cdn/{JWQEVVGZ.js → TW6UUVYU.js} +2 -2
- package/dist/cdn/{YLRWNW7X.js → TXQJA5FF.js} +2 -2
- package/dist/cdn/{6QURPAVI.js → UCC7U6GD.js} +2 -2
- package/dist/cdn/{PU7IPEVC.js → UCJNRCKN.js} +2 -2
- package/dist/cdn/{3P2BVHC6.js → UD7ZPBG3.js} +2 -2
- package/dist/cdn/{AJKHBOTD.js → UIVEMXY2.js} +2 -2
- package/dist/cdn/{IA34IUVP.js → UOHYBZBX.js} +2 -2
- package/dist/cdn/{TQSUBIQC.js → UW5HVT3W.js} +2 -2
- package/dist/cdn/{HGEQP2TL.js → UYILCCTR.js} +2 -2
- package/dist/cdn/{HXW57RBE.js → V2R2GXZL.js} +2 -2
- package/dist/cdn/{EBFLVUJY.js → VAABAGMS.js} +2 -2
- package/dist/cdn/{FTHE2RYA.js → VE52ZFSD.js} +2 -2
- package/dist/cdn/{HHSXULY6.js → VLRB2BHD.js} +2 -2
- package/dist/cdn/{C2TKWZJ2.js → VSIN7VHG.js} +2 -2
- package/dist/cdn/{SJX4XRUP.js → WFF4NLPZ.js} +2 -2
- package/dist/cdn/{2IQZ2FK3.js → WODQZC7Q.js} +2 -2
- package/dist/cdn/{7SK56MM3.js → WTREYBMC.js} +2 -2
- package/dist/cdn/{HZKADXO5.js → WUV2PCXK.js} +2 -2
- package/dist/cdn/{UED4VILH.js → WVV72KBU.js} +2 -2
- package/dist/cdn/{HGVCSUSN.js → X3SUAHI7.js} +2 -2
- package/dist/cdn/{LP4Y3PDP.js → X67YGVLO.js} +2 -2
- package/dist/cdn/{UB77H4DG.js → X6WGD4Y7.js} +2 -2
- package/dist/cdn/{TLNCSNUT.js → XCLMIOTU.js} +2 -2
- package/dist/cdn/{S43DULHA.js → XEBUFSBL.js} +1 -1
- package/dist/cdn/{PO4HXRP7.js → XIUV7TMN.js} +2 -2
- package/dist/cdn/{UDOE2GMZ.js → XTKUZHBD.js} +2 -2
- package/dist/cdn/{TO32A2OW.js → XVMLTYPU.js} +2 -2
- package/dist/cdn/{HRTDT4LN.js → Y3FCLFWR.js} +2 -2
- package/dist/cdn/{W27BWY6P.js → Y6JBPHYK.js} +2 -2
- package/dist/cdn/{ZYCJTXVD.js → YQ3LN2SF.js} +2 -2
- package/dist/cdn/YSDAHD65.js +4 -0
- package/dist/cdn/{SRGKUWPP.js → Z6CYQBX7.js} +2 -2
- package/dist/cdn/{DPEXKYZI.js → Z7DXXHXA.js} +1 -1
- package/dist/cdn/{LHMOWJ5W.js → ZI757KTC.js} +2 -2
- package/dist/cdn/{2UQQEQFF.js → ZPJDWRO3.js} +2 -2
- package/dist/cdn/{ONMF6LA2.js → ZVY6BTWD.js} +2 -2
- package/dist/cdn/{QMLLIJ6R.js → ZW4YFKUP.js} +2 -2
- package/dist/cdn/index.js +2 -2
- package/dist/chunks/AnalysisViewModel.js +1 -1
- package/dist/chunks/action-utils.js +1 -1
- package/dist/chunks/async-utils.js +1 -1
- package/dist/chunks/basemap-gallery-resources.js +1 -1
- package/dist/chunks/building-layer-utils.js +1 -1
- package/dist/chunks/chart-utils.js +1 -1
- package/dist/chunks/chartCommon.js +1 -1
- package/dist/chunks/component-utils.js +1 -1
- package/dist/chunks/component-wrapper.js +1 -1
- package/dist/chunks/constants.js +1 -1
- package/dist/chunks/createCloseEvent.js +1 -1
- package/dist/chunks/esri-main.js +1 -1
- package/dist/chunks/feature-utils.js +1 -1
- package/dist/chunks/globalCss.js +1 -1
- package/dist/chunks/handle.js +1 -1
- package/dist/chunks/heading.js +1 -1
- package/dist/chunks/layer-list.js +1 -1
- package/dist/chunks/legacyIcon.js +1 -1
- package/dist/chunks/maybe.js +1 -1
- package/dist/chunks/measurementUtils.js +1 -1
- package/dist/chunks/runtime.js +1 -1
- package/dist/chunks/screenLocation.js +1 -1
- package/dist/chunks/slots.js +1 -1
- package/dist/chunks/svgUtils.js +1 -1
- package/dist/chunks/time-utils.js +1 -1
- package/dist/chunks/univariateUtils.js +1 -1
- package/dist/chunks/useArcgisViewReadyError.js +1 -1
- package/dist/chunks/useHandles.js +1 -1
- package/dist/chunks/useT9n.js +1 -1
- package/dist/chunks/useView.js +1 -1
- package/dist/chunks/useViewModel.js +1 -1
- package/dist/chunks/useWidget.js +1 -1
- package/dist/chunks/utils.js +1 -1
- package/dist/chunks/utils2.js +1 -1
- package/dist/chunks/visible-element.js +1 -1
- package/dist/components/arcgis-area-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-area-measurement-3d/customElement.js +1 -1
- package/dist/components/arcgis-attachments/customElement.js +1 -1
- package/dist/components/arcgis-basemap-gallery/customElement.js +1 -1
- package/dist/components/arcgis-basemap-gallery-item/customElement.js +1 -1
- package/dist/components/arcgis-basemap-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-basemap-toggle/customElement.js +1 -1
- package/dist/components/arcgis-bookmarks/customElement.js +1 -1
- package/dist/components/arcgis-building-discipline-tree/customElement.js +1 -1
- package/dist/components/arcgis-building-explorer/customElement.js +1 -1
- package/dist/components/arcgis-building-level-item/customElement.js +1 -1
- package/dist/components/arcgis-building-level-picker/customElement.js +1 -1
- package/dist/components/arcgis-building-phase-picker/customElement.js +1 -1
- package/dist/components/arcgis-catalog-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-color-select/customElement.js +1 -1
- package/dist/components/arcgis-compass/customElement.js +1 -1
- package/dist/components/arcgis-coordinate-conversion/customElement.js +1 -1
- package/dist/components/arcgis-daylight/customElement.js +1 -1
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.js +1 -1
- package/dist/components/arcgis-directional-pad/customElement.js +1 -1
- package/dist/components/arcgis-directions/customElement.js +1 -1
- package/dist/components/arcgis-distance-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-editor/customElement.js +1 -1
- package/dist/components/arcgis-elevation-profile/customElement.d.ts +32 -10
- package/dist/components/arcgis-elevation-profile/customElement.js +3 -3
- package/dist/components/arcgis-elevation-profile-legend/customElement.js +1 -1
- package/dist/components/arcgis-elevation-profile-legend-item/customElement.js +1 -1
- package/dist/components/arcgis-elevation-profile-settings/customElement.js +1 -1
- package/dist/components/arcgis-elevation-profile-statistics/customElement.js +1 -1
- package/dist/components/arcgis-expand/customElement.js +1 -1
- package/dist/components/arcgis-feature/customElement.js +1 -1
- package/dist/components/arcgis-feature-attachments/customElement.js +1 -1
- package/dist/components/arcgis-feature-content/customElement.js +1 -1
- package/dist/components/arcgis-feature-element-info/customElement.js +1 -1
- package/dist/components/arcgis-feature-expression/customElement.js +1 -1
- package/dist/components/arcgis-feature-fields/customElement.js +1 -1
- package/dist/components/arcgis-feature-form/customElement.js +1 -1
- package/dist/components/arcgis-feature-media/customElement.js +1 -1
- package/dist/components/arcgis-feature-relationship/customElement.js +1 -1
- package/dist/components/arcgis-feature-table/customElement.js +1 -1
- package/dist/components/arcgis-feature-templates/customElement.js +1 -1
- package/dist/components/arcgis-feature-utility-network-association-list/customElement.js +1 -1
- package/dist/components/arcgis-feature-utility-network-associations/customElement.js +2 -2
- package/dist/components/arcgis-features/customElement.js +1 -1
- package/dist/components/arcgis-floor-filter/customElement.js +1 -1
- package/dist/components/arcgis-fullscreen/customElement.js +1 -1
- package/dist/components/arcgis-grid-controls/customElement.js +1 -1
- package/dist/components/arcgis-histogram-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-home/customElement.js +1 -1
- package/dist/components/arcgis-labeled-switch/customElement.js +1 -1
- package/dist/components/arcgis-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-layer-list-item/customElement.js +1 -1
- package/dist/components/arcgis-legend/customElement.js +1 -1
- package/dist/components/arcgis-legend-card-color-ramp/customElement.js +1 -1
- package/dist/components/arcgis-legend-card-element/customElement.js +1 -1
- package/dist/components/arcgis-legend-card-size-ramp/customElement.js +1 -1
- package/dist/components/arcgis-legend-card-univariate-above-and-below-ramp/customElement.js +1 -1
- package/dist/components/arcgis-legend-card-univariate-color-size-ramp/customElement.js +1 -1
- package/dist/components/arcgis-legend-card-view/customElement.js +1 -1
- package/dist/components/arcgis-legend-classic-color-ramp/customElement.js +1 -1
- package/dist/components/arcgis-legend-classic-element/customElement.js +1 -1
- package/dist/components/arcgis-legend-classic-size-ramp/customElement.js +1 -1
- package/dist/components/arcgis-legend-classic-univariate-above-and-below-ramp/customElement.js +1 -1
- package/dist/components/arcgis-legend-classic-univariate-color-size-ramp/customElement.js +1 -1
- package/dist/components/arcgis-legend-classic-view/customElement.js +1 -1
- package/dist/components/arcgis-legend-relationship-ramp/customElement.js +1 -1
- package/dist/components/arcgis-legend-spike-ramp/customElement.js +1 -1
- package/dist/components/arcgis-line-of-sight/customElement.js +1 -1
- package/dist/components/arcgis-link-chart/customElement.js +1 -1
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.js +1 -1
- package/dist/components/arcgis-locate/customElement.js +1 -1
- package/dist/components/arcgis-map/customElement.js +1 -1
- package/dist/components/arcgis-measurement/customElement.js +1 -1
- package/dist/components/arcgis-measurement-content/customElement.js +1 -1
- package/dist/components/arcgis-navigation-toggle/customElement.js +1 -1
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.js +1 -1
- package/dist/components/arcgis-popup/customElement.js +1 -1
- package/dist/components/arcgis-presentation/customElement.js +1 -1
- package/dist/components/arcgis-print/customElement.js +1 -1
- package/dist/components/arcgis-print-custom-text-elements/customElement.js +1 -1
- package/dist/components/arcgis-print-dpi-input/customElement.js +1 -1
- package/dist/components/arcgis-print-export-button/customElement.js +1 -1
- package/dist/components/arcgis-print-exports-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-format-select/customElement.js +1 -1
- package/dist/components/arcgis-print-layout-advanced-options/customElement.js +1 -1
- package/dist/components/arcgis-print-layout-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-main-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-map-only-advanced-options/customElement.js +1 -1
- package/dist/components/arcgis-print-map-only-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-out-spatial-reference-input/customElement.js +1 -1
- package/dist/components/arcgis-print-preview-input/customElement.js +1 -1
- package/dist/components/arcgis-print-scale-section/customElement.js +1 -1
- package/dist/components/arcgis-print-template-select/customElement.js +1 -1
- package/dist/components/arcgis-print-template-selector/customElement.js +1 -1
- package/dist/components/arcgis-scale-bar/customElement.js +1 -1
- package/dist/components/arcgis-scale-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-scene/customElement.d.ts +1 -0
- package/dist/components/arcgis-scene/customElement.js +1 -1
- package/dist/components/arcgis-search/customElement.js +1 -1
- package/dist/components/arcgis-search-result-renderer/customElement.js +1 -1
- package/dist/components/arcgis-shadow-cast/customElement.js +1 -1
- package/dist/components/arcgis-shadow-cast-discrete-config/customElement.js +1 -1
- package/dist/components/arcgis-shadow-cast-min-duration-config/customElement.js +1 -1
- package/dist/components/arcgis-shadow-cast-total-duration-config/customElement.js +1 -1
- package/dist/components/arcgis-sketch/customElement.js +1 -1
- package/dist/components/arcgis-slice/customElement.js +1 -1
- package/dist/components/arcgis-spinner/customElement.js +1 -1
- package/dist/components/arcgis-swipe/customElement.js +1 -1
- package/dist/components/arcgis-table-list/customElement.js +1 -1
- package/dist/components/arcgis-time-slider/customElement.js +1 -1
- package/dist/components/arcgis-time-zone-label/customElement.js +1 -1
- package/dist/components/arcgis-track/customElement.js +1 -1
- package/dist/components/arcgis-unit-select/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-association-list/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-associations/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-subnetwork-info/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-trace/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-trace-analysis/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-trace-inputs/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-trace-location/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-trace-location-list/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-trace-results/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-validate-topology/customElement.js +1 -1
- package/dist/components/arcgis-value-picker/customElement.js +1 -1
- package/dist/components/arcgis-version-management/customElement.js +1 -1
- package/dist/components/arcgis-version-management-service-item/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-list/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-properties/customElement.js +1 -1
- package/dist/components/arcgis-video/customElement.js +1 -1
- package/dist/components/arcgis-video-player/customElement.js +1 -1
- package/dist/components/arcgis-video-player-action-bar/customElement.js +1 -1
- package/dist/components/arcgis-video-player-actions-group/customElement.js +1 -1
- package/dist/components/arcgis-video-player-controls-group/customElement.js +1 -1
- package/dist/components/arcgis-video-player-metadata/customElement.js +1 -1
- package/dist/components/arcgis-video-player-settings/customElement.js +1 -1
- package/dist/components/arcgis-video-player-slider/customElement.js +1 -1
- package/dist/components/arcgis-volume-measurement/customElement.js +1 -1
- package/dist/components/arcgis-weather/customElement.js +1 -1
- package/dist/components/arcgis-webgl-error/customElement.js +1 -1
- package/dist/components/arcgis-zoom/customElement.js +1 -1
- package/dist/docs/api.json +21842 -21629
- package/dist/docs/docs.json +2114 -2069
- package/dist/docs/vscode.html-custom-data.json +74 -74
- package/dist/docs/web-types.json +76 -81
- package/dist/index.d.ts +74 -74
- package/dist/index.js +1 -1
- package/dist/loader.js +2 -2
- package/dist/types/components.d.ts +1 -0
- package/dist/types/lumina.d.ts +75 -75
- package/dist/types/preact.d.ts +75 -75
- package/dist/types/react.d.ts +75 -75
- package/dist/types/stencil.d.ts +75 -75
- package/package.json +4 -4
- package/dist/cdn/FQAYAGAH.js +0 -4
- package/dist/cdn/GVFGS7G2.js +0 -4
- package/dist/cdn/IHXAE3U5.js +0 -4
- package/dist/cdn/M5KX7OCE.js +0 -4
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"tags": [
|
|
5
5
|
{
|
|
6
6
|
"name": "arcgis-area-measurement-2d",
|
|
7
|
-
"description": "The Area Measurement 2D component can be added to a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent to calculate and display the area and perimeter of a polygon.\n\nHow areas and perimeters are computed depends on the map's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, areas and perimeters are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, areas and perimeters are computed in a Euclidean manner (in their respective PCS).\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<
|
|
7
|
+
"description": "The Area Measurement 2D component can be added to a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent to calculate and display the area and perimeter of a polygon.\n\nHow areas and perimeters are computed depends on the map's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, areas and perimeters are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, areas and perimeters are computed in a Euclidean manner (in their respective PCS).\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<this>` - 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",
|
|
@@ -115,7 +115,7 @@
|
|
|
115
115
|
},
|
|
116
116
|
{
|
|
117
117
|
"name": "arcgis-area-measurement-3d",
|
|
118
|
-
"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<
|
|
118
|
+
"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<this>` - 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.",
|
|
119
119
|
"attributes": [
|
|
120
120
|
{
|
|
121
121
|
"name": "auto-destroy-disabled",
|
|
@@ -223,7 +223,7 @@
|
|
|
223
223
|
},
|
|
224
224
|
{
|
|
225
225
|
"name": "arcgis-attachments",
|
|
226
|
-
"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<
|
|
226
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
227
227
|
"attributes": [
|
|
228
228
|
{
|
|
229
229
|
"name": "auto-destroy-disabled",
|
|
@@ -320,7 +320,7 @@
|
|
|
320
320
|
},
|
|
321
321
|
{
|
|
322
322
|
"name": "arcgis-basemap-gallery",
|
|
323
|
-
"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<
|
|
323
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
324
324
|
"attributes": [
|
|
325
325
|
{
|
|
326
326
|
"name": "active-basemap",
|
|
@@ -408,7 +408,7 @@
|
|
|
408
408
|
},
|
|
409
409
|
{
|
|
410
410
|
"name": "arcgis-basemap-layer-list",
|
|
411
|
-
"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<
|
|
411
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
412
412
|
"attributes": [
|
|
413
413
|
{
|
|
414
414
|
"name": "auto-destroy-disabled",
|
|
@@ -608,7 +608,7 @@
|
|
|
608
608
|
},
|
|
609
609
|
{
|
|
610
610
|
"name": "arcgis-basemap-toggle",
|
|
611
|
-
"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<
|
|
611
|
+
"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<this>` - 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).",
|
|
612
612
|
"attributes": [
|
|
613
613
|
{
|
|
614
614
|
"name": "auto-destroy-disabled",
|
|
@@ -672,7 +672,7 @@
|
|
|
672
672
|
},
|
|
673
673
|
{
|
|
674
674
|
"name": "arcgis-bookmarks",
|
|
675
|
-
"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** - Fires 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- **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\n### Methods\n- `componentOnReady(): Promise<
|
|
675
|
+
"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** - Fires 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- **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\n### Methods\n- `componentOnReady(): Promise<this>` - 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.",
|
|
676
676
|
"attributes": [
|
|
677
677
|
{
|
|
678
678
|
"name": "auto-destroy-disabled",
|
|
@@ -814,7 +814,7 @@
|
|
|
814
814
|
},
|
|
815
815
|
{
|
|
816
816
|
"name": "arcgis-building-explorer",
|
|
817
|
-
"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- **arcgisBuildingLevelChange** - Emitted when the user changes the selected building level, or when a new filter instance is loaded.\n- **arcgisBuildingPhaseChange** - Emitted when the user changes the selected construction phase, or when a new filter instance is loaded.\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<
|
|
817
|
+
"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- **arcgisBuildingLevelChange** - Emitted when the user changes the selected building level, or when a new filter instance is loaded.\n- **arcgisBuildingPhaseChange** - Emitted when the user changes the selected construction phase, or when a new filter instance is loaded.\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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
818
818
|
"attributes": [
|
|
819
819
|
{
|
|
820
820
|
"name": "auto-destroy-disabled",
|
|
@@ -901,7 +901,7 @@
|
|
|
901
901
|
},
|
|
902
902
|
{
|
|
903
903
|
"name": "arcgis-building-level-item",
|
|
904
|
-
"description": "### Events\n- **arcgisTileBlur**\n- **arcgisTileFocus**\n- **arcgisTileSelect**\n\n### Methods\n- `componentOnReady(): Promise<
|
|
904
|
+
"description": "### Events\n- **arcgisTileBlur**\n- **arcgisTileFocus**\n- **arcgisTileSelect**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.",
|
|
905
905
|
"attributes": [
|
|
906
906
|
{
|
|
907
907
|
"name": "active",
|
|
@@ -939,7 +939,7 @@
|
|
|
939
939
|
},
|
|
940
940
|
{
|
|
941
941
|
"name": "arcgis-catalog-layer-list",
|
|
942
|
-
"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<
|
|
942
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
943
943
|
"attributes": [
|
|
944
944
|
{
|
|
945
945
|
"name": "auto-destroy-disabled",
|
|
@@ -1104,7 +1104,7 @@
|
|
|
1104
1104
|
},
|
|
1105
1105
|
{
|
|
1106
1106
|
"name": "arcgis-compass",
|
|
1107
|
-
"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<
|
|
1107
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>`\n- `reset(): Promise<void>`",
|
|
1108
1108
|
"attributes": [
|
|
1109
1109
|
{
|
|
1110
1110
|
"name": "auto-destroy-disabled",
|
|
@@ -1165,7 +1165,7 @@
|
|
|
1165
1165
|
},
|
|
1166
1166
|
{
|
|
1167
1167
|
"name": "arcgis-coordinate-conversion",
|
|
1168
|
-
"description": "The Coordinate Conversion component provides a way to display user cursor position either as map coordinates or\nas any of several popular coordinate notations. Additionally, the component provides a way to convert\nuser input coordinates into a [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n\n\nSeveral common formats are included by default:\n* XY - Longitude, Latitude (WGS84)\n* MGRS - [Military Grid Reference System](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#mgrs)\n* UTM - [Universal Transverse Mercator](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#utm)\n* DD - Decimal Degrees\n* DDM - Degrees Decimal Minutes\n* DMS - Degrees Minutes Seconds\n* Basemap - X, Y in the coordinate system used by the current basemap in the units used by the basemap.\nWeb Mercator is the standard for Esri-provided basemaps.\n\nAdditional formats can be created by a developer and made available\nthrough the component\n--\n\n### Events\n- **arcgisConversionChange** - Emitted when a conversion is added or removed, or when the order of conversions changes.\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<
|
|
1168
|
+
"description": "The Coordinate Conversion component provides a way to display user cursor position either as map coordinates or\nas any of several popular coordinate notations. Additionally, the component provides a way to convert\nuser input coordinates into a [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n\n\nSeveral common formats are included by default:\n* XY - Longitude, Latitude (WGS84)\n* MGRS - [Military Grid Reference System](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#mgrs)\n* UTM - [Universal Transverse Mercator](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#utm)\n* DD - Decimal Degrees\n* DDM - Degrees Decimal Minutes\n* DMS - Degrees Minutes Seconds\n* Basemap - X, Y in the coordinate system used by the current basemap in the units used by the basemap.\nWeb Mercator is the standard for Esri-provided basemaps.\n\nAdditional formats can be created by a developer and made available\nthrough the component\n--\n\n### Events\n- **arcgisConversionChange** - Emitted when a conversion is added or removed, or when the order of conversions changes.\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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `reverseConvert(coordinate: string, format: Format): Promise<__esri.Point | nullish>` - Attempt to convert a string into a [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html). The format of the\nstring must be specified. A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of available formats can be\nobtained from the [formats](#formats) property.",
|
|
1169
1169
|
"attributes": [
|
|
1170
1170
|
{
|
|
1171
1171
|
"name": "auto-destroy-disabled",
|
|
@@ -1309,7 +1309,7 @@
|
|
|
1309
1309
|
},
|
|
1310
1310
|
{
|
|
1311
1311
|
"name": "arcgis-daylight",
|
|
1312
|
-
"description": "The Daylight component can be used to manipulate the lighting conditions of a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nTo achieve this, the component modifies the `lighting` property of the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) of the Scene component.\n\nTo illuminate the scene, one can either use a configuration of date and time to position the\n[sun](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) or switch to the\n[virtual](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html) mode,\nwhere the light source is relative to the camera.\n\nWhen illuminating the scene with **[sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)**\nand adjusting the time and date, the positions of the sun and stars are updated accordingly. This also updates the\n[date](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#date) property of\n[environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n\nThe component has an option to select the timezone. When the user makes any adjustments here, a new time\nin the chosen timezone is calculated and displayed in the slider. The timezone selector can be disabled\nby using the [hideTimezone](#hideTimezone) property.\n\nBy default, a calendar is displayed to select the day, month, and year.\nWith the [dateOrSeason](#dateOrSeason) property, the calendar can be replaced with\na dropdown menu where a season can be selected instead:\n\n\n\nThere are two play buttons: one corresponds to the time-of-day slider and animates the lighting\nover the course of a day, while the other corresponds to the date picker\nand animates the lighting over the course of a year (month by month). The speed of the time-of-day animation can\nbe set using the [playSpeedMultiplier](#playSpeedMultiplier) property.\n\n\n\nExcept for the daytime slider, all the elements in the Daylight component can be hidden:\n\n\n\nWhenever the sun position option is unchecked, the scene applies the\n**[virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)** source relative to the camera.\nWith this, the component's time slider, timezone, and date picker get automatically disabled:\n\n\n\n**Things to consider**\n\n* Daylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* The Daylight component uses UTC time and does not account for the daylight savings times in different countries and regions of the world.\n* When using the [virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html),\nsetting the time and date programmatically does not have an influence on the lighting conditions of the scene.\n* When using the [sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html),\nthe time slider and time zone automatically react to the changes of the camera (e.g., position, rotation, pan, zoom) because the position of the simulated sun\nis updated to maintain a consistent solar time of day based on the camera's current longitude. This can be adjusted using the\n[cameraTrackingEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#cameraTrackingEnabled)\nproperty on [environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\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<
|
|
1312
|
+
"description": "The Daylight component can be used to manipulate the lighting conditions of a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nTo achieve this, the component modifies the `lighting` property of the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) of the Scene component.\n\nTo illuminate the scene, one can either use a configuration of date and time to position the\n[sun](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html) or switch to the\n[virtual](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html) mode,\nwhere the light source is relative to the camera.\n\nWhen illuminating the scene with **[sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)**\nand adjusting the time and date, the positions of the sun and stars are updated accordingly. This also updates the\n[date](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#date) property of\n[environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n\nThe component has an option to select the timezone. When the user makes any adjustments here, a new time\nin the chosen timezone is calculated and displayed in the slider. The timezone selector can be disabled\nby using the [hideTimezone](#hideTimezone) property.\n\nBy default, a calendar is displayed to select the day, month, and year.\nWith the [dateOrSeason](#dateOrSeason) property, the calendar can be replaced with\na dropdown menu where a season can be selected instead:\n\n\n\nThere are two play buttons: one corresponds to the time-of-day slider and animates the lighting\nover the course of a day, while the other corresponds to the date picker\nand animates the lighting over the course of a year (month by month). The speed of the time-of-day animation can\nbe set using the [playSpeedMultiplier](#playSpeedMultiplier) property.\n\n\n\nExcept for the daytime slider, all the elements in the Daylight component can be hidden:\n\n\n\nWhenever the sun position option is unchecked, the scene applies the\n**[virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)** source relative to the camera.\nWith this, the component's time slider, timezone, and date picker get automatically disabled:\n\n\n\n**Things to consider**\n\n* Daylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* The Daylight component uses UTC time and does not account for the daylight savings times in different countries and regions of the world.\n* When using the [virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html),\nsetting the time and date programmatically does not have an influence on the lighting conditions of the scene.\n* When using the [sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html),\nthe time slider and time zone automatically react to the changes of the camera (e.g., position, rotation, pan, zoom) because the position of the simulated sun\nis updated to maintain a consistent solar time of day based on the camera's current longitude. This can be adjusted using the\n[cameraTrackingEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html#cameraTrackingEnabled)\nproperty on [environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
1313
1313
|
"attributes": [
|
|
1314
1314
|
{
|
|
1315
1315
|
"name": "auto-destroy-disabled",
|
|
@@ -1453,7 +1453,7 @@
|
|
|
1453
1453
|
},
|
|
1454
1454
|
{
|
|
1455
1455
|
"name": "arcgis-directional-pad",
|
|
1456
|
-
"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<
|
|
1456
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
1457
1457
|
"attributes": [
|
|
1458
1458
|
{
|
|
1459
1459
|
"name": "auto-destroy-disabled",
|
|
@@ -1539,7 +1539,7 @@
|
|
|
1539
1539
|
},
|
|
1540
1540
|
{
|
|
1541
1541
|
"name": "arcgis-directions",
|
|
1542
|
-
"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<
|
|
1542
|
+
"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<this>` - 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>`",
|
|
1543
1543
|
"attributes": [
|
|
1544
1544
|
{
|
|
1545
1545
|
"name": "api-key",
|
|
@@ -1696,7 +1696,7 @@
|
|
|
1696
1696
|
},
|
|
1697
1697
|
{
|
|
1698
1698
|
"name": "arcgis-direct-line-measurement-3d",
|
|
1699
|
-
"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<
|
|
1699
|
+
"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<this>` - 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.",
|
|
1700
1700
|
"attributes": [
|
|
1701
1701
|
{
|
|
1702
1702
|
"name": "auto-destroy-disabled",
|
|
@@ -1795,7 +1795,7 @@
|
|
|
1795
1795
|
},
|
|
1796
1796
|
{
|
|
1797
1797
|
"name": "arcgis-distance-measurement-2d",
|
|
1798
|
-
"description": "The Distance Measurement 2D component can be added to a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent to calculate and display the length of a polyline.\n\nHow distances are computed depends on the scene's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, lengths are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, lengths are computed in a Euclidean manner (in their respective PCS).\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<
|
|
1798
|
+
"description": "The Distance Measurement 2D component can be added to a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent to calculate and display the length of a polyline.\n\nHow distances are computed depends on the scene's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, lengths are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, lengths are computed in a Euclidean manner (in their respective PCS).\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<this>` - 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.",
|
|
1799
1799
|
"attributes": [
|
|
1800
1800
|
{
|
|
1801
1801
|
"name": "auto-destroy-disabled",
|
|
@@ -1897,7 +1897,7 @@
|
|
|
1897
1897
|
},
|
|
1898
1898
|
{
|
|
1899
1899
|
"name": "arcgis-editor",
|
|
1900
|
-
"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- **arcgisSketchCreate** - Fires when a user starts drawing a feature, is actively drawing a feature, and completes drawing a feature.\n- **arcgisSketchUpdate** - Fires when a user starts updating a feature's geometry, is actively updating a feature's geometry, and completes updating a feature's geometry.\n\n### Methods\n- `cancelWorkflow(): Promise<void>`\n- `componentOnReady(): Promise<
|
|
1900
|
+
"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- **arcgisSketchCreate** - Fires when a user starts drawing a feature, is actively drawing a feature, and completes drawing a feature.\n- **arcgisSketchUpdate** - Fires when a user starts updating a feature's geometry, is actively updating a feature's geometry, and completes updating a feature's geometry.\n\n### Methods\n- `cancelWorkflow(): Promise<void>`\n- `componentOnReady(): Promise<this>` - 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>`",
|
|
1901
1901
|
"attributes": [
|
|
1902
1902
|
{
|
|
1903
1903
|
"name": "auto-destroy-disabled",
|
|
@@ -2095,7 +2095,7 @@
|
|
|
2095
2095
|
},
|
|
2096
2096
|
{
|
|
2097
2097
|
"name": "arcgis-elevation-profile",
|
|
2098
|
-
"description": "The Elevation Profile component manages an [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html) and displays its elevation profiles.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n\nThe component can visualize multiple profile lines, depending on whether it is used in a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) component or a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component and on the available elevation source data:\n\n* [**ElevationProfileLineGround**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineGround.html): represents a profile line that uses elevation from [Map.ground](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#ground) of the connected Map or Scene component. The profile recomputes automatically when ground layers are added, removed, or their visibility changes.\n* [**ElevationProfileLineInput**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineInput.html): represents a profile line that reads elevation from the analysis geometry itself; typically used for polylines with z values. If the line lacks z values but is displayed with a non-draped elevation mode, a profile is still computed. If `elevationInfo` is set to `on-the-ground`, elevation comes from the Ground (when ground layers are present). An elevation offset can be applied. In a Map this requires client-side graphics that already contain z values.\n* [**ElevationProfileLineQuery**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html): represents a profile line that samples elevation from the elevation source set in the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html#source) property. The elevation source can be an [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) or ant object with a method called `queryElevation` that has the same signature as [queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation).\n* [**ElevationProfileLineScene**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineScene.html): represents a profile line that derives elevation from the `Scene` and all its volumetric objects (e.g. SceneLayer, IntegratedMeshLayer).\n\nYou can choose to display one or several profile lines in the chart, by setting them in the [profiles](#profiles) property.\n\nHovering over the chart shows an overlaid tooltip with elevation values of all profiles, and displays colored dot markers at the matching positions.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n\nCheckboxes in the legend allow hiding individual profiles. Chart units can be set via the settings menu to metric, imperial or a specific unit.\n\nScrolling the chart zooms in to a specific part of the profile chart. When zoomed in, click the minus button to reset the zoom. On touch devices, pinch to zoom in and out.\n\nHow distance values are computed depends on the map's spatial reference:\n\n* In geographic coordinate systems (GCS) and in Web Mercator, distances are computed geodetically.\n* In projected coordinate systems (PCS), apart from Web Mercator, distances are computed in a Euclidean manner (in their respective PCS).\n\n**Known limitations**\n\n- [ElevationProfileLineInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineInput.html) in 2D is only valid when the analysis [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#geometry) has z values, `hasZ===true` and no [elevationInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#elevationInfo) is set.\n- [ElevationProfileLineScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineScene.html) 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- [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html)\n- [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n- [Sample - Elevation Profile analysis](https://developers.arcgis.com/javascript/latest/sample-code/analysis-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- `clear(): Promise<void>` - Clear the current elevation profile. If an interactive operation is in progress, it will also be stopped.\n- `componentOnReady(): Promise<
|
|
2098
|
+
"description": "The Elevation Profile component manages an [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html) and displays its elevation profiles.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n\nThe component can visualize multiple profile lines, depending on whether it is used in a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) component or a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component and on the available elevation source data:\n\n* [**ElevationProfileLineGround**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineGround.html): represents a profile line that uses elevation from [Map.ground](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#ground) of the connected Map or Scene component. The profile recomputes automatically when ground layers are added, removed, or their visibility changes.\n* [**ElevationProfileLineInput**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineInput.html): represents a profile line that reads elevation from the analysis geometry itself; typically used for polylines with z values. If the line lacks z values but is displayed with a non-draped elevation mode, a profile is still computed. If `elevationInfo` is set to `on-the-ground`, elevation comes from the Ground (when ground layers are present). An elevation offset can be applied. In a Map this requires client-side graphics that already contain z values.\n* [**ElevationProfileLineQuery**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html): represents a profile line that samples elevation from the elevation source set in the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html#source) property. The elevation source can be an [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) or ant object with a method called `queryElevation` that has the same signature as [queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation).\n* [**ElevationProfileLineScene**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineScene.html): represents a profile line that derives elevation from the `Scene` and all its volumetric objects (e.g. SceneLayer, IntegratedMeshLayer).\n\nYou can choose to display one or several profile lines in the chart, by setting them in the [profiles](#profiles) property.\n\nHovering over the chart shows an overlaid tooltip with elevation values of all profiles, and displays colored dot markers at the matching positions.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n\nCheckboxes in the legend allow hiding individual profiles. Chart units can be set via the settings menu to metric, imperial or a specific unit.\n\nScrolling the chart zooms in to a specific part of the profile chart. When zoomed in, click the minus button to reset the zoom. On touch devices, pinch to zoom in and out.\n\nHow distance values are computed depends on the map's spatial reference:\n\n* In geographic coordinate systems (GCS) and in Web Mercator, distances are computed geodetically.\n* In projected coordinate systems (PCS), apart from Web Mercator, distances are computed in a Euclidean manner (in their respective PCS).\n\n**Known limitations**\n\n- [ElevationProfileLineInput](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineInput.html) in 2D is only valid when the analysis [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#geometry) has z values, `hasZ===true` and no [elevationInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#elevationInfo) is set.\n- [ElevationProfileLineScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineScene.html) 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- [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html)\n- [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n- [Sample - Elevation Profile analysis](https://developers.arcgis.com/javascript/latest/sample-code/analysis-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- `clear(): Promise<void>` - Clear the current elevation profile. If an interactive operation is in progress, it will also be stopped.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `select(): Promise<void>` - Start an interactive operation to pick an existing polyline feature in the view to use as the input for the\nelevation profile. The operation ends when the user presses the <kbd>Escape</kbd> key.\nTo programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#stop) method.\n- `start(): Promise<void>` - Start an interactive operation that lets the user sketch a new path in the view along which the elevation profile\nwill be generated. The operation completes when the user double-clicks, presses the <kbd>Escape</kbd> key or clicks\nthe Done button in the UI.\nTo programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#stop) method.\n- `stop(): Promise<void>` - Stop any ongoing interactive operation (for example, selecting or sketching a profile line). This can be used to\nprogrammatically cancel operations started by [start()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#start) or\n[select()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#select).",
|
|
2099
2099
|
"attributes": [
|
|
2100
2100
|
{
|
|
2101
2101
|
"name": "auto-destroy-disabled",
|
|
@@ -2295,7 +2295,7 @@
|
|
|
2295
2295
|
},
|
|
2296
2296
|
{
|
|
2297
2297
|
"name": "arcgis-expand",
|
|
2298
|
-
"description": "Expand acts as a clickable button for displaying interactive content, most commonly other components.\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- `collapse(): Promise<void>` - Collapse the component.\n- `componentOnReady(): Promise<
|
|
2298
|
+
"description": "Expand acts as a clickable button for displaying interactive content, most commonly other components.\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- `collapse(): Promise<void>` - Collapse the component.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `expand(): Promise<void>` - Expand the component.",
|
|
2299
2299
|
"attributes": [
|
|
2300
2300
|
{
|
|
2301
2301
|
"name": "auto-collapse",
|
|
@@ -2481,7 +2481,7 @@
|
|
|
2481
2481
|
},
|
|
2482
2482
|
{
|
|
2483
2483
|
"name": "arcgis-feature",
|
|
2484
|
-
"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 [arcgis-features](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<
|
|
2484
|
+
"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 [arcgis-features](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<this>` - 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.\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- `updateGeometry(): Promise<void>` - Updates the geometry of the graphic.",
|
|
2485
2485
|
"attributes": [
|
|
2486
2486
|
{
|
|
2487
2487
|
"name": "auto-destroy-disabled",
|
|
@@ -2629,7 +2629,7 @@
|
|
|
2629
2629
|
},
|
|
2630
2630
|
{
|
|
2631
2631
|
"name": "arcgis-feature-form",
|
|
2632
|
-
"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** - Fires when the [submit()](#submit) method is called.\n- **arcgisValueChange** - Fires when a field value is updated.\n\n### Methods\n- `componentOnReady(): Promise<
|
|
2632
|
+
"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** - Fires when the [submit()](#submit) method is called.\n- **arcgisValueChange** - Fires when a field value is updated.\n\n### Methods\n- `componentOnReady(): Promise<this>` - 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.",
|
|
2633
2633
|
"attributes": [
|
|
2634
2634
|
{
|
|
2635
2635
|
"name": "auto-destroy-disabled",
|
|
@@ -2731,7 +2731,7 @@
|
|
|
2731
2731
|
},
|
|
2732
2732
|
{
|
|
2733
2733
|
"name": "arcgis-feature-table",
|
|
2734
|
-
"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<
|
|
2734
|
+
"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<this>` - 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>`",
|
|
2735
2735
|
"attributes": [
|
|
2736
2736
|
{
|
|
2737
2737
|
"name": "attachments-enabled",
|
|
@@ -3045,7 +3045,7 @@
|
|
|
3045
3045
|
},
|
|
3046
3046
|
{
|
|
3047
3047
|
"name": "arcgis-feature-templates",
|
|
3048
|
-
"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<
|
|
3048
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
3049
3049
|
"attributes": [
|
|
3050
3050
|
{
|
|
3051
3051
|
"name": "auto-destroy-disabled",
|
|
@@ -3153,7 +3153,7 @@
|
|
|
3153
3153
|
},
|
|
3154
3154
|
{
|
|
3155
3155
|
"name": "arcgis-features",
|
|
3156
|
-
"description": "The Features component allows users to view a feature's popupTemplate content such as attributes,\nactions, related records, etc., without having to be tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThis component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component,\nhowever unlike Popup, the Features component can be placed outside of the map or scene component.\nFor example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/),\nthe [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) opens within the map whether it is docked\nor anchored to the selected feature.\nWith the Features component, the same information that Popup provides is shown in a separate container from the map, such as\na HTML div within a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\nIf multiple features are passed into the Features component, the component provides buttons to page though the features and a feature menu that allows the\nlist of features to be displayed so the user can choose which feature content to display in the component. The component also respects\nfeature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate).\n\nThe Features component should be used if needing to use the Popup functionality outside of the map or scene component. If wanting to show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature/) component.\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** - Fires after the user clicks on an action in the Features component.\nThis event may be used to define a custom function to execute when particular actions are clicked.\n\n### Methods\n- `clear(): Promise<void>` - Removes [promises](#promises), [features](#features), [content](#content), and\n[heading](#heading) from the Features component.\n- `close(): Promise<void>` - A convenience method to close the component.\n- `componentOnReady(): Promise<
|
|
3156
|
+
"description": "The Features component allows users to view a feature's popupTemplate content such as attributes,\nactions, related records, etc., without having to be tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThis component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component,\nhowever unlike Popup, the Features component can be placed outside of the map or scene component.\nFor example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/),\nthe [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) opens within the map whether it is docked\nor anchored to the selected feature.\nWith the Features component, the same information that Popup provides is shown in a separate container from the map, such as\na HTML div within a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\nIf multiple features are passed into the Features component, the component provides buttons to page though the features and a feature menu that allows the\nlist of features to be displayed so the user can choose which feature content to display in the component. The component also respects\nfeature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate).\n\nThe Features component should be used if needing to use the Popup functionality outside of the map or scene component. If wanting to show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature/) component.\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** - Fires after the user clicks on an action in the Features component.\nThis event may be used to define a custom function to execute when particular actions are clicked.\n\n### Methods\n- `clear(): Promise<void>` - Removes [promises](#promises), [features](#features), [content](#content), and\n[heading](#heading) from the Features component.\n- `close(): Promise<void>` - A convenience method to close the component.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `fetchFeatures(screenPoint: __esri.ScreenPoint, 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](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nin the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). In order to use this, a layer must already have an\nassociated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). This method allows a developer to\ncontrol how the input location is handled.\n- `next(): Promise<FeaturesViewModel>` - Selects the feature at the next index in relation to the [selected feature](#selectedFeature).\n- `open(options?: __esri.FeaturesViewModelOpenOptions): Promise<void>` - Opens the Features component with content defined either explicitly with `content`\nor driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features.\n- `previous(): Promise<FeaturesViewModel>` - Selects the feature at the previous index in relation to the [selected feature](#selectedFeature).\n- `setFocus(): Promise<void>` - Use this method to give focus to the Component if the component is able to be focused.\n- `triggerAction(action: __esri.ActionButton | __esri.ActionToggle): Promise<void>` - Triggers the [`arcgisTriggerAction`](#arcgisTriggerAction) event and executes the action\nat the specified index in the [actions](#actions) array.",
|
|
3157
3157
|
"attributes": [
|
|
3158
3158
|
{
|
|
3159
3159
|
"name": "auto-destroy-disabled",
|
|
@@ -3397,7 +3397,7 @@
|
|
|
3397
3397
|
},
|
|
3398
3398
|
{
|
|
3399
3399
|
"name": "arcgis-floor-filter",
|
|
3400
|
-
"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<
|
|
3400
|
+
"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<this>` - 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>`",
|
|
3401
3401
|
"attributes": [
|
|
3402
3402
|
{
|
|
3403
3403
|
"name": "auto-destroy-disabled",
|
|
@@ -3472,7 +3472,7 @@
|
|
|
3472
3472
|
},
|
|
3473
3473
|
{
|
|
3474
3474
|
"name": "arcgis-fullscreen",
|
|
3475
|
-
"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* Fullscreen 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<
|
|
3475
|
+
"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* Fullscreen 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<this>` - Create a promise that resolves once component is fully loaded.",
|
|
3476
3476
|
"attributes": [
|
|
3477
3477
|
{
|
|
3478
3478
|
"name": "element",
|
|
@@ -3535,7 +3535,7 @@
|
|
|
3535
3535
|
},
|
|
3536
3536
|
{
|
|
3537
3537
|
"name": "arcgis-grid-controls",
|
|
3538
|
-
"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<
|
|
3538
|
+
"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<this>` - 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.",
|
|
3539
3539
|
"attributes": [
|
|
3540
3540
|
{
|
|
3541
3541
|
"name": "auto-destroy-disabled",
|
|
@@ -3740,7 +3740,7 @@
|
|
|
3740
3740
|
},
|
|
3741
3741
|
{
|
|
3742
3742
|
"name": "arcgis-histogram-range-slider",
|
|
3743
|
-
"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<
|
|
3743
|
+
"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<this>` - 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",
|
|
3744
3744
|
"attributes": [
|
|
3745
3745
|
{
|
|
3746
3746
|
"name": "auto-destroy-disabled",
|
|
@@ -3849,7 +3849,7 @@
|
|
|
3849
3849
|
},
|
|
3850
3850
|
{
|
|
3851
3851
|
"name": "arcgis-home",
|
|
3852
|
-
"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<
|
|
3852
|
+
"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<this>` - 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`.",
|
|
3853
3853
|
"attributes": [
|
|
3854
3854
|
{
|
|
3855
3855
|
"name": "auto-destroy-disabled",
|
|
@@ -3910,7 +3910,7 @@
|
|
|
3910
3910
|
},
|
|
3911
3911
|
{
|
|
3912
3912
|
"name": "arcgis-layer-list",
|
|
3913
|
-
"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<
|
|
3913
|
+
"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<this>` - 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>`",
|
|
3914
3914
|
"attributes": [
|
|
3915
3915
|
{
|
|
3916
3916
|
"name": "auto-destroy-disabled",
|
|
@@ -4090,7 +4090,7 @@
|
|
|
4090
4090
|
},
|
|
4091
4091
|
{
|
|
4092
4092
|
"name": "arcgis-legend",
|
|
4093
|
-
"description": "The Legend component displays the symbols and labels used to represent layers in a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nOnly layers and sublayers visible in the view are shown, unless [ignoreLayerVisibility](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/#ignoreLayerVisibility) is set to `true`.\n\nThe legend automatically updates when:\n - the visibility of a layer or sublayer changes\n - a layer is added or removed from the map\n - a layer's `renderer`, `opacity`, or `title` is changed\n - the `legendEnabled` property is changed (set to `true` or `false` on the layer)\n\n## Known Limitations\n\n* Currently, the legend component does not support the following layer types:\n[ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html),\n[KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html),\n[MapNotesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html),\n[OpenStreetMapLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OpenStreetMapLayer.html),\n[VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html), and\n[WebTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html).\n* [Symbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html) with more than one\n[symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) are not supported.\n* [DictionaryRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html) is not supported.\n* [TrackInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TrackInfo.html) is not supported.\n* CIM Symbol [primitiveOverride](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) is not supported.\n* RasterStretchRenderer [dynamicRangeAdjustment](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#dynamicRangeAdjustment) is not supported.\n\n## Various examples of legends based on renderer type.\n\n### Unique values\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-location-types/)\n\n### Continuous color\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-vv-color/)\n\n### Classed color\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-classbreaks/)\n\n### Continuous size\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-size/)\n\n### Size - above and below\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-size-themes/)\n\n### Dot density\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-dot-density/)\n\n### Predominance\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-arcade/)\n\n### Relationship\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-relationship/)\n\n\n## Legend labels\n\nLegend text is directly controlled through the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) and [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) properties. For example, `layer.title` is directly used by the legend to present a layer's symbology to the end user. To override this text, you can directly update `layer.title`.\n\nFurthermore, you can control date and number formatting in Legend by using the [FieldConfiguration](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FieldConfiguration.html) formatting options on the layer. As an alternative to this, you can override Legend text via the renderer's properties. For example, the renderer may have a [legendOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#legendOptions) property (or a label property in the case of visual variable stops or UniqueValueInfos) that can be used to override default legend text describing the renderer element in question. The [Update legend text sample](https://developers.arcgis.com/javascript/latest/sample-code/legend-update/) provides an example of overriding legend text via the renderer.\n\nNote that when you override legend text, all formatting and localization that would otherwise be dynamically applied to labels will no longer apply.\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<
|
|
4093
|
+
"description": "The Legend component displays the symbols and labels used to represent layers in a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nOnly layers and sublayers visible in the view are shown, unless [ignoreLayerVisibility](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/#ignoreLayerVisibility) is set to `true`.\n\nThe legend automatically updates when:\n - the visibility of a layer or sublayer changes\n - a layer is added or removed from the map\n - a layer's `renderer`, `opacity`, or `title` is changed\n - the `legendEnabled` property is changed (set to `true` or `false` on the layer)\n\n## Known Limitations\n\n* Currently, the legend component does not support the following layer types:\n[ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html),\n[KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html),\n[MapNotesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html),\n[OpenStreetMapLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OpenStreetMapLayer.html),\n[VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html), and\n[WebTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html).\n* [Symbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html) with more than one\n[symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) are not supported.\n* [DictionaryRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html) is not supported.\n* [TrackInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TrackInfo.html) is not supported.\n* CIM Symbol [primitiveOverride](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) is not supported.\n* RasterStretchRenderer [dynamicRangeAdjustment](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#dynamicRangeAdjustment) is not supported.\n\n## Various examples of legends based on renderer type.\n\n### Unique values\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-location-types/)\n\n### Continuous color\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-vv-color/)\n\n### Classed color\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-classbreaks/)\n\n### Continuous size\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-size/)\n\n### Size - above and below\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-size-themes/)\n\n### Dot density\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-dot-density/)\n\n### Predominance\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-arcade/)\n\n### Relationship\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-relationship/)\n\n\n## Legend labels\n\nLegend text is directly controlled through the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) and [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) properties. For example, `layer.title` is directly used by the legend to present a layer's symbology to the end user. To override this text, you can directly update `layer.title`.\n\nFurthermore, you can control date and number formatting in Legend by using the [FieldConfiguration](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FieldConfiguration.html) formatting options on the layer. As an alternative to this, you can override Legend text via the renderer's properties. For example, the renderer may have a [legendOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#legendOptions) property (or a label property in the case of visual variable stops or UniqueValueInfos) that can be used to override default legend text describing the renderer element in question. The [Update legend text sample](https://developers.arcgis.com/javascript/latest/sample-code/legend-update/) provides an example of overriding legend text via the renderer.\n\nNote that when you override legend text, all formatting and localization that would otherwise be dynamically applied to labels will no longer apply.\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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
4094
4094
|
"attributes": [
|
|
4095
4095
|
{
|
|
4096
4096
|
"name": "auto-destroy-disabled",
|
|
@@ -4214,7 +4214,7 @@
|
|
|
4214
4214
|
},
|
|
4215
4215
|
{
|
|
4216
4216
|
"name": "arcgis-line-of-sight",
|
|
4217
|
-
"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<
|
|
4217
|
+
"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<this>` - 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.",
|
|
4218
4218
|
"attributes": [
|
|
4219
4219
|
{
|
|
4220
4220
|
"name": "auto-destroy-disabled",
|
|
@@ -4268,7 +4268,7 @@
|
|
|
4268
4268
|
},
|
|
4269
4269
|
{
|
|
4270
4270
|
"name": "arcgis-link-chart",
|
|
4271
|
-
"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\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisLoadError** - Fires when a ArcgisLinkChart fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\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-MapView.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-MapView.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-MapView.html#event-analysis-view-destroy)\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- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<Layer>, 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<
|
|
4271
|
+
"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\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisLoadError** - Fires when a ArcgisLinkChart fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\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-MapView.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-MapView.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-MapView.html#event-analysis-view-destroy)\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- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<Layer>, 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<this>` - 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- `whenAnalysisView(analysis: __esri.Analysis): Promise<__esri.AnalysisView2DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.\n\n### Slots\n- _default_ - Default slot for adding components to the link chart. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n- **popup** - Slot for the [Popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot.\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the map or scene. ",
|
|
4272
4272
|
"attributes": [
|
|
4273
4273
|
{
|
|
4274
4274
|
"name": "animations-disabled",
|
|
@@ -4404,7 +4404,7 @@
|
|
|
4404
4404
|
},
|
|
4405
4405
|
{
|
|
4406
4406
|
"name": "arcgis-link-chart-layout-switcher",
|
|
4407
|
-
"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\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<
|
|
4407
|
+
"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\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<this>` - 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.",
|
|
4408
4408
|
"attributes": [
|
|
4409
4409
|
{
|
|
4410
4410
|
"name": "appearance",
|
|
@@ -4472,7 +4472,7 @@
|
|
|
4472
4472
|
},
|
|
4473
4473
|
{
|
|
4474
4474
|
"name": "arcgis-locate",
|
|
4475
|
-
"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<
|
|
4475
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`",
|
|
4476
4476
|
"attributes": [
|
|
4477
4477
|
{
|
|
4478
4478
|
"name": "auto-destroy-disabled",
|
|
@@ -4553,7 +4553,7 @@
|
|
|
4553
4553
|
},
|
|
4554
4554
|
{
|
|
4555
4555
|
"name": "arcgis-map",
|
|
4556
|
-
"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\n#### Initializing the Map component\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)\nand can be initialized in one of three ways:\n\n##### 1. Using a WebMap\nLoad a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) from [ArcGIS Online](https://www.arcgis.com/home/index.html)\nor an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) by specifying the [item-id](#itemId) attribute.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\"></arcgis-map>\n```\n\n##### 2. Setting Map component attributes directly\nDefine the Map component using attributes like [basemap](#basemap), [center](#center), and [zoom](#zoom) directly.\n\n```html\n<arcgis-map basemap=\"satellite\" center=\"-154.88, 19.46\" zoom=\"15\"></arcgis-map>\n```\n\n##### 3. Providing a Map instance\nAlternatively, you can provide your own [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) instance to the component.\nThis allows full control over map configuration, including [basemap](#basemap), operational [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers)\nand [spatial reference](#spatialReference). See the [Select features by rectangle sample](https://developers.arcgis.com/javascript/latest/sample-code/highlight-features-by-geometry/)\nfor an example of this approach in action.\n\n```html\n<arcgis-map></arcgis-map>\n<script type=\"module\">\n const viewElement = document.querySelector(\"arcgis-map\");\n\n // set the basemap of the map to states feature layer\n // add national parks feature layer and a polygon graphics layer\n viewElement.map = new Map({\n basemap: new Basemap({ baseLayers: [states] }),\n layers: [nationalParksLayer, polygonGraphicsLayer]\n });\n\n // set the spatial reference of the map to NAD 1983 Albers contiguous USA\n viewElement.spatialReference = { wkid: 102003 };\n</script>\n```\n#### Adding components and customizing the Map\n\nOther components can be added and connected to the Map component.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\">\n <arcgis-zoom slot=\"top-left\"></arcgis-zoom>\n <arcgis-legend slot=\"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- **arcgisLoadError** - Fires when a ArcgisMap fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\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-MapView.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-MapView.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-MapView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is triggered when view-related properties change, such as [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[viewpoint](#viewpoint), or [stationary](#stationary).\nIt reflects user interactions (e.g. panning or zooming) or programmatic updates to the view.\n- **arcgisViewClick** - Fires after a user clicks on the view. This event emits slightly slower than an [arcgisViewImmediateClick](#arcgisViewImmediateClick)\nevent to make sure that an [arcgisViewDoubleClick](#arcgisViewDoubleClick) event isn't triggered instead. The `arcgisViewImmediateClick`\nevent can be used for responding to an `arcgisViewClick` event without delay.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view. In contrast to the [arcgisViewClick](#arcgisViewClick) event, the `arcgisViewImmediateClick`\nis emitted as soon as the user clicks on the view, and is not inhibited by a [arcgisViewDoubleClick](#arcgisViewDoubleClick) event.\nThis event is useful for interactive experiences that require feedback without delay.\n- **arcgisViewImmediateDoubleClick** - Fires after two consecutive [arcgisViewImmediateClick](#arcgisViewImmediateClick) events. In contrast to [arcgisViewDoubleClick](#arcgisViewDoubleClick),\nan `arcgisViewImmediateDoubleClick` cannot be prevented by use of `stopPropagation()` on the [arcgisViewImmediateClick](#arcgisViewImmediateClick)\nevent and can therefore be used to react to double-clicking independently of usage of the [arcgisViewImmediateClick](#arcgisViewImmediateClick) event.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding\n[LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\ncreated and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error occurs during the creation of a [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nafter a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nis 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 is emitted when the view is ready.\nFires also when the [map](#map) is updated.\n- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\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](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates. The results are\norganized as an array of objects containing different [result types](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult).\n\nThe following layer types will return all [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit) if a hit is\nmade on intersecting features: [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[GeoRSSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html),\n[KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html),\n[MapNotesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html),\n[SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html),\n[VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html), and\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html).\n\nThe [ParquetLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ParquetLayer.html) hit result returns only the topmost feature\nwhen the hit occurs on overlapping features in a ParquetLayer.\n\nThe [VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html) hit test result contains an array of objects containing\na [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit).\nThe graphic returns attributes of a style layer. In addition, the graphic's [origin](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#origin)\ncontains the style layer's [id](https://maplibre.org/maplibre-style-spec/layers/#id) and layer index within the [vector tile style](https://doc.arcgis.com/en/arcgis-online/reference/tile-layers.htm#ESRI_SECTION1_8F68399EB47B48FF9EF46719FCC96978).\nSpatial information about the actual feature represented in the style layer is returned only if the style layer is a [symbol layer](https://maplibre.org/maplibre-style-spec/layers/#symbol).\nOtherwise, the graphic's geometry is `null`.\n\nThe [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) hit test result contains all media elements if the hit is made on intersecting elements.\nThe [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) hit test result contains all route elements if the hit is made on intersecting elements.\n\nIf the [polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) feature's symbol\n[style](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#style) is set to `none`, the hitTest method will not\nreturn results when the fill is clicked. However, it will return results when the outline is clicked. To get results when clicking the fill, set the\n[color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#color) to a transparent color instead.\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- `whenAnalysisView(analysis: __esri.Analysis): Promise<__esri.AnalysisView2DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenAnalysisView)\n- `whenLayerView<TLayer extends __esri.Layer>(layer: TLayer): Promise<LayerView2DFor<TLayer>>` - Gets the LayerView created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)\n\n### Slots\n- _default_ - Default slot for adding components to the map. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n- **popup** - Slot for the [Popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot.\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the map or scene. ",
|
|
4556
|
+
"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\n#### Initializing the Map component\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)\nand can be initialized in one of three ways:\n\n##### 1. Using a WebMap\nLoad a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) from [ArcGIS Online](https://www.arcgis.com/home/index.html)\nor an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) by specifying the [item-id](#itemId) attribute.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\"></arcgis-map>\n```\n\n##### 2. Setting Map component attributes directly\nDefine the Map component using attributes like [basemap](#basemap), [center](#center), and [zoom](#zoom) directly.\n\n```html\n<arcgis-map basemap=\"satellite\" center=\"-154.88, 19.46\" zoom=\"15\"></arcgis-map>\n```\n\n##### 3. Providing a Map instance\nAlternatively, you can provide your own [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) instance to the component.\nThis allows full control over map configuration, including [basemap](#basemap), operational [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers)\nand [spatial reference](#spatialReference). See the [Select features by rectangle sample](https://developers.arcgis.com/javascript/latest/sample-code/highlight-features-by-geometry/)\nfor an example of this approach in action.\n\n```html\n<arcgis-map></arcgis-map>\n<script type=\"module\">\n const viewElement = document.querySelector(\"arcgis-map\");\n\n // set the basemap of the map to states feature layer\n // add national parks feature layer and a polygon graphics layer\n viewElement.map = new Map({\n basemap: new Basemap({ baseLayers: [states] }),\n layers: [nationalParksLayer, polygonGraphicsLayer]\n });\n\n // set the spatial reference of the map to NAD 1983 Albers contiguous USA\n viewElement.spatialReference = { wkid: 102003 };\n</script>\n```\n#### Adding components and customizing the Map\n\nOther components can be added and connected to the Map component.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\">\n <arcgis-zoom slot=\"top-left\"></arcgis-zoom>\n <arcgis-legend slot=\"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- **arcgisLoadError** - Fires when a ArcgisMap fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\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-MapView.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-MapView.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-MapView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is triggered when view-related properties change, such as [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[viewpoint](#viewpoint), or [stationary](#stationary).\nIt reflects user interactions (e.g. panning or zooming) or programmatic updates to the view.\n- **arcgisViewClick** - Fires after a user clicks on the view. This event emits slightly slower than an [arcgisViewImmediateClick](#arcgisViewImmediateClick)\nevent to make sure that an [arcgisViewDoubleClick](#arcgisViewDoubleClick) event isn't triggered instead. The `arcgisViewImmediateClick`\nevent can be used for responding to an `arcgisViewClick` event without delay.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view. In contrast to the [arcgisViewClick](#arcgisViewClick) event, the `arcgisViewImmediateClick`\nis emitted as soon as the user clicks on the view, and is not inhibited by a [arcgisViewDoubleClick](#arcgisViewDoubleClick) event.\nThis event is useful for interactive experiences that require feedback without delay.\n- **arcgisViewImmediateDoubleClick** - Fires after two consecutive [arcgisViewImmediateClick](#arcgisViewImmediateClick) events. In contrast to [arcgisViewDoubleClick](#arcgisViewDoubleClick),\nan `arcgisViewImmediateDoubleClick` cannot be prevented by use of `stopPropagation()` on the [arcgisViewImmediateClick](#arcgisViewImmediateClick)\nevent and can therefore be used to react to double-clicking independently of usage of the [arcgisViewImmediateClick](#arcgisViewImmediateClick) event.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding\n[LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\ncreated and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error occurs during the creation of a [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nafter a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nis 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 is emitted when the view is ready.\nFires also when the [map](#map) is updated.\n- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\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<this>` - 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](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates. The results are\norganized as an array of objects containing different [result types](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult).\n\nThe following layer types will return all [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit) if a hit is\nmade on intersecting features: [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[GeoRSSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html),\n[KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html),\n[MapNotesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html),\n[SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html),\n[VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html), and\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html).\n\nThe [ParquetLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ParquetLayer.html) hit result returns only the topmost feature\nwhen the hit occurs on overlapping features in a ParquetLayer.\n\nThe [VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html) hit test result contains an array of objects containing\na [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit).\nThe graphic returns attributes of a style layer. In addition, the graphic's [origin](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#origin)\ncontains the style layer's [id](https://maplibre.org/maplibre-style-spec/layers/#id) and layer index within the [vector tile style](https://doc.arcgis.com/en/arcgis-online/reference/tile-layers.htm#ESRI_SECTION1_8F68399EB47B48FF9EF46719FCC96978).\nSpatial information about the actual feature represented in the style layer is returned only if the style layer is a [symbol layer](https://maplibre.org/maplibre-style-spec/layers/#symbol).\nOtherwise, the graphic's geometry is `null`.\n\nThe [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) hit test result contains all media elements if the hit is made on intersecting elements.\nThe [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) hit test result contains all route elements if the hit is made on intersecting elements.\n\nIf the [polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) feature's symbol\n[style](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#style) is set to `none`, the hitTest method will not\nreturn results when the fill is clicked. However, it will return results when the outline is clicked. To get results when clicking the fill, set the\n[color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#color) to a transparent color instead.\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- `whenAnalysisView(analysis: __esri.Analysis): Promise<__esri.AnalysisView2DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenAnalysisView)\n- `whenLayerView<TLayer extends __esri.Layer>(layer: TLayer): Promise<LayerView2DFor<TLayer>>` - Gets the LayerView created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenLayerView)\n\n### Slots\n- _default_ - Default slot for adding components to the map. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n- **popup** - Slot for the [Popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot.\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the map or scene. ",
|
|
4557
4557
|
"attributes": [
|
|
4558
4558
|
{
|
|
4559
4559
|
"name": "animations-disabled",
|
|
@@ -4689,7 +4689,7 @@
|
|
|
4689
4689
|
},
|
|
4690
4690
|
{
|
|
4691
4691
|
"name": "arcgis-measurement",
|
|
4692
|
-
"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<
|
|
4692
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `startMeasurement(): Promise<void>`",
|
|
4693
4693
|
"attributes": [
|
|
4694
4694
|
{
|
|
4695
4695
|
"name": "active-tool",
|
|
@@ -4848,7 +4848,7 @@
|
|
|
4848
4848
|
},
|
|
4849
4849
|
{
|
|
4850
4850
|
"name": "arcgis-navigation-toggle",
|
|
4851
|
-
"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<
|
|
4851
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `toggle(): Promise<void>`",
|
|
4852
4852
|
"attributes": [
|
|
4853
4853
|
{
|
|
4854
4854
|
"name": "auto-destroy-disabled",
|
|
@@ -4930,7 +4930,7 @@
|
|
|
4930
4930
|
},
|
|
4931
4931
|
{
|
|
4932
4932
|
"name": "arcgis-oriented-imagery-viewer",
|
|
4933
|
-
"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<
|
|
4933
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
4934
4934
|
"attributes": [
|
|
4935
4935
|
{
|
|
4936
4936
|
"name": "auto-destroy-disabled",
|
|
@@ -5015,7 +5015,7 @@
|
|
|
5015
5015
|
},
|
|
5016
5016
|
{
|
|
5017
5017
|
"name": "arcgis-popup",
|
|
5018
|
-
"description": "## Overview\nThe Popup component allows users to view content from feature attributes. Popups enhance web applications\nby providing users with a simple way to interact with and view attributes in a layer.\nThey play an important role in relaying information to the user, which improves the storytelling capabilities of the application.\n\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), and [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components currently use the [Popup widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) by default.\nTo use the Popup component, add it to the [arcgis-map.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#popup), [arcgis-scene.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup), or [arcgis-link-chart.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#popup) component using the `popup` slot.\nThe Popup component will be opened automatically to display the selected feature's popup template when features in the Map, Scene, or Link Chart are clicked.\n\n```html\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\">\n <!-- Add the popup component to the popup slot. -->\n <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n```\nThe Popup component can also be opened manually at a specific location with custom content specified in the method parameters using the `open()` method.\nTo prevent the popup from opening automatically when clicking on features within view components, set the `popup-disabled` attribute to `true`.\n\n```html\n<!-- Set popup-disabled attribute -->\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\" popup-disabled>\n <!-- Add the popup component to the popup slot. -->\n <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n<script>\nconst viewElement = document.querySelector(\"arcgis-map\");\nconst popupComponent = document.querySelector(\"arcgis-popup\");\n// Listen for clicks on the view and open the popup at the clicked location with custom content.\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n const { mapPoint } = event.detail;\n popupComponent.open({\n location: mapPoint,\n heading: \"You clicked here\",\n content: \"Latitude: \" + mapPoint.latitude.toFixed(3) + \", Longitude: \" + mapPoint.longitude.toFixed(3)\n });\n});\n</script>\n```\n\n## Popup UI\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components contain a default popup.\nThis popup can display generic content, which is set in its [heading](#heading)\nand [content](#content) properties.\nWhen content is set directly on the Popup instance it is not tied to a specific feature or layer.\n\n\n\nIn the image above, the text \"Marriage in Nassau County Census Tract 5177.01\" is the popup's [heading](#heading).\nThe remaining text is the popup's [content](#content).\nA dock button is displayed in the top right corner of the popup allowing the user to dock the popup to one of the sides or corners of the view.\nThe options for docking may be set in the [dockOptions](#dockOptions) property.\nThe popup may also be collapsed by clicking the collapse button (the down arrow icon) in the top right corner of the popup.\nWhen collapsed, only the heading of the popup displays.\nThe popup may be closed by clicking the close button (the \"x\" icon) in the top right corner of the popup.\n\nPopups can also contain [actions](#actions) which execute a function defined by the developer when clicked.\nBy default, every popup has a \"Zoom to\" action (as shown in the image above with the magnifying glass) that allows users to zoom to the selected feature.\nSee the [actions](#actions) property for information about adding custom actions to a popup.\n\nThe Popup component is tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) component, whether it's docked or anchored to the selected feature.\nIf wanting to utilize the Popup functionality outside of [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/), the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/) component can be used to display the same content\nin its own container.\n\n## Popup and PopupTemplate\n[PopupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) are closely related to Popup, but are more specific to [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)\nand [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). Popup templates allow you to define custom titles and content templates based on the source of the\n[selected feature](#selectedFeature). When a layer or a graphic has a defined\npopup template, the popup will display the content defined in the popup template when the feature is clicked.\nThe content may contain field values from the attributes of the [selected feature](#selectedFeature).\n\nCustom PopupTemplates may also be assigned directly to a popup by setting [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) on the\n[features](#features) property.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange**\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Fires after the user clicks on an action in the Popup component.\nThis event may be used to define a custom function to execute when particular actions are clicked.\n\n### Methods\n- `clear(): Promise<void>` - Removes all [promises](#promises), [features](#features), [content](#content),\n[heading](#heading) and [location](#location) from the Popup.\n- `componentOnReady(): Promise<
|
|
5018
|
+
"description": "## Overview\nThe Popup component allows users to view content from feature attributes. Popups enhance web applications\nby providing users with a simple way to interact with and view attributes in a layer.\nThey play an important role in relaying information to the user, which improves the storytelling capabilities of the application.\n\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), and [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components currently use the [Popup widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) by default.\nTo use the Popup component, add it to the [arcgis-map.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#popup), [arcgis-scene.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup), or [arcgis-link-chart.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#popup) component using the `popup` slot.\nThe Popup component will be opened automatically to display the selected feature's popup template when features in the Map, Scene, or Link Chart are clicked.\n\n```html\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\">\n <!-- Add the popup component to the popup slot. -->\n <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n```\nThe Popup component can also be opened manually at a specific location with custom content specified in the method parameters using the `open()` method.\nTo prevent the popup from opening automatically when clicking on features within view components, set the `popup-disabled` attribute to `true`.\n\n```html\n<!-- Set popup-disabled attribute -->\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\" popup-disabled>\n <!-- Add the popup component to the popup slot. -->\n <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n<script>\nconst viewElement = document.querySelector(\"arcgis-map\");\nconst popupComponent = document.querySelector(\"arcgis-popup\");\n// Listen for clicks on the view and open the popup at the clicked location with custom content.\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n const { mapPoint } = event.detail;\n popupComponent.open({\n location: mapPoint,\n heading: \"You clicked here\",\n content: \"Latitude: \" + mapPoint.latitude.toFixed(3) + \", Longitude: \" + mapPoint.longitude.toFixed(3)\n });\n});\n</script>\n```\n\n## Popup UI\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components contain a default popup.\nThis popup can display generic content, which is set in its [heading](#heading)\nand [content](#content) properties.\nWhen content is set directly on the Popup instance it is not tied to a specific feature or layer.\n\n\n\nIn the image above, the text \"Marriage in Nassau County Census Tract 5177.01\" is the popup's [heading](#heading).\nThe remaining text is the popup's [content](#content).\nA dock button is displayed in the top right corner of the popup allowing the user to dock the popup to one of the sides or corners of the view.\nThe options for docking may be set in the [dockOptions](#dockOptions) property.\nThe popup may also be collapsed by clicking the collapse button (the down arrow icon) in the top right corner of the popup.\nWhen collapsed, only the heading of the popup displays.\nThe popup may be closed by clicking the close button (the \"x\" icon) in the top right corner of the popup.\n\nPopups can also contain [actions](#actions) which execute a function defined by the developer when clicked.\nBy default, every popup has a \"Zoom to\" action (as shown in the image above with the magnifying glass) that allows users to zoom to the selected feature.\nSee the [actions](#actions) property for information about adding custom actions to a popup.\n\nThe Popup component is tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) component, whether it's docked or anchored to the selected feature.\nIf wanting to utilize the Popup functionality outside of [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/), the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/) component can be used to display the same content\nin its own container.\n\n## Popup and PopupTemplate\n[PopupTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) are closely related to Popup, but are more specific to [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)\nand [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). Popup templates allow you to define custom titles and content templates based on the source of the\n[selected feature](#selectedFeature). When a layer or a graphic has a defined\npopup template, the popup will display the content defined in the popup template when the feature is clicked.\nThe content may contain field values from the attributes of the [selected feature](#selectedFeature).\n\nCustom PopupTemplates may also be assigned directly to a popup by setting [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) on the\n[features](#features) property.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange**\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Fires after the user clicks on an action in the Popup component.\nThis event may be used to define a custom function to execute when particular actions are clicked.\n\n### Methods\n- `clear(): Promise<void>` - Removes all [promises](#promises), [features](#features), [content](#content),\n[heading](#heading) and [location](#location) from the Popup.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `fetchFeatures(screenPoint: __esri.ScreenPoint, options?: FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>` - Use this method to return feature(s) at a given screen location.\nThese features are fetched from all of the [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nin the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). In order to use this, a layer must already have an\nassociated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) and have its [popupEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupEnabled).\n- `handleViewClick(event: __esri.ViewClickEvent): Promise<__esri.FeaturesViewModelOpenOptions>`\n- `next(): Promise<FeaturesViewModel>` - Selects the feature at the next index in relation to the selected feature.\n- `open(options?: __esri.FeaturesViewModelOpenOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with `content`\nor driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features. This method sets\nthe popup's [visible](#visible) property to `true`. Users can alternatively open the popup\nby directly setting the [visible](#visible) property to `true`.\n\n***Note:***\nThe popup will only display if the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) size constraints in [dockOptions](#dockOptions) are met or the [location](#location)\nproperty is set to a geometry.\n- `previous(): Promise<FeaturesViewModel>` - Selects the feature at the previous index in relation to the selected feature.\n- `setFocus(): Promise<void>` - Use this method to give focus to the component if the component is able to be focused.\n- `triggerAction(action: __esri.ActionButton | __esri.ActionToggle): Promise<void>` - Triggers the [arcgisTriggerAction](#arcgisTriggerAction) event and executes the [action](#actions)\nat the specified index in the [actions](#actions) array.",
|
|
5019
5019
|
"attributes": [
|
|
5020
5020
|
{
|
|
5021
5021
|
"name": "alignment",
|
|
@@ -5227,7 +5227,7 @@
|
|
|
5227
5227
|
},
|
|
5228
5228
|
{
|
|
5229
5229
|
"name": "arcgis-presentation",
|
|
5230
|
-
"description": "The Presentation component allows to present slides of a web scene in a presentation mode\nand supports navigating between the slides of a web scene.\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<
|
|
5230
|
+
"description": "The Presentation component allows to present slides of a web scene in a presentation mode\nand supports navigating between the slides of a web scene.\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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component",
|
|
5231
5231
|
"attributes": [
|
|
5232
5232
|
{
|
|
5233
5233
|
"name": "auto-destroy-disabled",
|
|
@@ -5273,7 +5273,7 @@
|
|
|
5273
5273
|
},
|
|
5274
5274
|
{
|
|
5275
5275
|
"name": "arcgis-print",
|
|
5276
|
-
"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 slot=\"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- **arcgisBrowseTemplatesChange** - Emitted when the collection of browse templates changes.\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- **arcgisSaveAs** - Emitted when the user saves an exported map printout.\n- **arcgisSubmit** - Emitted when the component is submitted.\n\n### Methods\n- `addPortalTemplate(portalItem: __esri.PortalItem): Promise<void>` - Adds a portal item to a collection of browse templates available in the Print component UI.\n- `componentOnReady(): Promise<
|
|
5276
|
+
"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 slot=\"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- **arcgisBrowseTemplatesChange** - Emitted when the collection of browse templates changes.\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- **arcgisSaveAs** - Emitted when the user saves an exported map printout.\n- **arcgisSubmit** - Emitted when the component is submitted.\n\n### Methods\n- `addPortalTemplate(portalItem: __esri.PortalItem): Promise<void>` - Adds a portal item to a collection of browse templates available in the Print component UI.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
5277
5277
|
"attributes": [
|
|
5278
5278
|
{
|
|
5279
5279
|
"name": "allowed-formats",
|
|
@@ -5418,7 +5418,7 @@
|
|
|
5418
5418
|
},
|
|
5419
5419
|
{
|
|
5420
5420
|
"name": "arcgis-scale-bar",
|
|
5421
|
-
"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<
|
|
5421
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
5422
5422
|
"attributes": [
|
|
5423
5423
|
{
|
|
5424
5424
|
"name": "auto-destroy-disabled",
|
|
@@ -5481,7 +5481,7 @@
|
|
|
5481
5481
|
},
|
|
5482
5482
|
{
|
|
5483
5483
|
"name": "arcgis-scale-range-slider",
|
|
5484
|
-
"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<
|
|
5484
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
5485
5485
|
"attributes": [
|
|
5486
5486
|
{
|
|
5487
5487
|
"name": "auto-destroy-disabled",
|
|
@@ -5584,7 +5584,7 @@
|
|
|
5584
5584
|
},
|
|
5585
5585
|
{
|
|
5586
5586
|
"name": "arcgis-scene",
|
|
5587
|
-
"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 slot=\"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- **arcgisLoadError** - Fires when a ArcgisScene fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\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- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\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<AnalysisType extends __esri.Analysis>(analysis: AnalysisType): Promise<AnalysisView3DFor<AnalysisType>>` - 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<TLayer extends __esri.Layer>(layer: TLayer): Promise<__esri.Layer extends TLayer ? __esri.LayerView : LayerView3DFor<TLayer>>` - 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)\n\n### Slots\n- _default_ - Default slot for adding components to the scene. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n- **popup** - Slot for the [Popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot.\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the map or scene. ",
|
|
5587
|
+
"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 slot=\"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- **arcgisLoadError** - Fires when a ArcgisScene fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\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- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\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<this>` - 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<AnalysisType extends __esri.Analysis>(analysis: AnalysisType): Promise<AnalysisView3DFor<AnalysisType>>` - 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<TLayer extends __esri.Layer>(layer: TLayer): Promise<__esri.Layer extends TLayer ? __esri.LayerView : LayerView3DFor<TLayer>>` - 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)\n\n### Slots\n- _default_ - Default slot for adding components to the scene. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n- **popup** - Slot for the [Popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot.\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the map or scene. ",
|
|
5588
5588
|
"attributes": [
|
|
5589
5589
|
{
|
|
5590
5590
|
"name": "alpha-compositing-enabled",
|
|
@@ -5724,7 +5724,7 @@
|
|
|
5724
5724
|
},
|
|
5725
5725
|
{
|
|
5726
5726
|
"name": "arcgis-search",
|
|
5727
|
-
"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<
|
|
5727
|
+
"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<this>` - 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`.",
|
|
5728
5728
|
"attributes": [
|
|
5729
5729
|
{
|
|
5730
5730
|
"name": "active-menu",
|
|
@@ -5863,7 +5863,7 @@
|
|
|
5863
5863
|
},
|
|
5864
5864
|
{
|
|
5865
5865
|
"name": "arcgis-search-result-renderer",
|
|
5866
|
-
"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<
|
|
5866
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
5867
5867
|
"attributes": [
|
|
5868
5868
|
{
|
|
5869
5869
|
"name": "auto-destroy-disabled",
|
|
@@ -5880,7 +5880,7 @@
|
|
|
5880
5880
|
},
|
|
5881
5881
|
{
|
|
5882
5882
|
"name": "arcgis-shadow-cast",
|
|
5883
|
-
"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 [modes](#mode): minimum duration, total duration, and discrete mode.\n\nIn the **minimum duration** 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 mode which displays individual shadows at a given time interval.\nFor example, setting the time range to 10AM-11AM and the 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),\n[endTimeOfDay](#endTimeOfDay), and [mode](#mode) 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<
|
|
5883
|
+
"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 [modes](#mode): minimum duration, total duration, and discrete mode.\n\nIn the **minimum duration** 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 mode which displays individual shadows at a given time interval.\nFor example, setting the time range to 10AM-11AM and the 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),\n[endTimeOfDay](#endTimeOfDay), and [mode](#mode) 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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getDurationAtScreen(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-views-3d-analysis-ShadowCast-ShadowCastAnalysisView3D.html#getDurationAtScreen)",
|
|
5884
5884
|
"attributes": [
|
|
5885
5885
|
{
|
|
5886
5886
|
"name": "auto-destroy-disabled",
|
|
@@ -6119,7 +6119,7 @@
|
|
|
6119
6119
|
},
|
|
6120
6120
|
{
|
|
6121
6121
|
"name": "arcgis-sketch",
|
|
6122
|
-
"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<
|
|
6122
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `create(tool: Parameters<Sketch[\"create\"]>[0], createOptions?: Parameters<Sketch[\"create\"]>[1]): 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: Parameters<Sketch[\"update\"]>[0], updateOptions?: Parameters<Sketch[\"update\"]>[1]): Promise<void>`\n- `undo(): Promise<void>`",
|
|
6123
6123
|
"attributes": [
|
|
6124
6124
|
{
|
|
6125
6125
|
"name": "active-tool",
|
|
@@ -6391,7 +6391,7 @@
|
|
|
6391
6391
|
},
|
|
6392
6392
|
{
|
|
6393
6393
|
"name": "arcgis-slice",
|
|
6394
|
-
"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<
|
|
6394
|
+
"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<this>` - 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`.",
|
|
6395
6395
|
"attributes": [
|
|
6396
6396
|
{
|
|
6397
6397
|
"name": "auto-destroy-disabled",
|
|
@@ -6482,7 +6482,7 @@
|
|
|
6482
6482
|
},
|
|
6483
6483
|
{
|
|
6484
6484
|
"name": "arcgis-color-select",
|
|
6485
|
-
"description": "Labeled swatch which opens a color picker popover to select a color.\n--\n\n### Events\n- **arcgisColorChanged** - Emitted when the color value changes.\n\n### Methods\n- `componentOnReady(): Promise<
|
|
6485
|
+
"description": "Labeled swatch which opens a color picker popover to select a color.\n--\n\n### Events\n- **arcgisColorChanged** - Emitted when the color value changes.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.",
|
|
6486
6486
|
"attributes": [
|
|
6487
6487
|
{
|
|
6488
6488
|
"name": "color",
|
|
@@ -6508,7 +6508,7 @@
|
|
|
6508
6508
|
},
|
|
6509
6509
|
{
|
|
6510
6510
|
"name": "arcgis-webgl-error",
|
|
6511
|
-
"description": "Warning for WebGL errors.\n--\n\n### Methods\n- `componentOnReady(): Promise<
|
|
6511
|
+
"description": "Warning for WebGL errors.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.",
|
|
6512
6512
|
"attributes": [
|
|
6513
6513
|
{
|
|
6514
6514
|
"name": "error-name",
|
|
@@ -6525,7 +6525,7 @@
|
|
|
6525
6525
|
},
|
|
6526
6526
|
{
|
|
6527
6527
|
"name": "arcgis-swipe",
|
|
6528
|
-
"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<
|
|
6528
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
6529
6529
|
"attributes": [
|
|
6530
6530
|
{
|
|
6531
6531
|
"name": "auto-destroy-disabled",
|
|
@@ -6605,7 +6605,7 @@
|
|
|
6605
6605
|
},
|
|
6606
6606
|
{
|
|
6607
6607
|
"name": "arcgis-table-list",
|
|
6608
|
-
"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<
|
|
6608
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
6609
6609
|
"attributes": [
|
|
6610
6610
|
{
|
|
6611
6611
|
"name": "auto-destroy-disabled",
|
|
@@ -6744,7 +6744,7 @@
|
|
|
6744
6744
|
},
|
|
6745
6745
|
{
|
|
6746
6746
|
"name": "arcgis-time-slider",
|
|
6747
|
-
"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<
|
|
6747
|
+
"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<this>` - 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>`",
|
|
6748
6748
|
"attributes": [
|
|
6749
6749
|
{
|
|
6750
6750
|
"name": "auto-destroy-disabled",
|
|
@@ -6848,7 +6848,7 @@
|
|
|
6848
6848
|
},
|
|
6849
6849
|
{
|
|
6850
6850
|
"name": "arcgis-time-zone-label",
|
|
6851
|
-
"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<
|
|
6851
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.",
|
|
6852
6852
|
"attributes": [
|
|
6853
6853
|
{
|
|
6854
6854
|
"name": "disabled",
|
|
@@ -6939,7 +6939,7 @@
|
|
|
6939
6939
|
},
|
|
6940
6940
|
{
|
|
6941
6941
|
"name": "arcgis-track",
|
|
6942
|
-
"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<
|
|
6942
|
+
"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<this>` - 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.",
|
|
6943
6943
|
"attributes": [
|
|
6944
6944
|
{
|
|
6945
6945
|
"name": "auto-destroy-disabled",
|
|
@@ -7024,7 +7024,7 @@
|
|
|
7024
7024
|
},
|
|
7025
7025
|
{
|
|
7026
7026
|
"name": "arcgis-utility-network-associations",
|
|
7027
|
-
"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<
|
|
7027
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
7028
7028
|
"attributes": [
|
|
7029
7029
|
{
|
|
7030
7030
|
"name": "auto-destroy-disabled",
|
|
@@ -7211,7 +7211,7 @@
|
|
|
7211
7211
|
},
|
|
7212
7212
|
{
|
|
7213
7213
|
"name": "arcgis-utility-network-trace",
|
|
7214
|
-
"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<
|
|
7214
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `confirmReset(): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
7215
7215
|
"attributes": [
|
|
7216
7216
|
{
|
|
7217
7217
|
"name": "auto-destroy-disabled",
|
|
@@ -7279,7 +7279,7 @@
|
|
|
7279
7279
|
},
|
|
7280
7280
|
{
|
|
7281
7281
|
"name": "arcgis-utility-network-trace-analysis",
|
|
7282
|
-
"description": "### Events\n- **arcgisPropertyChange**\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nEvent payload contains a callback method `cancelSelect` to cancel a selection in progress.\nThe event can also be prevented with `event.preventDefault()` to stop the selection.\n- **arcgisTraceResultFeaturesReady** - Fires when the trace result features are ready.\nCheck property `traceResultFeatures` for the trace result features.\n\n### Methods\n- `componentOnReady(): Promise<
|
|
7282
|
+
"description": "### Events\n- **arcgisPropertyChange**\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nEvent payload contains a callback method `cancelSelect` to cancel a selection in progress.\nThe event can also be prevented with `event.preventDefault()` to stop the selection.\n- **arcgisTraceResultFeaturesReady** - Fires when the trace result features are ready.\nCheck property `traceResultFeatures` for the trace result features.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
7283
7283
|
"attributes": [
|
|
7284
7284
|
{
|
|
7285
7285
|
"name": "allow-editing-disabled",
|
|
@@ -7343,7 +7343,7 @@
|
|
|
7343
7343
|
},
|
|
7344
7344
|
{
|
|
7345
7345
|
"name": "arcgis-utility-network-subnetwork-info",
|
|
7346
|
-
"description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a utility network and named trace configuration as input.\nThe sub-component displays information from the trace configuration relevant to subnetworks:\nDomain network name, tier name, and target tier name.\n--\n\n### Methods\n- `componentOnReady(): Promise<
|
|
7346
|
+
"description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a utility network and named trace configuration as input.\nThe sub-component displays information from the trace configuration relevant to subnetworks:\nDomain network name, tier name, and target tier name.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.",
|
|
7347
7347
|
"attributes": [],
|
|
7348
7348
|
"references": [
|
|
7349
7349
|
{
|
|
@@ -7354,7 +7354,7 @@
|
|
|
7354
7354
|
},
|
|
7355
7355
|
{
|
|
7356
7356
|
"name": "arcgis-utility-network-trace-inputs",
|
|
7357
|
-
"description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a map view as an input.\nIt allows users to select utility networks, trace configurations, and input features for tracing.\n--\n\n### Events\n- **arcgisPropertyChange**\n- **arcgisTraceInputsChange** - There will be more added to this event as we increase the functionality of this component\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nCan be prevented to stop the selection.\n- **arcgisUtilityNetworkChange** - This will be fired less often than above, only when the utility network changes\n\n### Methods\n- `componentOnReady(): Promise<
|
|
7357
|
+
"description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a map view as an input.\nIt allows users to select utility networks, trace configurations, and input features for tracing.\n--\n\n### Events\n- **arcgisPropertyChange**\n- **arcgisTraceInputsChange** - There will be more added to this event as we increase the functionality of this component\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nCan be prevented to stop the selection.\n- **arcgisUtilityNetworkChange** - This will be fired less often than above, only when the utility network changes\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.",
|
|
7358
7358
|
"attributes": [
|
|
7359
7359
|
{
|
|
7360
7360
|
"name": "mode",
|
|
@@ -7381,7 +7381,7 @@
|
|
|
7381
7381
|
},
|
|
7382
7382
|
{
|
|
7383
7383
|
"name": "arcgis-utility-network-trace-location",
|
|
7384
|
-
"description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a map view as an input.\nIt allows users to select locations on the map to use as trace inputs.\n--\n\n### Events\n- **arcgisTraceLocationChange**\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nCan be prevented to stop the selection.\n\n### Methods\n- `componentOnReady(): Promise<
|
|
7384
|
+
"description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a map view as an input.\nIt allows users to select locations on the map to use as trace inputs.\n--\n\n### Events\n- **arcgisTraceLocationChange**\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nCan be prevented to stop the selection.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.",
|
|
7385
7385
|
"attributes": [
|
|
7386
7386
|
{
|
|
7387
7387
|
"name": "spatial-tolerance",
|
|
@@ -7411,7 +7411,7 @@
|
|
|
7411
7411
|
},
|
|
7412
7412
|
{
|
|
7413
7413
|
"name": "arcgis-utility-network-trace-location-list",
|
|
7414
|
-
"description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component renders a collection of trace locations as a list.\n--\n\n### Methods\n- `componentOnReady(): Promise<
|
|
7414
|
+
"description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component renders a collection of trace locations as a list.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.",
|
|
7415
7415
|
"attributes": [
|
|
7416
7416
|
{
|
|
7417
7417
|
"name": "trace-location-type",
|
|
@@ -7437,7 +7437,7 @@
|
|
|
7437
7437
|
},
|
|
7438
7438
|
{
|
|
7439
7439
|
"name": "arcgis-utility-network-trace-results",
|
|
7440
|
-
"description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a `TraceResult` instance as input.\nOptionally, the title of a trace configuration can be provided as a heading to display.\n--\n\n### Events\n- **arcgisSelectedLayerChange**\n- **arcgisSelectedResultTypeChange**\n- **arcgisTraceResultFeaturesReady**\n\n### Methods\n- `componentOnReady(): Promise<
|
|
7440
|
+
"description": "This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a `TraceResult` instance as input.\nOptionally, the title of a trace configuration can be provided as a heading to display.\n--\n\n### Events\n- **arcgisSelectedLayerChange**\n- **arcgisSelectedResultTypeChange**\n- **arcgisTraceResultFeaturesReady**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.",
|
|
7441
7441
|
"attributes": [
|
|
7442
7442
|
{
|
|
7443
7443
|
"name": "is-elements-selected",
|
|
@@ -7473,7 +7473,7 @@
|
|
|
7473
7473
|
},
|
|
7474
7474
|
{
|
|
7475
7475
|
"name": "arcgis-utility-network-validate-topology",
|
|
7476
|
-
"description": "The UtilityNetworkValidateTopology component simplifies the process of validating a DirtyArea within a utility network. It offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The UtilityNetworkValidateTopology Component does not support proxied feature services or feature services that utilize stored credentials.\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<
|
|
7476
|
+
"description": "The UtilityNetworkValidateTopology component simplifies the process of validating a DirtyArea within a utility network. It offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The UtilityNetworkValidateTopology Component does not support proxied feature services or feature services that utilize stored credentials.\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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
7477
7477
|
"attributes": [
|
|
7478
7478
|
{
|
|
7479
7479
|
"name": "auto-destroy-disabled",
|
|
@@ -7536,7 +7536,7 @@
|
|
|
7536
7536
|
},
|
|
7537
7537
|
{
|
|
7538
7538
|
"name": "arcgis-value-picker",
|
|
7539
|
-
"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<
|
|
7539
|
+
"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<this>` - 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>`",
|
|
7540
7540
|
"attributes": [
|
|
7541
7541
|
{
|
|
7542
7542
|
"name": "auto-destroy-disabled",
|
|
@@ -7620,7 +7620,7 @@
|
|
|
7620
7620
|
},
|
|
7621
7621
|
{
|
|
7622
7622
|
"name": "arcgis-version-management",
|
|
7623
|
-
"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<
|
|
7623
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
7624
7624
|
"attributes": [
|
|
7625
7625
|
{
|
|
7626
7626
|
"name": "allow-editing-disabled",
|
|
@@ -7696,7 +7696,7 @@
|
|
|
7696
7696
|
},
|
|
7697
7697
|
{
|
|
7698
7698
|
"name": "arcgis-video",
|
|
7699
|
-
"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<
|
|
7699
|
+
"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<this>` - 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\n### Slots\n- _default_ - Default slot for adding components to the video. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the map or scene. ",
|
|
7700
7700
|
"attributes": [
|
|
7701
7701
|
{
|
|
7702
7702
|
"name": "attribution-mode",
|
|
@@ -7724,7 +7724,7 @@
|
|
|
7724
7724
|
},
|
|
7725
7725
|
{
|
|
7726
7726
|
"name": "arcgis-video-player",
|
|
7727
|
-
"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<
|
|
7727
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
7728
7728
|
"attributes": [
|
|
7729
7729
|
{
|
|
7730
7730
|
"name": "auto-destroy-disabled",
|
|
@@ -7817,7 +7817,7 @@
|
|
|
7817
7817
|
},
|
|
7818
7818
|
{
|
|
7819
7819
|
"name": "arcgis-volume-measurement",
|
|
7820
|
-
"description": "The Volume Measurement component can be added to a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) to\ncalculate and visualize the volume of ground surfaces within a defined polygonal area.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/analysis-volume-measurement/)*\n\nVolume Measurement component offers multiple volume measurement modes:\n\n- **Cut & Fill Volume**: Computes cut and fill volumes relative to a flat, horizontal surface defined by the input\npolygon. Ideal for estimating the amount of material to remove or add to level terrain for construction.\n\n- **Stockpile Volume**: Calculates cut and fill volumes against a surface approximated from the polygon's coordinates.\nUseful for estimating the volume of temporary ground features such as piles of material, mounds or depressions.\n\nThe analysis depends on the scene's spatial reference, and the length of the measured perimeter:\n\n- In **Projected Coordinate Systems (PCS)**, apart from Web Mercator used in **local** viewing mode, there is no limit\nto the measurement's perimeter, making it the recommended setup for analysis as accuracy is not compromised.\n\n- In **Web Mercator PCS** used in **local** viewing mode, if the measurement's perimeter exceeds 10 km, the analysis is considered invalid due to potential accuracy issues.\n\n- In **Geographic Coordinate Systems (GCS)** and **Web Mercator** in **global** viewing mode, if the measurement's perimeter exceeds 50 km, the analysis is considered invalid due to potential accuracy issues.\n\n\n**Known Limitations**\n\n- Volume Measurement component can only be added to a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n- The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.\n- If the view is too close or too far from the measurement polygon, the results will not be computed due to LOD-induced inaccuracies.\n- The elevation of the target surface in the \"Cut & Fill Volume\" mode is restricted to the range of -11 km and +9 km.\n- This tool operates only on the non-transparent [Map.ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html)\nand an [IntegratedMesh3DTilesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html).\n- This tool does not support WGS 1984 spatial reference in a local\n[viewing mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewingMode).\n\n**Things to consider**\n\n- In \"Cut & Fill Volume\" mode, you can hover over the shift manipulator, press `Tab` to enable tooltip input, \nand enter the target surface elevation.\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- [Volume Measurement Analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html)\n- [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurementAnalysisView3D.html)\n- [VolumeMeasurementCutFillOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementCutFillOptions.html)\n- [VolumeMeasurementResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurement-VolumeMeasurementResult.html)\n- [VolumeMeasurementDisplayUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementDisplayUnits.html)\n- [VolumeMeasurementInputUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementInputUnits.html)\n- [VolumeMeasurementError](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurement-VolumeMeasurementError.html)\n- [Sample - Volume measurement analysis object](https://developers.arcgis.com/javascript/latest/sample-code/analysis-volume-measurement/)\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<
|
|
7820
|
+
"description": "The Volume Measurement component can be added to a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) to\ncalculate and visualize the volume of ground surfaces within a defined polygonal area.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/analysis-volume-measurement/)*\n\nVolume Measurement component offers multiple volume measurement modes:\n\n- **Cut & Fill Volume**: Computes cut and fill volumes relative to a flat, horizontal surface defined by the input\npolygon. Ideal for estimating the amount of material to remove or add to level terrain for construction.\n\n- **Stockpile Volume**: Calculates cut and fill volumes against a surface approximated from the polygon's coordinates.\nUseful for estimating the volume of temporary ground features such as piles of material, mounds or depressions.\n\nThe analysis depends on the scene's spatial reference, and the length of the measured perimeter:\n\n- In **Projected Coordinate Systems (PCS)**, apart from Web Mercator used in **local** viewing mode, there is no limit\nto the measurement's perimeter, making it the recommended setup for analysis as accuracy is not compromised.\n\n- In **Web Mercator PCS** used in **local** viewing mode, if the measurement's perimeter exceeds 10 km, the analysis is considered invalid due to potential accuracy issues.\n\n- In **Geographic Coordinate Systems (GCS)** and **Web Mercator** in **global** viewing mode, if the measurement's perimeter exceeds 50 km, the analysis is considered invalid due to potential accuracy issues.\n\n\n**Known Limitations**\n\n- Volume Measurement component can only be added to a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n- The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.\n- If the view is too close or too far from the measurement polygon, the results will not be computed due to LOD-induced inaccuracies.\n- The elevation of the target surface in the \"Cut & Fill Volume\" mode is restricted to the range of -11 km and +9 km.\n- This tool operates only on the non-transparent [Map.ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html)\nand an [IntegratedMesh3DTilesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html).\n- This tool does not support WGS 1984 spatial reference in a local\n[viewing mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewingMode).\n\n**Things to consider**\n\n- In \"Cut & Fill Volume\" mode, you can hover over the shift manipulator, press `Tab` to enable tooltip input, \nand enter the target surface elevation.\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- [Volume Measurement Analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html)\n- [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurementAnalysisView3D.html)\n- [VolumeMeasurementCutFillOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementCutFillOptions.html)\n- [VolumeMeasurementResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurement-VolumeMeasurementResult.html)\n- [VolumeMeasurementDisplayUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementDisplayUnits.html)\n- [VolumeMeasurementInputUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementInputUnits.html)\n- [VolumeMeasurementError](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurement-VolumeMeasurementError.html)\n- [Sample - Volume measurement analysis object](https://developers.arcgis.com/javascript/latest/sample-code/analysis-volume-measurement/)\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<this>` - 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.",
|
|
7821
7821
|
"attributes": [
|
|
7822
7822
|
{
|
|
7823
7823
|
"name": "auto-destroy-disabled",
|
|
@@ -8069,7 +8069,7 @@
|
|
|
8069
8069
|
},
|
|
8070
8070
|
{
|
|
8071
8071
|
"name": "arcgis-weather",
|
|
8072
|
-
"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<
|
|
8072
|
+
"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<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
8073
8073
|
"attributes": [
|
|
8074
8074
|
{
|
|
8075
8075
|
"name": "auto-destroy-disabled",
|
|
@@ -8149,7 +8149,7 @@
|
|
|
8149
8149
|
},
|
|
8150
8150
|
{
|
|
8151
8151
|
"name": "arcgis-zoom",
|
|
8152
|
-
"description": "The Zoom component allows users to zoom in/out within a map or scene.\n--\n\n### Events\n- **arcgisClick** - Emitted when one of the zoom controls 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\n### Methods\n- `componentOnReady(): Promise<
|
|
8152
|
+
"description": "The Zoom component allows users to zoom in/out within a map or scene.\n--\n\n### Events\n- **arcgisClick** - Emitted when one of the zoom controls 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\n### Methods\n- `componentOnReady(): Promise<this>` - 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.",
|
|
8153
8153
|
"attributes": [
|
|
8154
8154
|
{
|
|
8155
8155
|
"name": "auto-destroy-disabled",
|