@arcgis/map-components 5.0.0-next.3 → 5.0.0-next.30
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/22PBEW6E.js +4 -0
- package/dist/cdn/25PCEBHD.js +4 -0
- package/dist/cdn/{PT4SB4F4.js → 27WBIJ7W.js} +2 -2
- package/dist/cdn/{5Y726H3N.js → 2CJC5LPR.js} +2 -2
- package/dist/cdn/2CRWDE5K.js +4 -0
- package/dist/cdn/{2Y7DD43B.js → 2S7NPB67.js} +2 -2
- package/dist/cdn/{XS57JNBV.js → 374IBN5E.js} +2 -2
- package/dist/cdn/{XSHK3IHW.js → 3OVNUSGR.js} +2 -2
- package/dist/cdn/{JMEUEYO3.js → 3PNHYPR5.js} +2 -2
- package/dist/cdn/3Q4TZZN5.js +9 -0
- package/dist/cdn/{V2SEO7LF.js → 3TDUGLWP.js} +2 -2
- package/dist/cdn/3U4M6EMC.js +4 -0
- package/dist/cdn/3ZCQG6W2.js +4 -0
- package/dist/cdn/425YBS5O.js +4 -0
- package/dist/cdn/{U5AQM4PG.js → 42EAA7ZK.js} +2 -2
- package/dist/cdn/{7CNGYGTJ.js → 4EURR2HO.js} +2 -2
- package/dist/cdn/{5KLSEZXC.js → 4I6KXDCS.js} +2 -2
- package/dist/cdn/4KAVQQCL.js +4 -0
- package/dist/cdn/{6NDFRLCI.js → 4S63FYIQ.js} +2 -2
- package/dist/cdn/{FJ2ODCZO.js → 4ZDH3LUI.js} +2 -2
- package/dist/cdn/{WM6PZMMT.js → 5622NXQG.js} +2 -2
- package/dist/cdn/{ZIEJSM2I.js → 56LJCIRJ.js} +2 -2
- package/dist/cdn/5CCZDJS6.js +4 -0
- package/dist/cdn/5I77EKDP.js +4 -0
- package/dist/cdn/{GHJ24W6Y.js → 5MBPCAXE.js} +2 -2
- package/dist/cdn/5RXPN4ZA.js +4 -0
- package/dist/cdn/{E6NGXE4D.js → 5T4NERJA.js} +2 -2
- package/dist/cdn/6264Y6OB.js +4 -0
- package/dist/cdn/{5BGXROFC.js → 63P5OPEW.js} +2 -2
- package/dist/cdn/{NZU4NUKA.js → 66XSUGOO.js} +2 -2
- package/dist/cdn/6JOMTTMO.js +4 -0
- package/dist/cdn/6LLHP446.js +4 -0
- package/dist/cdn/6QMZX7TX.js +4 -0
- package/dist/cdn/6YGA3ZTW.js +4 -0
- package/dist/cdn/74D735ZE.js +4 -0
- package/dist/cdn/{OQ4DWZRX.js → 76PSKS56.js} +2 -2
- package/dist/cdn/7BW7BEKS.js +4 -0
- package/dist/cdn/{SPSIJZKA.js → 7BZ6ZZWG.js} +2 -2
- package/dist/cdn/7LW2MJ34.js +4 -0
- package/dist/cdn/{CAGCLXVW.js → 7N7RFZDC.js} +2 -2
- package/dist/cdn/7R25WXBY.js +4 -0
- package/dist/cdn/{YGN7CXIS.js → A7WF3SII.js} +2 -2
- package/dist/cdn/AJVA5KJZ.js +4 -0
- package/dist/cdn/{4XLFNXAU.js → AUBNL7NN.js} +1 -1
- package/dist/cdn/AYDYS5XP.js +4 -0
- package/dist/cdn/B5J2VO23.js +4 -0
- package/dist/cdn/{KHBODFWE.js → BBF2UUMF.js} +1 -1
- package/dist/cdn/{V7Z2OLGJ.js → BCB3OHT5.js} +1 -1
- package/dist/cdn/BFGOCVTQ.js +4 -0
- package/dist/cdn/{H7M3PSWM.js → BGIPXNCI.js} +2 -2
- package/dist/cdn/BID2IGTA.js +4 -0
- package/dist/cdn/BP3EIAXM.js +4 -0
- package/dist/cdn/BPZWPZSL.js +4 -0
- package/dist/cdn/{QQEDG3FQ.js → BYDZCBXS.js} +1 -1
- package/dist/cdn/CKWHFRUK.js +4 -0
- package/dist/cdn/{OTAT274C.js → CLULAXQD.js} +2 -2
- package/dist/cdn/CNTHUZWZ.js +4 -0
- package/dist/cdn/CUG6PNIA.js +4 -0
- package/dist/cdn/{IFCRROLM.js → CYBCIT4Y.js} +1 -1
- package/dist/cdn/{MJ33XVNW.js → CZJ42KVB.js} +2 -2
- package/dist/cdn/DCVY57UJ.js +4 -0
- package/dist/cdn/DDTFGXJB.js +4 -0
- package/dist/cdn/DGTCJPUJ.js +4 -0
- package/dist/cdn/DKQDFHBQ.js +4 -0
- package/dist/cdn/{QLRG2ZV7.js → DNH555Q6.js} +2 -2
- package/dist/cdn/{VYJLK7NT.js → DVMZQU3S.js} +2 -2
- package/dist/cdn/{JY4X6DI4.js → DX7CIW2P.js} +2 -2
- package/dist/cdn/{2NLU5P6Z.js → DZMHLJTL.js} +2 -2
- package/dist/cdn/E47J5GZF.js +4 -0
- package/dist/cdn/E57VVYYO.js +4 -0
- package/dist/cdn/E6LAZTCZ.js +4 -0
- package/dist/cdn/E7LECLZS.js +4 -0
- package/dist/cdn/{UOB52WH7.js → EANAURQW.js} +2 -2
- package/dist/cdn/EIA2HRVX.js +4 -0
- package/dist/cdn/{ZVMC7KNO.js → EJNPIPYI.js} +2 -2
- package/dist/cdn/{G7HJYLTI.js → EK2C6MIA.js} +2 -2
- package/dist/cdn/EL2VJ6RS.js +4 -0
- package/dist/cdn/{PH5CV2LM.js → EYVOMZXY.js} +1 -1
- package/dist/cdn/EZRA4T3B.js +4 -0
- package/dist/cdn/FDJQS7A5.js +4 -0
- package/dist/cdn/FJSDHTDE.js +4 -0
- package/dist/cdn/FKA23U6F.js +4 -0
- package/dist/cdn/FN2HVGXN.js +4 -0
- package/dist/cdn/{FGL64TB3.js → FN45TY5U.js} +2 -2
- package/dist/cdn/{VUH7USVP.js → FOLKGWCG.js} +2 -2
- package/dist/cdn/FRHKHEQC.js +4 -0
- package/dist/cdn/{TIKIHUXB.js → FWUUE67P.js} +2 -2
- package/dist/cdn/{XOR2JIKE.js → FZ5UYVXE.js} +2 -2
- package/dist/cdn/{E3GEOJL3.js → GHB4S7FZ.js} +2 -2
- package/dist/cdn/GJULE3KX.js +4 -0
- package/dist/cdn/{IRVVFCPI.js → GKBYAVVU.js} +2 -2
- package/dist/cdn/GRCCF7NK.js +4 -0
- package/dist/cdn/{E3PFF3QO.js → GSPGZZIN.js} +2 -2
- package/dist/cdn/GW4QU3CW.js +4 -0
- package/dist/cdn/GX5MB57E.js +4 -0
- package/dist/cdn/HBEKTKXB.js +4 -0
- package/dist/cdn/HKSFUMS2.js +4 -0
- package/dist/cdn/{NSSQHGXK.js → HLYYV5IJ.js} +2 -2
- package/dist/cdn/{O6EPJYM3.js → HT3PGW7M.js} +2 -2
- package/dist/cdn/HWBYBOFO.js +4 -0
- package/dist/cdn/I4VWHCEV.js +4 -0
- package/dist/cdn/{LYJ4UH2R.js → I5KPSSMS.js} +2 -2
- package/dist/cdn/{QEP5NFEU.js → I5OZYAAG.js} +2 -2
- package/dist/cdn/{FKYZEDOJ.js → I656AJFF.js} +2 -2
- package/dist/cdn/{A3762FET.js → I7DVVSQ5.js} +2 -2
- package/dist/cdn/{YTHR4NZ6.js → IAEK5W65.js} +2 -2
- package/dist/cdn/{AYNMHQEJ.js → IDCRXCZH.js} +2 -2
- package/dist/cdn/IRAFVG6N.js +4 -0
- package/dist/cdn/IT3NFXVO.js +4 -0
- package/dist/cdn/{PL6UYYNH.js → IUZBJNIT.js} +2 -2
- package/dist/cdn/IUZRROGZ.js +4 -0
- package/dist/cdn/J3ZLMJL7.js +4 -0
- package/dist/cdn/{OXFFB6Y3.js → J5IGACIV.js} +2 -2
- package/dist/cdn/{X6KL6BYF.js → J5JIUE4E.js} +2 -2
- package/dist/cdn/{UU6DUHJ7.js → J75FAWOX.js} +1 -1
- package/dist/cdn/JC3Y3H2J.js +4 -0
- package/dist/cdn/{D4LXLZZW.js → JC6BPG6L.js} +2 -2
- package/dist/cdn/JD3UYAHR.js +4 -0
- package/dist/cdn/{WLZJRN6C.js → JD6SZBTI.js} +1 -1
- package/dist/cdn/JNHWTLF5.js +4 -0
- package/dist/cdn/{H37YYHYW.js → K4HH7Q7F.js} +2 -2
- package/dist/cdn/KHN4WS5O.js +4 -0
- package/dist/cdn/{T25TCQNP.js → KWO4P6X3.js} +2 -2
- package/dist/cdn/L2S6UPIL.js +4 -0
- package/dist/cdn/LG3E3FEI.js +4 -0
- package/dist/cdn/LG6IQO74.js +4 -0
- package/dist/cdn/LGRVJOKM.js +4 -0
- package/dist/cdn/LHKVE7QW.js +4 -0
- package/dist/cdn/LMHRSVIK.js +4 -0
- package/dist/cdn/{IPSS2ZMH.js → LTRRBRH6.js} +2 -2
- package/dist/cdn/{IHZK6TIX.js → LUPWZHEN.js} +2 -2
- package/dist/cdn/LXMJA6SN.js +4 -0
- package/dist/cdn/{Y4JZGJBR.js → MEK3PSMR.js} +2 -2
- package/dist/cdn/MGSBWHU6.js +4 -0
- package/dist/cdn/{NQG5ZLHV.js → MIWATNX7.js} +2 -2
- package/dist/cdn/{7UZQHGLP.js → MPGBF2CR.js} +2 -2
- package/dist/cdn/MROF6ZLY.js +4 -0
- package/dist/cdn/{L7F3QWKO.js → MW27JFII.js} +2 -2
- package/dist/cdn/MYHT3FNL.js +4 -0
- package/dist/cdn/{36DL5HXP.js → N4IBOVID.js} +2 -2
- package/dist/cdn/{V4QJNRPL.js → NB6FYZSP.js} +1 -1
- package/dist/cdn/{SUC4EKIE.js → NGRN6PRP.js} +2 -2
- package/dist/cdn/NIVNICTN.js +4 -0
- package/dist/cdn/NUWJO552.js +4 -0
- package/dist/cdn/{MY5DKMMJ.js → NVQTDJG4.js} +2 -2
- package/dist/cdn/{HYX7CRNH.js → OCLQXJGF.js} +2 -2
- package/dist/cdn/{HDI3Z2HD.js → OF5TKTLJ.js} +2 -2
- package/dist/cdn/OISWBYPZ.js +4 -0
- package/dist/cdn/OLIVWOUG.js +4 -0
- package/dist/cdn/OLTPA66L.js +4 -0
- package/dist/cdn/ONNIQKMO.js +4 -0
- package/dist/cdn/OP7UWDJC.js +4 -0
- package/dist/cdn/OQPWIH5D.js +4 -0
- package/dist/cdn/PCLAY3FC.js +4 -0
- package/dist/cdn/PDDWIQ7N.js +4 -0
- package/dist/cdn/PP47N6OQ.js +4 -0
- package/dist/cdn/PPG44XNA.js +4 -0
- package/dist/cdn/PSXK4TAG.js +4 -0
- package/dist/cdn/PZJX66WF.js +4 -0
- package/dist/cdn/Q5KRWXQZ.js +4 -0
- package/dist/cdn/Q7MP7GCA.js +4 -0
- package/dist/cdn/QUIRGW73.js +4 -0
- package/dist/cdn/QYWKUYX6.js +4 -0
- package/dist/cdn/{V2J3UBB6.js → R3XM3W55.js} +2 -2
- package/dist/cdn/{SLM4KEUZ.js → R4UWGEKU.js} +2 -2
- package/dist/cdn/{O7JOBF3W.js → RBQBAWXT.js} +2 -2
- package/dist/cdn/REGCZKJO.js +4 -0
- package/dist/cdn/{HQL6HUHP.js → RGDYDUVM.js} +2 -2
- package/dist/cdn/{24FW7BG5.js → RNHHSJBN.js} +2 -2
- package/dist/cdn/RXKG57HU.js +4 -0
- package/dist/cdn/{PAQHYLRL.js → RYEBGC2T.js} +2 -2
- package/dist/cdn/{PHBC5D77.js → S5SBZVDO.js} +2 -2
- package/dist/cdn/S6TGNN5K.js +4 -0
- package/dist/cdn/SBWVZPEI.js +4 -0
- package/dist/cdn/{JIWHI7EW.js → SCZ6FM7D.js} +2 -2
- package/dist/cdn/SGL4GRLW.js +4 -0
- package/dist/cdn/SKUATZL2.js +4 -0
- package/dist/cdn/{ALNZYXRY.js → SNEAUADR.js} +2 -2
- package/dist/cdn/{SK3UKEH4.js → SNFN2BKO.js} +2 -2
- package/dist/cdn/{J74HR7ZS.js → SQ5KXPKM.js} +2 -2
- package/dist/cdn/SSN4WU5P.js +4 -0
- package/dist/cdn/{USMO52IS.js → SZCYMTSH.js} +2 -2
- package/dist/cdn/{TG7X24CK.js → T36L76YW.js} +2 -2
- package/dist/cdn/{7PEEU67P.js → TEGTWZFB.js} +2 -2
- package/dist/cdn/TFZ4RUW2.js +4 -0
- package/dist/cdn/{LTI2QYVU.js → TGAFLU6F.js} +2 -2
- package/dist/cdn/{AQ2NPWC6.js → TI47WRKB.js} +2 -2
- package/dist/cdn/TJXNZQ6E.js +4 -0
- package/dist/cdn/{BL7YER2G.js → TNU7CJYU.js} +2 -2
- package/dist/cdn/U3Y4NEIU.js +4 -0
- package/dist/cdn/UA3NEZD2.js +4 -0
- package/dist/cdn/{XCUKO2A2.js → UHRRVA5A.js} +2 -2
- package/dist/cdn/{T352QWFP.js → UIEHONGS.js} +2 -2
- package/dist/cdn/{4SGPWL6P.js → UNJHMZ3F.js} +2 -2
- package/dist/cdn/UV6BXD7O.js +4 -0
- package/dist/cdn/V2HPTG5E.js +4 -0
- package/dist/cdn/V4GYQU7T.js +4 -0
- package/dist/cdn/VTBJGFMG.js +4 -0
- package/dist/cdn/{UDPPDKXD.js → VVG7FBHC.js} +2 -2
- package/dist/cdn/VWNSIY3Z.js +4 -0
- package/dist/cdn/VX7XHWH3.js +4 -0
- package/dist/cdn/W4OV7AC2.js +4 -0
- package/dist/cdn/W4RATWQC.js +4 -0
- package/dist/cdn/WFFXOIVG.js +4 -0
- package/dist/cdn/{JNRTXRIA.js → WOZWBFU3.js} +2 -2
- package/dist/cdn/{RQGY47DP.js → WSDNUWO4.js} +2 -2
- package/dist/cdn/{SSTOK5YE.js → WXL3L2FD.js} +2 -2
- package/dist/cdn/X2P5ZICY.js +4 -0
- package/dist/cdn/{FJHYJ3NL.js → XCXSBECM.js} +2 -2
- package/dist/cdn/XDXAENM3.js +4 -0
- package/dist/cdn/XGIGLVS7.js +5 -0
- package/dist/cdn/XJZXQDR2.js +4 -0
- package/dist/cdn/XOKCQ5UG.js +4 -0
- package/dist/cdn/Y3U2JDPE.js +4 -0
- package/dist/cdn/Y7H7Z7BU.js +4 -0
- package/dist/cdn/YRSPO3RH.js +4 -0
- package/dist/cdn/YSBP4YU4.js +4 -0
- package/dist/cdn/{NIQUPN4E.js → Z5MMZXMP.js} +2 -2
- package/dist/cdn/{QWNJRMAQ.js → ZI2HBMIO.js} +2 -2
- package/dist/cdn/ZQY6XVS2.js +4 -0
- package/dist/cdn/ZUOJPC77.js +4 -0
- package/dist/cdn/{4UP6FMTP.js → ZWSRYLIE.js} +2 -2
- package/dist/cdn/ZYOD4BBB.js +4 -0
- package/dist/cdn/{HHFFCMML.js → ZZ5AKBHE.js} +1 -1
- package/dist/cdn/assets/elevation-profile-next/t9n/messages.en.json +1 -1
- package/dist/cdn/assets/feature/t9n/messages.en.json +1 -1
- package/dist/cdn/assets/utility-network-subnetwork-info/t9n/messages.en.json +1 -0
- package/dist/cdn/assets/utility-network-trace-inputs/t9n/messages.en.json +1 -1
- package/dist/cdn/assets/utility-network-trace-location/t9n/messages.en.json +1 -0
- package/dist/cdn/index.js +2 -2
- package/dist/cdn/main.css +1 -1
- package/dist/chunks/AnalysisViewModel.js +40 -36
- package/dist/chunks/action-utils.js +1 -1
- package/dist/chunks/async-utils.js +80 -62
- package/dist/chunks/basemap-gallery-resources.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/createCloseEvent.js +1 -1
- package/dist/chunks/esri-main.js +2 -2
- package/dist/chunks/feature-utils.js +152 -107
- package/dist/chunks/globalCss.js +1 -1
- package/dist/chunks/handle.js +14 -0
- package/dist/chunks/heading.js +1 -1
- package/dist/chunks/layer-list.js +1 -1
- package/dist/chunks/legacyIcon.js +1 -1
- package/dist/chunks/maybe.js +1 -1
- package/dist/chunks/measurementUtils.js +1 -1
- package/dist/chunks/runtime.js +1 -1
- package/dist/chunks/screenLocation.js +1 -1
- package/dist/chunks/slots.js +7 -7
- package/dist/chunks/svgUtils.js +1 -1
- package/dist/chunks/univariateUtils.js +1 -1
- package/dist/chunks/useArcgisViewReadyError.js +91 -0
- 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 +11 -16
- package/dist/chunks/utils2.js +1 -1
- package/dist/components/arcgis-area-measurement-2d/customElement.d.ts +4 -4
- package/dist/components/arcgis-area-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-area-measurement-3d/AreaMeasurement3dViewModel.d.ts +8 -9
- package/dist/components/arcgis-area-measurement-3d/customElement.d.ts +3 -3
- package/dist/components/arcgis-area-measurement-3d/customElement.js +30 -31
- package/dist/components/arcgis-attachments/customElement.d.ts +5 -5
- package/dist/components/arcgis-attachments/customElement.js +6 -6
- package/dist/components/arcgis-basemap-gallery/customElement.d.ts +2 -2
- package/dist/components/arcgis-basemap-gallery/customElement.js +1 -1
- package/dist/components/arcgis-basemap-gallery-item/customElement.js +4 -4
- package/dist/components/arcgis-basemap-layer-list/customElement.d.ts +3 -3
- package/dist/components/arcgis-basemap-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-basemap-toggle/customElement.d.ts +2 -2
- package/dist/components/arcgis-basemap-toggle/customElement.js +1 -1
- package/dist/components/arcgis-bookmarks/customElement.d.ts +16 -6
- package/dist/components/arcgis-bookmarks/customElement.js +57 -55
- package/dist/components/arcgis-building-explorer/customElement.d.ts +3 -3
- package/dist/components/arcgis-building-explorer/customElement.js +6 -6
- package/dist/components/arcgis-catalog-layer-list/customElement.d.ts +3 -3
- package/dist/components/arcgis-catalog-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-compass/customElement.d.ts +2 -2
- package/dist/components/arcgis-compass/customElement.js +6 -6
- package/dist/components/arcgis-coordinate-conversion/customElement.d.ts +53 -54
- package/dist/components/arcgis-coordinate-conversion/customElement.js +91 -82
- package/dist/components/arcgis-daylight/customElement.d.ts +116 -57
- package/dist/components/arcgis-daylight/customElement.js +154 -157
- package/dist/components/arcgis-daylight/index.d.ts +1 -0
- package/dist/components/arcgis-daylight/index.js +1 -0
- package/dist/components/arcgis-direct-line-measurement-3d/DirectLineMeasurement3dViewModel.d.ts +9 -10
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.d.ts +3 -13
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.js +50 -58
- package/dist/components/arcgis-directional-pad/customElement.d.ts +2 -2
- package/dist/components/arcgis-directional-pad/customElement.js +2 -2
- package/dist/components/arcgis-directions/customElement.d.ts +3 -3
- package/dist/components/arcgis-directions/customElement.js +1 -1
- package/dist/components/arcgis-distance-measurement-2d/customElement.d.ts +4 -4
- package/dist/components/arcgis-distance-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-editor/customElement.d.ts +14 -6
- package/dist/components/arcgis-editor/customElement.js +2 -2
- package/dist/components/arcgis-elevation-profile/customElement.d.ts +6 -6
- package/dist/components/arcgis-elevation-profile/customElement.js +1 -1
- package/dist/components/arcgis-elevation-profile-legend/customElement.d.ts +5 -2
- package/dist/components/arcgis-elevation-profile-legend/customElement.js +11 -11
- package/dist/components/arcgis-elevation-profile-legend-item/customElement.d.ts +5 -2
- package/dist/components/arcgis-elevation-profile-legend-item/customElement.js +18 -15
- package/dist/components/arcgis-elevation-profile-next/ElevationProfileViewModel.d.ts +17 -6
- package/dist/components/arcgis-elevation-profile-next/customElement.d.ts +5 -5
- package/dist/components/arcgis-elevation-profile-next/customElement.js +212 -163
- package/dist/components/arcgis-elevation-profile-next/geometryUtils.d.ts +1 -1
- package/dist/components/arcgis-elevation-profile-next/interfaces.d.ts +2 -11
- package/dist/components/arcgis-elevation-profile-settings/customElement.js +1 -1
- package/dist/components/arcgis-elevation-profile-statistics/customElement.d.ts +3 -2
- package/dist/components/arcgis-elevation-profile-statistics/customElement.js +6 -6
- package/dist/components/arcgis-expand/customElement.d.ts +10 -9
- package/dist/components/arcgis-expand/customElement.js +33 -39
- package/dist/components/arcgis-feature/customElement.d.ts +18 -22
- package/dist/components/arcgis-feature/customElement.js +90 -77
- package/dist/components/arcgis-feature/index.d.ts +1 -0
- package/dist/components/arcgis-feature/index.js +1 -0
- package/dist/components/arcgis-feature-attachments/customElement.d.ts +2 -0
- package/dist/components/arcgis-feature-attachments/customElement.js +8 -8
- package/dist/components/arcgis-feature-content/customElement.js +2 -2
- 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.d.ts +4 -0
- package/dist/components/arcgis-feature-fields/customElement.js +36 -32
- package/dist/components/arcgis-feature-form/customElement.d.ts +4 -4
- package/dist/components/arcgis-feature-form/customElement.js +1 -1
- package/dist/components/arcgis-feature-media/customElement.d.ts +1 -2
- package/dist/components/arcgis-feature-media/customElement.js +179 -178
- package/dist/components/arcgis-feature-relationship/customElement.js +1 -1
- package/dist/components/arcgis-feature-table/customElement.d.ts +8 -7
- package/dist/components/arcgis-feature-table/customElement.js +1 -1
- package/dist/components/arcgis-feature-templates/customElement.d.ts +2 -2
- package/dist/components/arcgis-feature-templates/customElement.js +1 -1
- package/dist/components/arcgis-feature-utility-network-association-list/customElement.d.ts +23 -0
- package/dist/components/arcgis-feature-utility-network-association-list/customElement.js +123 -0
- package/dist/components/arcgis-feature-utility-network-association-list/index.d.ts +8 -0
- package/dist/components/arcgis-feature-utility-network-association-list/index.js +8 -0
- package/dist/components/arcgis-feature-utility-network-associations/customElement.d.ts +73 -0
- package/dist/components/arcgis-feature-utility-network-associations/customElement.js +506 -0
- package/dist/components/arcgis-feature-utility-network-associations/index.d.ts +8 -0
- package/dist/components/arcgis-feature-utility-network-associations/index.js +8 -0
- package/dist/components/arcgis-features/customElement.d.ts +26 -11
- package/dist/components/arcgis-features/customElement.js +7 -7
- package/dist/components/arcgis-floor-filter/customElement.d.ts +3 -3
- package/dist/components/arcgis-floor-filter/customElement.js +7 -7
- package/dist/components/arcgis-fullscreen/customElement.d.ts +1 -1
- package/dist/components/arcgis-fullscreen/customElement.js +2 -2
- package/dist/components/arcgis-grid-controls/customElement.d.ts +2 -2
- package/dist/components/arcgis-grid-controls/customElement.js +1 -1
- package/dist/components/arcgis-histogram-range-slider/customElement.d.ts +3 -3
- package/dist/components/arcgis-histogram-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-home/customElement.d.ts +3 -3
- package/dist/components/arcgis-home/customElement.js +2 -2
- package/dist/components/arcgis-labeled-switch/customElement.js +1 -1
- package/dist/components/arcgis-layer-list/customElement.d.ts +3 -3
- 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.d.ts +18 -3
- 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 +12 -12
- package/dist/components/arcgis-legend-card-univariate-color-size-ramp/customElement.js +9 -9
- package/dist/components/arcgis-legend-card-view/customElement.js +1 -1
- package/dist/components/arcgis-legend-classic-color-ramp/customElement.js +10 -10
- 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 +5 -5
- package/dist/components/arcgis-legend-classic-univariate-color-size-ramp/customElement.js +9 -9
- 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 +4 -4
- package/dist/components/arcgis-line-of-sight/customElement.d.ts +2 -2
- package/dist/components/arcgis-line-of-sight/customElement.js +28 -27
- package/dist/components/arcgis-link-chart/customElement.d.ts +70 -4
- package/dist/components/arcgis-link-chart/customElement.js +20 -22
- package/dist/components/arcgis-link-chart/index.d.ts +2 -0
- package/dist/components/arcgis-link-chart/index.js +2 -0
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.d.ts +2 -2
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.js +1 -1
- package/dist/components/arcgis-locate/customElement.d.ts +2 -2
- package/dist/components/arcgis-locate/customElement.js +2 -2
- package/dist/components/arcgis-map/customElement.d.ts +477 -61
- package/dist/components/arcgis-map/customElement.js +29 -31
- package/dist/components/arcgis-map/index.d.ts +2 -0
- package/dist/components/arcgis-map/index.js +2 -0
- package/dist/components/arcgis-measurement/customElement.d.ts +6 -6
- package/dist/components/arcgis-measurement/customElement.js +1 -1
- package/dist/components/arcgis-measurement-content/customElement.js +1 -1
- package/dist/components/arcgis-navigation-toggle/customElement.d.ts +2 -2
- package/dist/components/arcgis-navigation-toggle/customElement.js +5 -5
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.d.ts +4 -4
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.js +2 -2
- package/dist/components/arcgis-placement/customElement.d.ts +2 -2
- package/dist/components/arcgis-placement/customElement.js +1 -1
- package/dist/components/arcgis-popup/customElement.d.ts +48 -18
- package/dist/components/arcgis-popup/customElement.js +72 -72
- package/dist/components/arcgis-print/customElement.d.ts +2 -2
- package/dist/components/arcgis-print/customElement.js +1 -1
- package/dist/components/arcgis-print/utils.d.ts +1 -2
- 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-exported-link/customElement.js +38 -48
- package/dist/components/arcgis-print-exports-panel/customElement.js +4 -4
- 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 +17 -15
- package/dist/components/arcgis-print-template-selector/customElement.js +1 -1
- package/dist/components/arcgis-scale-bar/customElement.d.ts +2 -2
- package/dist/components/arcgis-scale-bar/customElement.js +1 -1
- package/dist/components/arcgis-scale-range-slider/customElement.d.ts +4 -3
- package/dist/components/arcgis-scale-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-scene/customElement.d.ts +46 -6
- package/dist/components/arcgis-scene/customElement.js +27 -29
- package/dist/components/arcgis-scene/index.d.ts +2 -0
- package/dist/components/arcgis-scene/index.js +2 -0
- package/dist/components/arcgis-search/customElement.d.ts +17 -19
- package/dist/components/arcgis-search/customElement.js +1 -1
- package/dist/components/arcgis-search-result-renderer/customElement.d.ts +2 -0
- package/dist/components/arcgis-search-result-renderer/customElement.js +1 -1
- package/dist/components/arcgis-shadow-cast/customElement.d.ts +4 -4
- package/dist/components/arcgis-shadow-cast/customElement.js +2 -2
- package/dist/components/arcgis-sketch/customElement.d.ts +16 -8
- package/dist/components/arcgis-sketch/customElement.js +15 -7
- package/dist/components/arcgis-slice/customElement.d.ts +2 -2
- package/dist/components/arcgis-slice/customElement.js +14 -15
- package/dist/components/arcgis-spinner/customElement.js +1 -1
- package/dist/components/arcgis-swipe/customElement.d.ts +2 -2
- package/dist/components/arcgis-swipe/customElement.js +2 -2
- package/dist/components/arcgis-table-list/customElement.d.ts +6 -4
- package/dist/components/arcgis-table-list/customElement.js +1 -1
- package/dist/components/arcgis-time-slider/customElement.d.ts +4 -4
- package/dist/components/arcgis-time-slider/customElement.js +2 -2
- package/dist/components/arcgis-time-zone-label/customElement.d.ts +12 -13
- package/dist/components/arcgis-time-zone-label/customElement.js +41 -49
- package/dist/components/arcgis-track/customElement.d.ts +2 -2
- package/dist/components/arcgis-track/customElement.js +2 -2
- package/dist/components/arcgis-unit-select/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-association-list/customElement.d.ts +27 -0
- package/dist/components/arcgis-utility-network-association-list/customElement.js +110 -0
- package/dist/components/arcgis-utility-network-association-list/index.d.ts +4 -0
- package/dist/components/arcgis-utility-network-association-list/index.js +4 -0
- package/dist/components/arcgis-utility-network-association-list/types.d.ts +2 -0
- package/dist/components/arcgis-utility-network-associations/customElement.d.ts +69 -25
- package/dist/components/arcgis-utility-network-associations/customElement.js +3 -3
- package/dist/components/arcgis-utility-network-result-feature-list/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-subnetwork-info/customElement.d.ts +20 -0
- package/dist/components/arcgis-utility-network-subnetwork-info/customElement.js +36 -0
- package/dist/components/arcgis-utility-network-subnetwork-info/index.d.ts +1 -0
- package/dist/components/arcgis-utility-network-subnetwork-info/index.js +1 -0
- package/dist/components/arcgis-utility-network-trace/customElement.d.ts +5 -3
- package/dist/components/arcgis-utility-network-trace/customElement.js +2 -2
- package/dist/components/arcgis-utility-network-trace-analysis/customElement.d.ts +2 -48
- package/dist/components/arcgis-utility-network-trace-analysis/customElement.js +30 -51
- package/dist/components/arcgis-utility-network-trace-inputs/customElement.d.ts +7 -8
- package/dist/components/arcgis-utility-network-trace-inputs/customElement.js +214 -56
- package/dist/components/arcgis-utility-network-trace-inputs/index.d.ts +7 -2
- package/dist/components/arcgis-utility-network-trace-inputs/index.js +7 -2
- package/dist/components/arcgis-utility-network-trace-location/customElement.d.ts +44 -0
- package/dist/components/arcgis-utility-network-trace-location/customElement.js +194 -0
- package/dist/components/arcgis-utility-network-trace-location/index.d.ts +3 -0
- package/dist/components/arcgis-utility-network-trace-location/index.js +3 -0
- package/dist/components/arcgis-utility-network-trace-results/customElement.js +2 -2
- package/dist/components/arcgis-utility-network-validate-topology/customElement.d.ts +3 -3
- package/dist/components/arcgis-utility-network-validate-topology/customElement.js +2 -2
- package/dist/components/arcgis-value-picker/customElement.d.ts +3 -3
- package/dist/components/arcgis-value-picker/customElement.js +1 -1
- package/dist/components/arcgis-version-management/customElement.d.ts +1 -1
- package/dist/components/arcgis-version-management/customElement.js +2 -2
- package/dist/components/arcgis-version-management-service-item/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-list/customElement.js +42 -27
- package/dist/components/arcgis-version-management-version-list/index.d.ts +2 -1
- package/dist/components/arcgis-version-management-version-list/index.js +2 -1
- package/dist/components/arcgis-version-management-version-properties/customElement.js +1 -1
- package/dist/components/arcgis-video/customElement.d.ts +9 -2
- package/dist/components/arcgis-video/customElement.js +15 -9
- package/dist/components/arcgis-video-player/customElement.d.ts +3 -3
- package/dist/components/arcgis-video-player/customElement.js +4 -4
- package/dist/components/arcgis-video-player-action-bar/customElement.js +18 -18
- package/dist/components/arcgis-video-player-actions-group/customElement.js +13 -12
- package/dist/components/arcgis-video-player-controls-group/customElement.js +23 -23
- package/dist/components/arcgis-video-player-metadata/customElement.js +1 -1
- package/dist/components/arcgis-video-player-settings/customElement.js +19 -18
- package/dist/components/arcgis-video-player-slider/customElement.js +2 -2
- package/dist/components/arcgis-weather/customElement.d.ts +2 -2
- package/dist/components/arcgis-weather/customElement.js +1 -1
- package/dist/components/arcgis-zoom/customElement.d.ts +2 -2
- package/dist/components/arcgis-zoom/customElement.js +2 -2
- package/dist/components/support/utility-components/component-wrapper.d.ts +1 -1
- package/dist/controllers/uiController.d.ts +11 -1
- package/dist/controllers/useArcgisLoadError.d.ts +27 -0
- package/dist/controllers/useArcgisViewReadyError.d.ts +17 -0
- package/dist/docs/api.json +2168 -1599
- package/dist/docs/docs.json +1986 -1346
- package/dist/docs/vscode.css-custom-data.json +16 -16
- package/dist/docs/vscode.html-custom-data.json +208 -290
- package/dist/docs/web-types.json +619 -517
- package/dist/index.d.ts +33 -20
- package/dist/index.js +1 -1
- package/dist/loader.js +23 -20
- package/dist/support/AnalysisViewModel.d.ts +1 -0
- package/dist/support/handle.d.ts +1 -1
- package/dist/support/measurementUtils.d.ts +2 -2
- package/dist/support/slots.d.ts +1 -1
- package/dist/types/lumina.d.ts +31 -18
- package/dist/types/preact.d.ts +33 -19
- package/dist/types/preact10.d.ts +35 -20
- package/dist/types/react.d.ts +35 -20
- package/dist/types/stencil.d.ts +31 -18
- package/dist/utils/async-utils.d.ts +19 -0
- package/dist/utils/feature-utils.d.ts +16 -1
- package/dist/utils/highlight-utils.d.ts +22 -0
- package/dist/utils/layer-utils.d.ts +4 -0
- package/package.json +5 -5
- package/dist/cdn/2AZHLSAM.js +0 -4
- package/dist/cdn/2QRPRZG7.js +0 -4
- package/dist/cdn/2TIHIEKF.js +0 -4
- package/dist/cdn/34BYMZKN.js +0 -4
- package/dist/cdn/34UFWCNP.js +0 -4
- package/dist/cdn/37KDGILU.js +0 -4
- package/dist/cdn/3R2IE2EP.js +0 -4
- package/dist/cdn/3TNLQA2F.js +0 -4
- package/dist/cdn/44N6D3WC.js +0 -4
- package/dist/cdn/4CPDJQ27.js +0 -4
- package/dist/cdn/53D5QJFX.js +0 -4
- package/dist/cdn/5UJK4YHX.js +0 -4
- package/dist/cdn/63KJYSZ6.js +0 -4
- package/dist/cdn/6G2XDWMZ.js +0 -4
- package/dist/cdn/6VRVCX3L.js +0 -4
- package/dist/cdn/7BGZFWPA.js +0 -4
- package/dist/cdn/7C2OVYAI.js +0 -4
- package/dist/cdn/7CTFDRQC.js +0 -4
- package/dist/cdn/7DC3PGD2.js +0 -4
- package/dist/cdn/7HSMTM2G.js +0 -4
- package/dist/cdn/7KIRVDDY.js +0 -4
- package/dist/cdn/AFYGKVBX.js +0 -4
- package/dist/cdn/AH3BVTCT.js +0 -4
- package/dist/cdn/ALENT5NF.js +0 -4
- package/dist/cdn/ATKMD43D.js +0 -5
- package/dist/cdn/BG77QJIW.js +0 -4
- package/dist/cdn/CKCTJ6CW.js +0 -4
- package/dist/cdn/CNLBDFHY.js +0 -4
- package/dist/cdn/CTZ7P2ON.js +0 -4
- package/dist/cdn/CV57WMBL.js +0 -9
- package/dist/cdn/CVMDCLGB.js +0 -4
- package/dist/cdn/DRLSZQDU.js +0 -4
- package/dist/cdn/DV2N434J.js +0 -4
- package/dist/cdn/EESASTEL.js +0 -4
- package/dist/cdn/EIB4B7NM.js +0 -4
- package/dist/cdn/EJ6NO5NK.js +0 -4
- package/dist/cdn/EQ5LPNFG.js +0 -4
- package/dist/cdn/ESWN44C2.js +0 -4
- package/dist/cdn/FGMLBVRU.js +0 -4
- package/dist/cdn/FMG27I4G.js +0 -4
- package/dist/cdn/G7HMCSFT.js +0 -4
- package/dist/cdn/GF6IWOJL.js +0 -4
- package/dist/cdn/GKKACUDU.js +0 -4
- package/dist/cdn/GNUO5PT5.js +0 -4
- package/dist/cdn/GO3GNQWU.js +0 -4
- package/dist/cdn/GTX63LFG.js +0 -4
- package/dist/cdn/IJ7RAUIP.js +0 -4
- package/dist/cdn/IXQV54AH.js +0 -4
- package/dist/cdn/IYKN5PO5.js +0 -4
- package/dist/cdn/J3J6R74M.js +0 -4
- package/dist/cdn/J775FRFE.js +0 -4
- package/dist/cdn/JCD5KEV5.js +0 -4
- package/dist/cdn/JO6R7FAD.js +0 -4
- package/dist/cdn/JULFSLDD.js +0 -4
- package/dist/cdn/KA2OECP3.js +0 -4
- package/dist/cdn/KQ3JBLDT.js +0 -4
- package/dist/cdn/KT3EUEKF.js +0 -4
- package/dist/cdn/L3AGPAN7.js +0 -4
- package/dist/cdn/LUBY2O7T.js +0 -4
- package/dist/cdn/LWWUKKLM.js +0 -4
- package/dist/cdn/MJIHMPZU.js +0 -4
- package/dist/cdn/MNLAUE2R.js +0 -4
- package/dist/cdn/MSCH74JK.js +0 -4
- package/dist/cdn/N3ZZQIYY.js +0 -4
- package/dist/cdn/NFNK7YME.js +0 -4
- package/dist/cdn/NNJWJUAD.js +0 -4
- package/dist/cdn/NXFS5VZC.js +0 -4
- package/dist/cdn/NYJOUGGN.js +0 -4
- package/dist/cdn/O7ICRTC5.js +0 -4
- package/dist/cdn/OH55X5ST.js +0 -4
- package/dist/cdn/OHXEZHUF.js +0 -4
- package/dist/cdn/OULH6KEN.js +0 -4
- package/dist/cdn/OXCYD67R.js +0 -4
- package/dist/cdn/P4GL7TQJ.js +0 -4
- package/dist/cdn/PK5EPYTE.js +0 -4
- package/dist/cdn/Q26RMW45.js +0 -4
- package/dist/cdn/Q7CX6235.js +0 -4
- package/dist/cdn/QMRZYMIJ.js +0 -4
- package/dist/cdn/QPXLDAZR.js +0 -4
- package/dist/cdn/QREJFC5Z.js +0 -4
- package/dist/cdn/QRPZEJLW.js +0 -4
- package/dist/cdn/QUFHIUYU.js +0 -4
- package/dist/cdn/R35F7LSR.js +0 -4
- package/dist/cdn/RAUOWG2P.js +0 -4
- package/dist/cdn/RBLUJIEM.js +0 -4
- package/dist/cdn/RD4WHUHX.js +0 -4
- package/dist/cdn/RPYAAT7A.js +0 -4
- package/dist/cdn/RQUX2H7R.js +0 -4
- package/dist/cdn/RXHQCPJY.js +0 -4
- package/dist/cdn/RYXSSH5D.js +0 -4
- package/dist/cdn/SBYAAEWD.js +0 -4
- package/dist/cdn/SSEBMECL.js +0 -4
- package/dist/cdn/SZABV557.js +0 -4
- package/dist/cdn/T6XWFHOM.js +0 -4
- package/dist/cdn/TF2524IM.js +0 -4
- package/dist/cdn/TUHJKFNY.js +0 -4
- package/dist/cdn/TWK4M5TM.js +0 -4
- package/dist/cdn/TWZ6WRUM.js +0 -4
- package/dist/cdn/U5HMRSJG.js +0 -4
- package/dist/cdn/UBXMRMPS.js +0 -4
- package/dist/cdn/V25AJNHD.js +0 -4
- package/dist/cdn/V3KSNGDN.js +0 -4
- package/dist/cdn/V54CMZHN.js +0 -4
- package/dist/cdn/V5SM3QEH.js +0 -4
- package/dist/cdn/VLS7CPMI.js +0 -4
- package/dist/cdn/VSIBQFUQ.js +0 -4
- package/dist/cdn/VWFDTLYA.js +0 -4
- package/dist/cdn/X74EKXT7.js +0 -4
- package/dist/cdn/XAPWGYND.js +0 -4
- package/dist/cdn/XCKB43CS.js +0 -4
- package/dist/cdn/YAJHM6HT.js +0 -4
- package/dist/cdn/Z25G3SCO.js +0 -4
- package/dist/cdn/Z4Z7YFNR.js +0 -4
- package/dist/cdn/ZKKZT5GI.js +0 -4
- package/dist/cdn/ZR4UXKJK.js +0 -4
- package/dist/chunks/uiController.js +0 -45
- package/dist/components/arcgis-version-management-version-item/customElement.d.ts +0 -22
- package/dist/components/arcgis-version-management-version-item/customElement.js +0 -30
- package/dist/components/arcgis-version-management-version-item/index.d.ts +0 -5
- package/dist/components/arcgis-version-management-version-item/index.js +0 -5
package/dist/docs/web-types.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
|
|
3
3
|
"name": "@arcgis/map-components",
|
|
4
|
-
"version": "5.0.0-next.
|
|
4
|
+
"version": "5.0.0-next.30",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
},
|
|
37
37
|
{
|
|
38
38
|
"name": "position",
|
|
39
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
39
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
40
40
|
"value": {
|
|
41
41
|
"type": [
|
|
42
42
|
"\"bottom-leading\"",
|
|
@@ -152,11 +152,11 @@
|
|
|
152
152
|
{
|
|
153
153
|
"name": "unitOptions",
|
|
154
154
|
"description": "List of available units and unit systems (imperial, metric) for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unitOptions)",
|
|
155
|
-
"type": "Array<\"
|
|
155
|
+
"type": "Array<\"imperial\" | \"metric\" | \"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\">"
|
|
156
156
|
},
|
|
157
157
|
{
|
|
158
158
|
"name": "view",
|
|
159
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
159
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Area Measurement 2D component will be associated with a map or scene component rather than using the `view` property.",
|
|
160
160
|
"type": "MapView"
|
|
161
161
|
}
|
|
162
162
|
],
|
|
@@ -204,7 +204,7 @@
|
|
|
204
204
|
},
|
|
205
205
|
{
|
|
206
206
|
"name": "position",
|
|
207
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
207
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
208
208
|
"value": {
|
|
209
209
|
"type": [
|
|
210
210
|
"\"bottom-leading\"",
|
|
@@ -319,11 +319,11 @@
|
|
|
319
319
|
{
|
|
320
320
|
"name": "unitOptions",
|
|
321
321
|
"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: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [unit](#unit) values can only be a subset of this list.",
|
|
322
|
-
"type": "Array<\"
|
|
322
|
+
"type": "Array<\"imperial\" | \"metric\" | \"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\">"
|
|
323
323
|
},
|
|
324
324
|
{
|
|
325
325
|
"name": "view",
|
|
326
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
326
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Area Measurement 3D component will be associated with a map or scene component rather than using the `view` property.",
|
|
327
327
|
"type": "SceneView"
|
|
328
328
|
}
|
|
329
329
|
],
|
|
@@ -439,7 +439,7 @@
|
|
|
439
439
|
},
|
|
440
440
|
{
|
|
441
441
|
"name": "position",
|
|
442
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
442
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
443
443
|
"value": {
|
|
444
444
|
"type": [
|
|
445
445
|
"\"bottom-leading\"",
|
|
@@ -660,7 +660,7 @@
|
|
|
660
660
|
},
|
|
661
661
|
{
|
|
662
662
|
"name": "position",
|
|
663
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
663
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
664
664
|
"value": {
|
|
665
665
|
"type": [
|
|
666
666
|
"\"bottom-leading\"",
|
|
@@ -766,7 +766,7 @@
|
|
|
766
766
|
},
|
|
767
767
|
{
|
|
768
768
|
"name": "view",
|
|
769
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
769
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Basemap Gallery component will be associated with a map or scene component rather than using the `view` property.",
|
|
770
770
|
"type": "MapView | SceneView"
|
|
771
771
|
}
|
|
772
772
|
],
|
|
@@ -920,7 +920,7 @@
|
|
|
920
920
|
},
|
|
921
921
|
{
|
|
922
922
|
"name": "position",
|
|
923
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
923
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
924
924
|
"value": {
|
|
925
925
|
"type": [
|
|
926
926
|
"\"bottom-leading\"",
|
|
@@ -1228,7 +1228,7 @@
|
|
|
1228
1228
|
},
|
|
1229
1229
|
{
|
|
1230
1230
|
"name": "view",
|
|
1231
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
1231
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Basemap Layer List component will be associated with a map or scene component rather than using the `view` property.",
|
|
1232
1232
|
"type": "MapView | SceneView"
|
|
1233
1233
|
},
|
|
1234
1234
|
{
|
|
@@ -1298,7 +1298,7 @@
|
|
|
1298
1298
|
},
|
|
1299
1299
|
{
|
|
1300
1300
|
"name": "position",
|
|
1301
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
1301
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
1302
1302
|
"value": {
|
|
1303
1303
|
"type": [
|
|
1304
1304
|
"\"bottom-leading\"",
|
|
@@ -1407,7 +1407,7 @@
|
|
|
1407
1407
|
},
|
|
1408
1408
|
{
|
|
1409
1409
|
"name": "view",
|
|
1410
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
1410
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Basemap Toggle component will be associated with a map or scene component rather than using the `view` property.",
|
|
1411
1411
|
"type": "MapView | SceneView"
|
|
1412
1412
|
}
|
|
1413
1413
|
],
|
|
@@ -1427,7 +1427,7 @@
|
|
|
1427
1427
|
},
|
|
1428
1428
|
{
|
|
1429
1429
|
"name": "arcgis-bookmarks",
|
|
1430
|
-
"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** -
|
|
1430
|
+
"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<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `goTo(bookmark: __esri.Bookmark): Promise<void>` - Zoom to a specific bookmark.",
|
|
1431
1431
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/",
|
|
1432
1432
|
"attributes": [
|
|
1433
1433
|
{
|
|
@@ -1534,7 +1534,7 @@
|
|
|
1534
1534
|
},
|
|
1535
1535
|
{
|
|
1536
1536
|
"name": "position",
|
|
1537
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
1537
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
1538
1538
|
"value": {
|
|
1539
1539
|
"type": [
|
|
1540
1540
|
"\"bottom-leading\"",
|
|
@@ -1628,13 +1628,18 @@
|
|
|
1628
1628
|
{
|
|
1629
1629
|
"name": "arcgisBookmarkEdit",
|
|
1630
1630
|
"type": "BookmarksBookmarkEditEvent",
|
|
1631
|
-
"description": "
|
|
1631
|
+
"description": "Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited."
|
|
1632
1632
|
},
|
|
1633
1633
|
{
|
|
1634
1634
|
"name": "arcgisBookmarkSelect",
|
|
1635
1635
|
"type": "BookmarksBookmarkSelectEvent",
|
|
1636
1636
|
"description": "Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected."
|
|
1637
1637
|
},
|
|
1638
|
+
{
|
|
1639
|
+
"name": "arcgisClose",
|
|
1640
|
+
"type": "void",
|
|
1641
|
+
"description": "Emitted when the component's close button is clicked."
|
|
1642
|
+
},
|
|
1638
1643
|
{
|
|
1639
1644
|
"name": "arcgisPropertyChange",
|
|
1640
1645
|
"type": "{ name: \"state\"; }",
|
|
@@ -1665,12 +1670,12 @@
|
|
|
1665
1670
|
},
|
|
1666
1671
|
{
|
|
1667
1672
|
"name": "defaultCreateOptions",
|
|
1668
|
-
"description": "Specifies how new bookmarks will be created if [showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showAddBookmarkButton) is set to `true`.\nCan be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current\nview when a bookmark is created. See [BookmarkOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel
|
|
1673
|
+
"description": "Specifies how new bookmarks will be created if [showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showAddBookmarkButton) is set to `true`.\nCan be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current\nview when a bookmark is created. See [BookmarkOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions)\nfor the full list of options.",
|
|
1669
1674
|
"type": "BookmarkOptions"
|
|
1670
1675
|
},
|
|
1671
1676
|
{
|
|
1672
1677
|
"name": "defaultEditOptions",
|
|
1673
|
-
"description": "Specifies how bookmarks will be edited, if [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton) is set to `true`.\nCan be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current\nview when a bookmark is edited. See [BookmarkOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel
|
|
1678
|
+
"description": "Specifies how bookmarks will be edited, if [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton) is set to `true`.\nCan be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current\nview when a bookmark is edited. See [BookmarkOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#BookmarkOptions)\nfor the full list of options.",
|
|
1674
1679
|
"type": "BookmarkOptions"
|
|
1675
1680
|
},
|
|
1676
1681
|
{
|
|
@@ -1784,7 +1789,7 @@
|
|
|
1784
1789
|
},
|
|
1785
1790
|
{
|
|
1786
1791
|
"name": "view",
|
|
1787
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
1792
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Bookmarks component will be associated with a map or scene component rather than using the `view` property.",
|
|
1788
1793
|
"type": "MapView | SceneView"
|
|
1789
1794
|
}
|
|
1790
1795
|
],
|
|
@@ -1792,13 +1797,18 @@
|
|
|
1792
1797
|
{
|
|
1793
1798
|
"name": "arcgisBookmarkEdit",
|
|
1794
1799
|
"type": "BookmarksBookmarkEditEvent",
|
|
1795
|
-
"description": "
|
|
1800
|
+
"description": "Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited."
|
|
1796
1801
|
},
|
|
1797
1802
|
{
|
|
1798
1803
|
"name": "arcgisBookmarkSelect",
|
|
1799
1804
|
"type": "BookmarksBookmarkSelectEvent",
|
|
1800
1805
|
"description": "Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected."
|
|
1801
1806
|
},
|
|
1807
|
+
{
|
|
1808
|
+
"name": "arcgisClose",
|
|
1809
|
+
"type": "void",
|
|
1810
|
+
"description": "Emitted when the component's close button is clicked."
|
|
1811
|
+
},
|
|
1802
1812
|
{
|
|
1803
1813
|
"name": "arcgisPropertyChange",
|
|
1804
1814
|
"type": "{ name: \"state\"; }",
|
|
@@ -1871,7 +1881,7 @@
|
|
|
1871
1881
|
},
|
|
1872
1882
|
{
|
|
1873
1883
|
"name": "position",
|
|
1874
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
1884
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
1875
1885
|
"value": {
|
|
1876
1886
|
"type": [
|
|
1877
1887
|
"\"bottom-leading\"",
|
|
@@ -1984,7 +1994,7 @@
|
|
|
1984
1994
|
},
|
|
1985
1995
|
{
|
|
1986
1996
|
"name": "view",
|
|
1987
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
1997
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Building Explorer component will be associated with a map or scene component rather than using the `view` property.",
|
|
1988
1998
|
"type": "SceneView"
|
|
1989
1999
|
}
|
|
1990
2000
|
],
|
|
@@ -2094,7 +2104,7 @@
|
|
|
2094
2104
|
},
|
|
2095
2105
|
{
|
|
2096
2106
|
"name": "position",
|
|
2097
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
2107
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
2098
2108
|
"value": {
|
|
2099
2109
|
"type": [
|
|
2100
2110
|
"\"bottom-leading\"",
|
|
@@ -2342,7 +2352,7 @@
|
|
|
2342
2352
|
},
|
|
2343
2353
|
{
|
|
2344
2354
|
"name": "view",
|
|
2345
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
2355
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Catalog Layer List component will be associated with a map or scene component rather than using the `view` property.",
|
|
2346
2356
|
"type": "MapView | SceneView"
|
|
2347
2357
|
},
|
|
2348
2358
|
{
|
|
@@ -2404,7 +2414,7 @@
|
|
|
2404
2414
|
},
|
|
2405
2415
|
{
|
|
2406
2416
|
"name": "position",
|
|
2407
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
2417
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
2408
2418
|
"value": {
|
|
2409
2419
|
"type": [
|
|
2410
2420
|
"\"bottom-leading\"",
|
|
@@ -2499,7 +2509,7 @@
|
|
|
2499
2509
|
},
|
|
2500
2510
|
{
|
|
2501
2511
|
"name": "view",
|
|
2502
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
2512
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Compass component will be associated with a map or scene component rather than using the `view` property.",
|
|
2503
2513
|
"type": "MapView | SceneView"
|
|
2504
2514
|
}
|
|
2505
2515
|
],
|
|
@@ -2519,7 +2529,7 @@
|
|
|
2519
2529
|
},
|
|
2520
2530
|
{
|
|
2521
2531
|
"name": "arcgis-coordinate-conversion",
|
|
2522
|
-
"description": "The
|
|
2532
|
+
"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<void>` - 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.",
|
|
2523
2533
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-coordinate-conversion/",
|
|
2524
2534
|
"attributes": [
|
|
2525
2535
|
{
|
|
@@ -2532,7 +2542,7 @@
|
|
|
2532
2542
|
},
|
|
2533
2543
|
{
|
|
2534
2544
|
"name": "expanded",
|
|
2535
|
-
"description": "Describes whether the
|
|
2545
|
+
"description": "Describes whether the component is expanded or not. If `true`, the component is expanded and all conversions are visible.",
|
|
2536
2546
|
"default": "false",
|
|
2537
2547
|
"value": {
|
|
2538
2548
|
"type": "boolean"
|
|
@@ -2555,7 +2565,7 @@
|
|
|
2555
2565
|
},
|
|
2556
2566
|
{
|
|
2557
2567
|
"name": "hide-capture-button",
|
|
2558
|
-
"description": "Determines whether the capture button will be shown in the component",
|
|
2568
|
+
"description": "Determines whether the capture button will be shown in the component. If `true`, the capture button will be hidden.",
|
|
2559
2569
|
"default": "false",
|
|
2560
2570
|
"value": {
|
|
2561
2571
|
"type": "boolean"
|
|
@@ -2563,7 +2573,7 @@
|
|
|
2563
2573
|
},
|
|
2564
2574
|
{
|
|
2565
2575
|
"name": "hide-expand-button",
|
|
2566
|
-
"description": "Determines whether the expand button will be shown in the component",
|
|
2576
|
+
"description": "Determines whether the expand button will be shown in the component. If `true`, the expand button will be hidden.",
|
|
2567
2577
|
"default": "false",
|
|
2568
2578
|
"value": {
|
|
2569
2579
|
"type": "boolean"
|
|
@@ -2571,7 +2581,7 @@
|
|
|
2571
2581
|
},
|
|
2572
2582
|
{
|
|
2573
2583
|
"name": "hide-input-button",
|
|
2574
|
-
"description": "Determines whether the
|
|
2584
|
+
"description": "Determines whether the input coordinate button will be shown in the component. If `true`, the input button will be hidden.",
|
|
2575
2585
|
"default": "false",
|
|
2576
2586
|
"value": {
|
|
2577
2587
|
"type": "boolean"
|
|
@@ -2579,7 +2589,7 @@
|
|
|
2579
2589
|
},
|
|
2580
2590
|
{
|
|
2581
2591
|
"name": "hide-settings-button",
|
|
2582
|
-
"description": "Determines whether the settings button will be shown in the component",
|
|
2592
|
+
"description": "Determines whether the settings button will be shown in the component. If `true`, the settings button will be hidden.",
|
|
2583
2593
|
"default": "false",
|
|
2584
2594
|
"value": {
|
|
2585
2595
|
"type": "boolean"
|
|
@@ -2612,9 +2622,17 @@
|
|
|
2612
2622
|
]
|
|
2613
2623
|
}
|
|
2614
2624
|
},
|
|
2625
|
+
{
|
|
2626
|
+
"name": "multiple-conversions-disabled",
|
|
2627
|
+
"description": "If this property is set to `true`, multiple conversions will be disabled, and only a single conversion will be displayed. Otherwise, multiple conversions will be shown.",
|
|
2628
|
+
"default": "false",
|
|
2629
|
+
"value": {
|
|
2630
|
+
"type": "boolean"
|
|
2631
|
+
}
|
|
2632
|
+
},
|
|
2615
2633
|
{
|
|
2616
2634
|
"name": "orientation",
|
|
2617
|
-
"description": "Determines whether the component should expand up or down. If set to `auto
|
|
2635
|
+
"description": "Determines whether the component should expand up or down. If set to `auto`,\nthe component will be oriented based on its position in the view.",
|
|
2618
2636
|
"default": "\"auto\"",
|
|
2619
2637
|
"value": {
|
|
2620
2638
|
"type": [
|
|
@@ -2626,7 +2644,7 @@
|
|
|
2626
2644
|
},
|
|
2627
2645
|
{
|
|
2628
2646
|
"name": "position",
|
|
2629
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
2647
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
2630
2648
|
"value": {
|
|
2631
2649
|
"type": [
|
|
2632
2650
|
"\"bottom-leading\"",
|
|
@@ -2648,14 +2666,6 @@
|
|
|
2648
2666
|
"type": "string"
|
|
2649
2667
|
}
|
|
2650
2668
|
},
|
|
2651
|
-
{
|
|
2652
|
-
"name": "single-conversion",
|
|
2653
|
-
"description": "If this property is set to `true`, only a single conversion can be displated. For a simpler experience with only\none conversion at a time, this property can be set to `true`.",
|
|
2654
|
-
"default": "false",
|
|
2655
|
-
"value": {
|
|
2656
|
-
"type": "boolean"
|
|
2657
|
-
}
|
|
2658
|
-
},
|
|
2659
2669
|
{
|
|
2660
2670
|
"name": "state",
|
|
2661
2671
|
"description": "The current state of the component.",
|
|
@@ -2691,11 +2701,12 @@
|
|
|
2691
2701
|
"events": [
|
|
2692
2702
|
{
|
|
2693
2703
|
"name": "arcgisConversionChange",
|
|
2694
|
-
"type": "void"
|
|
2704
|
+
"type": "void",
|
|
2705
|
+
"description": "Emitted when a conversion is added or removed, or when the order of conversions changes."
|
|
2695
2706
|
},
|
|
2696
2707
|
{
|
|
2697
2708
|
"name": "arcgisPropertyChange",
|
|
2698
|
-
"type": "{ name: \"state\" | \"
|
|
2709
|
+
"type": "{ name: \"state\" | \"expanded\" | \"mode\" | \"currentLocation\"; }",
|
|
2699
2710
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
2700
2711
|
},
|
|
2701
2712
|
{
|
|
@@ -2723,7 +2734,7 @@
|
|
|
2723
2734
|
},
|
|
2724
2735
|
{
|
|
2725
2736
|
"name": "expanded",
|
|
2726
|
-
"description": "Describes whether the
|
|
2737
|
+
"description": "Describes whether the component is expanded or not. If `true`, the component is expanded and all conversions are visible.",
|
|
2727
2738
|
"type": "boolean"
|
|
2728
2739
|
},
|
|
2729
2740
|
{
|
|
@@ -2743,22 +2754,22 @@
|
|
|
2743
2754
|
},
|
|
2744
2755
|
{
|
|
2745
2756
|
"name": "hideCaptureButton",
|
|
2746
|
-
"description": "Determines whether the capture button will be shown in the component",
|
|
2757
|
+
"description": "Determines whether the capture button will be shown in the component. If `true`, the capture button will be hidden.",
|
|
2747
2758
|
"type": "boolean"
|
|
2748
2759
|
},
|
|
2749
2760
|
{
|
|
2750
2761
|
"name": "hideExpandButton",
|
|
2751
|
-
"description": "Determines whether the expand button will be shown in the component",
|
|
2762
|
+
"description": "Determines whether the expand button will be shown in the component. If `true`, the expand button will be hidden.",
|
|
2752
2763
|
"type": "boolean"
|
|
2753
2764
|
},
|
|
2754
2765
|
{
|
|
2755
2766
|
"name": "hideInputButton",
|
|
2756
|
-
"description": "Determines whether the
|
|
2767
|
+
"description": "Determines whether the input coordinate button will be shown in the component. If `true`, the input button will be hidden.",
|
|
2757
2768
|
"type": "boolean"
|
|
2758
2769
|
},
|
|
2759
2770
|
{
|
|
2760
2771
|
"name": "hideSettingsButton",
|
|
2761
|
-
"description": "Determines whether the settings button will be shown in the component",
|
|
2772
|
+
"description": "Determines whether the settings button will be shown in the component. If `true`, the settings button will be hidden.",
|
|
2762
2773
|
"type": "boolean"
|
|
2763
2774
|
},
|
|
2764
2775
|
{
|
|
@@ -2773,7 +2784,7 @@
|
|
|
2773
2784
|
},
|
|
2774
2785
|
{
|
|
2775
2786
|
"name": "locationSymbol",
|
|
2776
|
-
"description": "This symbol is used to visualize the location currently described by the component when `capture` mode\nis active.\n\nThis property should be set to
|
|
2787
|
+
"description": "This symbol is used to visualize the location currently described by the component when `capture` mode\nis active.\n\nThis property should be set to a point symbol, typically a [Simple Marker Symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleMarkerSymbol.html).",
|
|
2777
2788
|
"type": "CIMSymbol | PictureMarkerSymbol | PointSymbol3D | SimpleMarkerSymbol"
|
|
2778
2789
|
},
|
|
2779
2790
|
{
|
|
@@ -2781,9 +2792,14 @@
|
|
|
2781
2792
|
"description": "Describes the current mode of the component.\n\n* While in `live` mode, the component will update as the cursor moves.\n* While in `capture` mode, the component will update on mouse click and display a graphic\nmarking the current location.",
|
|
2782
2793
|
"type": "\"capture\" | \"live\""
|
|
2783
2794
|
},
|
|
2795
|
+
{
|
|
2796
|
+
"name": "multipleConversionsDisabled",
|
|
2797
|
+
"description": "If this property is set to `true`, multiple conversions will be disabled, and only a single conversion will be displayed. Otherwise, multiple conversions will be shown.",
|
|
2798
|
+
"type": "boolean"
|
|
2799
|
+
},
|
|
2784
2800
|
{
|
|
2785
2801
|
"name": "orientation",
|
|
2786
|
-
"description": "Determines whether the component should expand up or down. If set to `auto
|
|
2802
|
+
"description": "Determines whether the component should expand up or down. If set to `auto`,\nthe component will be oriented based on its position in the view.",
|
|
2787
2803
|
"type": "\"auto\" | \"expand-down\" | \"expand-up\""
|
|
2788
2804
|
},
|
|
2789
2805
|
{
|
|
@@ -2795,11 +2811,6 @@
|
|
|
2795
2811
|
"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.",
|
|
2796
2812
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2797
2813
|
},
|
|
2798
|
-
{
|
|
2799
|
-
"name": "singleConversion",
|
|
2800
|
-
"description": "If this property is set to `true`, only a single conversion can be displated. For a simpler experience with only\none conversion at a time, this property can be set to `true`.",
|
|
2801
|
-
"type": "boolean"
|
|
2802
|
-
},
|
|
2803
2814
|
{
|
|
2804
2815
|
"name": "state",
|
|
2805
2816
|
"description": "The current state of the component.",
|
|
@@ -2817,18 +2828,19 @@
|
|
|
2817
2828
|
},
|
|
2818
2829
|
{
|
|
2819
2830
|
"name": "view",
|
|
2820
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
2831
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Coordinate Conversion component will be associated with a map or scene component rather than using the `view` property.",
|
|
2821
2832
|
"type": "MapView | SceneView"
|
|
2822
2833
|
}
|
|
2823
2834
|
],
|
|
2824
2835
|
"events": [
|
|
2825
2836
|
{
|
|
2826
2837
|
"name": "arcgisConversionChange",
|
|
2827
|
-
"type": "void"
|
|
2838
|
+
"type": "void",
|
|
2839
|
+
"description": "Emitted when a conversion is added or removed, or when the order of conversions changes."
|
|
2828
2840
|
},
|
|
2829
2841
|
{
|
|
2830
2842
|
"name": "arcgisPropertyChange",
|
|
2831
|
-
"type": "{ name: \"state\" | \"
|
|
2843
|
+
"type": "{ name: \"state\" | \"expanded\" | \"mode\" | \"currentLocation\"; }",
|
|
2832
2844
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
2833
2845
|
},
|
|
2834
2846
|
{
|
|
@@ -2841,7 +2853,7 @@
|
|
|
2841
2853
|
},
|
|
2842
2854
|
{
|
|
2843
2855
|
"name": "arcgis-daylight",
|
|
2844
|
-
"description": "The Daylight component can be used to manipulate the lighting conditions of a
|
|
2856
|
+
"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 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<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
2845
2857
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/",
|
|
2846
2858
|
"attributes": [
|
|
2847
2859
|
{
|
|
@@ -2854,7 +2866,7 @@
|
|
|
2854
2866
|
},
|
|
2855
2867
|
{
|
|
2856
2868
|
"name": "current-season",
|
|
2857
|
-
"description": "
|
|
2869
|
+
"description": "Sets the season that is used when the component displays the season picker.\nEach season uses a fixed date corresponding to the seasonal equinoxes and solstices.",
|
|
2858
2870
|
"value": {
|
|
2859
2871
|
"type": [
|
|
2860
2872
|
"\"fall\"",
|
|
@@ -2866,7 +2878,7 @@
|
|
|
2866
2878
|
},
|
|
2867
2879
|
{
|
|
2868
2880
|
"name": "date-or-season",
|
|
2869
|
-
"description": "Controls whether the component displays a date or a season picker
|
|
2881
|
+
"description": "Controls whether the component displays a date or a season picker. When the date picker is set, the user selects the date from a calendar. The season picker allows the user to choose a season from a drop-down list. Each season uses a fixed date corresponding to the equinoxes and solstices of 2014.",
|
|
2870
2882
|
"default": "\"date\"",
|
|
2871
2883
|
"value": {
|
|
2872
2884
|
"type": [
|
|
@@ -2877,14 +2889,7 @@
|
|
|
2877
2889
|
},
|
|
2878
2890
|
{
|
|
2879
2891
|
"name": "day-playing",
|
|
2880
|
-
"description": "Starts or pauses the daytime animation cycling through the minutes of the day.\nSet to `true` to start the animation and to `false` to pause it.",
|
|
2881
|
-
"default": "false",
|
|
2882
|
-
"value": {
|
|
2883
|
-
"type": "boolean"
|
|
2884
|
-
}
|
|
2885
|
-
},
|
|
2886
|
-
{
|
|
2887
|
-
"name": "direct-shadows-disabled",
|
|
2892
|
+
"description": "Starts or pauses the daytime animation cycling through the minutes of the day.\nSet the property to `true` to start the animation and to `false` to pause it.",
|
|
2888
2893
|
"default": "false",
|
|
2889
2894
|
"value": {
|
|
2890
2895
|
"type": "boolean"
|
|
@@ -2949,7 +2954,7 @@
|
|
|
2949
2954
|
},
|
|
2950
2955
|
{
|
|
2951
2956
|
"name": "icon",
|
|
2952
|
-
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component)
|
|
2957
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
2953
2958
|
"default": "\"brightness\"",
|
|
2954
2959
|
"value": {
|
|
2955
2960
|
"type": "string"
|
|
@@ -2964,7 +2969,7 @@
|
|
|
2964
2969
|
},
|
|
2965
2970
|
{
|
|
2966
2971
|
"name": "local-date",
|
|
2967
|
-
"description": "The calendar date in the timezone given by [utcOffset](#utcOffset)
|
|
2972
|
+
"description": "The calendar date in the timezone given by [utcOffset](#utcOffset).",
|
|
2968
2973
|
"value": {
|
|
2969
2974
|
"type": [
|
|
2970
2975
|
"number",
|
|
@@ -2980,19 +2985,9 @@
|
|
|
2980
2985
|
"type": "number"
|
|
2981
2986
|
}
|
|
2982
2987
|
},
|
|
2983
|
-
{
|
|
2984
|
-
"name": "playing-state",
|
|
2985
|
-
"value": {
|
|
2986
|
-
"type": [
|
|
2987
|
-
"\"day\"",
|
|
2988
|
-
"\"none\"",
|
|
2989
|
-
"\"year\""
|
|
2990
|
-
]
|
|
2991
|
-
}
|
|
2992
|
-
},
|
|
2993
2988
|
{
|
|
2994
2989
|
"name": "position",
|
|
2995
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
2990
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
2996
2991
|
"value": {
|
|
2997
2992
|
"type": [
|
|
2998
2993
|
"\"bottom-leading\"",
|
|
@@ -3014,24 +3009,16 @@
|
|
|
3014
3009
|
"type": "string"
|
|
3015
3010
|
}
|
|
3016
3011
|
},
|
|
3017
|
-
{
|
|
3018
|
-
"name": "sunlighting-disabled",
|
|
3019
|
-
"description": "Indicates whether date and time are used to determine position of the light source.\nWhen `false`, the light source is positioned relative to the camera, using [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html).",
|
|
3020
|
-
"default": "false",
|
|
3021
|
-
"value": {
|
|
3022
|
-
"type": "boolean"
|
|
3023
|
-
}
|
|
3024
|
-
},
|
|
3025
3012
|
{
|
|
3026
3013
|
"name": "time-slider-position",
|
|
3027
|
-
"description": "Slider position for the time of day in the timezone\ngiven by [utcOffset](#utcOffset). The position represents the time\nof the day in minutes. Possible values range between 0 and 1440
|
|
3014
|
+
"description": "Slider position for the time of day in the timezone\ngiven by [utcOffset](#utcOffset). The position represents the time\nof the day in minutes. Possible values range between 0 and 1440.",
|
|
3028
3015
|
"value": {
|
|
3029
3016
|
"type": "number"
|
|
3030
3017
|
}
|
|
3031
3018
|
},
|
|
3032
3019
|
{
|
|
3033
3020
|
"name": "time-slider-steps",
|
|
3034
|
-
"description": "Sets
|
|
3021
|
+
"description": "Sets the interval, in minutes, with which the time slider increments or decrements as it is dragged or changed via the keyboard.",
|
|
3035
3022
|
"default": "5",
|
|
3036
3023
|
"value": {
|
|
3037
3024
|
"type": "number"
|
|
@@ -3039,14 +3026,14 @@
|
|
|
3039
3026
|
},
|
|
3040
3027
|
{
|
|
3041
3028
|
"name": "utc-offset",
|
|
3042
|
-
"description": "The difference in hours between UTC time and the time displayed in the
|
|
3029
|
+
"description": "The difference in hours between UTC time and the time displayed in the component.",
|
|
3043
3030
|
"value": {
|
|
3044
3031
|
"type": "number"
|
|
3045
3032
|
}
|
|
3046
3033
|
},
|
|
3047
3034
|
{
|
|
3048
3035
|
"name": "year-playing",
|
|
3049
|
-
"description": "Starts or pauses the date animation cycling through the months of the year
|
|
3036
|
+
"description": "Starts or pauses the date animation cycling through the months of the year.\nSet the property to `true` to start the animation and to `false` to pause it.",
|
|
3050
3037
|
"default": "false",
|
|
3051
3038
|
"value": {
|
|
3052
3039
|
"type": "boolean"
|
|
@@ -3074,21 +3061,17 @@
|
|
|
3074
3061
|
},
|
|
3075
3062
|
{
|
|
3076
3063
|
"name": "currentSeason",
|
|
3077
|
-
"description": "
|
|
3064
|
+
"description": "Sets the season that is used when the component displays the season picker.\nEach season uses a fixed date corresponding to the seasonal equinoxes and solstices.",
|
|
3078
3065
|
"type": "\"fall\" | \"spring\" | \"summer\" | \"winter\""
|
|
3079
3066
|
},
|
|
3080
3067
|
{
|
|
3081
3068
|
"name": "dateOrSeason",
|
|
3082
|
-
"description": "Controls whether the component displays a date or a season picker
|
|
3069
|
+
"description": "Controls whether the component displays a date or a season picker. When the date picker is set, the user selects the date from a calendar. The season picker allows the user to choose a season from a drop-down list. Each season uses a fixed date corresponding to the equinoxes and solstices of 2014.",
|
|
3083
3070
|
"type": "\"date\" | \"season\""
|
|
3084
3071
|
},
|
|
3085
3072
|
{
|
|
3086
3073
|
"name": "dayPlaying",
|
|
3087
|
-
"description": "Starts or pauses the daytime animation cycling through the minutes of the day.\nSet to `true` to start the animation and to `false` to pause it.",
|
|
3088
|
-
"type": "boolean"
|
|
3089
|
-
},
|
|
3090
|
-
{
|
|
3091
|
-
"name": "directShadowsDisabled",
|
|
3074
|
+
"description": "Starts or pauses the daytime animation cycling through the minutes of the day.\nSet the property to `true` to start the animation and to `false` to pause it.",
|
|
3092
3075
|
"type": "boolean"
|
|
3093
3076
|
},
|
|
3094
3077
|
{
|
|
@@ -3122,7 +3105,7 @@
|
|
|
3122
3105
|
},
|
|
3123
3106
|
{
|
|
3124
3107
|
"name": "icon",
|
|
3125
|
-
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component)
|
|
3108
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
3126
3109
|
"type": "string"
|
|
3127
3110
|
},
|
|
3128
3111
|
{
|
|
@@ -3130,19 +3113,11 @@
|
|
|
3130
3113
|
"description": "The component's default label.",
|
|
3131
3114
|
"type": "string"
|
|
3132
3115
|
},
|
|
3133
|
-
{
|
|
3134
|
-
"name": "lighting",
|
|
3135
|
-
"type": "SunLighting | VirtualLighting"
|
|
3136
|
-
},
|
|
3137
3116
|
{
|
|
3138
3117
|
"name": "localDate",
|
|
3139
|
-
"description": "The calendar date in the timezone given by [utcOffset](#utcOffset)
|
|
3118
|
+
"description": "The calendar date in the timezone given by [utcOffset](#utcOffset).",
|
|
3140
3119
|
"type": "Date | number | string"
|
|
3141
3120
|
},
|
|
3142
|
-
{
|
|
3143
|
-
"name": "playingState",
|
|
3144
|
-
"type": "\"day\" | \"none\" | \"year\""
|
|
3145
|
-
},
|
|
3146
3121
|
{
|
|
3147
3122
|
"name": "playSpeedMultiplier",
|
|
3148
3123
|
"description": "Controls the daytime and date animation speed.",
|
|
@@ -3157,37 +3132,28 @@
|
|
|
3157
3132
|
"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.",
|
|
3158
3133
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3159
3134
|
},
|
|
3160
|
-
{
|
|
3161
|
-
"name": "sunlightingDisabled",
|
|
3162
|
-
"description": "Indicates whether date and time are used to determine position of the light source.\nWhen `false`, the light source is positioned relative to the camera, using [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html).",
|
|
3163
|
-
"type": "boolean"
|
|
3164
|
-
},
|
|
3165
|
-
{
|
|
3166
|
-
"name": "supported",
|
|
3167
|
-
"type": "boolean"
|
|
3168
|
-
},
|
|
3169
3135
|
{
|
|
3170
3136
|
"name": "timeSliderPosition",
|
|
3171
|
-
"description": "Slider position for the time of day in the timezone\ngiven by [utcOffset](#utcOffset). The position represents the time\nof the day in minutes. Possible values range between 0 and 1440
|
|
3137
|
+
"description": "Slider position for the time of day in the timezone\ngiven by [utcOffset](#utcOffset). The position represents the time\nof the day in minutes. Possible values range between 0 and 1440.",
|
|
3172
3138
|
"type": "number"
|
|
3173
3139
|
},
|
|
3174
3140
|
{
|
|
3175
3141
|
"name": "timeSliderSteps",
|
|
3176
|
-
"description": "Sets
|
|
3177
|
-
"type": "number"
|
|
3142
|
+
"description": "Sets the interval, in minutes, with which the time slider increments or decrements as it is dragged or changed via the keyboard.",
|
|
3143
|
+
"type": "Array<number> | number"
|
|
3178
3144
|
},
|
|
3179
3145
|
{
|
|
3180
3146
|
"name": "utcOffset",
|
|
3181
|
-
"description": "The difference in hours between UTC time and the time displayed in the
|
|
3147
|
+
"description": "The difference in hours between UTC time and the time displayed in the component.",
|
|
3182
3148
|
"type": "number"
|
|
3183
3149
|
},
|
|
3184
3150
|
{
|
|
3185
3151
|
"name": "view",
|
|
3186
|
-
"type": "
|
|
3152
|
+
"type": "SceneView"
|
|
3187
3153
|
},
|
|
3188
3154
|
{
|
|
3189
3155
|
"name": "yearPlaying",
|
|
3190
|
-
"description": "Starts or pauses the date animation cycling through the months of the year
|
|
3156
|
+
"description": "Starts or pauses the date animation cycling through the months of the year.\nSet the property to `true` to start the animation and to `false` to pause it.",
|
|
3191
3157
|
"type": "boolean"
|
|
3192
3158
|
}
|
|
3193
3159
|
],
|
|
@@ -3251,7 +3217,7 @@
|
|
|
3251
3217
|
},
|
|
3252
3218
|
{
|
|
3253
3219
|
"name": "position",
|
|
3254
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
3220
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
3255
3221
|
"value": {
|
|
3256
3222
|
"type": [
|
|
3257
3223
|
"\"bottom-leading\"",
|
|
@@ -3383,7 +3349,7 @@
|
|
|
3383
3349
|
},
|
|
3384
3350
|
{
|
|
3385
3351
|
"name": "view",
|
|
3386
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
3352
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Directional Pad component will be associated with a map or scene component rather than using the `view` property.",
|
|
3387
3353
|
"type": "MapView"
|
|
3388
3354
|
},
|
|
3389
3355
|
{
|
|
@@ -3480,7 +3446,7 @@
|
|
|
3480
3446
|
},
|
|
3481
3447
|
{
|
|
3482
3448
|
"name": "position",
|
|
3483
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
3449
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
3484
3450
|
"value": {
|
|
3485
3451
|
"type": [
|
|
3486
3452
|
"\"bottom-leading\"",
|
|
@@ -3657,7 +3623,7 @@
|
|
|
3657
3623
|
},
|
|
3658
3624
|
{
|
|
3659
3625
|
"name": "view",
|
|
3660
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
3626
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Directions component will be associated with a map or scene component rather than using the `view` property.",
|
|
3661
3627
|
"type": "MapView | SceneView"
|
|
3662
3628
|
}
|
|
3663
3629
|
],
|
|
@@ -3705,171 +3671,7 @@
|
|
|
3705
3671
|
},
|
|
3706
3672
|
{
|
|
3707
3673
|
"name": "position",
|
|
3708
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
3709
|
-
"value": {
|
|
3710
|
-
"type": [
|
|
3711
|
-
"\"bottom-leading\"",
|
|
3712
|
-
"\"bottom-left\"",
|
|
3713
|
-
"\"bottom-right\"",
|
|
3714
|
-
"\"bottom-trailing\"",
|
|
3715
|
-
"\"manual\"",
|
|
3716
|
-
"\"top-leading\"",
|
|
3717
|
-
"\"top-left\"",
|
|
3718
|
-
"\"top-right\"",
|
|
3719
|
-
"\"top-trailing\""
|
|
3720
|
-
]
|
|
3721
|
-
}
|
|
3722
|
-
},
|
|
3723
|
-
{
|
|
3724
|
-
"name": "reference-element",
|
|
3725
|
-
"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.",
|
|
3726
|
-
"value": {
|
|
3727
|
-
"type": "string"
|
|
3728
|
-
}
|
|
3729
|
-
},
|
|
3730
|
-
{
|
|
3731
|
-
"name": "state",
|
|
3732
|
-
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3733
|
-
"value": {
|
|
3734
|
-
"type": [
|
|
3735
|
-
"\"disabled\"",
|
|
3736
|
-
"\"measured\"",
|
|
3737
|
-
"\"measuring\"",
|
|
3738
|
-
"\"ready\""
|
|
3739
|
-
]
|
|
3740
|
-
}
|
|
3741
|
-
},
|
|
3742
|
-
{
|
|
3743
|
-
"name": "unit",
|
|
3744
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3745
|
-
"value": {
|
|
3746
|
-
"type": [
|
|
3747
|
-
"\"centimeters\"",
|
|
3748
|
-
"\"decimeters\"",
|
|
3749
|
-
"\"feet\"",
|
|
3750
|
-
"\"imperial\"",
|
|
3751
|
-
"\"inches\"",
|
|
3752
|
-
"\"kilometers\"",
|
|
3753
|
-
"\"meters\"",
|
|
3754
|
-
"\"metric\"",
|
|
3755
|
-
"\"miles\"",
|
|
3756
|
-
"\"millimeters\"",
|
|
3757
|
-
"\"nautical-miles\"",
|
|
3758
|
-
"\"us-feet\"",
|
|
3759
|
-
"\"yards\""
|
|
3760
|
-
]
|
|
3761
|
-
}
|
|
3762
|
-
}
|
|
3763
|
-
],
|
|
3764
|
-
"events": [
|
|
3765
|
-
{
|
|
3766
|
-
"name": "arcgisPropertyChange",
|
|
3767
|
-
"type": "{ name: \"state\" | \"analysis\"; }",
|
|
3768
|
-
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
3769
|
-
},
|
|
3770
|
-
{
|
|
3771
|
-
"name": "arcgisReady",
|
|
3772
|
-
"type": "void",
|
|
3773
|
-
"description": "Emitted when the component associated with a map or scene view is ready to be interacted with."
|
|
3774
|
-
}
|
|
3775
|
-
],
|
|
3776
|
-
"js": {
|
|
3777
|
-
"properties": [
|
|
3778
|
-
{
|
|
3779
|
-
"name": "analysis",
|
|
3780
|
-
"description": "The [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Direct Line Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst directLineAnalysis = new DirectLineMeasurementAnalysis({\n startPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624995.61798748,\n y: 4550334.030096778,\n z: 63.378210234455764\n }),\n endPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624921.53589075,\n y: 4550407.42357004,\n z: 63.3783810287714\n }),\n});\n// Get the Scene and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst directLineMeasurement3d = document.querySelector(\"arcgis-direct-line-measurement-3d\");\nawait directLineMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(directLineAnalysis);\n// Connect the analysis to the measurement component:\ndirectLineMeasurement3d.analysis = directLineAnalysis;\n```",
|
|
3781
|
-
"type": "DirectLineMeasurementAnalysis"
|
|
3782
|
-
},
|
|
3783
|
-
{
|
|
3784
|
-
"name": "autoDestroyDisabled",
|
|
3785
|
-
"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-direct-line-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.",
|
|
3786
|
-
"type": "boolean"
|
|
3787
|
-
},
|
|
3788
|
-
{
|
|
3789
|
-
"name": "icon",
|
|
3790
|
-
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
3791
|
-
"type": "string"
|
|
3792
|
-
},
|
|
3793
|
-
{
|
|
3794
|
-
"name": "label",
|
|
3795
|
-
"description": "The component's default label.",
|
|
3796
|
-
"type": "string"
|
|
3797
|
-
},
|
|
3798
|
-
{
|
|
3799
|
-
"name": "position",
|
|
3800
|
-
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
|
|
3801
|
-
},
|
|
3802
|
-
{
|
|
3803
|
-
"name": "referenceElement",
|
|
3804
|
-
"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.",
|
|
3805
|
-
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3806
|
-
},
|
|
3807
|
-
{
|
|
3808
|
-
"name": "state",
|
|
3809
|
-
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3810
|
-
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
3811
|
-
},
|
|
3812
|
-
{
|
|
3813
|
-
"name": "unit",
|
|
3814
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3815
|
-
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
3816
|
-
},
|
|
3817
|
-
{
|
|
3818
|
-
"name": "unitOptions",
|
|
3819
|
-
"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: `metric`, `imperial`, `inches`, `feet`, `us-feet`, `yards`, `miles`, `nautical-miles`, `meters`, `kilometers`.\nPossible [unit](#unit) values can only be a subset of this list.",
|
|
3820
|
-
"type": "Array<\"meters\" | \"metric\" | \"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\" | \"miles\" | \"imperial\">"
|
|
3821
|
-
},
|
|
3822
|
-
{
|
|
3823
|
-
"name": "view",
|
|
3824
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the ArcgisDirectLineMeasurement3d component will be associated with a map or scene component rather than using the `view` property.",
|
|
3825
|
-
"type": "SceneView"
|
|
3826
|
-
}
|
|
3827
|
-
],
|
|
3828
|
-
"events": [
|
|
3829
|
-
{
|
|
3830
|
-
"name": "arcgisPropertyChange",
|
|
3831
|
-
"type": "{ name: \"state\" | \"analysis\"; }",
|
|
3832
|
-
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
3833
|
-
},
|
|
3834
|
-
{
|
|
3835
|
-
"name": "arcgisReady",
|
|
3836
|
-
"type": "void",
|
|
3837
|
-
"description": "Emitted when the component associated with a map or scene view is ready to be interacted with."
|
|
3838
|
-
}
|
|
3839
|
-
]
|
|
3840
|
-
}
|
|
3841
|
-
},
|
|
3842
|
-
{
|
|
3843
|
-
"name": "arcgis-directline-measurement-3d",
|
|
3844
|
-
"description": "**Deprecated**. The Directline Measurement 3D component calculates and displays the 3D distance between two points. It can be used in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component to measure the vertical, horizontal, and direct distance between two points.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
|
|
3845
|
-
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directline-measurement-3d/",
|
|
3846
|
-
"attributes": [
|
|
3847
|
-
{
|
|
3848
|
-
"name": "auto-destroy-disabled",
|
|
3849
|
-
"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-direct-line-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.",
|
|
3850
|
-
"default": "false",
|
|
3851
|
-
"value": {
|
|
3852
|
-
"type": "boolean"
|
|
3853
|
-
}
|
|
3854
|
-
},
|
|
3855
|
-
{
|
|
3856
|
-
"name": "icon",
|
|
3857
|
-
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
3858
|
-
"default": "\"measure-line\"",
|
|
3859
|
-
"value": {
|
|
3860
|
-
"type": "string"
|
|
3861
|
-
}
|
|
3862
|
-
},
|
|
3863
|
-
{
|
|
3864
|
-
"name": "label",
|
|
3865
|
-
"description": "The component's default label.",
|
|
3866
|
-
"value": {
|
|
3867
|
-
"type": "string"
|
|
3868
|
-
}
|
|
3869
|
-
},
|
|
3870
|
-
{
|
|
3871
|
-
"name": "position",
|
|
3872
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) instead.. ",
|
|
3674
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
3873
3675
|
"value": {
|
|
3874
3676
|
"type": [
|
|
3875
3677
|
"\"bottom-leading\"",
|
|
@@ -3981,11 +3783,11 @@
|
|
|
3981
3783
|
{
|
|
3982
3784
|
"name": "unitOptions",
|
|
3983
3785
|
"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: `metric`, `imperial`, `inches`, `feet`, `us-feet`, `yards`, `miles`, `nautical-miles`, `meters`, `kilometers`.\nPossible [unit](#unit) values can only be a subset of this list.",
|
|
3984
|
-
"type": "Array<\"
|
|
3786
|
+
"type": "Array<\"imperial\" | \"metric\" | \"meters\" | \"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\" | \"miles\">"
|
|
3985
3787
|
},
|
|
3986
3788
|
{
|
|
3987
3789
|
"name": "view",
|
|
3988
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
3790
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Direct Line Measurement 3D component will be associated with a map or scene component rather than using the `view` property.",
|
|
3989
3791
|
"type": "SceneView"
|
|
3990
3792
|
}
|
|
3991
3793
|
],
|
|
@@ -4033,7 +3835,7 @@
|
|
|
4033
3835
|
},
|
|
4034
3836
|
{
|
|
4035
3837
|
"name": "position",
|
|
4036
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
3838
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
4037
3839
|
"value": {
|
|
4038
3840
|
"type": [
|
|
4039
3841
|
"\"bottom-leading\"",
|
|
@@ -4146,11 +3948,11 @@
|
|
|
4146
3948
|
{
|
|
4147
3949
|
"name": "unitOptions",
|
|
4148
3950
|
"description": "List of available units and unit systems (imperial, metric) for displaying the distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#unitOptions)",
|
|
4149
|
-
"type": "Array<\"
|
|
3951
|
+
"type": "Array<\"imperial\" | \"metric\" | \"meters\" | \"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\" | \"miles\">"
|
|
4150
3952
|
},
|
|
4151
3953
|
{
|
|
4152
3954
|
"name": "view",
|
|
4153
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
3955
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Distance Measurement 2D component will be associated with a map or scene component rather than using the `view` property.",
|
|
4154
3956
|
"type": "MapView"
|
|
4155
3957
|
}
|
|
4156
3958
|
],
|
|
@@ -4262,7 +4064,7 @@
|
|
|
4262
4064
|
},
|
|
4263
4065
|
{
|
|
4264
4066
|
"name": "position",
|
|
4265
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
4067
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
4266
4068
|
"value": {
|
|
4267
4069
|
"type": [
|
|
4268
4070
|
"\"bottom-leading\"",
|
|
@@ -4304,6 +4106,7 @@
|
|
|
4304
4106
|
"\"awaiting-feature-to-create\"",
|
|
4305
4107
|
"\"awaiting-feature-to-update\"",
|
|
4306
4108
|
"\"awaiting-update-feature-candidate\"",
|
|
4109
|
+
"\"choosing-key-feature\"",
|
|
4307
4110
|
"\"creating-features\"",
|
|
4308
4111
|
"\"disabled\"",
|
|
4309
4112
|
"\"drawing-splitter-geometry\"",
|
|
@@ -4430,7 +4233,7 @@
|
|
|
4430
4233
|
{
|
|
4431
4234
|
"name": "state",
|
|
4432
4235
|
"description": "The current state of the component.",
|
|
4433
|
-
"type": "\"add-association-create-association\" | \"add-association-select-feature\" | \"add-association-select-layer\" | \"adding-attachment\" | \"awaiting-feature-creation-info\" | \"awaiting-feature-to-create\" | \"awaiting-feature-to-update\" | \"awaiting-update-feature-candidate\" | \"creating-features\" | \"disabled\" | \"drawing-splitter-geometry\" | \"editing-attachment\" | \"editing-attributes\" | \"editing-existing-feature\" | \"editing-features\" | \"ready\" | \"reviewing-features\" | \"viewing-selection-list\""
|
|
4236
|
+
"type": "\"add-association-create-association\" | \"add-association-select-feature\" | \"add-association-select-layer\" | \"adding-attachment\" | \"awaiting-feature-creation-info\" | \"awaiting-feature-to-create\" | \"awaiting-feature-to-update\" | \"awaiting-update-feature-candidate\" | \"choosing-key-feature\" | \"creating-features\" | \"disabled\" | \"drawing-splitter-geometry\" | \"editing-attachment\" | \"editing-attributes\" | \"editing-existing-feature\" | \"editing-features\" | \"ready\" | \"reviewing-features\" | \"viewing-selection-list\""
|
|
4434
4237
|
},
|
|
4435
4238
|
{
|
|
4436
4239
|
"name": "supportingWidgetDefaults",
|
|
@@ -4444,7 +4247,7 @@
|
|
|
4444
4247
|
},
|
|
4445
4248
|
{
|
|
4446
4249
|
"name": "view",
|
|
4447
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
4250
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Editor component will be associated with a map or scene component rather than using the `view` property.",
|
|
4448
4251
|
"type": "MapView | SceneView"
|
|
4449
4252
|
}
|
|
4450
4253
|
],
|
|
@@ -4573,7 +4376,7 @@
|
|
|
4573
4376
|
},
|
|
4574
4377
|
{
|
|
4575
4378
|
"name": "position",
|
|
4576
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
4379
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
4577
4380
|
"value": {
|
|
4578
4381
|
"type": [
|
|
4579
4382
|
"\"bottom-leading\"",
|
|
@@ -4643,7 +4446,7 @@
|
|
|
4643
4446
|
"events": [
|
|
4644
4447
|
{
|
|
4645
4448
|
"name": "arcgisPropertyChange",
|
|
4646
|
-
"type": "{ name: \"
|
|
4449
|
+
"type": "{ name: \"input\" | \"progress\" | \"state\" | \"effectiveUnits\"; }",
|
|
4647
4450
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
4648
4451
|
},
|
|
4649
4452
|
{
|
|
@@ -4758,18 +4561,18 @@
|
|
|
4758
4561
|
{
|
|
4759
4562
|
"name": "unitOptions",
|
|
4760
4563
|
"description": "List of available units and unit systems (imperial, metric) for displaying the elevation and distance values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unitOptions)",
|
|
4761
|
-
"type": "Array<\"
|
|
4564
|
+
"type": "Array<\"imperial\" | \"metric\" | \"meters\" | \"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\" | \"miles\">"
|
|
4762
4565
|
},
|
|
4763
4566
|
{
|
|
4764
4567
|
"name": "view",
|
|
4765
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
4568
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Elevation Profile component will be associated with a map or scene component rather than using the `view` property.",
|
|
4766
4569
|
"type": "MapView | SceneView"
|
|
4767
4570
|
}
|
|
4768
4571
|
],
|
|
4769
4572
|
"events": [
|
|
4770
4573
|
{
|
|
4771
4574
|
"name": "arcgisPropertyChange",
|
|
4772
|
-
"type": "{ name: \"
|
|
4575
|
+
"type": "{ name: \"input\" | \"progress\" | \"state\" | \"effectiveUnits\"; }",
|
|
4773
4576
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
4774
4577
|
},
|
|
4775
4578
|
{
|
|
@@ -4880,7 +4683,7 @@
|
|
|
4880
4683
|
},
|
|
4881
4684
|
{
|
|
4882
4685
|
"name": "position",
|
|
4883
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
4686
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
4884
4687
|
"value": {
|
|
4885
4688
|
"type": [
|
|
4886
4689
|
"\"bottom-leading\"",
|
|
@@ -4970,7 +4773,7 @@
|
|
|
4970
4773
|
"events": [
|
|
4971
4774
|
{
|
|
4972
4775
|
"name": "arcgisPropertyChange",
|
|
4973
|
-
"type": "{ name: \"
|
|
4776
|
+
"type": "{ name: \"progress\" | \"state\" | \"geometry\" | \"effectiveDisplayUnits\"; }",
|
|
4974
4777
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
4975
4778
|
},
|
|
4976
4779
|
{
|
|
@@ -5104,23 +4907,23 @@
|
|
|
5104
4907
|
{
|
|
5105
4908
|
"name": "unitOptionsDistance",
|
|
5106
4909
|
"description": "List of available units and unit systems (imperial, metric) for displaying the distance values. These are the\noptions displayed in the distance unit selector in the settings popover.",
|
|
5107
|
-
"type": "Array<\"
|
|
4910
|
+
"type": "Array<\"imperial\" | \"metric\" | \"meters\" | \"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\" | \"miles\">"
|
|
5108
4911
|
},
|
|
5109
4912
|
{
|
|
5110
4913
|
"name": "unitOptionsElevation",
|
|
5111
4914
|
"description": "List of available units and unit systems (imperial, metric) for displaying the elevation values. These are the\noptions displayed in the elevation unit selector in the settings popover.",
|
|
5112
|
-
"type": "Array<\"
|
|
4915
|
+
"type": "Array<\"imperial\" | \"metric\" | \"meters\" | \"centimeters\" | \"decimeters\" | \"feet\" | \"inches\" | \"kilometers\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\" | \"miles\">"
|
|
5113
4916
|
},
|
|
5114
4917
|
{
|
|
5115
4918
|
"name": "view",
|
|
5116
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
4919
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Elevation Profile Next component will be associated with a map or scene component rather than using the `view` property.",
|
|
5117
4920
|
"type": "MapView | SceneView"
|
|
5118
4921
|
}
|
|
5119
4922
|
],
|
|
5120
4923
|
"events": [
|
|
5121
4924
|
{
|
|
5122
4925
|
"name": "arcgisPropertyChange",
|
|
5123
|
-
"type": "{ name: \"
|
|
4926
|
+
"type": "{ name: \"progress\" | \"state\" | \"geometry\" | \"effectiveDisplayUnits\"; }",
|
|
5124
4927
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
5125
4928
|
},
|
|
5126
4929
|
{
|
|
@@ -5240,7 +5043,7 @@
|
|
|
5240
5043
|
},
|
|
5241
5044
|
{
|
|
5242
5045
|
"name": "mode",
|
|
5243
|
-
"description": "The mode in which the component displays. These modes are listed below
|
|
5046
|
+
"description": "The mode in which the component displays. These modes are listed below:\n\n- `auto`: This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application.\n- `floating`: Use this mode if you wish to always display the component as floating in a [Calcite Popover component](https://developers.arcgis.com/calcite-design-system/components/popover/) regardless of browser size.\n- `drawer`: Use this mode if you wish to always display the component in a [Calcite Sheet component](https://developers.arcgis.com/calcite-design-system/components/sheet/) regardless of browser size.",
|
|
5244
5047
|
"default": "\"auto\"",
|
|
5245
5048
|
"value": {
|
|
5246
5049
|
"type": [
|
|
@@ -5252,7 +5055,7 @@
|
|
|
5252
5055
|
},
|
|
5253
5056
|
{
|
|
5254
5057
|
"name": "placement",
|
|
5255
|
-
"description": "The placement used by the [
|
|
5058
|
+
"description": "The placement used by the [Calcite Popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.",
|
|
5256
5059
|
"value": {
|
|
5257
5060
|
"type": [
|
|
5258
5061
|
"\"auto\"",
|
|
@@ -5281,7 +5084,7 @@
|
|
|
5281
5084
|
},
|
|
5282
5085
|
{
|
|
5283
5086
|
"name": "position",
|
|
5284
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
5087
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
5285
5088
|
"value": {
|
|
5286
5089
|
"type": [
|
|
5287
5090
|
"\"bottom-leading\"",
|
|
@@ -5401,12 +5204,12 @@
|
|
|
5401
5204
|
},
|
|
5402
5205
|
{
|
|
5403
5206
|
"name": "mode",
|
|
5404
|
-
"description": "The mode in which the component displays. These modes are listed below
|
|
5207
|
+
"description": "The mode in which the component displays. These modes are listed below:\n\n- `auto`: This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application.\n- `floating`: Use this mode if you wish to always display the component as floating in a [Calcite Popover component](https://developers.arcgis.com/calcite-design-system/components/popover/) regardless of browser size.\n- `drawer`: Use this mode if you wish to always display the component in a [Calcite Sheet component](https://developers.arcgis.com/calcite-design-system/components/sheet/) regardless of browser size.",
|
|
5405
5208
|
"type": "\"auto\" | \"drawer\" | \"floating\""
|
|
5406
5209
|
},
|
|
5407
5210
|
{
|
|
5408
5211
|
"name": "placement",
|
|
5409
|
-
"description": "The placement used by the [
|
|
5212
|
+
"description": "The placement used by the [Calcite Popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.",
|
|
5410
5213
|
"type": "\"auto\" | \"auto-end\" | \"auto-start\" | \"bottom\" | \"bottom-end\" | \"bottom-start\" | \"leading\" | \"leading-end\" | \"leading-start\" | \"left\" | \"left-end\" | \"left-start\" | \"right\" | \"right-end\" | \"right-start\" | \"top\" | \"top-end\" | \"top-start\" | \"trailing\" | \"trailing-end\" | \"trailing-start\""
|
|
5411
5214
|
},
|
|
5412
5215
|
{
|
|
@@ -5425,7 +5228,7 @@
|
|
|
5425
5228
|
},
|
|
5426
5229
|
{
|
|
5427
5230
|
"name": "view",
|
|
5428
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
5231
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Expand component will be associated with a map or scene component rather than using the `view` property.",
|
|
5429
5232
|
"type": "MapView | SceneView"
|
|
5430
5233
|
}
|
|
5431
5234
|
],
|
|
@@ -5445,7 +5248,7 @@
|
|
|
5445
5248
|
},
|
|
5446
5249
|
{
|
|
5447
5250
|
"name": "arcgis-feature",
|
|
5448
|
-
"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<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `nextMedia(contentElementIndex: number): Promise<void>` - Paginates to the next [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info.\n- `previousMedia(contentElementIndex: number): Promise<void>` - Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info
|
|
5251
|
+
"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<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `nextMedia(contentElementIndex: number): Promise<void>` - Paginates to the next [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info.\n- `previousMedia(contentElementIndex: number): Promise<void>` - Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info.\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.",
|
|
5449
5252
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature/",
|
|
5450
5253
|
"attributes": [
|
|
5451
5254
|
{
|
|
@@ -5632,7 +5435,7 @@
|
|
|
5632
5435
|
},
|
|
5633
5436
|
{
|
|
5634
5437
|
"name": "position",
|
|
5635
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
5438
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
5636
5439
|
"value": {
|
|
5637
5440
|
"type": [
|
|
5638
5441
|
"\"bottom-leading\"",
|
|
@@ -5664,7 +5467,7 @@
|
|
|
5664
5467
|
},
|
|
5665
5468
|
{
|
|
5666
5469
|
"name": "show-utility-network-content",
|
|
5667
|
-
"description": "This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-
|
|
5470
|
+
"description": "This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-UtilityNetworkAssociationsContent.html) within the component.",
|
|
5668
5471
|
"default": "false",
|
|
5669
5472
|
"value": {
|
|
5670
5473
|
"type": "boolean"
|
|
@@ -5720,11 +5523,6 @@
|
|
|
5720
5523
|
"description": "Enables automatic creation of a popup template for layers that have popups enabled but no\npopupTemplate defined. Automatic popup templates are supported for layers that\nsupport the `createPopupTemplate()` method. (Supported for\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html)\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html), and\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html)).\n\n**Note:**\nStarting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#dateFormat)\nrather than `long-month-day-year` in the default [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.",
|
|
5721
5524
|
"type": "boolean"
|
|
5722
5525
|
},
|
|
5723
|
-
{
|
|
5724
|
-
"name": "flowItems",
|
|
5725
|
-
"description": "A collection of flow items that are used to manage drill-in navigation.",
|
|
5726
|
-
"type": "Collection<HTMLArcgisFeatureElement | HTMLArcgisFeatureRelationshipElement>"
|
|
5727
|
-
},
|
|
5728
5526
|
{
|
|
5729
5527
|
"name": "graphic",
|
|
5730
5528
|
"description": "The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature.",
|
|
@@ -5847,7 +5645,7 @@
|
|
|
5847
5645
|
},
|
|
5848
5646
|
{
|
|
5849
5647
|
"name": "messageOverrides",
|
|
5850
|
-
"description": "
|
|
5648
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
5851
5649
|
"type": "Record<string, unknown>"
|
|
5852
5650
|
},
|
|
5853
5651
|
{
|
|
@@ -5866,7 +5664,7 @@
|
|
|
5866
5664
|
},
|
|
5867
5665
|
{
|
|
5868
5666
|
"name": "showUtilityNetworkContent",
|
|
5869
|
-
"description": "This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-
|
|
5667
|
+
"description": "This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-UtilityNetworkAssociationsContent.html) within the component.",
|
|
5870
5668
|
"type": "boolean"
|
|
5871
5669
|
},
|
|
5872
5670
|
{
|
|
@@ -5886,7 +5684,7 @@
|
|
|
5886
5684
|
},
|
|
5887
5685
|
{
|
|
5888
5686
|
"name": "view",
|
|
5889
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
5687
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Feature component will be associated with a map or scene component rather than using the `view` property.",
|
|
5890
5688
|
"type": "MapView | SceneView"
|
|
5891
5689
|
},
|
|
5892
5690
|
{
|
|
@@ -5970,7 +5768,7 @@
|
|
|
5970
5768
|
},
|
|
5971
5769
|
{
|
|
5972
5770
|
"name": "position",
|
|
5973
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
5771
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
5974
5772
|
"value": {
|
|
5975
5773
|
"type": [
|
|
5976
5774
|
"\"bottom-leading\"",
|
|
@@ -6464,7 +6262,7 @@
|
|
|
6464
6262
|
},
|
|
6465
6263
|
{
|
|
6466
6264
|
"name": "position",
|
|
6467
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
6265
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
6468
6266
|
"value": {
|
|
6469
6267
|
"type": [
|
|
6470
6268
|
"\"bottom-leading\"",
|
|
@@ -6849,8 +6647,8 @@
|
|
|
6849
6647
|
},
|
|
6850
6648
|
{
|
|
6851
6649
|
"name": "layer",
|
|
6852
|
-
"description": "The associated [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html),\n[KnowledgeGraphSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html), [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),
|
|
6853
|
-
"type": "CSVLayer | CatalogFootprintLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | OrientedImageryLayer | SceneLayer | Sublayer | WFSLayer"
|
|
6650
|
+
"description": "The associated [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-catalog-CatalogFootprintLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html), [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html),\n[KnowledgeGraphSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-knowledgeGraph-KnowledgeGraphSublayer.html), [ParquetLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ParquetLayer.html) [SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html), [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html), [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OrientedImageryLayer.html)\nor [Sublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Sublayer.html) containing the fields and attributes to display within the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#layer)",
|
|
6651
|
+
"type": "CSVLayer | CatalogFootprintLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | OrientedImageryLayer | ParquetLayer | SceneLayer | Sublayer | WFSLayer"
|
|
6854
6652
|
},
|
|
6855
6653
|
{
|
|
6856
6654
|
"name": "layerItemId",
|
|
@@ -7063,7 +6861,7 @@
|
|
|
7063
6861
|
},
|
|
7064
6862
|
{
|
|
7065
6863
|
"name": "view",
|
|
7066
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
6864
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Feature Table component will be associated with a map or scene component rather than using the `view` property.",
|
|
7067
6865
|
"type": "LinkChartView | MapView | SceneView"
|
|
7068
6866
|
},
|
|
7069
6867
|
{
|
|
@@ -7178,7 +6976,7 @@
|
|
|
7178
6976
|
},
|
|
7179
6977
|
{
|
|
7180
6978
|
"name": "position",
|
|
7181
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
6979
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
7182
6980
|
"value": {
|
|
7183
6981
|
"type": [
|
|
7184
6982
|
"\"bottom-leading\"",
|
|
@@ -7330,7 +7128,7 @@
|
|
|
7330
7128
|
},
|
|
7331
7129
|
{
|
|
7332
7130
|
"name": "arcgis-features",
|
|
7333
|
-
"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 [
|
|
7131
|
+
"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<void>` - 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.",
|
|
7334
7132
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-features/",
|
|
7335
7133
|
"attributes": [
|
|
7336
7134
|
{
|
|
@@ -7474,7 +7272,7 @@
|
|
|
7474
7272
|
},
|
|
7475
7273
|
{
|
|
7476
7274
|
"name": "hide-flow",
|
|
7477
|
-
"description": "Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if set to `false`.\nThe flow component will be omitted from the
|
|
7275
|
+
"description": "Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if set to `false`.\nThe flow component will be omitted from the component if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.",
|
|
7478
7276
|
"default": "false",
|
|
7479
7277
|
"value": {
|
|
7480
7278
|
"type": "boolean"
|
|
@@ -7539,7 +7337,7 @@
|
|
|
7539
7337
|
},
|
|
7540
7338
|
{
|
|
7541
7339
|
"name": "position",
|
|
7542
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
7340
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
7543
7341
|
"value": {
|
|
7544
7342
|
"type": [
|
|
7545
7343
|
"\"bottom-leading\"",
|
|
@@ -7596,7 +7394,7 @@
|
|
|
7596
7394
|
},
|
|
7597
7395
|
{
|
|
7598
7396
|
"name": "visible",
|
|
7599
|
-
"description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open in the view.\nUse the property to check if the
|
|
7397
|
+
"description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open in the view.\nUse the property to check if the component is visible.",
|
|
7600
7398
|
"default": "false",
|
|
7601
7399
|
"value": {
|
|
7602
7400
|
"type": "boolean"
|
|
@@ -7749,7 +7547,7 @@
|
|
|
7749
7547
|
},
|
|
7750
7548
|
{
|
|
7751
7549
|
"name": "hideFlow",
|
|
7752
|
-
"description": "Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if set to `false`.\nThe flow component will be omitted from the
|
|
7550
|
+
"description": "Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if set to `false`.\nThe flow component will be omitted from the component if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.",
|
|
7753
7551
|
"type": "boolean"
|
|
7754
7552
|
},
|
|
7755
7553
|
{
|
|
@@ -7862,7 +7660,7 @@
|
|
|
7862
7660
|
},
|
|
7863
7661
|
{
|
|
7864
7662
|
"name": "visible",
|
|
7865
|
-
"description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open in the view.\nUse the property to check if the
|
|
7663
|
+
"description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open in the view.\nUse the property to check if the component is visible.",
|
|
7866
7664
|
"type": "boolean"
|
|
7867
7665
|
}
|
|
7868
7666
|
],
|
|
@@ -7950,7 +7748,7 @@
|
|
|
7950
7748
|
},
|
|
7951
7749
|
{
|
|
7952
7750
|
"name": "position",
|
|
7953
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
7751
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
7954
7752
|
"value": {
|
|
7955
7753
|
"type": [
|
|
7956
7754
|
"\"bottom-leading\"",
|
|
@@ -8040,7 +7838,7 @@
|
|
|
8040
7838
|
},
|
|
8041
7839
|
{
|
|
8042
7840
|
"name": "view",
|
|
8043
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
7841
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Floor Filter component will be associated with a map or scene component rather than using the `view` property.",
|
|
8044
7842
|
"type": "MapView | SceneView"
|
|
8045
7843
|
}
|
|
8046
7844
|
],
|
|
@@ -8074,7 +7872,7 @@
|
|
|
8074
7872
|
},
|
|
8075
7873
|
{
|
|
8076
7874
|
"name": "position",
|
|
8077
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
7875
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
8078
7876
|
"value": {
|
|
8079
7877
|
"type": [
|
|
8080
7878
|
"\"bottom-leading\"",
|
|
@@ -8332,7 +8130,7 @@
|
|
|
8332
8130
|
},
|
|
8333
8131
|
{
|
|
8334
8132
|
"name": "position",
|
|
8335
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
8133
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
8336
8134
|
"value": {
|
|
8337
8135
|
"type": [
|
|
8338
8136
|
"\"bottom-leading\"",
|
|
@@ -8592,7 +8390,7 @@
|
|
|
8592
8390
|
},
|
|
8593
8391
|
{
|
|
8594
8392
|
"name": "view",
|
|
8595
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
8393
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Grid Controls component will be associated with a map or scene component rather than using the `view` property.",
|
|
8596
8394
|
"type": "MapView"
|
|
8597
8395
|
}
|
|
8598
8396
|
],
|
|
@@ -8677,7 +8475,7 @@
|
|
|
8677
8475
|
},
|
|
8678
8476
|
{
|
|
8679
8477
|
"name": "position",
|
|
8680
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
8478
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
8681
8479
|
"value": {
|
|
8682
8480
|
"type": [
|
|
8683
8481
|
"\"bottom-leading\"",
|
|
@@ -8912,7 +8710,7 @@
|
|
|
8912
8710
|
},
|
|
8913
8711
|
{
|
|
8914
8712
|
"name": "position",
|
|
8915
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
8713
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
8916
8714
|
"value": {
|
|
8917
8715
|
"type": [
|
|
8918
8716
|
"\"bottom-leading\"",
|
|
@@ -9007,7 +8805,7 @@
|
|
|
9007
8805
|
},
|
|
9008
8806
|
{
|
|
9009
8807
|
"name": "view",
|
|
9010
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
8808
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Home component will be associated with a map or scene component rather than using the `view` property.",
|
|
9011
8809
|
"type": "MapView | SceneView"
|
|
9012
8810
|
},
|
|
9013
8811
|
{
|
|
@@ -9150,7 +8948,7 @@
|
|
|
9150
8948
|
},
|
|
9151
8949
|
{
|
|
9152
8950
|
"name": "position",
|
|
9153
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
8951
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
9154
8952
|
"value": {
|
|
9155
8953
|
"type": [
|
|
9156
8954
|
"\"bottom-leading\"",
|
|
@@ -9432,7 +9230,7 @@
|
|
|
9432
9230
|
},
|
|
9433
9231
|
{
|
|
9434
9232
|
"name": "view",
|
|
9435
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
9233
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Layer List component will be associated with a map or scene component rather than using the `view` property.",
|
|
9436
9234
|
"type": "MapView | SceneView"
|
|
9437
9235
|
},
|
|
9438
9236
|
{
|
|
@@ -9467,7 +9265,7 @@
|
|
|
9467
9265
|
},
|
|
9468
9266
|
{
|
|
9469
9267
|
"name": "arcgis-legend",
|
|
9470
|
-
"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### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
9268
|
+
"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<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
9471
9269
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/",
|
|
9472
9270
|
"attributes": [
|
|
9473
9271
|
{
|
|
@@ -9565,7 +9363,7 @@
|
|
|
9565
9363
|
},
|
|
9566
9364
|
{
|
|
9567
9365
|
"name": "position",
|
|
9568
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
9366
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
9569
9367
|
"value": {
|
|
9570
9368
|
"type": [
|
|
9571
9369
|
"\"bottom-leading\"",
|
|
@@ -9691,7 +9489,7 @@
|
|
|
9691
9489
|
},
|
|
9692
9490
|
{
|
|
9693
9491
|
"name": "messageOverrides",
|
|
9694
|
-
"description": "
|
|
9492
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
9695
9493
|
"type": "Record<string, unknown>"
|
|
9696
9494
|
},
|
|
9697
9495
|
{
|
|
@@ -9720,7 +9518,7 @@
|
|
|
9720
9518
|
},
|
|
9721
9519
|
{
|
|
9722
9520
|
"name": "view",
|
|
9723
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
9521
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Legend component will be associated with a map or scene component rather than using the `view` property.",
|
|
9724
9522
|
"type": "MapView | SceneView"
|
|
9725
9523
|
}
|
|
9726
9524
|
],
|
|
@@ -9768,7 +9566,7 @@
|
|
|
9768
9566
|
},
|
|
9769
9567
|
{
|
|
9770
9568
|
"name": "position",
|
|
9771
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
9569
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
9772
9570
|
"value": {
|
|
9773
9571
|
"type": [
|
|
9774
9572
|
"\"bottom-leading\"",
|
|
@@ -9858,7 +9656,7 @@
|
|
|
9858
9656
|
},
|
|
9859
9657
|
{
|
|
9860
9658
|
"name": "view",
|
|
9861
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
9659
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Line Of Sight component will be associated with a map or scene component rather than using the `view` property.",
|
|
9862
9660
|
"type": "SceneView"
|
|
9863
9661
|
}
|
|
9864
9662
|
],
|
|
@@ -9878,9 +9676,17 @@
|
|
|
9878
9676
|
},
|
|
9879
9677
|
{
|
|
9880
9678
|
"name": "arcgis-link-chart",
|
|
9881
|
-
"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- **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\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `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\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - Specifies the right padding for the layout. ",
|
|
9679
|
+
"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<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `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. When using this slot, the [`popup-disabled`](#popupDisabled) attribute must be set to `true`. 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. ",
|
|
9882
9680
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/",
|
|
9883
9681
|
"attributes": [
|
|
9682
|
+
{
|
|
9683
|
+
"name": "animations-disabled",
|
|
9684
|
+
"description": "Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html#goTo)).\nSetting this property to `true` disables all animations in the view.",
|
|
9685
|
+
"default": "false",
|
|
9686
|
+
"value": {
|
|
9687
|
+
"type": "boolean"
|
|
9688
|
+
}
|
|
9689
|
+
},
|
|
9884
9690
|
{
|
|
9885
9691
|
"name": "auto-destroy-disabled",
|
|
9886
9692
|
"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-link-chart/#destroy) method when you are done to\nprevent memory leaks.",
|
|
@@ -9920,7 +9726,7 @@
|
|
|
9920
9726
|
},
|
|
9921
9727
|
{
|
|
9922
9728
|
"name": "popup-disabled",
|
|
9923
|
-
"description": "Controls whether the popup opens when users click on the view.",
|
|
9729
|
+
"description": "Controls whether the popup opens automatically when users click on the view.",
|
|
9924
9730
|
"default": "false",
|
|
9925
9731
|
"value": {
|
|
9926
9732
|
"type": "boolean"
|
|
@@ -10019,9 +9825,18 @@
|
|
|
10019
9825
|
{
|
|
10020
9826
|
"name": "bottom-end",
|
|
10021
9827
|
"description": "Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL)."
|
|
9828
|
+
},
|
|
9829
|
+
{
|
|
9830
|
+
"name": "popup",
|
|
9831
|
+
"description": "Slot for the [Popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component to open automatically on click. When using this slot, the [`popup-disabled`](#popupDisabled) attribute must be set to `true`. Only the Popup component can be placed in this slot."
|
|
10022
9832
|
}
|
|
10023
9833
|
],
|
|
10024
9834
|
"events": [
|
|
9835
|
+
{
|
|
9836
|
+
"name": "arcgisLoadError",
|
|
9837
|
+
"type": "void",
|
|
9838
|
+
"description": "Fires when a ArcgisLinkChart fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers)."
|
|
9839
|
+
},
|
|
10025
9840
|
{
|
|
10026
9841
|
"name": "arcgisViewAnalysisViewCreate",
|
|
10027
9842
|
"type": "ViewAnalysisViewCreateEvent",
|
|
@@ -10131,6 +9946,11 @@
|
|
|
10131
9946
|
"name": "arcgisViewReadyChange",
|
|
10132
9947
|
"type": "void",
|
|
10133
9948
|
"description": "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."
|
|
9949
|
+
},
|
|
9950
|
+
{
|
|
9951
|
+
"name": "arcgisViewReadyError",
|
|
9952
|
+
"type": "void",
|
|
9953
|
+
"description": "Fires if the view encounters a content or rendering error."
|
|
10134
9954
|
}
|
|
10135
9955
|
],
|
|
10136
9956
|
"js": {
|
|
@@ -10145,6 +9965,16 @@
|
|
|
10145
9965
|
"description": "A collection of analyses associated with the view.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#analyses)",
|
|
10146
9966
|
"type": "Collection<Analysis>"
|
|
10147
9967
|
},
|
|
9968
|
+
{
|
|
9969
|
+
"name": "animationsDisabled",
|
|
9970
|
+
"description": "Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html#goTo)).\nSetting this property to `true` disables all animations in the view.",
|
|
9971
|
+
"type": "boolean"
|
|
9972
|
+
},
|
|
9973
|
+
{
|
|
9974
|
+
"name": "aria",
|
|
9975
|
+
"description": "The ARIA attributes for the view container. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [`label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [`description`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [`describedByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaDescribedByElements), and [`labelledByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaLabelledByElements).",
|
|
9976
|
+
"type": "DOMContainerAria"
|
|
9977
|
+
},
|
|
10148
9978
|
{
|
|
10149
9979
|
"name": "autoDestroyDisabled",
|
|
10150
9980
|
"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-link-chart/#destroy) method when you are done to\nprevent memory leaks.",
|
|
@@ -10220,6 +10050,11 @@
|
|
|
10220
10050
|
"description": "A collection containing a hierarchical list of all the created\n[LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the\n[operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html#layers) in the link chart.",
|
|
10221
10051
|
"type": "Collection<LayerView>"
|
|
10222
10052
|
},
|
|
10053
|
+
{
|
|
10054
|
+
"name": "loadErrorSources",
|
|
10055
|
+
"description": "An array of objects that encountered an error while loading the component or any of its dependencies (e.g., basemap, ground, layers, tables). You may inspect the errors by accessing each object's `loadError` property.",
|
|
10056
|
+
"type": "Array<WebLinkChart | Basemap | Ground | Layer | WebMap | WebScene>"
|
|
10057
|
+
},
|
|
10223
10058
|
{
|
|
10224
10059
|
"name": "magnifier",
|
|
10225
10060
|
"description": "The magnifier allows for showing a portion of the view as a magnifier image on top of the view.",
|
|
@@ -10252,7 +10087,7 @@
|
|
|
10252
10087
|
},
|
|
10253
10088
|
{
|
|
10254
10089
|
"name": "popupDisabled",
|
|
10255
|
-
"description": "Controls whether the popup opens when users click on the view.",
|
|
10090
|
+
"description": "Controls whether the popup opens automatically when users click on the view.",
|
|
10256
10091
|
"type": "boolean"
|
|
10257
10092
|
},
|
|
10258
10093
|
{
|
|
@@ -10332,6 +10167,11 @@
|
|
|
10332
10167
|
}
|
|
10333
10168
|
],
|
|
10334
10169
|
"events": [
|
|
10170
|
+
{
|
|
10171
|
+
"name": "arcgisLoadError",
|
|
10172
|
+
"type": "void",
|
|
10173
|
+
"description": "Fires when a ArcgisLinkChart fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers)."
|
|
10174
|
+
},
|
|
10335
10175
|
{
|
|
10336
10176
|
"name": "arcgisViewAnalysisViewCreate",
|
|
10337
10177
|
"type": "ViewAnalysisViewCreateEvent",
|
|
@@ -10441,6 +10281,11 @@
|
|
|
10441
10281
|
"name": "arcgisViewReadyChange",
|
|
10442
10282
|
"type": "void",
|
|
10443
10283
|
"description": "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."
|
|
10284
|
+
},
|
|
10285
|
+
{
|
|
10286
|
+
"name": "arcgisViewReadyError",
|
|
10287
|
+
"type": "void",
|
|
10288
|
+
"description": "Fires if the view encounters a content or rendering error."
|
|
10444
10289
|
}
|
|
10445
10290
|
]
|
|
10446
10291
|
}
|
|
@@ -10494,7 +10339,7 @@
|
|
|
10494
10339
|
},
|
|
10495
10340
|
{
|
|
10496
10341
|
"name": "position",
|
|
10497
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
10342
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
10498
10343
|
"value": {
|
|
10499
10344
|
"type": [
|
|
10500
10345
|
"\"bottom-leading\"",
|
|
@@ -10612,7 +10457,7 @@
|
|
|
10612
10457
|
},
|
|
10613
10458
|
{
|
|
10614
10459
|
"name": "view",
|
|
10615
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
10460
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Link Chart Layout Switcher component will be associated with a map or scene component rather than using the `view` property.",
|
|
10616
10461
|
"type": "LinkChartView"
|
|
10617
10462
|
}
|
|
10618
10463
|
],
|
|
@@ -10680,7 +10525,7 @@
|
|
|
10680
10525
|
},
|
|
10681
10526
|
{
|
|
10682
10527
|
"name": "position",
|
|
10683
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
10528
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
10684
10529
|
"value": {
|
|
10685
10530
|
"type": [
|
|
10686
10531
|
"\"bottom-leading\"",
|
|
@@ -10809,7 +10654,7 @@
|
|
|
10809
10654
|
},
|
|
10810
10655
|
{
|
|
10811
10656
|
"name": "view",
|
|
10812
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
10657
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Locate component will be associated with a map or scene component rather than using the `view` property.",
|
|
10813
10658
|
"type": "MapView | SceneView"
|
|
10814
10659
|
}
|
|
10815
10660
|
],
|
|
@@ -10837,9 +10682,17 @@
|
|
|
10837
10682
|
},
|
|
10838
10683
|
{
|
|
10839
10684
|
"name": "arcgis-map",
|
|
10840
|
-
"description": "The ArcGIS Map component is used to add 2D maps to web applications. For 3D maps, use the\n[ArcGIS Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and loads a WebMap from either [ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\"></arcgis-map>\n```\n\nAlternatively, the Map component can be initialized without a WebMap item.\n\n```html\n<arcgis-map basemap=\"satellite\" center=\"-154.88, 19.46\" zoom=\"15\"></arcgis-map>\n```\n\nOther components can be added and connected to the Map component.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\">\n <arcgis-zoom 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- **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 map has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the map tables collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the map tables collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `hitTest(screenPoint: __esri.MapViewScreenPoint | MouseEvent, options?: __esri.MapViewHitTestOptions): Promise<__esri.HitTestResult>` - Returns hit test results from each layer that intersects the specified screen coordinates.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `takeScreenshot(options?: __esri.MapViewTakeScreenshotOptions): Promise<__esri.Screenshot>` - Create a screenshot of the current view.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `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[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\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - Specifies the right padding for the layout. ",
|
|
10685
|
+
"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) and\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 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(layer: __esri.Layer): Promise<__esri.LayerView>` - 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. When using this slot, the [`popup-disabled`](#popupDisabled) attribute must be set to `true`. 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. ",
|
|
10841
10686
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/",
|
|
10842
10687
|
"attributes": [
|
|
10688
|
+
{
|
|
10689
|
+
"name": "animations-disabled",
|
|
10690
|
+
"description": "Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo)).\nSetting this property to `true` disables all animations in the view.",
|
|
10691
|
+
"default": "false",
|
|
10692
|
+
"value": {
|
|
10693
|
+
"type": "boolean"
|
|
10694
|
+
}
|
|
10695
|
+
},
|
|
10843
10696
|
{
|
|
10844
10697
|
"name": "auto-destroy-disabled",
|
|
10845
10698
|
"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-map/#destroy) method when you are done to\nprevent memory leaks.",
|
|
@@ -10857,14 +10710,14 @@
|
|
|
10857
10710
|
},
|
|
10858
10711
|
{
|
|
10859
10712
|
"name": "center",
|
|
10860
|
-
"description": "Represents the view's center point; when setting the center, you may pass a\
|
|
10713
|
+
"description": "Represents the view's center point; when setting the center, you may pass a\n[Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance, numbers representing\na longitude/latitude pair (`[-100.4593, 36.9014]`), or a string attribute representing a longitude/latitude pair (\"-100.4593, 36.9014\").\nSetting the `center` immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\n\nThe returned [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) object is always\nin the spatial reference of the view and may be modified internally.\nTo persist the returned object, create a clone using [clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone) method.\n\n**Notes**\n\n* If the spatial reference of `center` set in the constructor does not match the [spatialReference](#spatialReference) of the view, then the\n[projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) will be loaded dynamically.\n* At runtime, the [projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) must be\n[loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) when\nsetting the `center` to a spatial reference that doesn't match the view spatial reference. You can check if the projectOperator is\nloaded prior to setting the center by calling [isLoaded()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#isLoaded)\nmethod. If it is not yet loaded, you can call [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) method.",
|
|
10861
10714
|
"value": {
|
|
10862
10715
|
"type": "string"
|
|
10863
10716
|
}
|
|
10864
10717
|
},
|
|
10865
10718
|
{
|
|
10866
10719
|
"name": "display-filter-disabled",
|
|
10867
|
-
"description": "Indicates whether layer's
|
|
10720
|
+
"description": "Indicates whether a layer's `displayFilterInfo` is honored when rendering layers in the view.\nIf `false`, display filters are ignored and all features are rendered.",
|
|
10868
10721
|
"default": "false",
|
|
10869
10722
|
"value": {
|
|
10870
10723
|
"type": "boolean"
|
|
@@ -10886,7 +10739,7 @@
|
|
|
10886
10739
|
},
|
|
10887
10740
|
{
|
|
10888
10741
|
"name": "popup-disabled",
|
|
10889
|
-
"description": "Controls whether the popup opens when users click on the view.",
|
|
10742
|
+
"description": "Controls whether the popup opens automatically when users click on the view.",
|
|
10890
10743
|
"default": "false",
|
|
10891
10744
|
"value": {
|
|
10892
10745
|
"type": "boolean"
|
|
@@ -10920,14 +10773,14 @@
|
|
|
10920
10773
|
},
|
|
10921
10774
|
{
|
|
10922
10775
|
"name": "scale",
|
|
10923
|
-
"description": "Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's goTo() method.",
|
|
10776
|
+
"description": "Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](#goTo) method.",
|
|
10924
10777
|
"value": {
|
|
10925
10778
|
"type": "number"
|
|
10926
10779
|
}
|
|
10927
10780
|
},
|
|
10928
10781
|
{
|
|
10929
10782
|
"name": "spatial-reference-locked",
|
|
10930
|
-
"description": "Indicates if the map's spatialReference can be changed after it is ready.\nThe default is `false`, indicating the map's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the map's spatial reference\nwill be disabled in [arcgis-basemap-gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components and the map's spatialReference cannot be changed at runtime.",
|
|
10783
|
+
"description": "Indicates if the map's [spatialReference](#spatialReference) can be changed after it is ready.\nThe default is `false`, indicating the map's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the map's spatial reference\nwill be disabled in [arcgis-basemap-gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components and the map's spatialReference cannot be changed at runtime.",
|
|
10931
10784
|
"default": "false",
|
|
10932
10785
|
"value": {
|
|
10933
10786
|
"type": "boolean"
|
|
@@ -10951,7 +10804,7 @@
|
|
|
10951
10804
|
},
|
|
10952
10805
|
{
|
|
10953
10806
|
"name": "zoom",
|
|
10954
|
-
"description": "Represents the level of detail (LOD) at the center of the
|
|
10807
|
+
"description": "Represents the level of detail (LOD) at the center of the map.\nA zoom level (or scale) is a number that defines how large or small the contents of a map appear in a Map component.\nZoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.\nA value of -1 means the map has no LODs.\nWhen setting the zoom value, the component converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\nSetting this property in conjunction with `center` is a convenient way to set the initial extent of the view.",
|
|
10955
10808
|
"value": {
|
|
10956
10809
|
"type": "number"
|
|
10957
10810
|
}
|
|
@@ -10993,9 +10846,18 @@
|
|
|
10993
10846
|
{
|
|
10994
10847
|
"name": "bottom-end",
|
|
10995
10848
|
"description": "Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL)."
|
|
10849
|
+
},
|
|
10850
|
+
{
|
|
10851
|
+
"name": "popup",
|
|
10852
|
+
"description": "Slot for the [Popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component to open automatically on click. When using this slot, the [`popup-disabled`](#popupDisabled) attribute must be set to `true`. Only the Popup component can be placed in this slot."
|
|
10996
10853
|
}
|
|
10997
10854
|
],
|
|
10998
10855
|
"events": [
|
|
10856
|
+
{
|
|
10857
|
+
"name": "arcgisLoadError",
|
|
10858
|
+
"type": "void",
|
|
10859
|
+
"description": "Fires when a ArcgisMap fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers)."
|
|
10860
|
+
},
|
|
10999
10861
|
{
|
|
11000
10862
|
"name": "arcgisViewAnalysisViewCreate",
|
|
11001
10863
|
"type": "ViewAnalysisViewCreateEvent",
|
|
@@ -11014,12 +10876,12 @@
|
|
|
11014
10876
|
{
|
|
11015
10877
|
"name": "arcgisViewChange",
|
|
11016
10878
|
"type": "void",
|
|
11017
|
-
"description": "This event is
|
|
10879
|
+
"description": "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."
|
|
11018
10880
|
},
|
|
11019
10881
|
{
|
|
11020
10882
|
"name": "arcgisViewClick",
|
|
11021
10883
|
"type": "ViewClickEvent",
|
|
11022
|
-
"description": "Fires after a user clicks on the view."
|
|
10884
|
+
"description": "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."
|
|
11023
10885
|
},
|
|
11024
10886
|
{
|
|
11025
10887
|
"name": "arcgisViewDoubleClick",
|
|
@@ -11034,17 +10896,17 @@
|
|
|
11034
10896
|
{
|
|
11035
10897
|
"name": "arcgisViewHold",
|
|
11036
10898
|
"type": "ViewHoldEvent",
|
|
11037
|
-
"description": "Fires
|
|
10899
|
+
"description": "Fires after holding either a mouse button or a single finger on the view for a short amount of time."
|
|
11038
10900
|
},
|
|
11039
10901
|
{
|
|
11040
10902
|
"name": "arcgisViewImmediateClick",
|
|
11041
10903
|
"type": "ViewImmediateClickEvent",
|
|
11042
|
-
"description": "Fires right after a user clicks on the view."
|
|
10904
|
+
"description": "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."
|
|
11043
10905
|
},
|
|
11044
10906
|
{
|
|
11045
10907
|
"name": "arcgisViewImmediateDoubleClick",
|
|
11046
10908
|
"type": "ViewImmediateDoubleClickEvent",
|
|
11047
|
-
"description": "
|
|
10909
|
+
"description": "Fires after 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."
|
|
11048
10910
|
},
|
|
11049
10911
|
{
|
|
11050
10912
|
"name": "arcgisViewKeyDown",
|
|
@@ -11054,22 +10916,22 @@
|
|
|
11054
10916
|
{
|
|
11055
10917
|
"name": "arcgisViewKeyUp",
|
|
11056
10918
|
"type": "ViewKeyUpEvent",
|
|
11057
|
-
"description": "Fires after a keyboard key is
|
|
10919
|
+
"description": "Fires after a keyboard key is released."
|
|
11058
10920
|
},
|
|
11059
10921
|
{
|
|
11060
10922
|
"name": "arcgisViewLayerviewCreate",
|
|
11061
10923
|
"type": "ViewLayerviewCreateEvent",
|
|
11062
|
-
"description": "Fires after each layer in the map has a corresponding
|
|
10924
|
+
"description": "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."
|
|
11063
10925
|
},
|
|
11064
10926
|
{
|
|
11065
10927
|
"name": "arcgisViewLayerviewCreateError",
|
|
11066
10928
|
"type": "ViewLayerviewCreateErrorEvent",
|
|
11067
|
-
"description": "Fires when an error
|
|
10929
|
+
"description": "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."
|
|
11068
10930
|
},
|
|
11069
10931
|
{
|
|
11070
10932
|
"name": "arcgisViewLayerviewDestroy",
|
|
11071
10933
|
"type": "ViewLayerviewDestroyEvent",
|
|
11072
|
-
"description": "Fires after a LayerView
|
|
10934
|
+
"description": "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."
|
|
11073
10935
|
},
|
|
11074
10936
|
{
|
|
11075
10937
|
"name": "arcgisViewMouseWheel",
|
|
@@ -11104,7 +10966,12 @@
|
|
|
11104
10966
|
{
|
|
11105
10967
|
"name": "arcgisViewReadyChange",
|
|
11106
10968
|
"type": "void",
|
|
11107
|
-
"description": "This event is for the `ready` property and
|
|
10969
|
+
"description": "This event is for the `ready` property and is emitted when the view is ready.\nFires also when the [map](#map) is updated."
|
|
10970
|
+
},
|
|
10971
|
+
{
|
|
10972
|
+
"name": "arcgisViewReadyError",
|
|
10973
|
+
"type": "void",
|
|
10974
|
+
"description": "Fires if the view encounters a content or rendering error."
|
|
11108
10975
|
}
|
|
11109
10976
|
],
|
|
11110
10977
|
"js": {
|
|
@@ -11119,6 +10986,16 @@
|
|
|
11119
10986
|
"description": "A collection of analyses associated with the view.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View2D.html#analyses)",
|
|
11120
10987
|
"type": "Collection<Analysis>"
|
|
11121
10988
|
},
|
|
10989
|
+
{
|
|
10990
|
+
"name": "animationsDisabled",
|
|
10991
|
+
"description": "Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo)).\nSetting this property to `true` disables all animations in the view.",
|
|
10992
|
+
"type": "boolean"
|
|
10993
|
+
},
|
|
10994
|
+
{
|
|
10995
|
+
"name": "aria",
|
|
10996
|
+
"description": "The ARIA attributes for the view container. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [`label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [`description`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [`describedByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaDescribedByElements), and [`labelledByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaLabelledByElements).",
|
|
10997
|
+
"type": "DOMContainerAria"
|
|
10998
|
+
},
|
|
11122
10999
|
{
|
|
11123
11000
|
"name": "autoDestroyDisabled",
|
|
11124
11001
|
"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-map/#destroy) method when you are done to\nprevent memory leaks.",
|
|
@@ -11126,7 +11003,7 @@
|
|
|
11126
11003
|
},
|
|
11127
11004
|
{
|
|
11128
11005
|
"name": "background",
|
|
11129
|
-
"description": "The background color of the
|
|
11006
|
+
"description": "The background color of the Map component.",
|
|
11130
11007
|
"type": "ColorBackground"
|
|
11131
11008
|
},
|
|
11132
11009
|
{
|
|
@@ -11141,22 +11018,22 @@
|
|
|
11141
11018
|
},
|
|
11142
11019
|
{
|
|
11143
11020
|
"name": "center",
|
|
11144
|
-
"description": "Represents the view's center point; when setting the center, you may pass a\
|
|
11021
|
+
"description": "Represents the view's center point; when setting the center, you may pass a\n[Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance, numbers representing\na longitude/latitude pair (`[-100.4593, 36.9014]`), or a string attribute representing a longitude/latitude pair (\"-100.4593, 36.9014\").\nSetting the `center` immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\n\nThe returned [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) object is always\nin the spatial reference of the view and may be modified internally.\nTo persist the returned object, create a clone using [clone()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html#clone) method.\n\n**Notes**\n\n* If the spatial reference of `center` set in the constructor does not match the [spatialReference](#spatialReference) of the view, then the\n[projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) will be loaded dynamically.\n* At runtime, the [projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) must be\n[loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) when\nsetting the `center` to a spatial reference that doesn't match the view spatial reference. You can check if the projectOperator is\nloaded prior to setting the center by calling [isLoaded()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#isLoaded)\nmethod. If it is not yet loaded, you can call [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) method.",
|
|
11145
11022
|
"type": "Array<number> | Point | string"
|
|
11146
11023
|
},
|
|
11147
11024
|
{
|
|
11148
11025
|
"name": "constraints",
|
|
11149
|
-
"description": "Specifies constraints to scale, zoom, and rotation that may be applied to the
|
|
11026
|
+
"description": "Specifies constraints to scale, zoom, and rotation that may be applied to the map.",
|
|
11150
11027
|
"type": "View2DConstraints"
|
|
11151
11028
|
},
|
|
11152
11029
|
{
|
|
11153
11030
|
"name": "displayFilterDisabled",
|
|
11154
|
-
"description": "Indicates whether layer's
|
|
11031
|
+
"description": "Indicates whether a layer's `displayFilterInfo` is honored when rendering layers in the view.\nIf `false`, display filters are ignored and all features are rendered.",
|
|
11155
11032
|
"type": "boolean"
|
|
11156
11033
|
},
|
|
11157
11034
|
{
|
|
11158
11035
|
"name": "extent",
|
|
11159
|
-
"description": "The extent represents the visible portion of a map within the view as an instance of esri
|
|
11036
|
+
"description": "The extent represents the visible portion of a map within the view as an instance of [Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html).\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's [goTo()](#goTo) method.\nWhen the view is rotated, the extent does not update to include the newly visible portions of the map.\n\n**Notes**\n\n* If the spatial reference of `extent` set does not match the [spatialReference](#spatialReference) of the view, then the\n[projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) will be loaded dynamically.\n* At runtime, the [projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html)\nmust be [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) when\nsetting the `extent` to a spatial reference that doesn't match the view spatial reference. You can check if the projectOperator is\nloaded prior to setting the extent by calling [isLoaded()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#isLoaded)\nmethod. If it is not yet loaded, you can call the [load](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) method.",
|
|
11160
11037
|
"type": "Extent"
|
|
11161
11038
|
},
|
|
11162
11039
|
{
|
|
@@ -11191,12 +11068,12 @@
|
|
|
11191
11068
|
},
|
|
11192
11069
|
{
|
|
11193
11070
|
"name": "highlights",
|
|
11194
|
-
"description": "
|
|
11071
|
+
"description": "Represents a collection of [HighlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html)\nobjects which can be used to highlight features throughout an application. Highlighting works by applying highlight options to one or\nmore features. You can configure these options (such as color or opacity) to define how a feature will be visually\nemphasized.\n\nA maximum of six [HighlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html)\nobjects are supported in the collection, and they can be added, removed, and reordered freely. Their order in the collection determines priority, with the last\nobject having the highest priority. If you apply more than one highlight to a feature, the one that is last within\nthe collection will be applied. The [HighlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html)\nobject must be part of this collection in order to be applied to features.\n\nTo highlight a feature, use the [highlight()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#highlight)\nmethod on the relevant [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) instance. To apply specific\n[HighlightOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html), include the\n[name](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-support-HighlightOptions.html#name) in the `highlight()` method's `options` parameter.\nIf no `name` is provided, the feature will use the `default` highlight options.\n\nThe table below shows the default highlight options in the View's highlights collection if the collection has not\nbeen modified:\n\n| Highlight options name | Description | Default settings |\n| ---------------------- | ----------- | ---------------- |\n| default | The default highlight options. Used when `layerView.highlight()` is called without specifying any particular highlight options. | ` { name: \"default\", color: \"cyan\", haloOpacity: 1, fillOpacity: 0.25, shadowColor: \"black\", shadowOpacity: 0.4, shadowDifference: 0.2}` |\n| temporary | The temporary highlight options, pre-configured for common use cases such as hovering over a feature in the view. | `{ name: \"temporary\", color: \"yellow\", haloOpacity: 1, fillOpacity: 0.25, shadowColor: \"black\", shadowOpacity: 0.4, shadowDifference: 0.2 }` |",
|
|
11195
11072
|
"type": "Collection<HighlightOptions>"
|
|
11196
11073
|
},
|
|
11197
11074
|
{
|
|
11198
11075
|
"name": "interacting",
|
|
11199
|
-
"description": "
|
|
11076
|
+
"description": "Indicates whether the view is being interacted with (for example, when panning or via an interactive tool).",
|
|
11200
11077
|
"type": "boolean"
|
|
11201
11078
|
},
|
|
11202
11079
|
{
|
|
@@ -11211,9 +11088,14 @@
|
|
|
11211
11088
|
},
|
|
11212
11089
|
{
|
|
11213
11090
|
"name": "layerViews",
|
|
11214
|
-
"description": "A collection containing a hierarchical list of all the created\
|
|
11091
|
+
"description": "A collection containing a hierarchical list of all the created\n[LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)s of the\n[operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map.",
|
|
11215
11092
|
"type": "Collection<LayerView>"
|
|
11216
11093
|
},
|
|
11094
|
+
{
|
|
11095
|
+
"name": "loadErrorSources",
|
|
11096
|
+
"description": "An array of objects that encountered an error while loading the component or any of its dependencies (e.g., basemap, ground, layers, tables). You may inspect the errors by accessing each object's `loadError` property.",
|
|
11097
|
+
"type": "Array<WebLinkChart | Basemap | Ground | Layer | WebMap | WebScene>"
|
|
11098
|
+
},
|
|
11217
11099
|
{
|
|
11218
11100
|
"name": "magnifier",
|
|
11219
11101
|
"description": "The magnifier allows for showing a portion of the view as a magnifier image on top of the view.",
|
|
@@ -11221,7 +11103,7 @@
|
|
|
11221
11103
|
},
|
|
11222
11104
|
{
|
|
11223
11105
|
"name": "map",
|
|
11224
|
-
"description": "An instance of a esri
|
|
11106
|
+
"description": "An instance of a [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) object to display in the view.",
|
|
11225
11107
|
"type": "Map"
|
|
11226
11108
|
},
|
|
11227
11109
|
{
|
|
@@ -11246,12 +11128,12 @@
|
|
|
11246
11128
|
},
|
|
11247
11129
|
{
|
|
11248
11130
|
"name": "popupDisabled",
|
|
11249
|
-
"description": "Controls whether the popup opens when users click on the view.",
|
|
11131
|
+
"description": "Controls whether the popup opens automatically when users click on the view.",
|
|
11250
11132
|
"type": "boolean"
|
|
11251
11133
|
},
|
|
11252
11134
|
{
|
|
11253
11135
|
"name": "ready",
|
|
11254
|
-
"description": "When `true`, this property indicates whether the view successfully satisfied all dependencies
|
|
11136
|
+
"description": "When `true`, this property indicates whether the [view](#view) has successfully satisfied all dependencies, signaling that the following conditions are met:\n\n* The view has a [map](#map). If [map](#map)\nis a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html), then the map\nmust be [loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#loaded).\n* The view has a [spatialReference](#spatialReference), a [center](#center), and a [scale](#scale).\nThese also can be inferred by setting an [extent](#extent).\n\nWhen a view becomes ready it will resolve itself and invoke\nthe callback defined in [viewOnReady()](#viewOnReady) where code can execute on a working view.",
|
|
11255
11137
|
"type": "boolean"
|
|
11256
11138
|
},
|
|
11257
11139
|
{
|
|
@@ -11271,17 +11153,17 @@
|
|
|
11271
11153
|
},
|
|
11272
11154
|
{
|
|
11273
11155
|
"name": "scale",
|
|
11274
|
-
"description": "Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's goTo() method.",
|
|
11156
|
+
"description": "Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](#goTo) method.",
|
|
11275
11157
|
"type": "number"
|
|
11276
11158
|
},
|
|
11277
11159
|
{
|
|
11278
11160
|
"name": "spatialReference",
|
|
11279
|
-
"description": "The spatial reference of the view
|
|
11161
|
+
"description": "The spatial reference of the view. This indicates the projected or geographic coordinate system used to locate geographic features in the map.\nYou can change the spatialReference of the view after it is initialized by either directly changing\nthis property, or by changing the basemap from the [Basemap Gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/)\nand [Basemap Toggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components.\nSet [spatialReferenceLocked](#spatialReferenceLocked) property to `true` to prevent users from changing the view's spatial reference at runtime.\n\nPrior to changing the spatial reference, check if the [projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html)\nis loaded by calling [projectOperator.isLoaded()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#isLoaded) method.\nIf it is not yet loaded, call [projectOperator.load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) method.\nIf the `projectOperator` is not loaded, the view's [center](#center) will default to `[0, 0]` in the new spatial reference of the view and a console error will be thrown.\n\n**Notes**\n\n* [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) not compatible with the view's spatial reference\nare not displayed. In such case, the layer view's [suspended](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#suspended)\nproperty is `true` and [spatialReferenceSupported](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html#spatialReferenceSupported)\nproperty is `false`.\n* When setting view's spatial reference, the [center](#center), [extent](#extent) or [viewpoint.targetGeometry](#viewpoint) properties are projected to the new spatial\nreference. The [scale](#scale) and [rotation](#rotation) properties are adjusted to keep the content of the map at the same size and orientation on screen.\n* To ensure [TileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-TileLayer.html) and\n[VectorTileLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html)\nare displayed in a [basemap](#basemap) correctly, the spatialReference of the view must be set match their\n[tileInfo's](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TileInfo.html) spatial reference.\n* Switching spatial reference with an [imageCoordinateSystem](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html#imageCoordinateSystem)\nis not supported.",
|
|
11280
11162
|
"type": "SpatialReference"
|
|
11281
11163
|
},
|
|
11282
11164
|
{
|
|
11283
11165
|
"name": "spatialReferenceLocked",
|
|
11284
|
-
"description": "Indicates if the map's spatialReference can be changed after it is ready.\nThe default is `false`, indicating the map's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the map's spatial reference\nwill be disabled in [arcgis-basemap-gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components and the map's spatialReference cannot be changed at runtime.",
|
|
11166
|
+
"description": "Indicates if the map's [spatialReference](#spatialReference) can be changed after it is ready.\nThe default is `false`, indicating the map's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the map's spatial reference\nwill be disabled in [arcgis-basemap-gallery](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/) components and the map's spatialReference cannot be changed at runtime.",
|
|
11285
11167
|
"type": "boolean"
|
|
11286
11168
|
},
|
|
11287
11169
|
{
|
|
@@ -11296,7 +11178,7 @@
|
|
|
11296
11178
|
},
|
|
11297
11179
|
{
|
|
11298
11180
|
"name": "theme",
|
|
11299
|
-
"description": "This property specifies the base colors used by some
|
|
11181
|
+
"description": "This property specifies the base colors used by some components to render graphics and labels.",
|
|
11300
11182
|
"type": "Theme"
|
|
11301
11183
|
},
|
|
11302
11184
|
{
|
|
@@ -11316,12 +11198,12 @@
|
|
|
11316
11198
|
},
|
|
11317
11199
|
{
|
|
11318
11200
|
"name": "view",
|
|
11319
|
-
"description": "The [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance created and
|
|
11201
|
+
"description": "The [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) instance created and managed by the component. Accessible once the component is fully loaded.",
|
|
11320
11202
|
"type": "MapView"
|
|
11321
11203
|
},
|
|
11322
11204
|
{
|
|
11323
11205
|
"name": "viewpoint",
|
|
11324
|
-
"description": "Represents the current view as a Viewpoint or point of observation on the view.\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's goTo() method.",
|
|
11206
|
+
"description": "Represents the current view as a Viewpoint or point of observation on the view.\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's [goTo()](#goTo) method.",
|
|
11325
11207
|
"type": "Viewpoint"
|
|
11326
11208
|
},
|
|
11327
11209
|
{
|
|
@@ -11331,11 +11213,16 @@
|
|
|
11331
11213
|
},
|
|
11332
11214
|
{
|
|
11333
11215
|
"name": "zoom",
|
|
11334
|
-
"description": "Represents the level of detail (LOD) at the center of the
|
|
11216
|
+
"description": "Represents the level of detail (LOD) at the center of the map.\nA zoom level (or scale) is a number that defines how large or small the contents of a map appear in a Map component.\nZoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.\nA value of -1 means the map has no LODs.\nWhen setting the zoom value, the component converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\nSetting this property in conjunction with `center` is a convenient way to set the initial extent of the view.",
|
|
11335
11217
|
"type": "number"
|
|
11336
11218
|
}
|
|
11337
11219
|
],
|
|
11338
11220
|
"events": [
|
|
11221
|
+
{
|
|
11222
|
+
"name": "arcgisLoadError",
|
|
11223
|
+
"type": "void",
|
|
11224
|
+
"description": "Fires when a ArcgisMap fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers)."
|
|
11225
|
+
},
|
|
11339
11226
|
{
|
|
11340
11227
|
"name": "arcgisViewAnalysisViewCreate",
|
|
11341
11228
|
"type": "ViewAnalysisViewCreateEvent",
|
|
@@ -11354,12 +11241,12 @@
|
|
|
11354
11241
|
{
|
|
11355
11242
|
"name": "arcgisViewChange",
|
|
11356
11243
|
"type": "void",
|
|
11357
|
-
"description": "This event is
|
|
11244
|
+
"description": "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."
|
|
11358
11245
|
},
|
|
11359
11246
|
{
|
|
11360
11247
|
"name": "arcgisViewClick",
|
|
11361
11248
|
"type": "ViewClickEvent",
|
|
11362
|
-
"description": "Fires after a user clicks on the view."
|
|
11249
|
+
"description": "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."
|
|
11363
11250
|
},
|
|
11364
11251
|
{
|
|
11365
11252
|
"name": "arcgisViewDoubleClick",
|
|
@@ -11374,17 +11261,17 @@
|
|
|
11374
11261
|
{
|
|
11375
11262
|
"name": "arcgisViewHold",
|
|
11376
11263
|
"type": "ViewHoldEvent",
|
|
11377
|
-
"description": "Fires
|
|
11264
|
+
"description": "Fires after holding either a mouse button or a single finger on the view for a short amount of time."
|
|
11378
11265
|
},
|
|
11379
11266
|
{
|
|
11380
11267
|
"name": "arcgisViewImmediateClick",
|
|
11381
11268
|
"type": "ViewImmediateClickEvent",
|
|
11382
|
-
"description": "Fires right after a user clicks on the view."
|
|
11269
|
+
"description": "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."
|
|
11383
11270
|
},
|
|
11384
11271
|
{
|
|
11385
11272
|
"name": "arcgisViewImmediateDoubleClick",
|
|
11386
11273
|
"type": "ViewImmediateDoubleClickEvent",
|
|
11387
|
-
"description": "
|
|
11274
|
+
"description": "Fires after 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."
|
|
11388
11275
|
},
|
|
11389
11276
|
{
|
|
11390
11277
|
"name": "arcgisViewKeyDown",
|
|
@@ -11394,22 +11281,22 @@
|
|
|
11394
11281
|
{
|
|
11395
11282
|
"name": "arcgisViewKeyUp",
|
|
11396
11283
|
"type": "ViewKeyUpEvent",
|
|
11397
|
-
"description": "Fires after a keyboard key is
|
|
11284
|
+
"description": "Fires after a keyboard key is released."
|
|
11398
11285
|
},
|
|
11399
11286
|
{
|
|
11400
11287
|
"name": "arcgisViewLayerviewCreate",
|
|
11401
11288
|
"type": "ViewLayerviewCreateEvent",
|
|
11402
|
-
"description": "Fires after each layer in the map has a corresponding
|
|
11289
|
+
"description": "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."
|
|
11403
11290
|
},
|
|
11404
11291
|
{
|
|
11405
11292
|
"name": "arcgisViewLayerviewCreateError",
|
|
11406
11293
|
"type": "ViewLayerviewCreateErrorEvent",
|
|
11407
|
-
"description": "Fires when an error
|
|
11294
|
+
"description": "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."
|
|
11408
11295
|
},
|
|
11409
11296
|
{
|
|
11410
11297
|
"name": "arcgisViewLayerviewDestroy",
|
|
11411
11298
|
"type": "ViewLayerviewDestroyEvent",
|
|
11412
|
-
"description": "Fires after a LayerView
|
|
11299
|
+
"description": "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."
|
|
11413
11300
|
},
|
|
11414
11301
|
{
|
|
11415
11302
|
"name": "arcgisViewMouseWheel",
|
|
@@ -11444,7 +11331,12 @@
|
|
|
11444
11331
|
{
|
|
11445
11332
|
"name": "arcgisViewReadyChange",
|
|
11446
11333
|
"type": "void",
|
|
11447
|
-
"description": "This event is for the `ready` property and
|
|
11334
|
+
"description": "This event is for the `ready` property and is emitted when the view is ready.\nFires also when the [map](#map) is updated."
|
|
11335
|
+
},
|
|
11336
|
+
{
|
|
11337
|
+
"name": "arcgisViewReadyError",
|
|
11338
|
+
"type": "void",
|
|
11339
|
+
"description": "Fires if the view encounters a content or rendering error."
|
|
11448
11340
|
}
|
|
11449
11341
|
]
|
|
11450
11342
|
}
|
|
@@ -11536,7 +11428,7 @@
|
|
|
11536
11428
|
},
|
|
11537
11429
|
{
|
|
11538
11430
|
"name": "position",
|
|
11539
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
11431
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
11540
11432
|
"value": {
|
|
11541
11433
|
"type": [
|
|
11542
11434
|
"\"bottom-leading\"",
|
|
@@ -11637,7 +11529,7 @@
|
|
|
11637
11529
|
},
|
|
11638
11530
|
{
|
|
11639
11531
|
"name": "view",
|
|
11640
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
11532
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Measurement component will be associated with a map or scene component rather than using the `view` property.",
|
|
11641
11533
|
"type": "MapView | SceneView"
|
|
11642
11534
|
}
|
|
11643
11535
|
],
|
|
@@ -11698,7 +11590,7 @@
|
|
|
11698
11590
|
},
|
|
11699
11591
|
{
|
|
11700
11592
|
"name": "position",
|
|
11701
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
11593
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
11702
11594
|
"value": {
|
|
11703
11595
|
"type": [
|
|
11704
11596
|
"\"bottom-leading\"",
|
|
@@ -11786,7 +11678,7 @@
|
|
|
11786
11678
|
},
|
|
11787
11679
|
{
|
|
11788
11680
|
"name": "view",
|
|
11789
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
11681
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Navigation Toggle component will be associated with a map or scene component rather than using the `view` property.",
|
|
11790
11682
|
"type": "SceneView"
|
|
11791
11683
|
}
|
|
11792
11684
|
],
|
|
@@ -11920,7 +11812,7 @@
|
|
|
11920
11812
|
},
|
|
11921
11813
|
{
|
|
11922
11814
|
"name": "position",
|
|
11923
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
11815
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
11924
11816
|
"value": {
|
|
11925
11817
|
"type": [
|
|
11926
11818
|
"\"bottom-leading\"",
|
|
@@ -12052,7 +11944,7 @@
|
|
|
12052
11944
|
},
|
|
12053
11945
|
{
|
|
12054
11946
|
"name": "view",
|
|
12055
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
11947
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Oriented Imagery Viewer component will be associated with a map or scene component rather than using the `view` property.",
|
|
12056
11948
|
"type": "MapView | SceneView"
|
|
12057
11949
|
}
|
|
12058
11950
|
],
|
|
@@ -12077,7 +11969,7 @@
|
|
|
12077
11969
|
"attributes": [
|
|
12078
11970
|
{
|
|
12079
11971
|
"name": "position",
|
|
12080
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
11972
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
12081
11973
|
"value": {
|
|
12082
11974
|
"type": [
|
|
12083
11975
|
"\"bottom-leading\"",
|
|
@@ -12120,7 +12012,7 @@
|
|
|
12120
12012
|
},
|
|
12121
12013
|
{
|
|
12122
12014
|
"name": "view",
|
|
12123
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
12015
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Placement component will be associated with a map or scene component rather than using the `view` property.",
|
|
12124
12016
|
"type": "LinkChartView | MapView | SceneView"
|
|
12125
12017
|
}
|
|
12126
12018
|
],
|
|
@@ -12135,7 +12027,7 @@
|
|
|
12135
12027
|
},
|
|
12136
12028
|
{
|
|
12137
12029
|
"name": "arcgis-popup",
|
|
12138
|
-
"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\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
|
|
12030
|
+
"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<void>` - 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.",
|
|
12139
12031
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/",
|
|
12140
12032
|
"attributes": [
|
|
12141
12033
|
{
|
|
@@ -12352,7 +12244,7 @@
|
|
|
12352
12244
|
},
|
|
12353
12245
|
{
|
|
12354
12246
|
"name": "visible",
|
|
12355
|
-
"description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open.\nUse the property to check if the popup is visible
|
|
12247
|
+
"description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open.\nUse the property to check if the popup is visible.",
|
|
12356
12248
|
"default": "false",
|
|
12357
12249
|
"value": {
|
|
12358
12250
|
"type": "boolean"
|
|
@@ -12384,7 +12276,7 @@
|
|
|
12384
12276
|
"properties": [
|
|
12385
12277
|
{
|
|
12386
12278
|
"name": "actions",
|
|
12387
|
-
"description": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action button](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects.\nEach action may be executed by clicking the icon or image symbolizing them.\n\nBy default, popups have a `Zoom To` action styled with a magnifying glass icon.\nWhen this icon is clicked, the view zooms in four LODs and centers on the selected feature.\nYou may remove this default action by setting [includeDefaultActionsDisabled](#includeDefaultActionsDisabled) to `true`, or by setting the\n[`overwriteActions`](esri-PopupTemplate.html#overwriteActions) property to `true` in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).\n\nThe order of each action is the order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html).\n\nThe [arcgisTriggerAction](#arcgisTriggerAction) event fires each time an action is clicked.",
|
|
12279
|
+
"description": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of [action button](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionButton.html) or [action toggle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-actions-ActionToggle.html) objects.\nEach action may be executed by clicking the icon or image symbolizing them.\n\nBy default, popups have a `Zoom To` action styled with a magnifying glass icon.\nWhen this icon is clicked, the view zooms in four LODs and centers on the selected feature.\nYou may remove this default action by setting [includeDefaultActionsDisabled](#includeDefaultActionsDisabled) to `true`, or by setting the\n[`overwriteActions`](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#overwriteActions) property to `true` in a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).\n\nThe order of each action is the order in which they appear in the actions [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html).\n\nThe [arcgisTriggerAction](#arcgisTriggerAction) event fires each time an action is clicked.",
|
|
12388
12280
|
"type": "Collection<ActionButton | ActionToggle>"
|
|
12389
12281
|
},
|
|
12390
12282
|
{
|
|
@@ -12572,9 +12464,14 @@
|
|
|
12572
12464
|
"description": "The current state of the component.",
|
|
12573
12465
|
"type": "\"disabled\" | \"ready\""
|
|
12574
12466
|
},
|
|
12467
|
+
{
|
|
12468
|
+
"name": "view",
|
|
12469
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Popup component will be associated with a map or scene component rather than using the `view` property.",
|
|
12470
|
+
"type": "MapView | SceneView"
|
|
12471
|
+
},
|
|
12575
12472
|
{
|
|
12576
12473
|
"name": "visible",
|
|
12577
|
-
"description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open.\nUse the property to check if the popup is visible
|
|
12474
|
+
"description": "Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open.\nUse the property to check if the popup is visible.",
|
|
12578
12475
|
"type": "boolean"
|
|
12579
12476
|
}
|
|
12580
12477
|
],
|
|
@@ -12700,7 +12597,7 @@
|
|
|
12700
12597
|
},
|
|
12701
12598
|
{
|
|
12702
12599
|
"name": "position",
|
|
12703
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
12600
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
12704
12601
|
"value": {
|
|
12705
12602
|
"type": [
|
|
12706
12603
|
"\"bottom-leading\"",
|
|
@@ -12894,7 +12791,7 @@
|
|
|
12894
12791
|
},
|
|
12895
12792
|
{
|
|
12896
12793
|
"name": "view",
|
|
12897
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
12794
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Print component will be associated with a map or scene component rather than using the `view` property.",
|
|
12898
12795
|
"type": "MapView"
|
|
12899
12796
|
}
|
|
12900
12797
|
],
|
|
@@ -12963,7 +12860,7 @@
|
|
|
12963
12860
|
},
|
|
12964
12861
|
{
|
|
12965
12862
|
"name": "position",
|
|
12966
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
12863
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
12967
12864
|
"value": {
|
|
12968
12865
|
"type": [
|
|
12969
12866
|
"\"bottom-leading\"",
|
|
@@ -13047,7 +12944,7 @@
|
|
|
13047
12944
|
},
|
|
13048
12945
|
{
|
|
13049
12946
|
"name": "view",
|
|
13050
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
12947
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Scale Bar component will be associated with a map or scene component rather than using the `view` property.",
|
|
13051
12948
|
"type": "MapView"
|
|
13052
12949
|
}
|
|
13053
12950
|
],
|
|
@@ -13159,7 +13056,7 @@
|
|
|
13159
13056
|
},
|
|
13160
13057
|
{
|
|
13161
13058
|
"name": "position",
|
|
13162
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
13059
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
13163
13060
|
"value": {
|
|
13164
13061
|
"type": [
|
|
13165
13062
|
"\"bottom-leading\"",
|
|
@@ -13303,7 +13200,7 @@
|
|
|
13303
13200
|
},
|
|
13304
13201
|
{
|
|
13305
13202
|
"name": "view",
|
|
13306
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
13203
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Scale Range Slider component will be associated with a map or scene component rather than using the `view` property.",
|
|
13307
13204
|
"type": "MapView | SceneView"
|
|
13308
13205
|
}
|
|
13309
13206
|
],
|
|
@@ -13323,7 +13220,7 @@
|
|
|
13323
13220
|
},
|
|
13324
13221
|
{
|
|
13325
13222
|
"name": "arcgis-scene",
|
|
13326
|
-
"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- **arcgisViewAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create)\n- **arcgisViewAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes: [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[camera](#camera), [viewpoint](#viewpoint). This event will also emit if [stationary](#stationary) toggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](#popup).\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its [map](#map), [popup](#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView(analysis: __esri.Analysis): Promise<__esri.AnalysisView3DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)\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\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - Specifies the right padding for the layout. ",
|
|
13223
|
+
"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(analysis: __esri.Analysis): Promise<__esri.AnalysisView3DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)\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. When using this slot, the [`popup-disabled`](#popupDisabled) attribute must be set to `true`. 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. ",
|
|
13327
13224
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/",
|
|
13328
13225
|
"attributes": [
|
|
13329
13226
|
{
|
|
@@ -13408,7 +13305,7 @@
|
|
|
13408
13305
|
},
|
|
13409
13306
|
{
|
|
13410
13307
|
"name": "popup-disabled",
|
|
13411
|
-
"description": "Controls whether the popup opens when users click on the view.",
|
|
13308
|
+
"description": "Controls whether the popup opens automatically when users click on the view.",
|
|
13412
13309
|
"default": "false",
|
|
13413
13310
|
"value": {
|
|
13414
13311
|
"type": "boolean"
|
|
@@ -13495,9 +13392,18 @@
|
|
|
13495
13392
|
{
|
|
13496
13393
|
"name": "bottom-end",
|
|
13497
13394
|
"description": "Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL)."
|
|
13395
|
+
},
|
|
13396
|
+
{
|
|
13397
|
+
"name": "popup",
|
|
13398
|
+
"description": "Slot for the [Popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/) component to open automatically on click. When using this slot, the [`popup-disabled`](#popupDisabled) attribute must be set to `true`. Only the Popup component can be placed in this slot."
|
|
13498
13399
|
}
|
|
13499
13400
|
],
|
|
13500
13401
|
"events": [
|
|
13402
|
+
{
|
|
13403
|
+
"name": "arcgisLoadError",
|
|
13404
|
+
"type": "void",
|
|
13405
|
+
"description": "Fires when a ArcgisScene fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers)."
|
|
13406
|
+
},
|
|
13501
13407
|
{
|
|
13502
13408
|
"name": "arcgisViewAnalysisViewCreate",
|
|
13503
13409
|
"type": "ViewAnalysisViewCreateEvent",
|
|
@@ -13607,6 +13513,11 @@
|
|
|
13607
13513
|
"name": "arcgisViewReadyChange",
|
|
13608
13514
|
"type": "void",
|
|
13609
13515
|
"description": "This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed."
|
|
13516
|
+
},
|
|
13517
|
+
{
|
|
13518
|
+
"name": "arcgisViewReadyError",
|
|
13519
|
+
"type": "void",
|
|
13520
|
+
"description": "Fires if the view encounters a content or rendering error."
|
|
13610
13521
|
}
|
|
13611
13522
|
],
|
|
13612
13523
|
"js": {
|
|
@@ -13626,6 +13537,11 @@
|
|
|
13626
13537
|
"description": "A collection of analyses associated with the view.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#analyses)",
|
|
13627
13538
|
"type": "Collection<Analysis>"
|
|
13628
13539
|
},
|
|
13540
|
+
{
|
|
13541
|
+
"name": "aria",
|
|
13542
|
+
"description": "The ARIA attributes for the view container. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [`label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [`description`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [`describedByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaDescribedByElements), and [`labelledByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaLabelledByElements).",
|
|
13543
|
+
"type": "DOMContainerAria"
|
|
13544
|
+
},
|
|
13629
13545
|
{
|
|
13630
13546
|
"name": "autoDestroyDisabled",
|
|
13631
13547
|
"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-scene/#destroy) method when you are done to\nprevent memory leaks.",
|
|
@@ -13756,6 +13672,11 @@
|
|
|
13756
13672
|
"description": "A collection containing a hierarchical list of all the created\n[LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the\n[operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](#map).",
|
|
13757
13673
|
"type": "Collection<LayerView>"
|
|
13758
13674
|
},
|
|
13675
|
+
{
|
|
13676
|
+
"name": "loadErrorSources",
|
|
13677
|
+
"description": "An array of objects that encountered an error while loading the component or any of its dependencies (e.g., basemap, ground, layers, tables). You may inspect the errors by accessing each object's `loadError` property.",
|
|
13678
|
+
"type": "Array<WebLinkChart | Basemap | Ground | Layer | WebMap | WebScene>"
|
|
13679
|
+
},
|
|
13759
13680
|
{
|
|
13760
13681
|
"name": "magnifier",
|
|
13761
13682
|
"description": "The magnifier allows for showing a portion of the view as a magnifier image on top of the view.",
|
|
@@ -13793,7 +13714,7 @@
|
|
|
13793
13714
|
},
|
|
13794
13715
|
{
|
|
13795
13716
|
"name": "popupDisabled",
|
|
13796
|
-
"description": "Controls whether the popup opens when users click on the view.",
|
|
13717
|
+
"description": "Controls whether the popup opens automatically when users click on the view.",
|
|
13797
13718
|
"type": "boolean"
|
|
13798
13719
|
},
|
|
13799
13720
|
{
|
|
@@ -13873,6 +13794,11 @@
|
|
|
13873
13794
|
}
|
|
13874
13795
|
],
|
|
13875
13796
|
"events": [
|
|
13797
|
+
{
|
|
13798
|
+
"name": "arcgisLoadError",
|
|
13799
|
+
"type": "void",
|
|
13800
|
+
"description": "Fires when a ArcgisScene fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers)."
|
|
13801
|
+
},
|
|
13876
13802
|
{
|
|
13877
13803
|
"name": "arcgisViewAnalysisViewCreate",
|
|
13878
13804
|
"type": "ViewAnalysisViewCreateEvent",
|
|
@@ -13982,6 +13908,11 @@
|
|
|
13982
13908
|
"name": "arcgisViewReadyChange",
|
|
13983
13909
|
"type": "void",
|
|
13984
13910
|
"description": "This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed."
|
|
13911
|
+
},
|
|
13912
|
+
{
|
|
13913
|
+
"name": "arcgisViewReadyError",
|
|
13914
|
+
"type": "void",
|
|
13915
|
+
"description": "Fires if the view encounters a content or rendering error."
|
|
13985
13916
|
}
|
|
13986
13917
|
]
|
|
13987
13918
|
}
|
|
@@ -14029,7 +13960,7 @@
|
|
|
14029
13960
|
},
|
|
14030
13961
|
{
|
|
14031
13962
|
"name": "auto-navigate-disabled",
|
|
14032
|
-
"description": "Indicates whether to automatically navigate to the selected result.",
|
|
13963
|
+
"description": "Indicates whether to automatically navigate to the selected result. If `true`, will not automatically navigate to the selected result.",
|
|
14033
13964
|
"default": "false",
|
|
14034
13965
|
"value": {
|
|
14035
13966
|
"type": "boolean"
|
|
@@ -14037,7 +13968,7 @@
|
|
|
14037
13968
|
},
|
|
14038
13969
|
{
|
|
14039
13970
|
"name": "auto-select-disabled",
|
|
14040
|
-
"description": "
|
|
13971
|
+
"description": "By default, the component will automatically select and zoom to the first geocoded result. When `true`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
|
|
14041
13972
|
"default": "false",
|
|
14042
13973
|
"value": {
|
|
14043
13974
|
"type": "boolean"
|
|
@@ -14045,7 +13976,7 @@
|
|
|
14045
13976
|
},
|
|
14046
13977
|
{
|
|
14047
13978
|
"name": "disabled",
|
|
14048
|
-
"description": "When true
|
|
13979
|
+
"description": "When `true`, the component is visually withdrawn and cannot be interacted with.",
|
|
14049
13980
|
"default": "false",
|
|
14050
13981
|
"value": {
|
|
14051
13982
|
"type": "boolean"
|
|
@@ -14061,7 +13992,7 @@
|
|
|
14061
13992
|
},
|
|
14062
13993
|
{
|
|
14063
13994
|
"name": "include-default-sources-disabled",
|
|
14064
|
-
"description": "
|
|
13995
|
+
"description": "When `true`, will not include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.",
|
|
14065
13996
|
"default": "false",
|
|
14066
13997
|
"value": {
|
|
14067
13998
|
"type": "boolean"
|
|
@@ -14076,7 +14007,7 @@
|
|
|
14076
14007
|
},
|
|
14077
14008
|
{
|
|
14078
14009
|
"name": "location-disabled",
|
|
14079
|
-
"description": "
|
|
14010
|
+
"description": "When `true`, will disable location services within the component.\n\n\n\n**Note:**\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that supports\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).",
|
|
14080
14011
|
"default": "false",
|
|
14081
14012
|
"value": {
|
|
14082
14013
|
"type": "boolean"
|
|
@@ -14108,7 +14039,7 @@
|
|
|
14108
14039
|
},
|
|
14109
14040
|
{
|
|
14110
14041
|
"name": "popup-disabled",
|
|
14111
|
-
"description": "
|
|
14042
|
+
"description": "By default, the graphic can be clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).\nWhen `true`, disables displaying the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click.",
|
|
14112
14043
|
"default": "false",
|
|
14113
14044
|
"value": {
|
|
14114
14045
|
"type": "boolean"
|
|
@@ -14116,7 +14047,7 @@
|
|
|
14116
14047
|
},
|
|
14117
14048
|
{
|
|
14118
14049
|
"name": "position",
|
|
14119
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
14050
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
14120
14051
|
"value": {
|
|
14121
14052
|
"type": [
|
|
14122
14053
|
"\"bottom-leading\"",
|
|
@@ -14140,7 +14071,7 @@
|
|
|
14140
14071
|
},
|
|
14141
14072
|
{
|
|
14142
14073
|
"name": "result-graphic-disabled",
|
|
14143
|
-
"description": "
|
|
14074
|
+
"description": "If `true`, the [resultGraphic](#resultGraphic) will not display at the\nlocation of the selected feature.",
|
|
14144
14075
|
"default": "false",
|
|
14145
14076
|
"value": {
|
|
14146
14077
|
"type": "boolean"
|
|
@@ -14148,7 +14079,7 @@
|
|
|
14148
14079
|
},
|
|
14149
14080
|
{
|
|
14150
14081
|
"name": "search-all-disabled",
|
|
14151
|
-
"description": "
|
|
14082
|
+
"description": "By default, the \"All\" option is displayed by default to search all sources:\n\n\n\nWhen `true`, no option to search all sources at once is available:\n\n",
|
|
14152
14083
|
"default": "false",
|
|
14153
14084
|
"value": {
|
|
14154
14085
|
"type": "boolean"
|
|
@@ -14176,7 +14107,7 @@
|
|
|
14176
14107
|
},
|
|
14177
14108
|
{
|
|
14178
14109
|
"name": "suggestions-disabled",
|
|
14179
|
-
"description": "
|
|
14110
|
+
"description": "If `true`, disables suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
|
|
14180
14111
|
"default": "false",
|
|
14181
14112
|
"value": {
|
|
14182
14113
|
"type": "boolean"
|
|
@@ -14259,12 +14190,12 @@
|
|
|
14259
14190
|
},
|
|
14260
14191
|
{
|
|
14261
14192
|
"name": "autoNavigateDisabled",
|
|
14262
|
-
"description": "Indicates whether to automatically navigate to the selected result.",
|
|
14193
|
+
"description": "Indicates whether to automatically navigate to the selected result. If `true`, will not automatically navigate to the selected result.",
|
|
14263
14194
|
"type": "boolean"
|
|
14264
14195
|
},
|
|
14265
14196
|
{
|
|
14266
14197
|
"name": "autoSelectDisabled",
|
|
14267
|
-
"description": "
|
|
14198
|
+
"description": "By default, the component will automatically select and zoom to the first geocoded result. When `true`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
|
|
14268
14199
|
"type": "boolean"
|
|
14269
14200
|
},
|
|
14270
14201
|
{
|
|
@@ -14274,7 +14205,7 @@
|
|
|
14274
14205
|
},
|
|
14275
14206
|
{
|
|
14276
14207
|
"name": "disabled",
|
|
14277
|
-
"description": "When true
|
|
14208
|
+
"description": "When `true`, the component is visually withdrawn and cannot be interacted with.",
|
|
14278
14209
|
"type": "boolean"
|
|
14279
14210
|
},
|
|
14280
14211
|
{
|
|
@@ -14289,7 +14220,7 @@
|
|
|
14289
14220
|
},
|
|
14290
14221
|
{
|
|
14291
14222
|
"name": "includeDefaultSourcesDisabled",
|
|
14292
|
-
"description": "
|
|
14223
|
+
"description": "When `true`, will not include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.",
|
|
14293
14224
|
"type": "Function | boolean"
|
|
14294
14225
|
},
|
|
14295
14226
|
{
|
|
@@ -14299,7 +14230,7 @@
|
|
|
14299
14230
|
},
|
|
14300
14231
|
{
|
|
14301
14232
|
"name": "locationDisabled",
|
|
14302
|
-
"description": "
|
|
14233
|
+
"description": "When `true`, will disable location services within the component.\n\n\n\n**Note:**\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that supports\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).",
|
|
14303
14234
|
"type": "boolean"
|
|
14304
14235
|
},
|
|
14305
14236
|
{
|
|
@@ -14324,7 +14255,7 @@
|
|
|
14324
14255
|
},
|
|
14325
14256
|
{
|
|
14326
14257
|
"name": "popupDisabled",
|
|
14327
|
-
"description": "
|
|
14258
|
+
"description": "By default, the graphic can be clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).\nWhen `true`, disables displaying the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click.",
|
|
14328
14259
|
"type": "boolean"
|
|
14329
14260
|
},
|
|
14330
14261
|
{
|
|
@@ -14353,7 +14284,7 @@
|
|
|
14353
14284
|
},
|
|
14354
14285
|
{
|
|
14355
14286
|
"name": "resultGraphicDisabled",
|
|
14356
|
-
"description": "
|
|
14287
|
+
"description": "If `true`, the [resultGraphic](#resultGraphic) will not display at the\nlocation of the selected feature.",
|
|
14357
14288
|
"type": "boolean"
|
|
14358
14289
|
},
|
|
14359
14290
|
{
|
|
@@ -14363,7 +14294,7 @@
|
|
|
14363
14294
|
},
|
|
14364
14295
|
{
|
|
14365
14296
|
"name": "searchAllDisabled",
|
|
14366
|
-
"description": "
|
|
14297
|
+
"description": "By default, the \"All\" option is displayed by default to search all sources:\n\n\n\nWhen `true`, no option to search all sources at once is available:\n\n",
|
|
14367
14298
|
"type": "boolean"
|
|
14368
14299
|
},
|
|
14369
14300
|
{
|
|
@@ -14393,12 +14324,12 @@
|
|
|
14393
14324
|
},
|
|
14394
14325
|
{
|
|
14395
14326
|
"name": "suggestionsDisabled",
|
|
14396
|
-
"description": "
|
|
14327
|
+
"description": "If `true`, disables suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
|
|
14397
14328
|
"type": "boolean"
|
|
14398
14329
|
},
|
|
14399
14330
|
{
|
|
14400
14331
|
"name": "view",
|
|
14401
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
14332
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Search component will be associated with a map or scene component rather than using the `view` property.",
|
|
14402
14333
|
"type": "MapView | SceneView"
|
|
14403
14334
|
}
|
|
14404
14335
|
],
|
|
@@ -14476,7 +14407,7 @@
|
|
|
14476
14407
|
},
|
|
14477
14408
|
{
|
|
14478
14409
|
"name": "messages",
|
|
14479
|
-
"type": "({\n componentLabel: string;\n searchButtonTitle: string;\n placeholder: string;\n searchIn: string;\n all: string;\n allPlaceholder: string;\n locateError: string;\n untitledResult: string;\n untitledSource: string;\n noResults: string;\n noResultsFound: string;\n noResultsFoundForValue: string;\n showMoreResults: string;\n hideMoreResults: string;\n searchResult: string;\n moreResultsHeader: string;\n useCurrentLocation: string;\n} & {\n _lang: string;\n _t9nLocale: \"el\" | \"
|
|
14410
|
+
"type": "({\n componentLabel: string;\n searchButtonTitle: string;\n placeholder: string;\n searchIn: string;\n all: string;\n allPlaceholder: string;\n locateError: string;\n untitledResult: string;\n untitledSource: string;\n noResults: string;\n noResultsFound: string;\n noResultsFoundForValue: string;\n showMoreResults: string;\n hideMoreResults: string;\n searchResult: string;\n moreResultsHeader: string;\n useCurrentLocation: string;\n} & {\n _lang: string;\n _t9nLocale: \"el\" | \"hr\" | \"th\" | \"tr\" | \"id\" | \"ar\" | \"de\" | \"da\" | \"vi\" | \"ca\" | \"sl\" | \"fi\" | \"it\" | \"es\" | \"et\" | \"sk\" | \"en\" | \"sv\" | \"fr\" | \"he\" | \"cs\" | \"lt\" | \"no\" | \"pl\" | \"ro\" | \"ru\" | \"bs\" | \"bg\" | \"ko\" | \"pt-BR\" | \"pt-PT\" | \"zh-CN\" | \"zh-HK\" | \"zh-TW\" | \"hu\" | \"ja\" | \"lv\" | \"nl\" | \"nb\" | \"sr\" | \"uk\";\n _loading: boolean;\n _overrides: {\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n };\n _original?: {\n componentLabel: string;\n searchButtonTitle: string;\n placeholder: string;\n searchIn: string;\n all: string;\n allPlaceholder: string;\n locateError: string;\n untitledResult: string;\n untitledSource: string;\n noResults: string;\n noResultsFound: string;\n noResultsFoundForValue: string;\n showMoreResults: string;\n hideMoreResults: string;\n searchResult: string;\n moreResultsHeader: string;\n useCurrentLocation: string;\n } | undefined;\n})"
|
|
14480
14411
|
},
|
|
14481
14412
|
{
|
|
14482
14413
|
"name": "viewModel",
|
|
@@ -14618,7 +14549,7 @@
|
|
|
14618
14549
|
},
|
|
14619
14550
|
{
|
|
14620
14551
|
"name": "position",
|
|
14621
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
14552
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
14622
14553
|
"value": {
|
|
14623
14554
|
"type": [
|
|
14624
14555
|
"\"bottom-leading\"",
|
|
@@ -14804,7 +14735,7 @@
|
|
|
14804
14735
|
},
|
|
14805
14736
|
{
|
|
14806
14737
|
"name": "view",
|
|
14807
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
14738
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Shadow Cast component will be associated with a map or scene component rather than using the `view` property.",
|
|
14808
14739
|
"type": "SceneView"
|
|
14809
14740
|
},
|
|
14810
14741
|
{
|
|
@@ -15045,7 +14976,7 @@
|
|
|
15045
14976
|
},
|
|
15046
14977
|
{
|
|
15047
14978
|
"name": "position",
|
|
15048
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
14979
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
15049
14980
|
"value": {
|
|
15050
14981
|
"type": [
|
|
15051
14982
|
"\"bottom-leading\"",
|
|
@@ -15079,6 +15010,20 @@
|
|
|
15079
15010
|
]
|
|
15080
15011
|
}
|
|
15081
15012
|
},
|
|
15013
|
+
{
|
|
15014
|
+
"name": "show-create-tools-freehand-polygon",
|
|
15015
|
+
"default": "false",
|
|
15016
|
+
"value": {
|
|
15017
|
+
"type": "boolean"
|
|
15018
|
+
}
|
|
15019
|
+
},
|
|
15020
|
+
{
|
|
15021
|
+
"name": "show-create-tools-freehand-polyline",
|
|
15022
|
+
"default": "false",
|
|
15023
|
+
"value": {
|
|
15024
|
+
"type": "boolean"
|
|
15025
|
+
}
|
|
15026
|
+
},
|
|
15082
15027
|
{
|
|
15083
15028
|
"name": "show-snapping-controls-elements-header",
|
|
15084
15029
|
"default": "false",
|
|
@@ -15099,7 +15044,7 @@
|
|
|
15099
15044
|
},
|
|
15100
15045
|
{
|
|
15101
15046
|
"name": "toolbar-kind",
|
|
15102
|
-
"description": "Controls the appearance of the sketch widget, allowing
|
|
15047
|
+
"description": "Controls the appearance of the sketch widget, allowing the toolbar to adapt its appearance appropriately based on context.\n\nSet this to `docked` for use within the Expand component, or any other situation\nwhere Sketch is not floating within a large canvas.",
|
|
15103
15048
|
"default": "\"floating\"",
|
|
15104
15049
|
"value": {
|
|
15105
15050
|
"type": [
|
|
@@ -15155,7 +15100,7 @@
|
|
|
15155
15100
|
},
|
|
15156
15101
|
{
|
|
15157
15102
|
"name": "availableCreateTools",
|
|
15158
|
-
"description": "Property controlling the visibility and order of create tool buttons.",
|
|
15103
|
+
"description": "Property controlling the visibility and order of create tool buttons.\nCreate tool buttons will only be rendered if they are in this collections and the\nmatching hide/show property or attribute is configured to show the tool.",
|
|
15159
15104
|
"type": "Array<\"circle\" | \"point\" | \"polygon\" | \"rectangle\" | \"text\" | \"multipoint\" | \"polyline\" | \"mesh\" | \"freehandPolyline\" | \"freehandPolygon\">"
|
|
15160
15105
|
},
|
|
15161
15106
|
{
|
|
@@ -15313,6 +15258,14 @@
|
|
|
15313
15258
|
"description": "Determines the size of widget elements.",
|
|
15314
15259
|
"type": "\"l\" | \"m\" | \"s\""
|
|
15315
15260
|
},
|
|
15261
|
+
{
|
|
15262
|
+
"name": "showCreateToolsFreehandPolygon",
|
|
15263
|
+
"type": "boolean"
|
|
15264
|
+
},
|
|
15265
|
+
{
|
|
15266
|
+
"name": "showCreateToolsFreehandPolyline",
|
|
15267
|
+
"type": "boolean"
|
|
15268
|
+
},
|
|
15316
15269
|
{
|
|
15317
15270
|
"name": "showSnappingControlsElementsHeader",
|
|
15318
15271
|
"type": "boolean"
|
|
@@ -15329,7 +15282,7 @@
|
|
|
15329
15282
|
},
|
|
15330
15283
|
{
|
|
15331
15284
|
"name": "toolbarKind",
|
|
15332
|
-
"description": "Controls the appearance of the sketch widget, allowing
|
|
15285
|
+
"description": "Controls the appearance of the sketch widget, allowing the toolbar to adapt its appearance appropriately based on context.\n\nSet this to `docked` for use within the Expand component, or any other situation\nwhere Sketch is not floating within a large canvas.",
|
|
15333
15286
|
"type": "\"docked\" | \"floating\""
|
|
15334
15287
|
},
|
|
15335
15288
|
{
|
|
@@ -15344,7 +15297,7 @@
|
|
|
15344
15297
|
},
|
|
15345
15298
|
{
|
|
15346
15299
|
"name": "view",
|
|
15347
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
15300
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Sketch component will be associated with a map or scene component rather than using the `view` property.",
|
|
15348
15301
|
"type": "MapView | SceneView"
|
|
15349
15302
|
}
|
|
15350
15303
|
],
|
|
@@ -15435,7 +15388,7 @@
|
|
|
15435
15388
|
},
|
|
15436
15389
|
{
|
|
15437
15390
|
"name": "position",
|
|
15438
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
15391
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
15439
15392
|
"value": {
|
|
15440
15393
|
"type": [
|
|
15441
15394
|
"\"bottom-leading\"",
|
|
@@ -15559,7 +15512,7 @@
|
|
|
15559
15512
|
},
|
|
15560
15513
|
{
|
|
15561
15514
|
"name": "view",
|
|
15562
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
15515
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Slice component will be associated with a map or scene component rather than using the `view` property.",
|
|
15563
15516
|
"type": "SceneView"
|
|
15564
15517
|
}
|
|
15565
15518
|
],
|
|
@@ -15643,7 +15596,7 @@
|
|
|
15643
15596
|
},
|
|
15644
15597
|
{
|
|
15645
15598
|
"name": "position",
|
|
15646
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
15599
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
15647
15600
|
"value": {
|
|
15648
15601
|
"type": [
|
|
15649
15602
|
"\"bottom-leading\"",
|
|
@@ -15780,7 +15733,7 @@
|
|
|
15780
15733
|
},
|
|
15781
15734
|
{
|
|
15782
15735
|
"name": "view",
|
|
15783
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
15736
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Swipe component will be associated with a map or scene component rather than using the `view` property.",
|
|
15784
15737
|
"type": "MapView"
|
|
15785
15738
|
}
|
|
15786
15739
|
],
|
|
@@ -15908,7 +15861,7 @@
|
|
|
15908
15861
|
},
|
|
15909
15862
|
{
|
|
15910
15863
|
"name": "position",
|
|
15911
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
15864
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
15912
15865
|
"value": {
|
|
15913
15866
|
"type": [
|
|
15914
15867
|
"\"bottom-leading\"",
|
|
@@ -16150,7 +16103,7 @@
|
|
|
16150
16103
|
},
|
|
16151
16104
|
{
|
|
16152
16105
|
"name": "view",
|
|
16153
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
16106
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Table List component will be associated with a map or scene component rather than using the `view` property.",
|
|
16154
16107
|
"type": "LinkChartView | MapView | SceneView"
|
|
16155
16108
|
}
|
|
16156
16109
|
],
|
|
@@ -16257,7 +16210,7 @@
|
|
|
16257
16210
|
},
|
|
16258
16211
|
{
|
|
16259
16212
|
"name": "position",
|
|
16260
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
16213
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
16261
16214
|
"value": {
|
|
16262
16215
|
"type": [
|
|
16263
16216
|
"\"bottom-leading\"",
|
|
@@ -16422,7 +16375,7 @@
|
|
|
16422
16375
|
},
|
|
16423
16376
|
{
|
|
16424
16377
|
"name": "view",
|
|
16425
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
16378
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Time Slider component will be associated with a map or scene component rather than using the `view` property.",
|
|
16426
16379
|
"type": "MapView | SceneView"
|
|
16427
16380
|
}
|
|
16428
16381
|
],
|
|
@@ -16476,6 +16429,14 @@
|
|
|
16476
16429
|
"type": "boolean"
|
|
16477
16430
|
}
|
|
16478
16431
|
},
|
|
16432
|
+
{
|
|
16433
|
+
"name": "icon",
|
|
16434
|
+
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
16435
|
+
"default": "\"time-zone\"",
|
|
16436
|
+
"value": {
|
|
16437
|
+
"type": "string"
|
|
16438
|
+
}
|
|
16439
|
+
},
|
|
16479
16440
|
{
|
|
16480
16441
|
"name": "label",
|
|
16481
16442
|
"description": "The component's default label.",
|
|
@@ -16509,7 +16470,6 @@
|
|
|
16509
16470
|
{
|
|
16510
16471
|
"name": "state",
|
|
16511
16472
|
"description": "The state of the component.",
|
|
16512
|
-
"default": "\"disabled\"",
|
|
16513
16473
|
"value": {
|
|
16514
16474
|
"type": [
|
|
16515
16475
|
"\"disabled\"",
|
|
@@ -16547,6 +16507,11 @@
|
|
|
16547
16507
|
"description": "The expanded state of the component.",
|
|
16548
16508
|
"type": "boolean"
|
|
16549
16509
|
},
|
|
16510
|
+
{
|
|
16511
|
+
"name": "icon",
|
|
16512
|
+
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
16513
|
+
"type": "string"
|
|
16514
|
+
},
|
|
16550
16515
|
{
|
|
16551
16516
|
"name": "label",
|
|
16552
16517
|
"description": "The component's default label.",
|
|
@@ -16569,6 +16534,10 @@
|
|
|
16569
16534
|
"name": "state",
|
|
16570
16535
|
"description": "The state of the component.",
|
|
16571
16536
|
"type": "\"disabled\" | \"ready\""
|
|
16537
|
+
},
|
|
16538
|
+
{
|
|
16539
|
+
"name": "view",
|
|
16540
|
+
"type": "MapView"
|
|
16572
16541
|
}
|
|
16573
16542
|
],
|
|
16574
16543
|
"events": [
|
|
@@ -16639,7 +16608,7 @@
|
|
|
16639
16608
|
},
|
|
16640
16609
|
{
|
|
16641
16610
|
"name": "position",
|
|
16642
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
16611
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
16643
16612
|
"value": {
|
|
16644
16613
|
"type": [
|
|
16645
16614
|
"\"bottom-leading\"",
|
|
@@ -16796,7 +16765,7 @@
|
|
|
16796
16765
|
},
|
|
16797
16766
|
{
|
|
16798
16767
|
"name": "view",
|
|
16799
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
16768
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Track component will be associated with a map or scene component rather than using the `view` property.",
|
|
16800
16769
|
"type": "MapView | SceneView"
|
|
16801
16770
|
}
|
|
16802
16771
|
],
|
|
@@ -16845,6 +16814,7 @@
|
|
|
16845
16814
|
},
|
|
16846
16815
|
{
|
|
16847
16816
|
"name": "hide-connectivity-associations-settings-color-picker",
|
|
16817
|
+
"description": "If true, hides the connectivity association color picker.",
|
|
16848
16818
|
"default": "false",
|
|
16849
16819
|
"value": {
|
|
16850
16820
|
"type": "boolean"
|
|
@@ -16852,6 +16822,7 @@
|
|
|
16852
16822
|
},
|
|
16853
16823
|
{
|
|
16854
16824
|
"name": "hide-connectivity-associations-settings-style-picker",
|
|
16825
|
+
"description": "If true, hides the connectivity association style picker.",
|
|
16855
16826
|
"default": "false",
|
|
16856
16827
|
"value": {
|
|
16857
16828
|
"type": "boolean"
|
|
@@ -16859,6 +16830,7 @@
|
|
|
16859
16830
|
},
|
|
16860
16831
|
{
|
|
16861
16832
|
"name": "hide-connectivity-associations-settings-width-input",
|
|
16833
|
+
"description": "If true, hides the connectivity association width input.",
|
|
16862
16834
|
"default": "false",
|
|
16863
16835
|
"value": {
|
|
16864
16836
|
"type": "boolean"
|
|
@@ -16866,6 +16838,7 @@
|
|
|
16866
16838
|
},
|
|
16867
16839
|
{
|
|
16868
16840
|
"name": "hide-structural-attachment-associations-settings-color-picker",
|
|
16841
|
+
"description": "If true, hides the structural attachment associations color picker.",
|
|
16869
16842
|
"default": "false",
|
|
16870
16843
|
"value": {
|
|
16871
16844
|
"type": "boolean"
|
|
@@ -16873,6 +16846,7 @@
|
|
|
16873
16846
|
},
|
|
16874
16847
|
{
|
|
16875
16848
|
"name": "hide-structural-attachment-associations-settings-style-picker",
|
|
16849
|
+
"description": "If true, hides the structural attachment associations style picker.",
|
|
16876
16850
|
"default": "false",
|
|
16877
16851
|
"value": {
|
|
16878
16852
|
"type": "boolean"
|
|
@@ -16880,6 +16854,7 @@
|
|
|
16880
16854
|
},
|
|
16881
16855
|
{
|
|
16882
16856
|
"name": "hide-structural-attachment-associations-settings-width-input",
|
|
16857
|
+
"description": "If true, hides the structural attachment associations width input.",
|
|
16883
16858
|
"default": "false",
|
|
16884
16859
|
"value": {
|
|
16885
16860
|
"type": "boolean"
|
|
@@ -16947,7 +16922,7 @@
|
|
|
16947
16922
|
},
|
|
16948
16923
|
{
|
|
16949
16924
|
"name": "position",
|
|
16950
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
16925
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
16951
16926
|
"value": {
|
|
16952
16927
|
"type": [
|
|
16953
16928
|
"\"bottom-leading\"",
|
|
@@ -16995,6 +16970,7 @@
|
|
|
16995
16970
|
},
|
|
16996
16971
|
{
|
|
16997
16972
|
"name": "show-connectivity-associations-settings-arrows-toggle",
|
|
16973
|
+
"description": "If true, shows the connectivity association arrows toggle.",
|
|
16998
16974
|
"default": "false",
|
|
16999
16975
|
"value": {
|
|
17000
16976
|
"type": "boolean"
|
|
@@ -17002,6 +16978,7 @@
|
|
|
17002
16978
|
},
|
|
17003
16979
|
{
|
|
17004
16980
|
"name": "show-connectivity-associations-settings-cap-select",
|
|
16981
|
+
"description": "If true, shows the connectivity association cap select.",
|
|
17005
16982
|
"default": "false",
|
|
17006
16983
|
"value": {
|
|
17007
16984
|
"type": "boolean"
|
|
@@ -17009,6 +16986,7 @@
|
|
|
17009
16986
|
},
|
|
17010
16987
|
{
|
|
17011
16988
|
"name": "show-max-allowable-associations-slider",
|
|
16989
|
+
"description": "If true, hides the max allowable associations slider.",
|
|
17012
16990
|
"default": "false",
|
|
17013
16991
|
"value": {
|
|
17014
16992
|
"type": "boolean"
|
|
@@ -17016,6 +16994,7 @@
|
|
|
17016
16994
|
},
|
|
17017
16995
|
{
|
|
17018
16996
|
"name": "show-structural-attachment-associations-settings-arrows-toggle",
|
|
16997
|
+
"description": "If true, shows the structural attachment associations arrow toggle.",
|
|
17019
16998
|
"default": "false",
|
|
17020
16999
|
"value": {
|
|
17021
17000
|
"type": "boolean"
|
|
@@ -17023,6 +17002,7 @@
|
|
|
17023
17002
|
},
|
|
17024
17003
|
{
|
|
17025
17004
|
"name": "show-structural-attachment-associations-settings-cap-select",
|
|
17005
|
+
"description": "If true, shows the structural attachment associations cap select.",
|
|
17026
17006
|
"default": "false",
|
|
17027
17007
|
"value": {
|
|
17028
17008
|
"type": "boolean"
|
|
@@ -17030,7 +17010,7 @@
|
|
|
17030
17010
|
},
|
|
17031
17011
|
{
|
|
17032
17012
|
"name": "visible-elements-connectivity-associations-settings-arrows-toggle",
|
|
17033
|
-
"description": "**Deprecated**: since 4.32, showConnectivityAssociationsSettingsArrowsToggle instead
|
|
17013
|
+
"description": "**Deprecated**: since 4.32, showConnectivityAssociationsSettingsArrowsToggle instead.. ",
|
|
17034
17014
|
"default": "false",
|
|
17035
17015
|
"value": {
|
|
17036
17016
|
"type": "boolean"
|
|
@@ -17038,7 +17018,7 @@
|
|
|
17038
17018
|
},
|
|
17039
17019
|
{
|
|
17040
17020
|
"name": "visible-elements-connectivity-associations-settings-cap-select",
|
|
17041
|
-
"description": "**Deprecated**: since 4.32, use showConnectivityAssociationsSettingsCapSelect instead
|
|
17021
|
+
"description": "**Deprecated**: since 4.32, use showConnectivityAssociationsSettingsCapSelect instead.. ",
|
|
17042
17022
|
"default": "false",
|
|
17043
17023
|
"value": {
|
|
17044
17024
|
"type": "boolean"
|
|
@@ -17046,7 +17026,7 @@
|
|
|
17046
17026
|
},
|
|
17047
17027
|
{
|
|
17048
17028
|
"name": "visible-elements-connectivity-associations-settings-color-picker",
|
|
17049
|
-
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsColorPicker instead
|
|
17029
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsColorPicker instead.. ",
|
|
17050
17030
|
"default": "true",
|
|
17051
17031
|
"value": {
|
|
17052
17032
|
"type": "boolean"
|
|
@@ -17054,7 +17034,7 @@
|
|
|
17054
17034
|
},
|
|
17055
17035
|
{
|
|
17056
17036
|
"name": "visible-elements-connectivity-associations-settings-style-picker",
|
|
17057
|
-
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsStylePicker instead
|
|
17037
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsStylePicker instead.. ",
|
|
17058
17038
|
"default": "true",
|
|
17059
17039
|
"value": {
|
|
17060
17040
|
"type": "boolean"
|
|
@@ -17062,7 +17042,7 @@
|
|
|
17062
17042
|
},
|
|
17063
17043
|
{
|
|
17064
17044
|
"name": "visible-elements-connectivity-associations-settings-width-input",
|
|
17065
|
-
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsWidthInput instead
|
|
17045
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsWidthInput instead.. ",
|
|
17066
17046
|
"default": "true",
|
|
17067
17047
|
"value": {
|
|
17068
17048
|
"type": "boolean"
|
|
@@ -17070,7 +17050,7 @@
|
|
|
17070
17050
|
},
|
|
17071
17051
|
{
|
|
17072
17052
|
"name": "visible-elements-max-allowable-associations-slider",
|
|
17073
|
-
"description": "**Deprecated**: since 4.32, use showMaxAllowableAssociationsSlider instead
|
|
17053
|
+
"description": "**Deprecated**: since 4.32, use showMaxAllowableAssociationsSlider instead.. ",
|
|
17074
17054
|
"default": "false",
|
|
17075
17055
|
"value": {
|
|
17076
17056
|
"type": "boolean"
|
|
@@ -17078,7 +17058,7 @@
|
|
|
17078
17058
|
},
|
|
17079
17059
|
{
|
|
17080
17060
|
"name": "visible-elements-structural-attachment-associations-settings-arrows-toggle",
|
|
17081
|
-
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsArrowsToggle instead
|
|
17061
|
+
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsArrowsToggle instead.. ",
|
|
17082
17062
|
"default": "false",
|
|
17083
17063
|
"value": {
|
|
17084
17064
|
"type": "boolean"
|
|
@@ -17086,7 +17066,7 @@
|
|
|
17086
17066
|
},
|
|
17087
17067
|
{
|
|
17088
17068
|
"name": "visible-elements-structural-attachment-associations-settings-cap-select",
|
|
17089
|
-
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsCapSelect instead
|
|
17069
|
+
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsCapSelect instead.. ",
|
|
17090
17070
|
"default": "false",
|
|
17091
17071
|
"value": {
|
|
17092
17072
|
"type": "boolean"
|
|
@@ -17094,7 +17074,7 @@
|
|
|
17094
17074
|
},
|
|
17095
17075
|
{
|
|
17096
17076
|
"name": "visible-elements-structural-attachment-associations-settings-color-picker",
|
|
17097
|
-
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsColorPicker instead
|
|
17077
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsColorPicker instead.. ",
|
|
17098
17078
|
"default": "true",
|
|
17099
17079
|
"value": {
|
|
17100
17080
|
"type": "boolean"
|
|
@@ -17102,7 +17082,7 @@
|
|
|
17102
17082
|
},
|
|
17103
17083
|
{
|
|
17104
17084
|
"name": "visible-elements-structural-attachment-associations-settings-style-picker",
|
|
17105
|
-
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsStylePicker instead
|
|
17085
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsStylePicker instead.. ",
|
|
17106
17086
|
"default": "true",
|
|
17107
17087
|
"value": {
|
|
17108
17088
|
"type": "boolean"
|
|
@@ -17110,7 +17090,7 @@
|
|
|
17110
17090
|
},
|
|
17111
17091
|
{
|
|
17112
17092
|
"name": "visible-elements-structural-attachment-associations-settings-width-input",
|
|
17113
|
-
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsWidthInput instead
|
|
17093
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsWidthInput instead.. ",
|
|
17114
17094
|
"default": "true",
|
|
17115
17095
|
"value": {
|
|
17116
17096
|
"type": "boolean"
|
|
@@ -17143,26 +17123,32 @@
|
|
|
17143
17123
|
},
|
|
17144
17124
|
{
|
|
17145
17125
|
"name": "hideConnectivityAssociationsSettingsColorPicker",
|
|
17126
|
+
"description": "If true, hides the connectivity association color picker.",
|
|
17146
17127
|
"type": "boolean"
|
|
17147
17128
|
},
|
|
17148
17129
|
{
|
|
17149
17130
|
"name": "hideConnectivityAssociationsSettingsStylePicker",
|
|
17131
|
+
"description": "If true, hides the connectivity association style picker.",
|
|
17150
17132
|
"type": "boolean"
|
|
17151
17133
|
},
|
|
17152
17134
|
{
|
|
17153
17135
|
"name": "hideConnectivityAssociationsSettingsWidthInput",
|
|
17136
|
+
"description": "If true, hides the connectivity association width input.",
|
|
17154
17137
|
"type": "boolean"
|
|
17155
17138
|
},
|
|
17156
17139
|
{
|
|
17157
17140
|
"name": "hideStructuralAttachmentAssociationsSettingsColorPicker",
|
|
17141
|
+
"description": "If true, hides the structural attachment associations color picker.",
|
|
17158
17142
|
"type": "boolean"
|
|
17159
17143
|
},
|
|
17160
17144
|
{
|
|
17161
17145
|
"name": "hideStructuralAttachmentAssociationsSettingsStylePicker",
|
|
17146
|
+
"description": "If true, hides the structural attachment associations style picker.",
|
|
17162
17147
|
"type": "boolean"
|
|
17163
17148
|
},
|
|
17164
17149
|
{
|
|
17165
17150
|
"name": "hideStructuralAttachmentAssociationsSettingsWidthInput",
|
|
17151
|
+
"description": "If true, hides the structural attachment associations width input.",
|
|
17166
17152
|
"type": "boolean"
|
|
17167
17153
|
},
|
|
17168
17154
|
{
|
|
@@ -17231,22 +17217,27 @@
|
|
|
17231
17217
|
},
|
|
17232
17218
|
{
|
|
17233
17219
|
"name": "showConnectivityAssociationsSettingsArrowsToggle",
|
|
17220
|
+
"description": "If true, shows the connectivity association arrows toggle.",
|
|
17234
17221
|
"type": "boolean"
|
|
17235
17222
|
},
|
|
17236
17223
|
{
|
|
17237
17224
|
"name": "showConnectivityAssociationsSettingsCapSelect",
|
|
17225
|
+
"description": "If true, shows the connectivity association cap select.",
|
|
17238
17226
|
"type": "boolean"
|
|
17239
17227
|
},
|
|
17240
17228
|
{
|
|
17241
17229
|
"name": "showMaxAllowableAssociationsSlider",
|
|
17230
|
+
"description": "If true, hides the max allowable associations slider.",
|
|
17242
17231
|
"type": "boolean"
|
|
17243
17232
|
},
|
|
17244
17233
|
{
|
|
17245
17234
|
"name": "showStructuralAttachmentAssociationsSettingsArrowsToggle",
|
|
17235
|
+
"description": "If true, shows the structural attachment associations arrow toggle.",
|
|
17246
17236
|
"type": "boolean"
|
|
17247
17237
|
},
|
|
17248
17238
|
{
|
|
17249
17239
|
"name": "showStructuralAttachmentAssociationsSettingsCapSelect",
|
|
17240
|
+
"description": "If true, shows the structural attachment associations cap select.",
|
|
17250
17241
|
"type": "boolean"
|
|
17251
17242
|
},
|
|
17252
17243
|
{
|
|
@@ -17261,7 +17252,7 @@
|
|
|
17261
17252
|
},
|
|
17262
17253
|
{
|
|
17263
17254
|
"name": "view",
|
|
17264
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
17255
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Utility Network Associations component will be associated with a map or scene component rather than using the `view` property.",
|
|
17265
17256
|
"type": "MapView"
|
|
17266
17257
|
},
|
|
17267
17258
|
{
|
|
@@ -17364,7 +17355,7 @@
|
|
|
17364
17355
|
},
|
|
17365
17356
|
{
|
|
17366
17357
|
"name": "position",
|
|
17367
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
17358
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
17368
17359
|
"value": {
|
|
17369
17360
|
"type": [
|
|
17370
17361
|
"\"bottom-leading\"",
|
|
@@ -17542,7 +17533,7 @@
|
|
|
17542
17533
|
},
|
|
17543
17534
|
{
|
|
17544
17535
|
"name": "view",
|
|
17545
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
17536
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Utility Network Trace component will be associated with a map or scene component rather than using the `view` property.",
|
|
17546
17537
|
"type": "MapView"
|
|
17547
17538
|
}
|
|
17548
17539
|
],
|
|
@@ -17759,6 +17750,22 @@
|
|
|
17759
17750
|
]
|
|
17760
17751
|
}
|
|
17761
17752
|
},
|
|
17753
|
+
{
|
|
17754
|
+
"name": "arcgis-utility-network-subnetwork-info",
|
|
17755
|
+
"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<void>` - Create a promise that resolves once component is fully loaded.",
|
|
17756
|
+
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-subnetwork-info/",
|
|
17757
|
+
"attributes": [],
|
|
17758
|
+
"events": [],
|
|
17759
|
+
"js": {
|
|
17760
|
+
"properties": [
|
|
17761
|
+
{
|
|
17762
|
+
"name": "namedTraceConfig",
|
|
17763
|
+
"type": "NamedTraceConfiguration | undefined"
|
|
17764
|
+
}
|
|
17765
|
+
],
|
|
17766
|
+
"events": []
|
|
17767
|
+
}
|
|
17768
|
+
},
|
|
17762
17769
|
{
|
|
17763
17770
|
"name": "arcgis-utility-network-trace-inputs",
|
|
17764
17771
|
"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- **arcgisTraceInputsChange**\n- **arcgisUtilityNetworkChange**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
|
|
@@ -17766,7 +17773,12 @@
|
|
|
17766
17773
|
"attributes": [
|
|
17767
17774
|
{
|
|
17768
17775
|
"name": "reference-element",
|
|
17769
|
-
"
|
|
17776
|
+
"value": {
|
|
17777
|
+
"type": "string"
|
|
17778
|
+
}
|
|
17779
|
+
},
|
|
17780
|
+
{
|
|
17781
|
+
"name": "selected-subnetwork-name",
|
|
17770
17782
|
"value": {
|
|
17771
17783
|
"type": "string"
|
|
17772
17784
|
}
|
|
@@ -17786,9 +17798,12 @@
|
|
|
17786
17798
|
"properties": [
|
|
17787
17799
|
{
|
|
17788
17800
|
"name": "referenceElement",
|
|
17789
|
-
"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.",
|
|
17790
17801
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
17791
17802
|
},
|
|
17803
|
+
{
|
|
17804
|
+
"name": "selectedSubnetworkName",
|
|
17805
|
+
"type": "string"
|
|
17806
|
+
},
|
|
17792
17807
|
{
|
|
17793
17808
|
"name": "selectedTraceConfiguration",
|
|
17794
17809
|
"type": "NamedTraceConfiguration"
|
|
@@ -17797,6 +17812,10 @@
|
|
|
17797
17812
|
"name": "selectedUtilityNetwork",
|
|
17798
17813
|
"type": "UtilityNetwork"
|
|
17799
17814
|
},
|
|
17815
|
+
{
|
|
17816
|
+
"name": "traceLocations",
|
|
17817
|
+
"type": "Array<TraceLocation>"
|
|
17818
|
+
},
|
|
17800
17819
|
{
|
|
17801
17820
|
"name": "view",
|
|
17802
17821
|
"type": "MapView | undefined"
|
|
@@ -17814,6 +17833,84 @@
|
|
|
17814
17833
|
]
|
|
17815
17834
|
}
|
|
17816
17835
|
},
|
|
17836
|
+
{
|
|
17837
|
+
"name": "arcgis-utility-network-trace-location",
|
|
17838
|
+
"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**\n- **arcgisTraceLocationSelectStart**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
|
|
17839
|
+
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace-location/",
|
|
17840
|
+
"attributes": [
|
|
17841
|
+
{
|
|
17842
|
+
"name": "trace-location-type",
|
|
17843
|
+
"default": "\"starting-point\"",
|
|
17844
|
+
"value": {
|
|
17845
|
+
"type": [
|
|
17846
|
+
"\"barrier\"",
|
|
17847
|
+
"\"starting-point\"",
|
|
17848
|
+
"\"stopping-point\""
|
|
17849
|
+
]
|
|
17850
|
+
}
|
|
17851
|
+
}
|
|
17852
|
+
],
|
|
17853
|
+
"events": [
|
|
17854
|
+
{
|
|
17855
|
+
"name": "arcgisTraceLocationChange",
|
|
17856
|
+
"type": "void"
|
|
17857
|
+
},
|
|
17858
|
+
{
|
|
17859
|
+
"name": "arcgisTraceLocationSelectEnd",
|
|
17860
|
+
"type": "void"
|
|
17861
|
+
},
|
|
17862
|
+
{
|
|
17863
|
+
"name": "arcgisTraceLocationSelectStart",
|
|
17864
|
+
"type": "void"
|
|
17865
|
+
}
|
|
17866
|
+
],
|
|
17867
|
+
"js": {
|
|
17868
|
+
"properties": [
|
|
17869
|
+
{
|
|
17870
|
+
"name": "filterLayers",
|
|
17871
|
+
"type": "Collection<Layer>"
|
|
17872
|
+
},
|
|
17873
|
+
{
|
|
17874
|
+
"name": "flagLayer",
|
|
17875
|
+
"type": "GraphicsLayer"
|
|
17876
|
+
},
|
|
17877
|
+
{
|
|
17878
|
+
"name": "sketchViewModel",
|
|
17879
|
+
"type": "SketchViewModel"
|
|
17880
|
+
},
|
|
17881
|
+
{
|
|
17882
|
+
"name": "traceLocations",
|
|
17883
|
+
"type": "Collection<FlagProperty>"
|
|
17884
|
+
},
|
|
17885
|
+
{
|
|
17886
|
+
"name": "traceLocationType",
|
|
17887
|
+
"type": "\"barrier\" | \"starting-point\" | \"stopping-point\""
|
|
17888
|
+
},
|
|
17889
|
+
{
|
|
17890
|
+
"name": "utilityNetwork",
|
|
17891
|
+
"type": "UtilityNetwork | undefined"
|
|
17892
|
+
},
|
|
17893
|
+
{
|
|
17894
|
+
"name": "view",
|
|
17895
|
+
"type": "MapView | undefined"
|
|
17896
|
+
}
|
|
17897
|
+
],
|
|
17898
|
+
"events": [
|
|
17899
|
+
{
|
|
17900
|
+
"name": "arcgisTraceLocationChange",
|
|
17901
|
+
"type": "void"
|
|
17902
|
+
},
|
|
17903
|
+
{
|
|
17904
|
+
"name": "arcgisTraceLocationSelectEnd",
|
|
17905
|
+
"type": "void"
|
|
17906
|
+
},
|
|
17907
|
+
{
|
|
17908
|
+
"name": "arcgisTraceLocationSelectStart",
|
|
17909
|
+
"type": "void"
|
|
17910
|
+
}
|
|
17911
|
+
]
|
|
17912
|
+
}
|
|
17913
|
+
},
|
|
17817
17914
|
{
|
|
17818
17915
|
"name": "arcgis-utility-network-trace-results",
|
|
17819
17916
|
"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.\n\nIt displays a list of result types returned by a trace in the provided `TraceResult`.\nSelecting a trace result type renders a flow item for that result type.\n--\n\n### Events\n- **arcgisSelectedResultTypeChange**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
|
|
@@ -17908,7 +18005,7 @@
|
|
|
17908
18005
|
},
|
|
17909
18006
|
{
|
|
17910
18007
|
"name": "position",
|
|
17911
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
18008
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
17912
18009
|
"value": {
|
|
17913
18010
|
"type": [
|
|
17914
18011
|
"\"bottom-leading\"",
|
|
@@ -18001,7 +18098,7 @@
|
|
|
18001
18098
|
},
|
|
18002
18099
|
{
|
|
18003
18100
|
"name": "view",
|
|
18004
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
18101
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Utility Network Validate Topology component will be associated with a map or scene component rather than using the `view` property.",
|
|
18005
18102
|
"type": "MapView"
|
|
18006
18103
|
}
|
|
18007
18104
|
],
|
|
@@ -18129,7 +18226,7 @@
|
|
|
18129
18226
|
},
|
|
18130
18227
|
{
|
|
18131
18228
|
"name": "position",
|
|
18132
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
18229
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
18133
18230
|
"value": {
|
|
18134
18231
|
"type": [
|
|
18135
18232
|
"\"bottom-leading\"",
|
|
@@ -18358,7 +18455,7 @@
|
|
|
18358
18455
|
},
|
|
18359
18456
|
{
|
|
18360
18457
|
"name": "position",
|
|
18361
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
18458
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
18362
18459
|
"value": {
|
|
18363
18460
|
"type": [
|
|
18364
18461
|
"\"bottom-leading\"",
|
|
@@ -18489,7 +18586,7 @@
|
|
|
18489
18586
|
},
|
|
18490
18587
|
{
|
|
18491
18588
|
"name": "arcgis-video",
|
|
18492
|
-
"description": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid VideoLayer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n--\n\n### Events\n- **arcgisViewReadyChange**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\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** - Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - Specifies the right padding for the layout. ",
|
|
18589
|
+
"description": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid VideoLayer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n--\n\n### Events\n- **arcgisViewReadyChange**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\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. ",
|
|
18493
18590
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/",
|
|
18494
18591
|
"attributes": [
|
|
18495
18592
|
{
|
|
@@ -18546,6 +18643,11 @@
|
|
|
18546
18643
|
],
|
|
18547
18644
|
"js": {
|
|
18548
18645
|
"properties": [
|
|
18646
|
+
{
|
|
18647
|
+
"name": "aria",
|
|
18648
|
+
"description": "The ARIA attributes for the view container. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [`label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [`description`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [`describedByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaDescribedByElements), and [`labelledByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaLabelledByElements).",
|
|
18649
|
+
"type": "DOMContainerAria"
|
|
18650
|
+
},
|
|
18549
18651
|
{
|
|
18550
18652
|
"name": "autoDestroyDisabled",
|
|
18551
18653
|
"type": "boolean"
|
|
@@ -18630,7 +18732,7 @@
|
|
|
18630
18732
|
},
|
|
18631
18733
|
{
|
|
18632
18734
|
"name": "position",
|
|
18633
|
-
"description": "**Deprecated**: since 4.34, use `slot` instead.. ",
|
|
18735
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
18634
18736
|
"value": {
|
|
18635
18737
|
"type": [
|
|
18636
18738
|
"\"bottom-leading\"",
|
|
@@ -18738,7 +18840,7 @@
|
|
|
18738
18840
|
},
|
|
18739
18841
|
{
|
|
18740
18842
|
"name": "view",
|
|
18741
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
18843
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Video Player component will be associated with a map or scene component rather than using the `view` property.",
|
|
18742
18844
|
"type": "MapView"
|
|
18743
18845
|
}
|
|
18744
18846
|
],
|
|
@@ -18814,7 +18916,7 @@
|
|
|
18814
18916
|
},
|
|
18815
18917
|
{
|
|
18816
18918
|
"name": "position",
|
|
18817
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
18919
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
18818
18920
|
"value": {
|
|
18819
18921
|
"type": [
|
|
18820
18922
|
"\"bottom-leading\"",
|
|
@@ -18908,7 +19010,7 @@
|
|
|
18908
19010
|
},
|
|
18909
19011
|
{
|
|
18910
19012
|
"name": "view",
|
|
18911
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
19013
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Weather component will be associated with a map or scene component rather than using the `view` property.",
|
|
18912
19014
|
"type": "SceneView"
|
|
18913
19015
|
}
|
|
18914
19016
|
],
|
|
@@ -18967,7 +19069,7 @@
|
|
|
18967
19069
|
},
|
|
18968
19070
|
{
|
|
18969
19071
|
"name": "position",
|
|
18970
|
-
"description": "**Deprecated**: since 4.34, use [`slot`](https://
|
|
19072
|
+
"description": "**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ",
|
|
18971
19073
|
"value": {
|
|
18972
19074
|
"type": [
|
|
18973
19075
|
"\"bottom-leading\"",
|
|
@@ -19056,7 +19158,7 @@
|
|
|
19056
19158
|
},
|
|
19057
19159
|
{
|
|
19058
19160
|
"name": "view",
|
|
19059
|
-
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the
|
|
19161
|
+
"description": "The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the Zoom component will be associated with a map or scene component rather than using the `view` property.",
|
|
19060
19162
|
"type": "MapView | SceneView"
|
|
19061
19163
|
}
|
|
19062
19164
|
],
|
|
@@ -19080,67 +19182,67 @@
|
|
|
19080
19182
|
"properties": [
|
|
19081
19183
|
{
|
|
19082
19184
|
"name": "--arcgis-layout-overlay-space-top",
|
|
19083
|
-
"description": "Specifies the top padding for the layout."
|
|
19185
|
+
"description": "_Since 4.34_ Specifies the top padding for the layout."
|
|
19084
19186
|
},
|
|
19085
19187
|
{
|
|
19086
19188
|
"name": "--arcgis-layout-overlay-space-bottom",
|
|
19087
|
-
"description": "Specifies the bottom padding for the layout."
|
|
19189
|
+
"description": "_Since 4.34_ Specifies the bottom padding for the layout."
|
|
19088
19190
|
},
|
|
19089
19191
|
{
|
|
19090
19192
|
"name": "--arcgis-layout-overlay-space-left",
|
|
19091
|
-
"description": "Specifies the left padding for the layout."
|
|
19193
|
+
"description": "_Since 4.34_ Specifies the left padding for the layout."
|
|
19092
19194
|
},
|
|
19093
19195
|
{
|
|
19094
19196
|
"name": "--arcgis-layout-overlay-space-right",
|
|
19095
|
-
"description": "Specifies the right padding for the layout."
|
|
19197
|
+
"description": "_Since 4.34_ Specifies the right padding for the layout."
|
|
19096
19198
|
},
|
|
19097
19199
|
{
|
|
19098
19200
|
"name": "--arcgis-layout-overlay-space-top",
|
|
19099
|
-
"description": "Specifies the top padding for the layout."
|
|
19201
|
+
"description": "_Since 4.34_ Specifies the top padding for the layout."
|
|
19100
19202
|
},
|
|
19101
19203
|
{
|
|
19102
19204
|
"name": "--arcgis-layout-overlay-space-bottom",
|
|
19103
|
-
"description": "Specifies the bottom padding for the layout."
|
|
19205
|
+
"description": "_Since 4.34_ Specifies the bottom padding for the layout."
|
|
19104
19206
|
},
|
|
19105
19207
|
{
|
|
19106
19208
|
"name": "--arcgis-layout-overlay-space-left",
|
|
19107
|
-
"description": "Specifies the left padding for the layout."
|
|
19209
|
+
"description": "_Since 4.34_ Specifies the left padding for the layout."
|
|
19108
19210
|
},
|
|
19109
19211
|
{
|
|
19110
19212
|
"name": "--arcgis-layout-overlay-space-right",
|
|
19111
|
-
"description": "Specifies the right padding for the layout."
|
|
19213
|
+
"description": "_Since 4.34_ Specifies the right padding for the layout."
|
|
19112
19214
|
},
|
|
19113
19215
|
{
|
|
19114
19216
|
"name": "--arcgis-layout-overlay-space-top",
|
|
19115
|
-
"description": "Specifies the top padding for the layout."
|
|
19217
|
+
"description": "_Since 4.34_ Specifies the top padding for the layout."
|
|
19116
19218
|
},
|
|
19117
19219
|
{
|
|
19118
19220
|
"name": "--arcgis-layout-overlay-space-bottom",
|
|
19119
|
-
"description": "Specifies the bottom padding for the layout."
|
|
19221
|
+
"description": "_Since 4.34_ Specifies the bottom padding for the layout."
|
|
19120
19222
|
},
|
|
19121
19223
|
{
|
|
19122
19224
|
"name": "--arcgis-layout-overlay-space-left",
|
|
19123
|
-
"description": "Specifies the left padding for the layout."
|
|
19225
|
+
"description": "_Since 4.34_ Specifies the left padding for the layout."
|
|
19124
19226
|
},
|
|
19125
19227
|
{
|
|
19126
19228
|
"name": "--arcgis-layout-overlay-space-right",
|
|
19127
|
-
"description": "Specifies the right padding for the layout."
|
|
19229
|
+
"description": "_Since 4.34_ Specifies the right padding for the layout."
|
|
19128
19230
|
},
|
|
19129
19231
|
{
|
|
19130
19232
|
"name": "--arcgis-layout-overlay-space-top",
|
|
19131
|
-
"description": "Specifies the top padding for the layout."
|
|
19233
|
+
"description": "_Since 4.34_ Specifies the top padding for the layout."
|
|
19132
19234
|
},
|
|
19133
19235
|
{
|
|
19134
19236
|
"name": "--arcgis-layout-overlay-space-bottom",
|
|
19135
|
-
"description": "Specifies the bottom padding for the layout."
|
|
19237
|
+
"description": "_Since 4.34_ Specifies the bottom padding for the layout."
|
|
19136
19238
|
},
|
|
19137
19239
|
{
|
|
19138
19240
|
"name": "--arcgis-layout-overlay-space-left",
|
|
19139
|
-
"description": "Specifies the left padding for the layout."
|
|
19241
|
+
"description": "_Since 4.34_ Specifies the left padding for the layout."
|
|
19140
19242
|
},
|
|
19141
19243
|
{
|
|
19142
19244
|
"name": "--arcgis-layout-overlay-space-right",
|
|
19143
|
-
"description": "Specifies the right padding for the layout."
|
|
19245
|
+
"description": "_Since 4.34_ Specifies the right padding for the layout."
|
|
19144
19246
|
}
|
|
19145
19247
|
],
|
|
19146
19248
|
"pseudo-elements": []
|