@arcgis/map-components 5.0.0-next.116 → 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/{4W5RRHEC.js → 2C6VJMPT.js} +2 -2
- package/dist/cdn/{BNY23M6W.js → 2HWOA3FX.js} +2 -2
- package/dist/cdn/{QOS5XFF4.js → 2I65FTXJ.js} +2 -2
- package/dist/cdn/{KBXFF3DI.js → 2IPFTZCM.js} +2 -2
- package/dist/cdn/{CUWZZ7UR.js → 2KUQ3BL7.js} +2 -2
- package/dist/cdn/{GCR7MC6T.js → 2SCCOB7L.js} +2 -2
- package/dist/cdn/{I64FJQEP.js → 2ZWPNOAY.js} +2 -2
- package/dist/cdn/{HKS7TDRA.js → 37O4V7IX.js} +2 -2
- package/dist/cdn/{FNEHYIS2.js → 3CMKHRPP.js} +2 -2
- package/dist/cdn/{JJE6UUG7.js → 3ELRTZOZ.js} +2 -2
- package/dist/cdn/{IUITMQAI.js → 3IEVN25A.js} +2 -2
- package/dist/cdn/{457QFKOI.js → 3IK2WX6O.js} +2 -2
- package/dist/cdn/{RSOKTVT6.js → 3IQZRABY.js} +2 -2
- package/dist/cdn/{LJG33NK5.js → 3NLUIM5M.js} +2 -2
- package/dist/cdn/{WKIEWEYF.js → 3NX5P7IZ.js} +2 -2
- package/dist/cdn/{JD3XEDSJ.js → 3P4IQGNB.js} +2 -2
- package/dist/cdn/{C5TSDOIM.js → 44GOMI6N.js} +2 -2
- package/dist/cdn/{XINHZ267.js → 45IMGM24.js} +2 -2
- package/dist/cdn/{GTHF45P7.js → 46JAFFPO.js} +2 -2
- package/dist/cdn/{TBEABAFE.js → 4CWJIQKC.js} +2 -2
- package/dist/cdn/{3XW3AK3L.js → 4DBM44OI.js} +2 -2
- package/dist/cdn/{BC6EN3Q2.js → 4IF6O35C.js} +2 -2
- package/dist/cdn/{NTJDMWZC.js → 4KZGFK46.js} +2 -2
- package/dist/cdn/{BGQF52TE.js → 4R3FO5X6.js} +1 -1
- package/dist/cdn/{RSWCGD7P.js → 4RPGUA5P.js} +2 -2
- package/dist/cdn/{G7D43MJN.js → 4TMT67RB.js} +2 -2
- package/dist/cdn/{GGRBOJ32.js → 4XKZZQWJ.js} +2 -2
- package/dist/cdn/{UUSZGY5W.js → 53FLKZNF.js} +2 -2
- package/dist/cdn/{ZOLAL4VL.js → 5BIHZSZI.js} +2 -2
- package/dist/cdn/{E3ACBLRP.js → 5EFGDM5F.js} +1 -1
- package/dist/cdn/{CK6QFNCV.js → 5EQEEBB4.js} +2 -2
- package/dist/cdn/{LB2QOBGJ.js → 5PWV4PN4.js} +2 -2
- package/dist/cdn/{MSZ646XM.js → 5PZGMJBE.js} +3 -3
- package/dist/cdn/{N7ZIN45T.js → 5UD65RXC.js} +2 -2
- package/dist/cdn/{OY6JI3QW.js → 5UFX5PVW.js} +2 -2
- package/dist/cdn/{ZP2CB4NS.js → 5XTXMXBZ.js} +2 -2
- package/dist/cdn/{CVKLWL5U.js → 6PKIPLXE.js} +2 -2
- package/dist/cdn/{N3GPAU62.js → 6PXJLJD6.js} +2 -2
- package/dist/cdn/{FITOYU5L.js → 6R5YZVCL.js} +2 -2
- package/dist/cdn/{2O5HXG7K.js → 6SBIIW3H.js} +2 -2
- package/dist/cdn/{RVTYZNXI.js → 6TTWFKFF.js} +2 -2
- package/dist/cdn/{6EWVHKI6.js → 6UFNCBCF.js} +2 -2
- package/dist/cdn/{RT3IZT3M.js → 6XO2NZ2B.js} +2 -2
- package/dist/cdn/{4NRAKJHV.js → 76NIO4HH.js} +2 -2
- package/dist/cdn/{ZASYCQZ4.js → 7CPSSUEN.js} +2 -2
- package/dist/cdn/{6CD3F5IH.js → 7GWQUVCH.js} +2 -2
- package/dist/cdn/{NLAYZXFO.js → 7J4BH4SJ.js} +2 -2
- package/dist/cdn/{TZZT2Y2U.js → A5N6WIFD.js} +2 -2
- package/dist/cdn/{TNBE3BCL.js → A6PBGN3U.js} +2 -2
- package/dist/cdn/{CIUJJS6R.js → ABAY754S.js} +2 -2
- package/dist/cdn/{XHFTXJQS.js → AM2RXOSH.js} +1 -1
- package/dist/cdn/{65ILCVM2.js → ANV4EP5K.js} +2 -2
- package/dist/cdn/{2S6FA443.js → APJERP7S.js} +2 -2
- package/dist/cdn/{WQAQBU3U.js → AXEIJP4Q.js} +2 -2
- package/dist/cdn/{OGODNMSR.js → AZFDGPRF.js} +2 -2
- package/dist/cdn/{3B2TER6T.js → B2BQUTGC.js} +2 -2
- package/dist/cdn/{ZGNLNY2O.js → B3BRXNF3.js} +2 -2
- package/dist/cdn/{VBT7WT6U.js → B3GVMYA3.js} +2 -2
- package/dist/cdn/{NMHBOJYX.js → BE6IAEEJ.js} +2 -2
- package/dist/cdn/{3AROSIBP.js → BMJTGGUM.js} +2 -2
- package/dist/cdn/{FRBCO3WB.js → BN37APGI.js} +2 -2
- package/dist/cdn/{N573IBFC.js → BQPH2DXU.js} +2 -2
- package/dist/cdn/{VNIYAC2S.js → BSUMMCQO.js} +2 -2
- package/dist/cdn/{5N6HJBS5.js → C6PMEB4C.js} +2 -2
- package/dist/cdn/{H2IP46G6.js → CA2SWJ73.js} +2 -2
- package/dist/cdn/{E547KCRX.js → CFLBQKBR.js} +2 -2
- package/dist/cdn/{34T7D67W.js → CIMA7S6X.js} +2 -2
- package/dist/cdn/{VJKH3D3D.js → D7C735ZH.js} +2 -2
- package/dist/cdn/{OHRNX66D.js → DCLTXQDJ.js} +2 -2
- package/dist/cdn/{XEG3U2V5.js → DDDAINAM.js} +2 -2
- package/dist/cdn/{P3BJJDQX.js → DEL5ZCU4.js} +2 -2
- package/dist/cdn/{W7KDJ2SA.js → DFABPUJ2.js} +2 -2
- package/dist/cdn/{DQNSK6AK.js → DITR46QS.js} +2 -2
- package/dist/cdn/{WQN3GJF3.js → DJ7NHIZH.js} +2 -2
- package/dist/cdn/{TT6WQZEU.js → DJTVTXUI.js} +2 -2
- package/dist/cdn/{3O33DFZG.js → DK523M4T.js} +2 -2
- package/dist/cdn/{3WSETGR6.js → DKG26AQH.js} +2 -2
- package/dist/cdn/{MPANBAOP.js → DTBOLH2S.js} +2 -2
- package/dist/cdn/{HDGVVWNC.js → DYLI2DGL.js} +2 -2
- package/dist/cdn/{APNYVVQX.js → ECBO7KK6.js} +2 -2
- package/dist/cdn/{O3WVICDL.js → EDGU6FOO.js} +2 -2
- package/dist/cdn/{YZCVM7UL.js → EDMQKA5S.js} +2 -2
- package/dist/cdn/{7JX7X4T4.js → ENCGADVY.js} +2 -2
- package/dist/cdn/{FZSB6Y5P.js → EX5QJ2QV.js} +2 -2
- package/dist/cdn/{XOZRAWNG.js → F27VCLE3.js} +2 -2
- package/dist/cdn/{PS7MUOXS.js → F4KPXUNK.js} +2 -2
- package/dist/cdn/{FYTRCJJM.js → F5AKYQI3.js} +2 -2
- package/dist/cdn/{S3ISIYNS.js → F65EK3Q4.js} +2 -2
- package/dist/cdn/{QBDNYZJ3.js → FCLG6BHG.js} +2 -2
- package/dist/cdn/{C24WTTJ4.js → FHJHJACQ.js} +2 -2
- package/dist/cdn/FQ7ODI7S.js +4 -0
- package/dist/cdn/{53NRHDL5.js → FZ47MOPF.js} +2 -2
- package/dist/cdn/{JCTPHTMJ.js → GEXMM6KH.js} +2 -2
- package/dist/cdn/{A7YY6T4H.js → GGZWAR3W.js} +2 -2
- package/dist/cdn/{M24G5ENS.js → GIK5OZIS.js} +2 -2
- package/dist/cdn/GM3ALHL5.js +4 -0
- package/dist/cdn/{DTNMOSXM.js → GNX4I22M.js} +2 -2
- package/dist/cdn/{FIES7SOV.js → GUA64H6M.js} +2 -2
- package/dist/cdn/{IKP3BT3U.js → GVKFQEA2.js} +1 -1
- package/dist/cdn/{OMKFWWF5.js → GVSOYV56.js} +2 -2
- package/dist/cdn/{HB4EMB4C.js → GXINI4MN.js} +2 -2
- package/dist/cdn/{GQ2R2IHP.js → H3CJ2MAU.js} +2 -2
- package/dist/cdn/{W2K6MMS7.js → H5LIEP62.js} +2 -2
- package/dist/cdn/{PT5ZME7Y.js → H5W6LNNC.js} +2 -2
- package/dist/cdn/{X7YNIPSF.js → HEZEJ6QZ.js} +2 -2
- package/dist/cdn/{S7RHMIGZ.js → HHV6O2DG.js} +2 -2
- package/dist/cdn/{R7HZW754.js → HJCPJLLE.js} +2 -2
- package/dist/cdn/{3WYID4IK.js → HKDHVMCT.js} +1 -1
- package/dist/cdn/{M3SIHEKY.js → HMIDCSWP.js} +1 -1
- package/dist/cdn/{NAP36HOL.js → HOH22F7A.js} +2 -2
- package/dist/cdn/{YQSATS6B.js → HP4AUSXX.js} +2 -2
- package/dist/cdn/{JQUYMQXY.js → HUK6MMUX.js} +2 -2
- package/dist/cdn/{7GAZEK7V.js → HUNXV7DO.js} +2 -2
- package/dist/cdn/{4CA3T4ND.js → HUR2YS23.js} +2 -2
- package/dist/cdn/{5RMKJKWG.js → HWVKTGLU.js} +2 -2
- package/dist/cdn/{MDITECSY.js → HY6LSZ3L.js} +2 -2
- package/dist/cdn/{4CVFQUI6.js → HYEOKULF.js} +2 -2
- package/dist/cdn/{FI5NLFH6.js → ICSH6J5O.js} +2 -2
- package/dist/cdn/{RKII3Y2E.js → ICTIO6P3.js} +1 -1
- package/dist/cdn/{YUK6KOMS.js → IQ7M7MVG.js} +2 -2
- package/dist/cdn/{POHNJZ5F.js → ISZKU7F3.js} +2 -2
- package/dist/cdn/{CQOEIG42.js → ITSHYNKP.js} +2 -2
- package/dist/cdn/{QYRIIFTX.js → ITVZEYGA.js} +2 -2
- package/dist/cdn/{5PHUN34T.js → J2PMQVCA.js} +2 -2
- package/dist/cdn/J3HRJNJ6.js +4 -0
- package/dist/cdn/{D7RHZCHS.js → J4QJQPEX.js} +2 -2
- package/dist/cdn/{JJE4AU3R.js → JARCL3SE.js} +1 -1
- package/dist/cdn/{I43U7RCG.js → JAXEQQ7N.js} +2 -2
- package/dist/cdn/{D4NQ6VHT.js → JBLNCMEY.js} +2 -2
- package/dist/cdn/{BUVWVQEG.js → JJ5PLYIJ.js} +2 -2
- package/dist/cdn/{SOWL7IRZ.js → JJH5KYEW.js} +2 -2
- package/dist/cdn/{RREKT7ZJ.js → JKEDLI2L.js} +2 -2
- package/dist/cdn/{P7T2FFPU.js → JNL42UTE.js} +2 -2
- package/dist/cdn/{RMG2JE6X.js → JSAE2NSO.js} +2 -2
- package/dist/cdn/{R44EYGZM.js → JUF3AQNM.js} +2 -2
- package/dist/cdn/{2RPEHA5B.js → JYJBI5RV.js} +2 -2
- package/dist/cdn/{Z2LTLKYM.js → JZNS5KQF.js} +2 -2
- package/dist/cdn/{OWHST3FU.js → K2224LC4.js} +2 -2
- package/dist/cdn/{YUQG2T3T.js → K5COKOJS.js} +2 -2
- package/dist/cdn/{QTF7XTR5.js → KBBV74BZ.js} +2 -2
- package/dist/cdn/{SGLXLCRC.js → KD2HWH2Q.js} +1 -1
- package/dist/cdn/{VAKXZTWT.js → KJV3G43Y.js} +2 -2
- package/dist/cdn/{EF3Y37JM.js → KM7EFMTR.js} +1 -1
- package/dist/cdn/{JQWZODBQ.js → KQ3QPADR.js} +2 -2
- package/dist/cdn/{DJWH7VJX.js → KVHU3NPR.js} +2 -2
- package/dist/cdn/{WWWPTZFF.js → KXLOT2TZ.js} +2 -2
- package/dist/cdn/{RCFGLGSH.js → KZXLF2BE.js} +2 -2
- package/dist/cdn/{O3YQKHKV.js → LLMR5IFN.js} +2 -2
- package/dist/cdn/{YG4T5Y5X.js → LXQMHYH5.js} +2 -2
- package/dist/cdn/{2O3VIKXO.js → LZ3GK4UY.js} +2 -2
- package/dist/cdn/{PWX5P2F6.js → M5KXFEPP.js} +2 -2
- package/dist/cdn/{RI4GSOPD.js → MHS7S2U7.js} +1 -1
- package/dist/cdn/{WH77ZSQB.js → MKTAGEHI.js} +2 -2
- package/dist/cdn/{SK4W6TV4.js → MMTAYL3S.js} +1 -1
- package/dist/cdn/{26ZV67T6.js → MO3BCHML.js} +2 -2
- package/dist/cdn/{VK35ZASW.js → MO5RQMX2.js} +2 -2
- package/dist/cdn/{64KGVP2K.js → MSQJDAIC.js} +2 -2
- package/dist/cdn/{KWN45NS2.js → N7GLRM6G.js} +2 -2
- package/dist/cdn/{DOFZM7NG.js → NA6MAS4D.js} +2 -2
- package/dist/cdn/{IGEPMSYB.js → NUQ5T2XO.js} +1 -1
- package/dist/cdn/{HEWVVRHN.js → NZJGR5I7.js} +2 -2
- package/dist/cdn/{OKIHFITR.js → ODIBGTSR.js} +2 -2
- package/dist/cdn/{MHREYRSU.js → OFELIXD3.js} +2 -2
- package/dist/cdn/OFURCYRN.js +4 -0
- package/dist/cdn/{7CTETJGT.js → OIIEZYSH.js} +2 -2
- package/dist/cdn/{DRVEIOOG.js → OLT4G3YD.js} +2 -2
- package/dist/cdn/{J7I4MA3M.js → OQMHQHAD.js} +2 -2
- package/dist/cdn/{AL53TDEI.js → OX2ONC4R.js} +1 -1
- package/dist/cdn/{ZRREU4A3.js → PECGNCGL.js} +2 -2
- package/dist/cdn/{52I3QGYG.js → PETDJYSJ.js} +2 -2
- package/dist/cdn/PFUJRVC5.js +4 -0
- package/dist/cdn/{BPNEBFVH.js → PK2HSK5J.js} +2 -2
- package/dist/cdn/{FRURM6SD.js → POJ5QX4T.js} +2 -2
- package/dist/cdn/{JZUFAHXL.js → Q3HJV2C4.js} +2 -2
- package/dist/cdn/{CMMXYCTF.js → QD7CHJYC.js} +2 -2
- package/dist/cdn/{6XLN4WQC.js → QDUOMXEB.js} +2 -2
- package/dist/cdn/{RILXCMZX.js → QGYKGI2B.js} +2 -2
- package/dist/cdn/{6DPU46FG.js → QJRVJYEQ.js} +2 -2
- package/dist/cdn/{WEPP6GSL.js → QKW5V5HX.js} +2 -2
- package/dist/cdn/{W3CDVK3I.js → QPGYFZXL.js} +2 -2
- package/dist/cdn/{FS547A3X.js → QVMBWNST.js} +2 -2
- package/dist/cdn/{FKZCTSLA.js → QXKCR6PT.js} +2 -2
- package/dist/cdn/{PAG53BOU.js → RDLMG7U6.js} +2 -2
- package/dist/cdn/{4MEL4YTH.js → RF3QXKXK.js} +2 -2
- package/dist/cdn/{EKHOIL7R.js → RGXMEXJY.js} +2 -2
- package/dist/cdn/{QYCIBHHC.js → RSZFBIDH.js} +2 -2
- package/dist/cdn/{47V3D3BB.js → RUY4HRAE.js} +2 -2
- package/dist/cdn/{AZARLDDB.js → RXWKEZTK.js} +2 -2
- package/dist/cdn/{KUW2KIP4.js → S77UYDKU.js} +2 -2
- package/dist/cdn/{ZLNMA7QI.js → S7J3G6ZY.js} +2 -2
- package/dist/cdn/{F3OFLQJ5.js → SQMACEDJ.js} +2 -2
- package/dist/cdn/{HXHE3X6C.js → SSNEZ7ML.js} +2 -2
- package/dist/cdn/{FQ6ZQSI4.js → SSYNFIHT.js} +2 -2
- package/dist/cdn/{E4E4GWWX.js → SVAO6JAV.js} +2 -2
- package/dist/cdn/{DCDFS5I7.js → SXCBIZN3.js} +2 -2
- package/dist/cdn/{AHD6I4CT.js → T57UAZUE.js} +2 -2
- package/dist/cdn/{VO2OIB3R.js → TFOB7RLD.js} +2 -2
- package/dist/cdn/{HX6EZTH3.js → TGJIMSBZ.js} +2 -2
- package/dist/cdn/{LNXCSXE6.js → TGR67UED.js} +2 -2
- package/dist/cdn/{XVKFFSPP.js → TJXDEM6Q.js} +2 -2
- package/dist/cdn/{KFJGRB7S.js → TSF2ZBCT.js} +2 -2
- package/dist/cdn/{Z7BDXEOS.js → TW6UUVYU.js} +2 -2
- package/dist/cdn/{CAVAXU5Q.js → TXQJA5FF.js} +2 -2
- package/dist/cdn/{KBD36R7K.js → UCC7U6GD.js} +2 -2
- package/dist/cdn/{GGDOVWBD.js → UCJNRCKN.js} +2 -2
- package/dist/cdn/{F6GST26I.js → UD7ZPBG3.js} +2 -2
- package/dist/cdn/{ZC647ZYD.js → UIVEMXY2.js} +2 -2
- package/dist/cdn/{6QGA53SP.js → UOHYBZBX.js} +2 -2
- package/dist/cdn/{CUDMW3ZV.js → UW5HVT3W.js} +2 -2
- package/dist/cdn/{UAMR6EQ6.js → UYILCCTR.js} +2 -2
- package/dist/cdn/{F6NSSGOA.js → V2R2GXZL.js} +2 -2
- package/dist/cdn/{URWBTNYE.js → VAABAGMS.js} +2 -2
- package/dist/cdn/{4E6OLHFL.js → VE52ZFSD.js} +2 -2
- package/dist/cdn/{CUT5F2GZ.js → VLRB2BHD.js} +2 -2
- package/dist/cdn/{S25I24H5.js → VSIN7VHG.js} +2 -2
- package/dist/cdn/{5L72KAPA.js → WFF4NLPZ.js} +2 -2
- package/dist/cdn/{OYBNHWU2.js → WODQZC7Q.js} +2 -2
- package/dist/cdn/{3JQTFSTI.js → WTREYBMC.js} +2 -2
- package/dist/cdn/{CRUY4QFF.js → WUV2PCXK.js} +2 -2
- package/dist/cdn/{G7E2U46A.js → WVV72KBU.js} +2 -2
- package/dist/cdn/{Y6ZFCZMV.js → X3SUAHI7.js} +2 -2
- package/dist/cdn/{BOZ7PM3D.js → X67YGVLO.js} +2 -2
- package/dist/cdn/{AW3EVZIG.js → X6WGD4Y7.js} +2 -2
- package/dist/cdn/{44W63RZH.js → XCLMIOTU.js} +2 -2
- package/dist/cdn/{2IVQGQ4C.js → XEBUFSBL.js} +1 -1
- package/dist/cdn/{ZFNL3BAW.js → XIUV7TMN.js} +2 -2
- package/dist/cdn/{BC3ZRNY5.js → XTKUZHBD.js} +2 -2
- package/dist/cdn/{VQ7N76EM.js → XVMLTYPU.js} +2 -2
- package/dist/cdn/{LPGPODTD.js → Y3FCLFWR.js} +2 -2
- package/dist/cdn/{5XOP67I5.js → Y6JBPHYK.js} +2 -2
- package/dist/cdn/{CDOBXWT3.js → YQ3LN2SF.js} +2 -2
- package/dist/cdn/YSDAHD65.js +4 -0
- package/dist/cdn/{G5RWN5K4.js → Z6CYQBX7.js} +2 -2
- package/dist/cdn/{2KYGTWEX.js → Z7DXXHXA.js} +1 -1
- package/dist/cdn/{F764WRNS.js → ZI757KTC.js} +2 -2
- package/dist/cdn/{7OW7PHJU.js → ZPJDWRO3.js} +2 -2
- package/dist/cdn/{G2RYADQK.js → ZVY6BTWD.js} +2 -2
- package/dist/cdn/{EE3BQEIZ.js → ZW4YFKUP.js} +2 -2
- package/dist/cdn/assets/volume-measurement/t9n/messages.en.json +1 -1
- 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 +8 -6
- 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.d.ts +2 -0
- 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.d.ts +2 -0
- package/dist/components/arcgis-unit-select/customElement.js +15 -15
- 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/VolumeMeasurementViewModel.d.ts +17 -4
- package/dist/components/arcgis-volume-measurement/customElement.d.ts +18 -3
- package/dist/components/arcgis-volume-measurement/customElement.js +168 -105
- package/dist/components/arcgis-volume-measurement/index.d.ts +1 -1
- package/dist/components/arcgis-volume-measurement/index.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 +22091 -21571
- package/dist/docs/docs.json +2323 -2050
- package/dist/docs/vscode.html-custom-data.json +148 -76
- package/dist/docs/web-types.json +177 -87
- package/dist/index.d.ts +74 -74
- package/dist/index.js +1 -1
- package/dist/loader.js +4 -4
- package/dist/support/measurementUtils.d.ts +5 -1
- package/dist/types/components.d.ts +1 -0
- package/dist/types/lumina.d.ts +76 -76
- package/dist/types/preact.d.ts +76 -76
- package/dist/types/react.d.ts +76 -76
- package/dist/types/stencil.d.ts +76 -76
- package/package.json +4 -4
- package/dist/cdn/54NHWBUI.js +0 -4
- package/dist/cdn/GKDB2OF5.js +0 -4
- package/dist/cdn/GUCWXGCY.js +0 -4
- package/dist/cdn/JNLPRU7R.js +0 -4
- package/dist/cdn/MIJ3XAHW.js +0 -4
- package/dist/cdn/XJOYP2RR.js +0 -4
package/dist/docs/web-types.json
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
|
|
3
3
|
"name": "@arcgis/map-components",
|
|
4
|
-
"version": "5.0.0-next.
|
|
4
|
+
"version": "5.0.0-next.118",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
8
8
|
"elements": [
|
|
9
9
|
{
|
|
10
10
|
"name": "arcgis-area-measurement-2d",
|
|
11
|
-
"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<
|
|
11
|
+
"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.",
|
|
12
12
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/",
|
|
13
13
|
"attributes": [
|
|
14
14
|
{
|
|
@@ -160,7 +160,7 @@
|
|
|
160
160
|
},
|
|
161
161
|
{
|
|
162
162
|
"name": "arcgis-area-measurement-3d",
|
|
163
|
-
"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<
|
|
163
|
+
"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.",
|
|
164
164
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/",
|
|
165
165
|
"attributes": [
|
|
166
166
|
{
|
|
@@ -311,7 +311,7 @@
|
|
|
311
311
|
},
|
|
312
312
|
{
|
|
313
313
|
"name": "arcgis-attachments",
|
|
314
|
-
"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<
|
|
314
|
+
"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.",
|
|
315
315
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-attachments/",
|
|
316
316
|
"attributes": [
|
|
317
317
|
{
|
|
@@ -556,7 +556,7 @@
|
|
|
556
556
|
},
|
|
557
557
|
{
|
|
558
558
|
"name": "arcgis-basemap-gallery",
|
|
559
|
-
"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<
|
|
559
|
+
"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.",
|
|
560
560
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/",
|
|
561
561
|
"attributes": [
|
|
562
562
|
{
|
|
@@ -720,7 +720,7 @@
|
|
|
720
720
|
},
|
|
721
721
|
{
|
|
722
722
|
"name": "arcgis-basemap-layer-list",
|
|
723
|
-
"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<
|
|
723
|
+
"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.",
|
|
724
724
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/",
|
|
725
725
|
"attributes": [
|
|
726
726
|
{
|
|
@@ -1197,7 +1197,7 @@
|
|
|
1197
1197
|
},
|
|
1198
1198
|
{
|
|
1199
1199
|
"name": "arcgis-basemap-toggle",
|
|
1200
|
-
"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<
|
|
1200
|
+
"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).",
|
|
1201
1201
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/",
|
|
1202
1202
|
"attributes": [
|
|
1203
1203
|
{
|
|
@@ -1340,7 +1340,7 @@
|
|
|
1340
1340
|
},
|
|
1341
1341
|
{
|
|
1342
1342
|
"name": "arcgis-bookmarks",
|
|
1343
|
-
"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<
|
|
1343
|
+
"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.",
|
|
1344
1344
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/",
|
|
1345
1345
|
"attributes": [
|
|
1346
1346
|
{
|
|
@@ -1708,7 +1708,7 @@
|
|
|
1708
1708
|
},
|
|
1709
1709
|
{
|
|
1710
1710
|
"name": "arcgis-building-explorer",
|
|
1711
|
-
"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<
|
|
1711
|
+
"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.",
|
|
1712
1712
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/",
|
|
1713
1713
|
"attributes": [
|
|
1714
1714
|
{
|
|
@@ -1918,7 +1918,7 @@
|
|
|
1918
1918
|
},
|
|
1919
1919
|
{
|
|
1920
1920
|
"name": "arcgis-building-level-item",
|
|
1921
|
-
"description": "### Events\n- **arcgisTileBlur**\n- **arcgisTileFocus**\n- **arcgisTileSelect**\n\n### Methods\n- `componentOnReady(): Promise<
|
|
1921
|
+
"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.",
|
|
1922
1922
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-level-item/",
|
|
1923
1923
|
"attributes": [
|
|
1924
1924
|
{
|
|
@@ -2029,7 +2029,7 @@
|
|
|
2029
2029
|
},
|
|
2030
2030
|
{
|
|
2031
2031
|
"name": "arcgis-catalog-layer-list",
|
|
2032
|
-
"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<
|
|
2032
|
+
"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.",
|
|
2033
2033
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-catalog-layer-list/",
|
|
2034
2034
|
"attributes": [
|
|
2035
2035
|
{
|
|
@@ -2396,7 +2396,7 @@
|
|
|
2396
2396
|
},
|
|
2397
2397
|
{
|
|
2398
2398
|
"name": "arcgis-compass",
|
|
2399
|
-
"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<
|
|
2399
|
+
"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>`",
|
|
2400
2400
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-compass/",
|
|
2401
2401
|
"attributes": [
|
|
2402
2402
|
{
|
|
@@ -2527,7 +2527,7 @@
|
|
|
2527
2527
|
},
|
|
2528
2528
|
{
|
|
2529
2529
|
"name": "arcgis-coordinate-conversion",
|
|
2530
|
-
"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<
|
|
2530
|
+
"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.",
|
|
2531
2531
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-coordinate-conversion/",
|
|
2532
2532
|
"attributes": [
|
|
2533
2533
|
{
|
|
@@ -2822,7 +2822,7 @@
|
|
|
2822
2822
|
},
|
|
2823
2823
|
{
|
|
2824
2824
|
"name": "arcgis-daylight",
|
|
2825
|
-
"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<
|
|
2825
|
+
"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.",
|
|
2826
2826
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/",
|
|
2827
2827
|
"attributes": [
|
|
2828
2828
|
{
|
|
@@ -3114,7 +3114,7 @@
|
|
|
3114
3114
|
},
|
|
3115
3115
|
{
|
|
3116
3116
|
"name": "arcgis-directional-pad",
|
|
3117
|
-
"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<
|
|
3117
|
+
"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.",
|
|
3118
3118
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directional-pad/",
|
|
3119
3119
|
"attributes": [
|
|
3120
3120
|
{
|
|
@@ -3294,7 +3294,7 @@
|
|
|
3294
3294
|
},
|
|
3295
3295
|
{
|
|
3296
3296
|
"name": "arcgis-directions",
|
|
3297
|
-
"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<
|
|
3297
|
+
"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>`",
|
|
3298
3298
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directions/",
|
|
3299
3299
|
"attributes": [
|
|
3300
3300
|
{
|
|
@@ -3547,7 +3547,7 @@
|
|
|
3547
3547
|
},
|
|
3548
3548
|
{
|
|
3549
3549
|
"name": "arcgis-direct-line-measurement-3d",
|
|
3550
|
-
"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<
|
|
3550
|
+
"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.",
|
|
3551
3551
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/",
|
|
3552
3552
|
"attributes": [
|
|
3553
3553
|
{
|
|
@@ -3695,7 +3695,7 @@
|
|
|
3695
3695
|
},
|
|
3696
3696
|
{
|
|
3697
3697
|
"name": "arcgis-distance-measurement-2d",
|
|
3698
|
-
"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<
|
|
3698
|
+
"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.",
|
|
3699
3699
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/",
|
|
3700
3700
|
"attributes": [
|
|
3701
3701
|
{
|
|
@@ -3844,7 +3844,7 @@
|
|
|
3844
3844
|
},
|
|
3845
3845
|
{
|
|
3846
3846
|
"name": "arcgis-editor",
|
|
3847
|
-
"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<
|
|
3847
|
+
"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>`",
|
|
3848
3848
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-editor/",
|
|
3849
3849
|
"attributes": [
|
|
3850
3850
|
{
|
|
@@ -4236,7 +4236,7 @@
|
|
|
4236
4236
|
},
|
|
4237
4237
|
{
|
|
4238
4238
|
"name": "arcgis-elevation-profile",
|
|
4239
|
-
"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<
|
|
4239
|
+
"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).",
|
|
4240
4240
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/",
|
|
4241
4241
|
"attributes": [
|
|
4242
4242
|
{
|
|
@@ -4520,11 +4520,6 @@
|
|
|
4520
4520
|
"description": "If true, the component will not highlight features selected in the view.",
|
|
4521
4521
|
"type": "boolean"
|
|
4522
4522
|
},
|
|
4523
|
-
{
|
|
4524
|
-
"name": "icon",
|
|
4525
|
-
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
4526
|
-
"type": "IconName"
|
|
4527
|
-
},
|
|
4528
4523
|
{
|
|
4529
4524
|
"name": "indicatorRelativePosition",
|
|
4530
4525
|
"description": "Relative position along the current elevation profile line, in the range [0, 1].\nThe component updates this value as the user hovers the chart.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ElevationProfileAnalysisView3D.html#indicatorRelativePosition)",
|
|
@@ -4587,7 +4582,7 @@
|
|
|
4587
4582
|
},
|
|
4588
4583
|
{
|
|
4589
4584
|
"name": "arcgis-expand",
|
|
4590
|
-
"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<
|
|
4585
|
+
"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.",
|
|
4591
4586
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/",
|
|
4592
4587
|
"attributes": [
|
|
4593
4588
|
{
|
|
@@ -4866,7 +4861,7 @@
|
|
|
4866
4861
|
},
|
|
4867
4862
|
{
|
|
4868
4863
|
"name": "arcgis-feature",
|
|
4869
|
-
"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<
|
|
4864
|
+
"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.",
|
|
4870
4865
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature/",
|
|
4871
4866
|
"attributes": [
|
|
4872
4867
|
{
|
|
@@ -5214,7 +5209,7 @@
|
|
|
5214
5209
|
},
|
|
5215
5210
|
{
|
|
5216
5211
|
"name": "arcgis-feature-form",
|
|
5217
|
-
"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<
|
|
5212
|
+
"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.",
|
|
5218
5213
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-form/",
|
|
5219
5214
|
"attributes": [
|
|
5220
5215
|
{
|
|
@@ -5408,7 +5403,7 @@
|
|
|
5408
5403
|
},
|
|
5409
5404
|
{
|
|
5410
5405
|
"name": "arcgis-feature-table",
|
|
5411
|
-
"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<
|
|
5406
|
+
"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>`",
|
|
5412
5407
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-table/",
|
|
5413
5408
|
"attributes": [
|
|
5414
5409
|
{
|
|
@@ -6390,7 +6385,7 @@
|
|
|
6390
6385
|
},
|
|
6391
6386
|
{
|
|
6392
6387
|
"name": "arcgis-feature-templates",
|
|
6393
|
-
"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<
|
|
6388
|
+
"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.",
|
|
6394
6389
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-templates/",
|
|
6395
6390
|
"attributes": [
|
|
6396
6391
|
{
|
|
@@ -6594,7 +6589,7 @@
|
|
|
6594
6589
|
},
|
|
6595
6590
|
{
|
|
6596
6591
|
"name": "arcgis-features",
|
|
6597
|
-
"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<
|
|
6592
|
+
"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.",
|
|
6598
6593
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/",
|
|
6599
6594
|
"attributes": [
|
|
6600
6595
|
{
|
|
@@ -7246,7 +7241,7 @@
|
|
|
7246
7241
|
},
|
|
7247
7242
|
{
|
|
7248
7243
|
"name": "arcgis-floor-filter",
|
|
7249
|
-
"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<
|
|
7244
|
+
"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>`",
|
|
7250
7245
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-floor-filter/",
|
|
7251
7246
|
"attributes": [
|
|
7252
7247
|
{
|
|
@@ -7387,7 +7382,7 @@
|
|
|
7387
7382
|
},
|
|
7388
7383
|
{
|
|
7389
7384
|
"name": "arcgis-fullscreen",
|
|
7390
|
-
"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<
|
|
7385
|
+
"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.",
|
|
7391
7386
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-fullscreen/",
|
|
7392
7387
|
"attributes": [
|
|
7393
7388
|
{
|
|
@@ -7499,7 +7494,7 @@
|
|
|
7499
7494
|
},
|
|
7500
7495
|
{
|
|
7501
7496
|
"name": "arcgis-grid-controls",
|
|
7502
|
-
"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<
|
|
7497
|
+
"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.",
|
|
7503
7498
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-grid-controls/",
|
|
7504
7499
|
"attributes": [
|
|
7505
7500
|
{
|
|
@@ -7919,7 +7914,7 @@
|
|
|
7919
7914
|
},
|
|
7920
7915
|
{
|
|
7921
7916
|
"name": "arcgis-histogram-range-slider",
|
|
7922
|
-
"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<
|
|
7917
|
+
"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",
|
|
7923
7918
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-histogram-range-slider/",
|
|
7924
7919
|
"attributes": [
|
|
7925
7920
|
{
|
|
@@ -8162,7 +8157,7 @@
|
|
|
8162
8157
|
},
|
|
8163
8158
|
{
|
|
8164
8159
|
"name": "arcgis-home",
|
|
8165
|
-
"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<
|
|
8160
|
+
"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`.",
|
|
8166
8161
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-home/",
|
|
8167
8162
|
"attributes": [
|
|
8168
8163
|
{
|
|
@@ -8302,7 +8297,7 @@
|
|
|
8302
8297
|
},
|
|
8303
8298
|
{
|
|
8304
8299
|
"name": "arcgis-layer-list",
|
|
8305
|
-
"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<
|
|
8300
|
+
"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>`",
|
|
8306
8301
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-layer-list/",
|
|
8307
8302
|
"attributes": [
|
|
8308
8303
|
{
|
|
@@ -8728,7 +8723,7 @@
|
|
|
8728
8723
|
},
|
|
8729
8724
|
{
|
|
8730
8725
|
"name": "arcgis-legend",
|
|
8731
|
-
"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<
|
|
8726
|
+
"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.",
|
|
8732
8727
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/",
|
|
8733
8728
|
"attributes": [
|
|
8734
8729
|
{
|
|
@@ -8967,7 +8962,7 @@
|
|
|
8967
8962
|
},
|
|
8968
8963
|
{
|
|
8969
8964
|
"name": "arcgis-line-of-sight",
|
|
8970
|
-
"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<
|
|
8965
|
+
"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.",
|
|
8971
8966
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-line-of-sight/",
|
|
8972
8967
|
"attributes": [
|
|
8973
8968
|
{
|
|
@@ -9089,7 +9084,7 @@
|
|
|
9089
9084
|
},
|
|
9090
9085
|
{
|
|
9091
9086
|
"name": "arcgis-link-chart",
|
|
9092
|
-
"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<
|
|
9087
|
+
"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. ",
|
|
9093
9088
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/",
|
|
9094
9089
|
"attributes": [
|
|
9095
9090
|
{
|
|
@@ -9762,7 +9757,7 @@
|
|
|
9762
9757
|
},
|
|
9763
9758
|
{
|
|
9764
9759
|
"name": "arcgis-link-chart-layout-switcher",
|
|
9765
|
-
"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<
|
|
9760
|
+
"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.",
|
|
9766
9761
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart-layout-switcher/",
|
|
9767
9762
|
"attributes": [
|
|
9768
9763
|
{
|
|
@@ -9923,7 +9918,7 @@
|
|
|
9923
9918
|
},
|
|
9924
9919
|
{
|
|
9925
9920
|
"name": "arcgis-locate",
|
|
9926
|
-
"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<
|
|
9921
|
+
"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>`",
|
|
9927
9922
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-locate/",
|
|
9928
9923
|
"attributes": [
|
|
9929
9924
|
{
|
|
@@ -10111,7 +10106,7 @@
|
|
|
10111
10106
|
},
|
|
10112
10107
|
{
|
|
10113
10108
|
"name": "arcgis-map",
|
|
10114
|
-
"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. ",
|
|
10109
|
+
"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. ",
|
|
10115
10110
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/",
|
|
10116
10111
|
"attributes": [
|
|
10117
10112
|
{
|
|
@@ -10805,7 +10800,7 @@
|
|
|
10805
10800
|
},
|
|
10806
10801
|
{
|
|
10807
10802
|
"name": "arcgis-measurement",
|
|
10808
|
-
"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<
|
|
10803
|
+
"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>`",
|
|
10809
10804
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-measurement/",
|
|
10810
10805
|
"attributes": [
|
|
10811
10806
|
{
|
|
@@ -10981,7 +10976,7 @@
|
|
|
10981
10976
|
},
|
|
10982
10977
|
{
|
|
10983
10978
|
"name": "arcgis-navigation-toggle",
|
|
10984
|
-
"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<
|
|
10979
|
+
"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>`",
|
|
10985
10980
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-navigation-toggle/",
|
|
10986
10981
|
"attributes": [
|
|
10987
10982
|
{
|
|
@@ -11132,7 +11127,7 @@
|
|
|
11132
11127
|
},
|
|
11133
11128
|
{
|
|
11134
11129
|
"name": "arcgis-oriented-imagery-viewer",
|
|
11135
|
-
"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<
|
|
11130
|
+
"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.",
|
|
11136
11131
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-oriented-imagery-viewer/",
|
|
11137
11132
|
"attributes": [
|
|
11138
11133
|
{
|
|
@@ -11369,7 +11364,7 @@
|
|
|
11369
11364
|
},
|
|
11370
11365
|
{
|
|
11371
11366
|
"name": "arcgis-popup",
|
|
11372
|
-
"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<
|
|
11367
|
+
"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.",
|
|
11373
11368
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/",
|
|
11374
11369
|
"attributes": [
|
|
11375
11370
|
{
|
|
@@ -11842,7 +11837,7 @@
|
|
|
11842
11837
|
},
|
|
11843
11838
|
{
|
|
11844
11839
|
"name": "arcgis-presentation",
|
|
11845
|
-
"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<
|
|
11840
|
+
"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",
|
|
11846
11841
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-presentation/",
|
|
11847
11842
|
"attributes": [
|
|
11848
11843
|
{
|
|
@@ -11927,7 +11922,7 @@
|
|
|
11927
11922
|
},
|
|
11928
11923
|
{
|
|
11929
11924
|
"name": "arcgis-print",
|
|
11930
|
-
"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<
|
|
11925
|
+
"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.",
|
|
11931
11926
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-print/",
|
|
11932
11927
|
"attributes": [
|
|
11933
11928
|
{
|
|
@@ -12271,7 +12266,7 @@
|
|
|
12271
12266
|
},
|
|
12272
12267
|
{
|
|
12273
12268
|
"name": "arcgis-scale-bar",
|
|
12274
|
-
"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<
|
|
12269
|
+
"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.",
|
|
12275
12270
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-bar/",
|
|
12276
12271
|
"attributes": [
|
|
12277
12272
|
{
|
|
@@ -12388,7 +12383,7 @@
|
|
|
12388
12383
|
},
|
|
12389
12384
|
{
|
|
12390
12385
|
"name": "arcgis-scale-range-slider",
|
|
12391
|
-
"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<
|
|
12386
|
+
"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.",
|
|
12392
12387
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-range-slider/",
|
|
12393
12388
|
"attributes": [
|
|
12394
12389
|
{
|
|
@@ -12626,7 +12621,7 @@
|
|
|
12626
12621
|
},
|
|
12627
12622
|
{
|
|
12628
12623
|
"name": "arcgis-scene",
|
|
12629
|
-
"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. ",
|
|
12624
|
+
"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. ",
|
|
12630
12625
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/",
|
|
12631
12626
|
"attributes": [
|
|
12632
12627
|
{
|
|
@@ -13071,7 +13066,7 @@
|
|
|
13071
13066
|
},
|
|
13072
13067
|
{
|
|
13073
13068
|
"name": "focusAreas",
|
|
13074
|
-
"description": "A container of all [focus areas](https://developers.arcgis.com/javascript/latest/api-reference/esri-effects-FocusAreas.html) present in the map.\n\n> [!WARNING]\n>\n> **Known Limitations**\n> Focus areas are only supported in [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).",
|
|
13069
|
+
"description": "A container of all [focus areas](https://developers.arcgis.com/javascript/latest/api-reference/esri-effects-FocusAreas.html) present in the map.\n\n> [!WARNING]\n>\n> **Known Limitations**\n>\n> Focus areas are only supported in [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).",
|
|
13075
13070
|
"type": "FocusAreas"
|
|
13076
13071
|
},
|
|
13077
13072
|
{
|
|
@@ -13371,7 +13366,7 @@
|
|
|
13371
13366
|
},
|
|
13372
13367
|
{
|
|
13373
13368
|
"name": "arcgis-search",
|
|
13374
|
-
"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<
|
|
13369
|
+
"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`.",
|
|
13375
13370
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/",
|
|
13376
13371
|
"attributes": [
|
|
13377
13372
|
{
|
|
@@ -13802,7 +13797,7 @@
|
|
|
13802
13797
|
},
|
|
13803
13798
|
{
|
|
13804
13799
|
"name": "arcgis-search-result-renderer",
|
|
13805
|
-
"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<
|
|
13800
|
+
"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.",
|
|
13806
13801
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search-result-renderer/",
|
|
13807
13802
|
"attributes": [
|
|
13808
13803
|
{
|
|
@@ -13848,7 +13843,7 @@
|
|
|
13848
13843
|
},
|
|
13849
13844
|
{
|
|
13850
13845
|
"name": "arcgis-shadow-cast",
|
|
13851
|
-
"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<
|
|
13846
|
+
"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)",
|
|
13852
13847
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/",
|
|
13853
13848
|
"attributes": [
|
|
13854
13849
|
{
|
|
@@ -14393,7 +14388,7 @@
|
|
|
14393
14388
|
},
|
|
14394
14389
|
{
|
|
14395
14390
|
"name": "arcgis-sketch",
|
|
14396
|
-
"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<
|
|
14391
|
+
"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>`",
|
|
14397
14392
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-sketch/",
|
|
14398
14393
|
"attributes": [
|
|
14399
14394
|
{
|
|
@@ -14999,7 +14994,7 @@
|
|
|
14999
14994
|
},
|
|
15000
14995
|
{
|
|
15001
14996
|
"name": "arcgis-slice",
|
|
15002
|
-
"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<
|
|
14997
|
+
"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`.",
|
|
15003
14998
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/",
|
|
15004
14999
|
"attributes": [
|
|
15005
15000
|
{
|
|
@@ -15178,7 +15173,7 @@
|
|
|
15178
15173
|
},
|
|
15179
15174
|
{
|
|
15180
15175
|
"name": "arcgis-color-select",
|
|
15181
|
-
"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<
|
|
15176
|
+
"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.",
|
|
15182
15177
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-color-select/",
|
|
15183
15178
|
"attributes": [
|
|
15184
15179
|
{
|
|
@@ -15227,7 +15222,7 @@
|
|
|
15227
15222
|
},
|
|
15228
15223
|
{
|
|
15229
15224
|
"name": "arcgis-webgl-error",
|
|
15230
|
-
"description": "Warning for WebGL errors.\n--\n\n### Methods\n- `componentOnReady(): Promise<
|
|
15225
|
+
"description": "Warning for WebGL errors.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.",
|
|
15231
15226
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-webgl-error/",
|
|
15232
15227
|
"attributes": [
|
|
15233
15228
|
{
|
|
@@ -15253,7 +15248,7 @@
|
|
|
15253
15248
|
},
|
|
15254
15249
|
{
|
|
15255
15250
|
"name": "arcgis-swipe",
|
|
15256
|
-
"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<
|
|
15251
|
+
"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.",
|
|
15257
15252
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/",
|
|
15258
15253
|
"attributes": [
|
|
15259
15254
|
{
|
|
@@ -15463,7 +15458,7 @@
|
|
|
15463
15458
|
},
|
|
15464
15459
|
{
|
|
15465
15460
|
"name": "arcgis-table-list",
|
|
15466
|
-
"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<
|
|
15461
|
+
"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.",
|
|
15467
15462
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-table-list/",
|
|
15468
15463
|
"attributes": [
|
|
15469
15464
|
{
|
|
@@ -15820,7 +15815,7 @@
|
|
|
15820
15815
|
},
|
|
15821
15816
|
{
|
|
15822
15817
|
"name": "arcgis-time-slider",
|
|
15823
|
-
"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<
|
|
15818
|
+
"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>`",
|
|
15824
15819
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-time-slider/",
|
|
15825
15820
|
"attributes": [
|
|
15826
15821
|
{
|
|
@@ -16058,7 +16053,7 @@
|
|
|
16058
16053
|
},
|
|
16059
16054
|
{
|
|
16060
16055
|
"name": "arcgis-time-zone-label",
|
|
16061
|
-
"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<
|
|
16056
|
+
"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.",
|
|
16062
16057
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-time-zone-label/",
|
|
16063
16058
|
"attributes": [
|
|
16064
16059
|
{
|
|
@@ -16206,7 +16201,7 @@
|
|
|
16206
16201
|
},
|
|
16207
16202
|
{
|
|
16208
16203
|
"name": "arcgis-track",
|
|
16209
|
-
"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<
|
|
16204
|
+
"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.",
|
|
16210
16205
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-track/",
|
|
16211
16206
|
"attributes": [
|
|
16212
16207
|
{
|
|
@@ -16414,7 +16409,7 @@
|
|
|
16414
16409
|
},
|
|
16415
16410
|
{
|
|
16416
16411
|
"name": "arcgis-utility-network-associations",
|
|
16417
|
-
"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<
|
|
16412
|
+
"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.",
|
|
16418
16413
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-associations/",
|
|
16419
16414
|
"attributes": [
|
|
16420
16415
|
{
|
|
@@ -16903,7 +16898,7 @@
|
|
|
16903
16898
|
},
|
|
16904
16899
|
{
|
|
16905
16900
|
"name": "arcgis-utility-network-trace",
|
|
16906
|
-
"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<
|
|
16901
|
+
"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.",
|
|
16907
16902
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace/",
|
|
16908
16903
|
"attributes": [
|
|
16909
16904
|
{
|
|
@@ -17136,7 +17131,7 @@
|
|
|
17136
17131
|
},
|
|
17137
17132
|
{
|
|
17138
17133
|
"name": "arcgis-utility-network-trace-analysis",
|
|
17139
|
-
"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<
|
|
17134
|
+
"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.",
|
|
17140
17135
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace-analysis/",
|
|
17141
17136
|
"attributes": [
|
|
17142
17137
|
{
|
|
@@ -17312,7 +17307,7 @@
|
|
|
17312
17307
|
},
|
|
17313
17308
|
{
|
|
17314
17309
|
"name": "arcgis-utility-network-subnetwork-info",
|
|
17315
|
-
"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<
|
|
17310
|
+
"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.",
|
|
17316
17311
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-subnetwork-info/",
|
|
17317
17312
|
"attributes": [],
|
|
17318
17313
|
"events": [],
|
|
@@ -17328,7 +17323,7 @@
|
|
|
17328
17323
|
},
|
|
17329
17324
|
{
|
|
17330
17325
|
"name": "arcgis-utility-network-trace-inputs",
|
|
17331
|
-
"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<
|
|
17326
|
+
"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.",
|
|
17332
17327
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace-inputs/",
|
|
17333
17328
|
"attributes": [
|
|
17334
17329
|
{
|
|
@@ -17441,7 +17436,7 @@
|
|
|
17441
17436
|
},
|
|
17442
17437
|
{
|
|
17443
17438
|
"name": "arcgis-utility-network-trace-location",
|
|
17444
|
-
"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<
|
|
17439
|
+
"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.",
|
|
17445
17440
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace-location/",
|
|
17446
17441
|
"attributes": [
|
|
17447
17442
|
{
|
|
@@ -17539,7 +17534,7 @@
|
|
|
17539
17534
|
},
|
|
17540
17535
|
{
|
|
17541
17536
|
"name": "arcgis-utility-network-trace-location-list",
|
|
17542
|
-
"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<
|
|
17537
|
+
"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.",
|
|
17543
17538
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace-location-list/",
|
|
17544
17539
|
"attributes": [
|
|
17545
17540
|
{
|
|
@@ -17571,7 +17566,7 @@
|
|
|
17571
17566
|
},
|
|
17572
17567
|
{
|
|
17573
17568
|
"name": "arcgis-utility-network-trace-results",
|
|
17574
|
-
"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<
|
|
17569
|
+
"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.",
|
|
17575
17570
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace-results/",
|
|
17576
17571
|
"attributes": [
|
|
17577
17572
|
{
|
|
@@ -17693,7 +17688,7 @@
|
|
|
17693
17688
|
},
|
|
17694
17689
|
{
|
|
17695
17690
|
"name": "arcgis-utility-network-validate-topology",
|
|
17696
|
-
"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<
|
|
17691
|
+
"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.",
|
|
17697
17692
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-validate-topology/",
|
|
17698
17693
|
"attributes": [
|
|
17699
17694
|
{
|
|
@@ -17816,7 +17811,7 @@
|
|
|
17816
17811
|
},
|
|
17817
17812
|
{
|
|
17818
17813
|
"name": "arcgis-value-picker",
|
|
17819
|
-
"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<
|
|
17814
|
+
"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>`",
|
|
17820
17815
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-value-picker/",
|
|
17821
17816
|
"attributes": [
|
|
17822
17817
|
{
|
|
@@ -18075,7 +18070,7 @@
|
|
|
18075
18070
|
},
|
|
18076
18071
|
{
|
|
18077
18072
|
"name": "arcgis-version-management",
|
|
18078
|
-
"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<
|
|
18073
|
+
"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.",
|
|
18079
18074
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-version-management/",
|
|
18080
18075
|
"attributes": [
|
|
18081
18076
|
{
|
|
@@ -18239,7 +18234,7 @@
|
|
|
18239
18234
|
},
|
|
18240
18235
|
{
|
|
18241
18236
|
"name": "arcgis-video",
|
|
18242
|
-
"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<
|
|
18237
|
+
"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. ",
|
|
18243
18238
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/",
|
|
18244
18239
|
"attributes": [
|
|
18245
18240
|
{
|
|
@@ -18351,7 +18346,7 @@
|
|
|
18351
18346
|
},
|
|
18352
18347
|
{
|
|
18353
18348
|
"name": "arcgis-video-player",
|
|
18354
|
-
"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<
|
|
18349
|
+
"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.",
|
|
18355
18350
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/",
|
|
18356
18351
|
"attributes": [
|
|
18357
18352
|
{
|
|
@@ -18533,7 +18528,7 @@
|
|
|
18533
18528
|
},
|
|
18534
18529
|
{
|
|
18535
18530
|
"name": "arcgis-volume-measurement",
|
|
18536
|
-
"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<
|
|
18531
|
+
"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.",
|
|
18537
18532
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-volume-measurement/",
|
|
18538
18533
|
"attributes": [
|
|
18539
18534
|
{
|
|
@@ -18544,6 +18539,24 @@
|
|
|
18544
18539
|
"type": "boolean"
|
|
18545
18540
|
}
|
|
18546
18541
|
},
|
|
18542
|
+
{
|
|
18543
|
+
"name": "elevation-input-unit",
|
|
18544
|
+
"value": {
|
|
18545
|
+
"type": [
|
|
18546
|
+
"\"centimeters\"",
|
|
18547
|
+
"\"decimeters\"",
|
|
18548
|
+
"\"feet\"",
|
|
18549
|
+
"\"inches\"",
|
|
18550
|
+
"\"kilometers\"",
|
|
18551
|
+
"\"meters\"",
|
|
18552
|
+
"\"miles\"",
|
|
18553
|
+
"\"millimeters\"",
|
|
18554
|
+
"\"nautical-miles\"",
|
|
18555
|
+
"\"us-feet\"",
|
|
18556
|
+
"\"yards\""
|
|
18557
|
+
]
|
|
18558
|
+
}
|
|
18559
|
+
},
|
|
18547
18560
|
{
|
|
18548
18561
|
"name": "elevation-unit",
|
|
18549
18562
|
"description": "Unit system (imperial, metric) or specific unit used for displaying the cut and fill target elevation. Possible values are listed in\n[elevationUnitOptions](#elevationUnitOptions).",
|
|
@@ -18580,6 +18593,27 @@
|
|
|
18580
18593
|
]
|
|
18581
18594
|
}
|
|
18582
18595
|
},
|
|
18596
|
+
{
|
|
18597
|
+
"name": "hide-display-unit-settings",
|
|
18598
|
+
"default": "false",
|
|
18599
|
+
"value": {
|
|
18600
|
+
"type": "boolean"
|
|
18601
|
+
}
|
|
18602
|
+
},
|
|
18603
|
+
{
|
|
18604
|
+
"name": "hide-elevation-display-unit-select",
|
|
18605
|
+
"default": "false",
|
|
18606
|
+
"value": {
|
|
18607
|
+
"type": "boolean"
|
|
18608
|
+
}
|
|
18609
|
+
},
|
|
18610
|
+
{
|
|
18611
|
+
"name": "hide-elevation-input-unit-select",
|
|
18612
|
+
"default": "false",
|
|
18613
|
+
"value": {
|
|
18614
|
+
"type": "boolean"
|
|
18615
|
+
}
|
|
18616
|
+
},
|
|
18583
18617
|
{
|
|
18584
18618
|
"name": "hide-header",
|
|
18585
18619
|
"description": "Hides the header.",
|
|
@@ -18588,6 +18622,13 @@
|
|
|
18588
18622
|
"type": "boolean"
|
|
18589
18623
|
}
|
|
18590
18624
|
},
|
|
18625
|
+
{
|
|
18626
|
+
"name": "hide-input-unit-settings",
|
|
18627
|
+
"default": "false",
|
|
18628
|
+
"value": {
|
|
18629
|
+
"type": "boolean"
|
|
18630
|
+
}
|
|
18631
|
+
},
|
|
18591
18632
|
{
|
|
18592
18633
|
"name": "hide-mode-select",
|
|
18593
18634
|
"description": "Hides the mode selection dropdown.",
|
|
@@ -18597,8 +18638,8 @@
|
|
|
18597
18638
|
}
|
|
18598
18639
|
},
|
|
18599
18640
|
{
|
|
18600
|
-
"name": "hide-
|
|
18601
|
-
"description": "Hides the
|
|
18641
|
+
"name": "hide-unit-settings",
|
|
18642
|
+
"description": "Hides the unit settings button.",
|
|
18602
18643
|
"default": "false",
|
|
18603
18644
|
"value": {
|
|
18604
18645
|
"type": "boolean"
|
|
@@ -18612,6 +18653,13 @@
|
|
|
18612
18653
|
"type": "boolean"
|
|
18613
18654
|
}
|
|
18614
18655
|
},
|
|
18656
|
+
{
|
|
18657
|
+
"name": "hide-volume-display-unit-select",
|
|
18658
|
+
"default": "false",
|
|
18659
|
+
"value": {
|
|
18660
|
+
"type": "boolean"
|
|
18661
|
+
}
|
|
18662
|
+
},
|
|
18615
18663
|
{
|
|
18616
18664
|
"name": "label",
|
|
18617
18665
|
"description": "The component's default label.",
|
|
@@ -18619,6 +18667,15 @@
|
|
|
18619
18667
|
"type": "string"
|
|
18620
18668
|
}
|
|
18621
18669
|
},
|
|
18670
|
+
{
|
|
18671
|
+
"name": "mode",
|
|
18672
|
+
"value": {
|
|
18673
|
+
"type": [
|
|
18674
|
+
"\"cut-fill\"",
|
|
18675
|
+
"\"stockpile\""
|
|
18676
|
+
]
|
|
18677
|
+
}
|
|
18678
|
+
},
|
|
18622
18679
|
{
|
|
18623
18680
|
"name": "reference-element",
|
|
18624
18681
|
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
@@ -18651,6 +18708,7 @@
|
|
|
18651
18708
|
"\"cubic-meters\"",
|
|
18652
18709
|
"\"cubic-miles\"",
|
|
18653
18710
|
"\"cubic-millimeters\"",
|
|
18711
|
+
"\"cubic-us-feet\"",
|
|
18654
18712
|
"\"cubic-yards\"",
|
|
18655
18713
|
"\"imperial\"",
|
|
18656
18714
|
"\"liters\"",
|
|
@@ -18683,6 +18741,14 @@
|
|
|
18683
18741
|
"description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-volume-measurement/#destroy) method when you are done to\nprevent memory leaks.",
|
|
18684
18742
|
"type": "boolean"
|
|
18685
18743
|
},
|
|
18744
|
+
{
|
|
18745
|
+
"name": "elevationInputUnit",
|
|
18746
|
+
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"meters\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
18747
|
+
},
|
|
18748
|
+
{
|
|
18749
|
+
"name": "elevationInputUnitOptions",
|
|
18750
|
+
"type": "Array<\"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\">"
|
|
18751
|
+
},
|
|
18686
18752
|
{
|
|
18687
18753
|
"name": "elevationUnit",
|
|
18688
18754
|
"description": "Unit system (imperial, metric) or specific unit used for displaying the cut and fill target elevation. Possible values are listed in\n[elevationUnitOptions](#elevationUnitOptions).",
|
|
@@ -18698,19 +18764,35 @@
|
|
|
18698
18764
|
"description": "Indicates the heading level to use for the headings in the component.",
|
|
18699
18765
|
"type": "1 | 2 | 3 | 4 | 5 | 6"
|
|
18700
18766
|
},
|
|
18767
|
+
{
|
|
18768
|
+
"name": "hideDisplayUnitSettings",
|
|
18769
|
+
"type": "boolean"
|
|
18770
|
+
},
|
|
18771
|
+
{
|
|
18772
|
+
"name": "hideElevationDisplayUnitSelect",
|
|
18773
|
+
"type": "boolean"
|
|
18774
|
+
},
|
|
18775
|
+
{
|
|
18776
|
+
"name": "hideElevationInputUnitSelect",
|
|
18777
|
+
"type": "boolean"
|
|
18778
|
+
},
|
|
18701
18779
|
{
|
|
18702
18780
|
"name": "hideHeader",
|
|
18703
18781
|
"description": "Hides the header.",
|
|
18704
18782
|
"type": "boolean"
|
|
18705
18783
|
},
|
|
18784
|
+
{
|
|
18785
|
+
"name": "hideInputUnitSettings",
|
|
18786
|
+
"type": "boolean"
|
|
18787
|
+
},
|
|
18706
18788
|
{
|
|
18707
18789
|
"name": "hideModeSelect",
|
|
18708
18790
|
"description": "Hides the mode selection dropdown.",
|
|
18709
18791
|
"type": "boolean"
|
|
18710
18792
|
},
|
|
18711
18793
|
{
|
|
18712
|
-
"name": "
|
|
18713
|
-
"description": "Hides the
|
|
18794
|
+
"name": "hideUnitSettings",
|
|
18795
|
+
"description": "Hides the unit settings button.",
|
|
18714
18796
|
"type": "boolean"
|
|
18715
18797
|
},
|
|
18716
18798
|
{
|
|
@@ -18718,6 +18800,10 @@
|
|
|
18718
18800
|
"description": "Indicates whether the component's visualization is hidden in the view.",
|
|
18719
18801
|
"type": "boolean"
|
|
18720
18802
|
},
|
|
18803
|
+
{
|
|
18804
|
+
"name": "hideVolumeDisplayUnitSelect",
|
|
18805
|
+
"type": "boolean"
|
|
18806
|
+
},
|
|
18721
18807
|
{
|
|
18722
18808
|
"name": "icon",
|
|
18723
18809
|
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
@@ -18728,6 +18814,10 @@
|
|
|
18728
18814
|
"description": "The component's default label.",
|
|
18729
18815
|
"type": "string"
|
|
18730
18816
|
},
|
|
18817
|
+
{
|
|
18818
|
+
"name": "mode",
|
|
18819
|
+
"type": "\"cut-fill\" | \"stockpile\""
|
|
18820
|
+
},
|
|
18731
18821
|
{
|
|
18732
18822
|
"name": "referenceElement",
|
|
18733
18823
|
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
@@ -18746,12 +18836,12 @@
|
|
|
18746
18836
|
{
|
|
18747
18837
|
"name": "volumeUnit",
|
|
18748
18838
|
"description": "Unit system (imperial, metric) or specific unit used for displaying the volume values. Possible values are listed in\n[volumeUnitOptions](#volumeUnitOptions).",
|
|
18749
|
-
"type": "\"cubic-centimeters\" | \"cubic-decimeters\" | \"cubic-feet\" | \"cubic-inches\" | \"cubic-kilometers\" | \"cubic-meters\" | \"cubic-miles\" | \"cubic-millimeters\" | \"cubic-yards\" | \"imperial\" | \"liters\" | \"metric\""
|
|
18839
|
+
"type": "\"cubic-centimeters\" | \"cubic-decimeters\" | \"cubic-feet\" | \"cubic-inches\" | \"cubic-kilometers\" | \"cubic-meters\" | \"cubic-miles\" | \"cubic-millimeters\" | \"cubic-us-feet\" | \"cubic-yards\" | \"imperial\" | \"liters\" | \"metric\""
|
|
18750
18840
|
},
|
|
18751
18841
|
{
|
|
18752
18842
|
"name": "volumeUnitOptions",
|
|
18753
18843
|
"description": "List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `imperial`, `metric`, `liters`, `cubic-millimeters`, `cubic-centimeters`, `cubic-decimeters`, `cubic-meters`, `cubic-kilometers`, `cubic-inches`, `cubic-feet`, `cubic-yards`, `cubic-miles`.\nPossible [volumeUnit](#volumeUnit) values can only be a subset of this list.",
|
|
18754
|
-
"type": "Array<\"imperial\" | \"metric\" | \"cubic-inches\" | \"cubic-feet\" | \"cubic-yards\" | \"cubic-miles\" | \"liters\" | \"cubic-millimeters\" | \"cubic-centimeters\" | \"cubic-decimeters\" | \"cubic-meters\" | \"cubic-kilometers\">"
|
|
18844
|
+
"type": "Array<\"imperial\" | \"metric\" | \"cubic-inches\" | \"cubic-feet\" | \"cubic-yards\" | \"cubic-miles\" | \"cubic-us-feet\" | \"liters\" | \"cubic-millimeters\" | \"cubic-centimeters\" | \"cubic-decimeters\" | \"cubic-meters\" | \"cubic-kilometers\">"
|
|
18755
18845
|
}
|
|
18756
18846
|
],
|
|
18757
18847
|
"events": [
|
|
@@ -18770,7 +18860,7 @@
|
|
|
18770
18860
|
},
|
|
18771
18861
|
{
|
|
18772
18862
|
"name": "arcgis-weather",
|
|
18773
|
-
"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<
|
|
18863
|
+
"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.",
|
|
18774
18864
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-weather/",
|
|
18775
18865
|
"attributes": [
|
|
18776
18866
|
{
|
|
@@ -18915,7 +19005,7 @@
|
|
|
18915
19005
|
},
|
|
18916
19006
|
{
|
|
18917
19007
|
"name": "arcgis-zoom",
|
|
18918
|
-
"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<
|
|
19008
|
+
"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.",
|
|
18919
19009
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-zoom/",
|
|
18920
19010
|
"attributes": [
|
|
18921
19011
|
{
|