@arcgis/map-components 4.34.0-next.3 → 4.34.0-next.31
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/26DLYMMR.js +4 -0
- package/dist/cdn/2LA4GLAI.js +4 -0
- package/dist/cdn/2YQKPNDT.js +4 -0
- package/dist/cdn/36IPUTQX.js +4 -0
- package/dist/cdn/3ADIDWVI.js +4 -0
- package/dist/cdn/{F3DQMWJ6.js → 3BAWA3LT.js} +2 -2
- package/dist/cdn/3CKMW2Q7.js +4 -0
- package/dist/cdn/3PBS3Q4N.js +4 -0
- package/dist/cdn/4B5PPETT.js +4 -0
- package/dist/cdn/4BDSIGFP.js +4 -0
- package/dist/cdn/4JVOBYXB.js +4 -0
- package/dist/cdn/4LFWEY26.js +4 -0
- package/dist/cdn/4M2LSAHJ.js +4 -0
- package/dist/cdn/4VPIQFJG.js +4 -0
- package/dist/cdn/{T3BMQYR2.js → 53CKEVNM.js} +2 -2
- package/dist/cdn/{46FOHP5W.js → 5HM4DXXC.js} +1 -1
- package/dist/cdn/5O4AEJTW.js +4 -0
- package/dist/cdn/622LTAWJ.js +4 -0
- package/dist/cdn/6DLZGELR.js +4 -0
- package/dist/cdn/6HCHHWVQ.js +4 -0
- package/dist/cdn/6IIYZGAO.js +4 -0
- package/dist/cdn/6JBTZTC4.js +4 -0
- package/dist/cdn/6KYTRBQ6.js +4 -0
- package/dist/cdn/6YITMAED.js +4 -0
- package/dist/cdn/73NMUS6P.js +4 -0
- package/dist/cdn/763422CW.js +4 -0
- package/dist/cdn/7CIEE227.js +4 -0
- package/dist/cdn/7FDT4OMI.js +4 -0
- package/dist/cdn/7ICHTEBA.js +4 -0
- package/dist/cdn/7OKH4ASK.js +4 -0
- package/dist/cdn/A7K23NW5.js +4 -0
- package/dist/cdn/{VXVE4ZXP.js → AA3IOEUJ.js} +2 -2
- package/dist/cdn/ALJRY2FC.js +4 -0
- package/dist/cdn/AXKKDFUQ.js +4 -0
- package/dist/cdn/BDLQBPYG.js +5 -0
- package/dist/cdn/BFKMSLZI.js +4 -0
- package/dist/cdn/BJM2DCRK.js +4 -0
- package/dist/cdn/BLULWZYD.js +4 -0
- package/dist/cdn/BTRN7VJ4.js +4 -0
- package/dist/cdn/BXK5XOEO.js +4 -0
- package/dist/cdn/{72K6PTPA.js → C76Q4VBO.js} +1 -1
- package/dist/cdn/CAFKXOOL.js +4 -0
- package/dist/cdn/CGRDJ5UJ.js +4 -0
- package/dist/cdn/CP5OPXZE.js +4 -0
- package/dist/cdn/CPM4VQI4.js +4 -0
- package/dist/cdn/D7NYAGRB.js +4 -0
- package/dist/cdn/DC6NDRG7.js +4 -0
- package/dist/cdn/DCWCSQRU.js +4 -0
- package/dist/cdn/DDEQLPG7.js +4 -0
- package/dist/cdn/DGNKHT6U.js +4 -0
- package/dist/cdn/DNKO5WD4.js +4 -0
- package/dist/cdn/DPDKZHBS.js +4 -0
- package/dist/cdn/DZSLNGVD.js +4 -0
- package/dist/cdn/EAVO2WOK.js +4 -0
- package/dist/cdn/{OYIZFWCL.js → EBOZA7ZG.js} +2 -2
- package/dist/cdn/{MFJLKVY3.js → EHLBYAW6.js} +2 -2
- package/dist/cdn/EJ5ZDARC.js +4 -0
- package/dist/cdn/EMVUGP3L.js +4 -0
- package/dist/cdn/EUN5OD2J.js +4 -0
- package/dist/cdn/FLGTTJBB.js +4 -0
- package/dist/cdn/FPBPE422.js +4 -0
- package/dist/cdn/FQV4SUAY.js +4 -0
- package/dist/cdn/FYPTTC7V.js +4 -0
- package/dist/cdn/{3W2WGUDP.js → G3YO6G3G.js} +1 -1
- package/dist/cdn/G5TA3KVQ.js +4 -0
- package/dist/cdn/GAOEXMR7.js +4 -0
- package/dist/cdn/GIYTXCBM.js +4 -0
- package/dist/cdn/GJJOP3HC.js +4 -0
- package/dist/cdn/GQTHMU4S.js +4 -0
- package/dist/cdn/GQYM23VB.js +4 -0
- package/dist/cdn/HHSFLGQJ.js +4 -0
- package/dist/cdn/HIOV6S45.js +4 -0
- package/dist/cdn/HUEFDYUQ.js +4 -0
- package/dist/cdn/HY6VFKBI.js +4 -0
- package/dist/cdn/I2BOYOB6.js +4 -0
- package/dist/cdn/I7ZOGENV.js +4 -0
- package/dist/cdn/IBCDVZKK.js +4 -0
- package/dist/cdn/{4IQYTQIS.js → IBLIJAUY.js} +2 -2
- package/dist/cdn/IHNSXSRB.js +4 -0
- package/dist/cdn/JCGEWIZJ.js +4 -0
- package/dist/cdn/JPP4VR4A.js +4 -0
- package/dist/cdn/K4AVZIZY.js +4 -0
- package/dist/cdn/K6D6OMQR.js +4 -0
- package/dist/cdn/KHUZW65E.js +4 -0
- package/dist/cdn/{WUICCK44.js → KKG33AH4.js} +2 -2
- package/dist/cdn/KP24HLQQ.js +4 -0
- package/dist/cdn/KWFYJ3PH.js +4 -0
- package/dist/cdn/KY7UB4SK.js +4 -0
- package/dist/cdn/LBKPOWHT.js +4 -0
- package/dist/cdn/LEJJWBPC.js +4 -0
- package/dist/cdn/LF6WKLSP.js +4 -0
- package/dist/cdn/{PQBBBIQU.js → LIWDJPSV.js} +2 -2
- package/dist/cdn/LQMXJQBO.js +4 -0
- package/dist/cdn/LTQN4UYJ.js +4 -0
- package/dist/cdn/LUGQJB5O.js +4 -0
- package/dist/cdn/M3ED5O6F.js +4 -0
- package/dist/cdn/M6FUVO53.js +4 -0
- package/dist/cdn/M7QHUCKP.js +4 -0
- package/dist/cdn/MI4KV3CX.js +4 -0
- package/dist/cdn/MN3XLBQS.js +4 -0
- package/dist/cdn/MSP4TFNY.js +4 -0
- package/dist/cdn/MZU5L2JD.js +4 -0
- package/dist/cdn/NATL267K.js +4 -0
- package/dist/cdn/NBEZ3HD2.js +4 -0
- package/dist/cdn/NEFKVILA.js +4 -0
- package/dist/cdn/NLEHYGIW.js +4 -0
- package/dist/cdn/NS3FMAYW.js +4 -0
- package/dist/cdn/NTF525KK.js +4 -0
- package/dist/cdn/{EGAU2GAK.js → O5UBAPDN.js} +2 -2
- package/dist/cdn/OATNAOVF.js +4 -0
- package/dist/cdn/OFAQC3GS.js +4 -0
- package/dist/cdn/OMVHEDLC.js +4 -0
- package/dist/cdn/OY36GFUB.js +4 -0
- package/dist/cdn/PAWTXHBY.js +4 -0
- package/dist/cdn/PEXNMK5Q.js +4 -0
- package/dist/cdn/PS62UU6E.js +4 -0
- package/dist/cdn/PUJ23HZE.js +4 -0
- package/dist/cdn/Q7LO7KLU.js +4 -0
- package/dist/cdn/Q7WVYIOB.js +4 -0
- package/dist/cdn/{5R5OWXAQ.js → QGT5ESJQ.js} +2 -2
- package/dist/cdn/QR7K3RUL.js +4 -0
- package/dist/cdn/QROWDO6U.js +4 -0
- package/dist/cdn/QXPJFR6H.js +4 -0
- package/dist/cdn/QZ53U2T6.js +4 -0
- package/dist/cdn/R2URNESZ.js +4 -0
- package/dist/cdn/{LP4I37RY.js → R4CT2F7F.js} +1 -1
- package/dist/cdn/R5LSLUTP.js +4 -0
- package/dist/cdn/R5OKIQET.js +4 -0
- package/dist/cdn/RDRAZMZM.js +4 -0
- package/dist/cdn/RIZJRT6Y.js +4 -0
- package/dist/cdn/RKBMMJM2.js +4 -0
- package/dist/cdn/{N4BQ2M5C.js → RNPVFMQ7.js} +2 -2
- package/dist/cdn/RNSKJ3XA.js +4 -0
- package/dist/cdn/RT46PA45.js +4 -0
- package/dist/cdn/RUSYF6NM.js +4 -0
- package/dist/cdn/SD3UUDRY.js +4 -0
- package/dist/cdn/SMCJKPQM.js +4 -0
- package/dist/cdn/SS2ZFJPC.js +4 -0
- package/dist/cdn/T7L24I5I.js +4 -0
- package/dist/cdn/{5YG75FR4.js → TAOTWWKU.js} +4 -4
- package/dist/cdn/TDYYD2N6.js +4 -0
- package/dist/cdn/TLVAT3AY.js +4 -0
- package/dist/cdn/TOLZJFGD.js +4 -0
- package/dist/cdn/TT3YIOPW.js +4 -0
- package/dist/cdn/U3PE5XKO.js +4 -0
- package/dist/cdn/U6I77C3G.js +4 -0
- package/dist/cdn/{TG4WOIVN.js → U75MZFTX.js} +2 -2
- package/dist/cdn/UARKWXHU.js +4 -0
- package/dist/cdn/UJUODCMJ.js +4 -0
- package/dist/cdn/UMI4O723.js +4 -0
- package/dist/cdn/UPSUYH4Y.js +4 -0
- package/dist/cdn/UT7UMC7K.js +4 -0
- package/dist/cdn/UVSB6JMI.js +4 -0
- package/dist/cdn/VHTHRPHC.js +4 -0
- package/dist/cdn/VUJ4WOH2.js +4 -0
- package/dist/cdn/VY4W7K6V.js +4 -0
- package/dist/cdn/WEAXSAF7.js +4 -0
- package/dist/cdn/{Y3HMAR44.js → WFZBPWEW.js} +1 -1
- package/dist/cdn/WL4DZY4L.js +4 -0
- package/dist/cdn/WLZHIEET.js +4 -0
- package/dist/cdn/WP7TCQS6.js +4 -0
- package/dist/cdn/WY2V34L5.js +4 -0
- package/dist/cdn/XBK7M2JX.js +4 -0
- package/dist/cdn/XCPXCNRD.js +4 -0
- package/dist/cdn/{ZDO5M5ZH.js → XQ5YJ6DC.js} +2 -2
- package/dist/cdn/XRYJX5GI.js +4 -0
- package/dist/cdn/XXMM7VGN.js +4 -0
- package/dist/cdn/XZ64KGLO.js +4 -0
- package/dist/cdn/YCXS4EZW.js +4 -0
- package/dist/cdn/{363OWKVL.js → YOHULSJK.js} +2 -2
- package/dist/cdn/YTCIMUZ4.js +4 -0
- package/dist/cdn/YXERGQ66.js +4 -0
- package/dist/cdn/YXWPO6AK.js +4 -0
- package/dist/cdn/Z2A3RVER.js +4 -0
- package/dist/cdn/ZB3SR2RL.js +4 -0
- package/dist/cdn/ZBCV3H2S.js +4 -0
- package/dist/cdn/ZBVID3H2.js +4 -0
- package/dist/cdn/ZE6RGNFJ.js +4 -0
- package/dist/cdn/ZFOERVH2.js +4 -0
- package/dist/cdn/{D4UC6YNK.js → ZKBCJP4L.js} +2 -2
- package/dist/cdn/ZNVU7M2F.js +4 -0
- package/dist/cdn/{BRHFFFB6.js → ZR3PDZ5Q.js} +1 -1
- package/dist/cdn/assets/feature/t9n/messages.ar.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.bg.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.bs.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ca.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.cs.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.da.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.de.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.el.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.en.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.es.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.et.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.fi.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.fr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.he.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.hr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.hu.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.id.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.it.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ja.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ko.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.lt.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.lv.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.nl.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.no.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.pl.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.pt-BR.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.pt-PT.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ro.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ru.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sk.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sl.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sv.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.th.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.tr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.uk.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.vi.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.zh-CN.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.zh-HK.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.zh-TW.json +1 -0
- package/dist/cdn/index.js +2 -2
- package/dist/chunks/AnalysisViewModel.js +1 -1
- package/dist/chunks/async-utils.js +1 -1
- package/dist/chunks/basemap-gallery-resources.js +1 -1
- package/dist/chunks/chart-utils.js +66 -0
- package/dist/chunks/chartCommon.js +19 -0
- package/dist/chunks/component-utils.js +1 -1
- package/dist/chunks/createCloseEvent.js +1 -1
- package/dist/chunks/feature-utils.js +145 -0
- package/dist/chunks/globalCss.js +2 -1
- package/dist/chunks/heading.js +1 -1
- package/dist/chunks/layer-list.js +1 -1
- package/dist/chunks/legacyIcon.js +1 -1
- package/dist/chunks/maybe.js +1 -1
- package/dist/chunks/measurementUtils.js +1 -1
- package/dist/chunks/runtime.js +1 -1
- package/dist/chunks/useHandles.js +4 -4
- package/dist/chunks/useT9n.js +1 -1
- package/dist/chunks/useView.js +1 -1
- package/dist/chunks/useViewModel.js +1 -1
- package/dist/chunks/useWidget.js +1 -1
- package/dist/chunks/utils.js +1 -1
- package/dist/components/arcgis-area-measurement-2d/customElement.d.ts +5 -0
- package/dist/components/arcgis-area-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-area-measurement-3d/customElement.d.ts +111 -9
- package/dist/components/arcgis-area-measurement-3d/customElement.js +3 -6
- package/dist/components/arcgis-attachments/customElement.d.ts +6 -1
- package/dist/components/arcgis-attachments/customElement.js +1 -1
- package/dist/components/arcgis-basemap-gallery/customElement.d.ts +10 -1
- package/dist/components/arcgis-basemap-gallery/customElement.js +1 -1
- package/dist/components/arcgis-basemap-gallery-item/customElement.js +1 -1
- package/dist/components/arcgis-basemap-layer-list/customElement.d.ts +5 -0
- package/dist/components/arcgis-basemap-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-basemap-toggle/customElement.d.ts +11 -2
- package/dist/components/arcgis-basemap-toggle/customElement.js +5 -5
- package/dist/components/arcgis-bookmarks/customElement.d.ts +6 -3
- package/dist/components/arcgis-bookmarks/customElement.js +1 -1
- package/dist/components/arcgis-building-explorer/customElement.d.ts +26 -14
- package/dist/components/arcgis-building-explorer/customElement.js +1 -1
- package/dist/components/arcgis-catalog-layer-list/customElement.d.ts +5 -0
- package/dist/components/arcgis-catalog-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-compass/customElement.d.ts +10 -1
- package/dist/components/arcgis-compass/customElement.js +1 -1
- package/dist/components/arcgis-coordinate-conversion/customElement.d.ts +6 -1
- package/dist/components/arcgis-coordinate-conversion/customElement.js +3 -3
- package/dist/components/arcgis-daylight/customElement.d.ts +27 -13
- package/dist/components/arcgis-daylight/customElement.js +1 -1
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.d.ts +112 -9
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.js +3 -6
- package/dist/components/arcgis-directional-pad/customElement.d.ts +10 -1
- package/dist/components/arcgis-directional-pad/customElement.js +1 -1
- package/dist/components/arcgis-directions/customElement.d.ts +6 -1
- package/dist/components/arcgis-directions/customElement.js +1 -1
- package/dist/components/arcgis-distance-measurement-2d/customElement.d.ts +5 -0
- package/dist/components/arcgis-distance-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-editor/customElement.d.ts +5 -0
- package/dist/components/arcgis-editor/customElement.js +1 -1
- package/dist/components/arcgis-elevation-profile/customElement.d.ts +28 -20
- package/dist/components/arcgis-elevation-profile/customElement.js +1 -1
- package/dist/components/arcgis-expand/customElement.d.ts +8 -2
- package/dist/components/arcgis-expand/customElement.js +1 -1
- package/dist/components/arcgis-feature/customElement.d.ts +6 -1
- package/dist/components/arcgis-feature/customElement.js +10 -9
- package/dist/components/arcgis-feature-attachments/customElement.d.ts +15 -0
- package/dist/components/arcgis-feature-attachments/customElement.js +24 -0
- package/dist/components/arcgis-feature-attachments/index.d.ts +3 -0
- package/dist/components/arcgis-feature-attachments/index.js +3 -0
- package/dist/components/arcgis-feature-content/customElement.d.ts +11 -0
- package/dist/components/arcgis-feature-content/customElement.js +66 -0
- package/dist/components/arcgis-feature-content/index.d.ts +2 -0
- package/dist/components/arcgis-feature-content/index.js +2 -0
- package/dist/components/arcgis-feature-element-info/customElement.d.ts +11 -0
- package/dist/components/arcgis-feature-element-info/customElement.js +39 -0
- package/dist/components/arcgis-feature-element-info/index.d.ts +1 -0
- package/dist/components/arcgis-feature-element-info/index.js +1 -0
- package/dist/components/arcgis-feature-fields/customElement.d.ts +16 -0
- package/dist/components/arcgis-feature-fields/customElement.js +141 -0
- package/dist/components/arcgis-feature-fields/index.d.ts +2 -0
- package/dist/components/arcgis-feature-fields/index.js +2 -0
- package/dist/components/arcgis-feature-form/customElement.d.ts +6 -1
- package/dist/components/arcgis-feature-form/customElement.js +1 -1
- package/dist/components/arcgis-feature-media/chartCommon.d.ts +1 -0
- package/dist/components/arcgis-feature-media/customElement.d.ts +37 -0
- package/dist/components/arcgis-feature-media/customElement.js +575 -0
- package/dist/components/arcgis-feature-media/index.d.ts +3 -0
- package/dist/components/arcgis-feature-media/index.js +3 -0
- package/dist/components/arcgis-feature-table/customElement.d.ts +7 -1
- package/dist/components/arcgis-feature-table/customElement.js +1 -1
- package/dist/components/arcgis-feature-templates/customElement.d.ts +5 -0
- package/dist/components/arcgis-feature-templates/customElement.js +1 -1
- package/dist/components/arcgis-features/customElement.d.ts +5 -0
- package/dist/components/arcgis-features/customElement.js +1 -1
- package/dist/components/arcgis-floor-filter/customElement.d.ts +5 -0
- package/dist/components/arcgis-floor-filter/customElement.js +1 -1
- package/dist/components/arcgis-fullscreen/customElement.d.ts +16 -1
- package/dist/components/arcgis-fullscreen/customElement.js +1 -1
- package/dist/components/arcgis-grid-controls/customElement.d.ts +10 -1
- package/dist/components/arcgis-grid-controls/customElement.js +1 -1
- package/dist/components/arcgis-histogram-range-slider/customElement.d.ts +5 -0
- package/dist/components/arcgis-histogram-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-home/customElement.d.ts +23 -12
- package/dist/components/arcgis-home/customElement.js +1 -1
- package/dist/components/arcgis-labeled-switch/customElement.js +1 -1
- package/dist/components/arcgis-layer-list/customElement.d.ts +5 -0
- 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 +5 -0
- package/dist/components/arcgis-legend/customElement.js +1 -1
- package/dist/components/arcgis-line-of-sight/customElement.d.ts +75 -19
- package/dist/components/arcgis-line-of-sight/customElement.js +10 -13
- package/dist/components/arcgis-link-chart/customElement.d.ts +19 -9
- package/dist/components/arcgis-link-chart/customElement.js +14 -5
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.d.ts +13 -2
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.js +25 -26
- package/dist/components/arcgis-link-chart-layout-switcher/index.d.ts +1 -2
- package/dist/components/arcgis-link-chart-layout-switcher/index.js +1 -2
- package/dist/components/arcgis-locate/customElement.d.ts +17 -5
- package/dist/components/arcgis-locate/customElement.js +29 -29
- package/dist/components/arcgis-map/customElement.d.ts +27 -14
- package/dist/components/arcgis-map/customElement.js +25 -14
- package/dist/components/arcgis-measurement/customElement.d.ts +5 -0
- 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 +17 -13
- package/dist/components/arcgis-navigation-toggle/customElement.js +14 -11
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.d.ts +5 -0
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.js +1 -1
- package/dist/components/arcgis-placement/customElement.d.ts +5 -0
- package/dist/components/arcgis-placement/customElement.js +1 -1
- package/dist/components/arcgis-print/customElement.d.ts +54 -40
- package/dist/components/arcgis-print/customElement.js +39 -33
- package/dist/components/arcgis-print-custom-text-elements/customElement.js +1 -1
- package/dist/components/arcgis-print-dpi-input/customElement.js +18 -23
- package/dist/components/arcgis-print-export-button/customElement.d.ts +1 -7
- package/dist/components/arcgis-print-export-button/customElement.js +3 -4
- package/dist/components/arcgis-print-exported-link/customElement.js +1 -1
- package/dist/components/arcgis-print-exports-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-format-select/customElement.js +1 -1
- package/dist/components/arcgis-print-layout-advanced-options/customElement.js +1 -1
- package/dist/components/arcgis-print-layout-panel/customElement.d.ts +1 -7
- package/dist/components/arcgis-print-layout-panel/customElement.js +8 -8
- package/dist/components/arcgis-print-main-panel/customElement.d.ts +1 -7
- package/dist/components/arcgis-print-main-panel/customElement.js +8 -8
- package/dist/components/arcgis-print-map-only-advanced-options/customElement.js +1 -1
- package/dist/components/arcgis-print-map-only-panel/customElement.d.ts +1 -7
- package/dist/components/arcgis-print-map-only-panel/customElement.js +28 -22
- package/dist/components/arcgis-print-out-spatial-reference-input/customElement.js +23 -18
- package/dist/components/arcgis-print-preview-input/customElement.js +1 -1
- package/dist/components/arcgis-print-scale-section/customElement.js +26 -19
- package/dist/components/arcgis-print-template-select/customElement.js +1 -1
- package/dist/components/arcgis-print-template-selector/customElement.js +1 -1
- package/dist/components/arcgis-scale-bar/customElement.d.ts +11 -2
- package/dist/components/arcgis-scale-bar/customElement.js +1 -1
- package/dist/components/arcgis-scale-range-slider/customElement.d.ts +5 -0
- package/dist/components/arcgis-scale-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-scene/customElement.d.ts +143 -80
- package/dist/components/arcgis-scene/customElement.js +27 -16
- package/dist/components/arcgis-search/customElement.d.ts +46 -16
- package/dist/components/arcgis-search/customElement.js +39 -36
- package/dist/components/arcgis-search-result-renderer/customElement.js +1 -1
- package/dist/components/arcgis-shadow-cast/customElement.d.ts +92 -30
- package/dist/components/arcgis-shadow-cast/customElement.js +1 -1
- package/dist/components/arcgis-sketch/customElement.d.ts +5 -0
- package/dist/components/arcgis-sketch/customElement.js +27 -19
- package/dist/components/arcgis-slice/customElement.d.ts +77 -18
- package/dist/components/arcgis-slice/customElement.js +2 -2
- package/dist/components/arcgis-slider/customElement.d.ts +5 -0
- package/dist/components/arcgis-slider/customElement.js +1 -1
- package/dist/components/arcgis-swipe/customElement.d.ts +11 -2
- package/dist/components/arcgis-swipe/customElement.js +1 -1
- package/dist/components/arcgis-table-list/customElement.d.ts +5 -0
- package/dist/components/arcgis-table-list/customElement.js +1 -1
- package/dist/components/arcgis-time-slider/customElement.d.ts +5 -0
- package/dist/components/arcgis-time-slider/customElement.js +1 -1
- package/dist/components/arcgis-time-zone-label/customElement.d.ts +3 -1
- package/dist/components/arcgis-time-zone-label/customElement.js +1 -1
- package/dist/components/arcgis-track/customElement.d.ts +26 -9
- package/dist/components/arcgis-track/customElement.js +1 -1
- package/dist/components/arcgis-unit-select/customElement.d.ts +5 -1
- package/dist/components/arcgis-unit-select/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-associations/customElement.d.ts +16 -13
- package/dist/components/arcgis-utility-network-associations/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-trace/customElement.d.ts +6 -1
- package/dist/components/arcgis-utility-network-trace/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-validate-topology/customElement.d.ts +5 -0
- package/dist/components/arcgis-utility-network-validate-topology/customElement.js +1 -1
- package/dist/components/arcgis-value-picker/customElement.d.ts +5 -0
- package/dist/components/arcgis-value-picker/customElement.js +1 -1
- package/dist/components/arcgis-version-management/customElement.d.ts +14 -5
- package/dist/components/arcgis-version-management/customElement.js +48 -50
- package/dist/components/arcgis-version-management-service-item/customElement.d.ts +0 -1
- package/dist/components/arcgis-version-management-service-item/customElement.js +19 -20
- package/dist/components/arcgis-version-management-version-item/customElement.d.ts +0 -1
- package/dist/components/arcgis-version-management-version-item/customElement.js +11 -11
- package/dist/components/arcgis-version-management-version-list/customElement.d.ts +0 -1
- package/dist/components/arcgis-version-management-version-list/customElement.js +19 -22
- package/dist/components/arcgis-version-management-version-properties/customElement.d.ts +0 -1
- package/dist/components/arcgis-version-management-version-properties/customElement.js +45 -45
- package/dist/components/arcgis-video/customElement.d.ts +20 -9
- package/dist/components/arcgis-video/customElement.js +10 -19
- package/dist/components/arcgis-video-player/customElement.d.ts +23 -5
- package/dist/components/arcgis-video-player/customElement.js +32 -26
- package/dist/components/arcgis-video-player-action-bar/customElement.js +1 -1
- package/dist/components/arcgis-video-player-actions-group/customElement.js +1 -1
- package/dist/components/arcgis-video-player-controls-group/customElement.js +12 -12
- package/dist/components/arcgis-video-player-metadata/customElement.js +2 -2
- package/dist/components/arcgis-video-player-settings/customElement.js +2 -2
- package/dist/components/arcgis-video-player-slider/customElement.js +1 -1
- package/dist/components/arcgis-weather/customElement.d.ts +52 -3
- package/dist/components/arcgis-weather/customElement.js +2 -2
- package/dist/components/arcgis-zoom/customElement.d.ts +10 -1
- package/dist/components/arcgis-zoom/customElement.js +1 -1
- package/dist/controllers/Handles.d.ts +2 -2
- package/dist/controllers/useHandles.d.ts +4 -4
- package/dist/docs/api.json +1381 -495
- package/dist/docs/docs.json +1119 -509
- package/dist/docs/vscode.html-custom-data.json +195 -102
- package/dist/docs/web-types.json +421 -230
- package/dist/geolocation/GeolocationPositioning.d.ts +5 -6
- package/dist/index.d.ts +3 -0
- package/dist/index.js +1 -1
- package/dist/loader.js +20 -15
- package/dist/types/lumina.d.ts +15 -12
- package/dist/types/preact.d.ts +15 -12
- package/dist/types/react.d.ts +15 -12
- package/dist/types/stencil.d.ts +15 -12
- package/dist/utils/chart-utils.d.ts +6 -0
- package/dist/utils/feature-utils.d.ts +30 -0
- package/dist/utils/related-feature-utils.d.ts +17 -0
- package/dist/utils/uri-utils.d.ts +4 -0
- package/package.json +5 -4
- package/dist/cdn/2DEASVZD.js +0 -4
- package/dist/cdn/2ESEAIA5.js +0 -4
- package/dist/cdn/46DOZMHG.js +0 -4
- package/dist/cdn/46NE5CD2.js +0 -4
- package/dist/cdn/4H2W5GYD.js +0 -4
- package/dist/cdn/4QRBF4FC.js +0 -4
- package/dist/cdn/4USUAQ3M.js +0 -4
- package/dist/cdn/4XMBZYKO.js +0 -4
- package/dist/cdn/56EGKCO3.js +0 -4
- package/dist/cdn/5VXQTBEA.js +0 -4
- package/dist/cdn/67UXLU2S.js +0 -4
- package/dist/cdn/6EE4JJ2I.js +0 -4
- package/dist/cdn/6K7QBAMI.js +0 -4
- package/dist/cdn/6X6BDLCA.js +0 -4
- package/dist/cdn/6Z56X76F.js +0 -4
- package/dist/cdn/7AXRMMLJ.js +0 -4
- package/dist/cdn/7L5XBWYD.js +0 -4
- package/dist/cdn/ALUNHIFF.js +0 -4
- package/dist/cdn/BKWCCZ53.js +0 -4
- package/dist/cdn/BOZBPEOQ.js +0 -4
- package/dist/cdn/C2GRKYPA.js +0 -4
- package/dist/cdn/C5VB62EV.js +0 -4
- package/dist/cdn/CQMPO2FO.js +0 -4
- package/dist/cdn/CV25FGWS.js +0 -4
- package/dist/cdn/CWRD56OW.js +0 -4
- package/dist/cdn/DPC4BXUO.js +0 -4
- package/dist/cdn/DVRWN2X3.js +0 -4
- package/dist/cdn/DWMAF3AB.js +0 -4
- package/dist/cdn/FGMM6TLQ.js +0 -4
- package/dist/cdn/GKQV3GV7.js +0 -4
- package/dist/cdn/GOEEX3IG.js +0 -4
- package/dist/cdn/H34JBL4Z.js +0 -4
- package/dist/cdn/HAFNNW3D.js +0 -4
- package/dist/cdn/HJBXOC2I.js +0 -4
- package/dist/cdn/HLKSYNBA.js +0 -4
- package/dist/cdn/HQEQV3QC.js +0 -4
- package/dist/cdn/JCQD3YNR.js +0 -4
- package/dist/cdn/JDTYQCZK.js +0 -4
- package/dist/cdn/JI6FC2KZ.js +0 -4
- package/dist/cdn/JLCRXIKZ.js +0 -4
- package/dist/cdn/JP5O6B5F.js +0 -4
- package/dist/cdn/JV24GCAP.js +0 -4
- package/dist/cdn/K7UZ42V3.js +0 -4
- package/dist/cdn/KXYEAIS4.js +0 -4
- package/dist/cdn/L3OI72NI.js +0 -4
- package/dist/cdn/LEGQAMIG.js +0 -4
- package/dist/cdn/LUJBBH5J.js +0 -4
- package/dist/cdn/LXPDH2BL.js +0 -4
- package/dist/cdn/M3YHSP3I.js +0 -4
- package/dist/cdn/MSKYKJCN.js +0 -4
- package/dist/cdn/MT5RQBAH.js +0 -4
- package/dist/cdn/MZ4A2RS4.js +0 -4
- package/dist/cdn/N2AWMIHG.js +0 -4
- package/dist/cdn/NFP7KMGH.js +0 -4
- package/dist/cdn/NNWDJSAH.js +0 -4
- package/dist/cdn/O7ZKXOTB.js +0 -4
- package/dist/cdn/OYUETUJJ.js +0 -4
- package/dist/cdn/PPUKTTQ3.js +0 -4
- package/dist/cdn/PYZLIY6P.js +0 -4
- package/dist/cdn/QPFJHO6Q.js +0 -4
- package/dist/cdn/QSM7LMGZ.js +0 -4
- package/dist/cdn/REMEYP6N.js +0 -4
- package/dist/cdn/RFMOKDOF.js +0 -4
- package/dist/cdn/RNXSFATM.js +0 -4
- package/dist/cdn/RURKZO7X.js +0 -4
- package/dist/cdn/S2O5QLCT.js +0 -4
- package/dist/cdn/SHCBXBY3.js +0 -4
- package/dist/cdn/SLDQ2YZY.js +0 -4
- package/dist/cdn/SWDKYZ6Z.js +0 -4
- package/dist/cdn/TJN54QWM.js +0 -4
- package/dist/cdn/TNVEJWIO.js +0 -4
- package/dist/cdn/TRPGUDFV.js +0 -4
- package/dist/cdn/TXZALV35.js +0 -4
- package/dist/cdn/U2HHRTN2.js +0 -4
- package/dist/cdn/V2RJSRTT.js +0 -4
- package/dist/cdn/V45UQX3A.js +0 -4
- package/dist/cdn/V4COQWPL.js +0 -4
- package/dist/cdn/V5ZNHCME.js +0 -4
- package/dist/cdn/VIDQXKDI.js +0 -4
- package/dist/cdn/VQD7JRM4.js +0 -4
- package/dist/cdn/W3XQBJXS.js +0 -4
- package/dist/cdn/WG47QYRW.js +0 -4
- package/dist/cdn/WQJO5G7X.js +0 -4
- package/dist/cdn/WY2EGIGS.js +0 -4
- package/dist/cdn/XFRS3WPC.js +0 -4
- package/dist/cdn/XRRL7PHW.js +0 -4
- package/dist/cdn/XUU76GOK.js +0 -4
- package/dist/cdn/Y5DTQNYQ.js +0 -4
- package/dist/cdn/Y5TCYX4Y.js +0 -4
- package/dist/cdn/YPOT4P5O.js +0 -4
- package/dist/cdn/Z5HH6M3E.js +0 -4
- package/dist/cdn/Z5JQ33M4.js +0 -4
- package/dist/cdn/ZAORUVUH.js +0 -4
- package/dist/cdn/ZEVG6CNZ.js +0 -4
- package/dist/cdn/ZHMO3DWS.js +0 -4
- package/dist/cdn/ZS3C5VPV.js +0 -4
- package/dist/cdn/ZUXJIOON.js +0 -4
package/dist/docs/docs.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
{
|
|
2
|
-
"timestamp": "2025-
|
|
2
|
+
"timestamp": "2025-06-20T04:44:58",
|
|
3
3
|
"compiler": {
|
|
4
4
|
"name": "@arcgis/lumina-compiler",
|
|
5
|
-
"version": "4.34.0-next.
|
|
5
|
+
"version": "4.34.0-next.31",
|
|
6
6
|
"typescriptVersion": "5.8.3"
|
|
7
7
|
},
|
|
8
8
|
"components": [
|
|
@@ -176,8 +176,13 @@
|
|
|
176
176
|
"mutable": true,
|
|
177
177
|
"attr": "reference-element",
|
|
178
178
|
"reflectToAttr": false,
|
|
179
|
-
"docs": "",
|
|
180
|
-
"docsTags": [
|
|
179
|
+
"docs": "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.",
|
|
180
|
+
"docsTags": [
|
|
181
|
+
{
|
|
182
|
+
"name": "see",
|
|
183
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
184
|
+
}
|
|
185
|
+
],
|
|
181
186
|
"values": [
|
|
182
187
|
{
|
|
183
188
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -410,7 +415,7 @@
|
|
|
410
415
|
"docsTags": [
|
|
411
416
|
{
|
|
412
417
|
"name": "example",
|
|
413
|
-
"text": "
|
|
418
|
+
"text": "```js\nconst arcgisAreaMeasurement2d = document.querySelector(\"arcgis-area-measurement-2d\");\ndocument.body.append(arcgisAreaMeasurement2d);\nawait arcgisAreaMeasurement2d.componentOnReady();\nconsole.log(\"arcgis-area-measurement-2d is ready to go!\");\n```"
|
|
414
419
|
},
|
|
415
420
|
{
|
|
416
421
|
"name": "inheritedFrom",
|
|
@@ -506,7 +511,7 @@
|
|
|
506
511
|
"overview": "",
|
|
507
512
|
"readme": "",
|
|
508
513
|
"usage": {},
|
|
509
|
-
"docs": "The Area Measurement 3D component
|
|
514
|
+
"docs": "The Area Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent to calculate and display area and perimeter of polygons.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow the area and perimeter are computed depends on the scene's spatial reference and the length of the measured perimeter.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- If the measurement's perimeter is below 100 km, they are computed in a Euclidean manner,\n in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets).\n- If the perimeter is above 100 km, they are computed geodetically, and the visualization takes\n the curvature of the planet into consideration.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, the area and perimeter\nare always calculated in a Euclidean manner (in their respective PCS).\n\nThe area may be visualized and calculated in two ways:\n1. If all the vertices are mostly coplanar (lying on the same plane),\n the measurement polygon is formed on that plane, and area and perimeter are calculated from its geometry.\n2. If the vertices don't form a planar surface, the measurement polygon\n is projected to a horizontal plane, and area and perimeter are calculated from its geometry.\n\n\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\n\n**Things to consider**\n\n* Area Measurement 3D is designed to work in the Scene component. For measurements in the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Area Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/).\n* Snapping is enabled by default. Holding the `CTRL` key disables it.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)",
|
|
510
515
|
"docsTags": [
|
|
511
516
|
{
|
|
512
517
|
"name": "superclass",
|
|
@@ -534,13 +539,8 @@
|
|
|
534
539
|
},
|
|
535
540
|
"mutable": true,
|
|
536
541
|
"reflectToAttr": false,
|
|
537
|
-
"docs": "",
|
|
538
|
-
"docsTags": [
|
|
539
|
-
{
|
|
540
|
-
"name": "readonly",
|
|
541
|
-
"text": ""
|
|
542
|
-
}
|
|
543
|
-
],
|
|
542
|
+
"docs": "The [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Area Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst areaMeasurementAnalysis = new AreaMeasurementAnalysis({\n geometry: new Polygon({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n rings: [\n [\n [-13624861.22274897, 4550346.5519295, 63.378210234455764],\n [-13624935.305160372, 4550273.144585712, 63.37829629518092],\n [-13624995.61798748, 4550334.030096778, 63.37819860037416],\n [-13624921.53589075, 4550407.42357004, 63.3783810287714],\n [-13624861.22274897, 4550346.5519295, 63.378210234455764]\n ]\n ]\n })\n});\n// Get the Scene and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst areaMeasurement3d = document.querySelector(\"arcgis-area-measurement-3d\");\nawait areaMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(areaMeasurementAnalysis);\n// Connect the analysis to the measurement component:\nareaMeasurement3d.analysis = areaMeasurementAnalysis;\n```",
|
|
543
|
+
"docsTags": [],
|
|
544
544
|
"values": [],
|
|
545
545
|
"optional": true,
|
|
546
546
|
"required": false
|
|
@@ -697,8 +697,13 @@
|
|
|
697
697
|
"mutable": true,
|
|
698
698
|
"attr": "reference-element",
|
|
699
699
|
"reflectToAttr": false,
|
|
700
|
-
"docs": "",
|
|
701
|
-
"docsTags": [
|
|
700
|
+
"docs": "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.",
|
|
701
|
+
"docsTags": [
|
|
702
|
+
{
|
|
703
|
+
"name": "see",
|
|
704
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
705
|
+
}
|
|
706
|
+
],
|
|
702
707
|
"values": [
|
|
703
708
|
{
|
|
704
709
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -727,8 +732,13 @@
|
|
|
727
732
|
"mutable": true,
|
|
728
733
|
"attr": "state",
|
|
729
734
|
"reflectToAttr": true,
|
|
730
|
-
"docs": "The
|
|
731
|
-
"docsTags": [
|
|
735
|
+
"docs": "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",
|
|
736
|
+
"docsTags": [
|
|
737
|
+
{
|
|
738
|
+
"name": "readonly",
|
|
739
|
+
"text": ""
|
|
740
|
+
}
|
|
741
|
+
],
|
|
732
742
|
"values": [
|
|
733
743
|
{
|
|
734
744
|
"value": "disabled",
|
|
@@ -761,7 +771,7 @@
|
|
|
761
771
|
"mutable": true,
|
|
762
772
|
"attr": "unit",
|
|
763
773
|
"reflectToAttr": false,
|
|
764
|
-
"docs": "Unit system (imperial, metric) or specific unit used for displaying the
|
|
774
|
+
"docs": "Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
765
775
|
"docsTags": [],
|
|
766
776
|
"values": [
|
|
767
777
|
{
|
|
@@ -848,7 +858,7 @@
|
|
|
848
858
|
},
|
|
849
859
|
"mutable": true,
|
|
850
860
|
"reflectToAttr": false,
|
|
851
|
-
"docs": "List of unit systems (imperial, metric)
|
|
861
|
+
"docs": "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.",
|
|
852
862
|
"docsTags": [],
|
|
853
863
|
"values": [],
|
|
854
864
|
"optional": true,
|
|
@@ -876,7 +886,7 @@
|
|
|
876
886
|
},
|
|
877
887
|
"signature": "clear(): Promise<void>",
|
|
878
888
|
"parameters": [],
|
|
879
|
-
"docs": "",
|
|
889
|
+
"docs": "Clears the current measurement.",
|
|
880
890
|
"docsTags": []
|
|
881
891
|
},
|
|
882
892
|
{
|
|
@@ -903,7 +913,7 @@
|
|
|
903
913
|
"docsTags": [
|
|
904
914
|
{
|
|
905
915
|
"name": "example",
|
|
906
|
-
"text": "
|
|
916
|
+
"text": "```js\nconst arcgisAreaMeasurement3d = document.querySelector(\"arcgis-area-measurement-3d\");\ndocument.body.append(arcgisAreaMeasurement3d);\nawait arcgisAreaMeasurement3d.componentOnReady();\nconsole.log(\"arcgis-area-measurement-3d is ready to go!\");\n```"
|
|
907
917
|
},
|
|
908
918
|
{
|
|
909
919
|
"name": "inheritedFrom",
|
|
@@ -954,7 +964,7 @@
|
|
|
954
964
|
},
|
|
955
965
|
"signature": "start(): Promise<void>",
|
|
956
966
|
"parameters": [],
|
|
957
|
-
"docs": "",
|
|
967
|
+
"docs": "Starts a new measurement.",
|
|
958
968
|
"docsTags": []
|
|
959
969
|
}
|
|
960
970
|
],
|
|
@@ -1417,8 +1427,13 @@
|
|
|
1417
1427
|
"mutable": true,
|
|
1418
1428
|
"attr": "reference-element",
|
|
1419
1429
|
"reflectToAttr": false,
|
|
1420
|
-
"docs": "",
|
|
1421
|
-
"docsTags": [
|
|
1430
|
+
"docs": "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.",
|
|
1431
|
+
"docsTags": [
|
|
1432
|
+
{
|
|
1433
|
+
"name": "see",
|
|
1434
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
1435
|
+
}
|
|
1436
|
+
],
|
|
1422
1437
|
"values": [
|
|
1423
1438
|
{
|
|
1424
1439
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -1524,7 +1539,7 @@
|
|
|
1524
1539
|
"docsTags": [
|
|
1525
1540
|
{
|
|
1526
1541
|
"name": "example",
|
|
1527
|
-
"text": "
|
|
1542
|
+
"text": "```js\nconst arcgisAttachments = document.querySelector(\"arcgis-attachments\");\ndocument.body.append(arcgisAttachments);\nawait arcgisAttachments.componentOnReady();\nconsole.log(\"arcgis-attachments is ready to go!\");\n```"
|
|
1528
1543
|
},
|
|
1529
1544
|
{
|
|
1530
1545
|
"name": "inheritedFrom",
|
|
@@ -1785,7 +1800,7 @@
|
|
|
1785
1800
|
},
|
|
1786
1801
|
"mutable": true,
|
|
1787
1802
|
"reflectToAttr": false,
|
|
1788
|
-
"docs": "Replace localized message strings with your own strings
|
|
1803
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
1789
1804
|
"docsTags": [],
|
|
1790
1805
|
"values": [],
|
|
1791
1806
|
"optional": true,
|
|
@@ -1873,8 +1888,13 @@
|
|
|
1873
1888
|
"mutable": true,
|
|
1874
1889
|
"attr": "reference-element",
|
|
1875
1890
|
"reflectToAttr": false,
|
|
1876
|
-
"docs": "",
|
|
1877
|
-
"docsTags": [
|
|
1891
|
+
"docs": "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.",
|
|
1892
|
+
"docsTags": [
|
|
1893
|
+
{
|
|
1894
|
+
"name": "see",
|
|
1895
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
1896
|
+
}
|
|
1897
|
+
],
|
|
1878
1898
|
"values": [
|
|
1879
1899
|
{
|
|
1880
1900
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -1992,7 +2012,7 @@
|
|
|
1992
2012
|
"docsTags": [
|
|
1993
2013
|
{
|
|
1994
2014
|
"name": "example",
|
|
1995
|
-
"text": "
|
|
2015
|
+
"text": "```js\nconst arcgisBasemapGallery = document.querySelector(\"arcgis-basemap-gallery\");\ndocument.body.append(arcgisBasemapGallery);\nawait arcgisBasemapGallery.componentOnReady();\nconsole.log(\"arcgis-basemap-gallery is ready to go!\");\n```"
|
|
1996
2016
|
},
|
|
1997
2017
|
{
|
|
1998
2018
|
"name": "inheritedFrom",
|
|
@@ -2656,8 +2676,13 @@
|
|
|
2656
2676
|
"mutable": true,
|
|
2657
2677
|
"attr": "reference-element",
|
|
2658
2678
|
"reflectToAttr": false,
|
|
2659
|
-
"docs": "",
|
|
2660
|
-
"docsTags": [
|
|
2679
|
+
"docs": "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.",
|
|
2680
|
+
"docsTags": [
|
|
2681
|
+
{
|
|
2682
|
+
"name": "see",
|
|
2683
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
2684
|
+
}
|
|
2685
|
+
],
|
|
2661
2686
|
"values": [
|
|
2662
2687
|
{
|
|
2663
2688
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -3045,7 +3070,7 @@
|
|
|
3045
3070
|
"docsTags": [
|
|
3046
3071
|
{
|
|
3047
3072
|
"name": "example",
|
|
3048
|
-
"text": "
|
|
3073
|
+
"text": "```js\nconst arcgisBasemapLayerList = document.querySelector(\"arcgis-basemap-layer-list\");\ndocument.body.append(arcgisBasemapLayerList);\nawait arcgisBasemapLayerList.componentOnReady();\nconsole.log(\"arcgis-basemap-layer-list is ready to go!\");\n```"
|
|
3049
3074
|
},
|
|
3050
3075
|
{
|
|
3051
3076
|
"name": "inheritedFrom",
|
|
@@ -3276,7 +3301,7 @@
|
|
|
3276
3301
|
},
|
|
3277
3302
|
"mutable": true,
|
|
3278
3303
|
"reflectToAttr": false,
|
|
3279
|
-
"docs": "Replace localized message strings with your own strings
|
|
3304
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
3280
3305
|
"docsTags": [],
|
|
3281
3306
|
"values": [],
|
|
3282
3307
|
"optional": true,
|
|
@@ -3394,8 +3419,13 @@
|
|
|
3394
3419
|
"mutable": true,
|
|
3395
3420
|
"attr": "reference-element",
|
|
3396
3421
|
"reflectToAttr": false,
|
|
3397
|
-
"docs": "",
|
|
3398
|
-
"docsTags": [
|
|
3422
|
+
"docs": "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.",
|
|
3423
|
+
"docsTags": [
|
|
3424
|
+
{
|
|
3425
|
+
"name": "see",
|
|
3426
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
3427
|
+
}
|
|
3428
|
+
],
|
|
3399
3429
|
"values": [
|
|
3400
3430
|
{
|
|
3401
3431
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -3501,7 +3531,7 @@
|
|
|
3501
3531
|
"docsTags": [
|
|
3502
3532
|
{
|
|
3503
3533
|
"name": "example",
|
|
3504
|
-
"text": "
|
|
3534
|
+
"text": "```js\nconst arcgisBasemapToggle = document.querySelector(\"arcgis-basemap-toggle\");\ndocument.body.append(arcgisBasemapToggle);\nawait arcgisBasemapToggle.componentOnReady();\nconsole.log(\"arcgis-basemap-toggle is ready to go!\");\n```"
|
|
3505
3535
|
},
|
|
3506
3536
|
{
|
|
3507
3537
|
"name": "inheritedFrom",
|
|
@@ -3559,11 +3589,11 @@
|
|
|
3559
3589
|
"events": [
|
|
3560
3590
|
{
|
|
3561
3591
|
"event": "arcgisPropertyChange",
|
|
3562
|
-
"detail": "{ name: \"state\" | \"nextBasemap\"; }",
|
|
3592
|
+
"detail": "{ name: \"state\" | \"activeBasemap\" | \"nextBasemap\"; }",
|
|
3563
3593
|
"bubbles": true,
|
|
3564
3594
|
"complexType": {
|
|
3565
|
-
"original": "{ name: \"state\" | \"nextBasemap\"; }",
|
|
3566
|
-
"resolved": "{ name: \"state\" | \"nextBasemap\"; }",
|
|
3595
|
+
"original": "{ name: \"state\" | \"activeBasemap\" | \"nextBasemap\"; }",
|
|
3596
|
+
"resolved": "{ name: \"state\" | \"activeBasemap\" | \"nextBasemap\"; }",
|
|
3567
3597
|
"references": {}
|
|
3568
3598
|
},
|
|
3569
3599
|
"cancelable": true,
|
|
@@ -4032,8 +4062,13 @@
|
|
|
4032
4062
|
"mutable": true,
|
|
4033
4063
|
"attr": "reference-element",
|
|
4034
4064
|
"reflectToAttr": false,
|
|
4035
|
-
"docs": "",
|
|
4036
|
-
"docsTags": [
|
|
4065
|
+
"docs": "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.",
|
|
4066
|
+
"docsTags": [
|
|
4067
|
+
{
|
|
4068
|
+
"name": "see",
|
|
4069
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
4070
|
+
}
|
|
4071
|
+
],
|
|
4037
4072
|
"values": [
|
|
4038
4073
|
{
|
|
4039
4074
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -4241,7 +4276,7 @@
|
|
|
4241
4276
|
"docsTags": [
|
|
4242
4277
|
{
|
|
4243
4278
|
"name": "example",
|
|
4244
|
-
"text": "
|
|
4279
|
+
"text": "```js\nconst arcgisBookmarks = document.querySelector(\"arcgis-bookmarks\");\ndocument.body.append(arcgisBookmarks);\nawait arcgisBookmarks.componentOnReady();\nconsole.log(\"arcgis-bookmarks is ready to go!\");\n```"
|
|
4245
4280
|
},
|
|
4246
4281
|
{
|
|
4247
4282
|
"name": "inheritedFrom",
|
|
@@ -4373,7 +4408,7 @@
|
|
|
4373
4408
|
"overview": "",
|
|
4374
4409
|
"readme": "",
|
|
4375
4410
|
"usage": {},
|
|
4376
|
-
"docs": "The Building Explorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.",
|
|
4411
|
+
"docs": "The Building Explorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.\n\n**Known limitations**\n\nBuilding Explorer is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.",
|
|
4377
4412
|
"docsTags": [
|
|
4378
4413
|
{
|
|
4379
4414
|
"name": "superclass",
|
|
@@ -4418,7 +4453,7 @@
|
|
|
4418
4453
|
"mutable": true,
|
|
4419
4454
|
"attr": "heading-level",
|
|
4420
4455
|
"reflectToAttr": false,
|
|
4421
|
-
"docs": "Indicates the heading level to use for the
|
|
4456
|
+
"docs": "Indicates the heading level to use for the component title.",
|
|
4422
4457
|
"docsTags": [],
|
|
4423
4458
|
"default": "3",
|
|
4424
4459
|
"values": [
|
|
@@ -4506,13 +4541,8 @@
|
|
|
4506
4541
|
"mutable": true,
|
|
4507
4542
|
"attr": "icon",
|
|
4508
4543
|
"reflectToAttr": false,
|
|
4509
|
-
"docs": "Icon which represents the
|
|
4510
|
-
"docsTags": [
|
|
4511
|
-
{
|
|
4512
|
-
"name": "see",
|
|
4513
|
-
"text": "[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"
|
|
4514
|
-
}
|
|
4515
|
-
],
|
|
4544
|
+
"docs": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
4545
|
+
"docsTags": [],
|
|
4516
4546
|
"default": "\"organization\"",
|
|
4517
4547
|
"values": [
|
|
4518
4548
|
{
|
|
@@ -4533,7 +4563,7 @@
|
|
|
4533
4563
|
"mutable": true,
|
|
4534
4564
|
"attr": "label",
|
|
4535
4565
|
"reflectToAttr": false,
|
|
4536
|
-
"docs": "The
|
|
4566
|
+
"docs": "The component's default label.",
|
|
4537
4567
|
"docsTags": [],
|
|
4538
4568
|
"values": [
|
|
4539
4569
|
{
|
|
@@ -4564,7 +4594,7 @@
|
|
|
4564
4594
|
},
|
|
4565
4595
|
"mutable": true,
|
|
4566
4596
|
"reflectToAttr": false,
|
|
4567
|
-
"docs": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)
|
|
4597
|
+
"docs": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)\nof layers of type [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html)\nthat are added to the componen for exploration.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#layers)",
|
|
4568
4598
|
"docsTags": [],
|
|
4569
4599
|
"values": [],
|
|
4570
4600
|
"optional": true,
|
|
@@ -4706,8 +4736,13 @@
|
|
|
4706
4736
|
"mutable": true,
|
|
4707
4737
|
"attr": "reference-element",
|
|
4708
4738
|
"reflectToAttr": false,
|
|
4709
|
-
"docs": "",
|
|
4710
|
-
"docsTags": [
|
|
4739
|
+
"docs": "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.",
|
|
4740
|
+
"docsTags": [
|
|
4741
|
+
{
|
|
4742
|
+
"name": "see",
|
|
4743
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
4744
|
+
}
|
|
4745
|
+
],
|
|
4711
4746
|
"values": [
|
|
4712
4747
|
{
|
|
4713
4748
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -4736,7 +4771,7 @@
|
|
|
4736
4771
|
"mutable": true,
|
|
4737
4772
|
"attr": "state",
|
|
4738
4773
|
"reflectToAttr": true,
|
|
4739
|
-
"docs": "The
|
|
4774
|
+
"docs": "The component's state. The values mean the following:\n\n* `disabled` - \tcomponent is being created\n* `loading` - layers and statistics are loading\n* `ready` - component is ready\n* `failed` - component failed to load data",
|
|
4740
4775
|
"docsTags": [
|
|
4741
4776
|
{
|
|
4742
4777
|
"name": "readonly",
|
|
@@ -4791,7 +4826,7 @@
|
|
|
4791
4826
|
"docsTags": [
|
|
4792
4827
|
{
|
|
4793
4828
|
"name": "example",
|
|
4794
|
-
"text": "
|
|
4829
|
+
"text": "```js\nconst arcgisBuildingExplorer = document.querySelector(\"arcgis-building-explorer\");\ndocument.body.append(arcgisBuildingExplorer);\nawait arcgisBuildingExplorer.componentOnReady();\nconsole.log(\"arcgis-building-explorer is ready to go!\");\n```"
|
|
4795
4830
|
},
|
|
4796
4831
|
{
|
|
4797
4832
|
"name": "inheritedFrom",
|
|
@@ -5298,8 +5333,13 @@
|
|
|
5298
5333
|
"mutable": true,
|
|
5299
5334
|
"attr": "reference-element",
|
|
5300
5335
|
"reflectToAttr": false,
|
|
5301
|
-
"docs": "",
|
|
5302
|
-
"docsTags": [
|
|
5336
|
+
"docs": "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.",
|
|
5337
|
+
"docsTags": [
|
|
5338
|
+
{
|
|
5339
|
+
"name": "see",
|
|
5340
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
5341
|
+
}
|
|
5342
|
+
],
|
|
5303
5343
|
"values": [
|
|
5304
5344
|
{
|
|
5305
5345
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -5600,7 +5640,7 @@
|
|
|
5600
5640
|
"docsTags": [
|
|
5601
5641
|
{
|
|
5602
5642
|
"name": "example",
|
|
5603
|
-
"text": "
|
|
5643
|
+
"text": "```js\nconst arcgisCatalogLayerList = document.querySelector(\"arcgis-catalog-layer-list\");\ndocument.body.append(arcgisCatalogLayerList);\nawait arcgisCatalogLayerList.componentOnReady();\nconsole.log(\"arcgis-catalog-layer-list is ready to go!\");\n```"
|
|
5604
5644
|
},
|
|
5605
5645
|
{
|
|
5606
5646
|
"name": "inheritedFrom",
|
|
@@ -5824,7 +5864,7 @@
|
|
|
5824
5864
|
},
|
|
5825
5865
|
"mutable": true,
|
|
5826
5866
|
"reflectToAttr": false,
|
|
5827
|
-
"docs": "Replace localized message strings with your own strings
|
|
5867
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
5828
5868
|
"docsTags": [],
|
|
5829
5869
|
"values": [],
|
|
5830
5870
|
"optional": true,
|
|
@@ -5940,8 +5980,13 @@
|
|
|
5940
5980
|
"mutable": true,
|
|
5941
5981
|
"attr": "reference-element",
|
|
5942
5982
|
"reflectToAttr": false,
|
|
5943
|
-
"docs": "",
|
|
5944
|
-
"docsTags": [
|
|
5983
|
+
"docs": "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.",
|
|
5984
|
+
"docsTags": [
|
|
5985
|
+
{
|
|
5986
|
+
"name": "see",
|
|
5987
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
5988
|
+
}
|
|
5989
|
+
],
|
|
5945
5990
|
"values": [
|
|
5946
5991
|
{
|
|
5947
5992
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -6021,7 +6066,7 @@
|
|
|
6021
6066
|
"docsTags": [
|
|
6022
6067
|
{
|
|
6023
6068
|
"name": "example",
|
|
6024
|
-
"text": "
|
|
6069
|
+
"text": "```js\nconst arcgisCompass = document.querySelector(\"arcgis-compass\");\ndocument.body.append(arcgisCompass);\nawait arcgisCompass.componentOnReady();\nconsole.log(\"arcgis-compass is ready to go!\");\n```"
|
|
6025
6070
|
},
|
|
6026
6071
|
{
|
|
6027
6072
|
"name": "inheritedFrom",
|
|
@@ -6298,7 +6343,7 @@
|
|
|
6298
6343
|
"required": false
|
|
6299
6344
|
},
|
|
6300
6345
|
{
|
|
6301
|
-
"name": "
|
|
6346
|
+
"name": "hideExpandButton",
|
|
6302
6347
|
"type": "boolean",
|
|
6303
6348
|
"complexType": {
|
|
6304
6349
|
"original": "boolean",
|
|
@@ -6306,7 +6351,7 @@
|
|
|
6306
6351
|
"references": {}
|
|
6307
6352
|
},
|
|
6308
6353
|
"mutable": true,
|
|
6309
|
-
"attr": "hide-
|
|
6354
|
+
"attr": "hide-expand-button",
|
|
6310
6355
|
"reflectToAttr": false,
|
|
6311
6356
|
"docs": "",
|
|
6312
6357
|
"docsTags": [],
|
|
@@ -6320,7 +6365,7 @@
|
|
|
6320
6365
|
"required": false
|
|
6321
6366
|
},
|
|
6322
6367
|
{
|
|
6323
|
-
"name": "
|
|
6368
|
+
"name": "hideInputButton",
|
|
6324
6369
|
"type": "boolean",
|
|
6325
6370
|
"complexType": {
|
|
6326
6371
|
"original": "boolean",
|
|
@@ -6328,7 +6373,7 @@
|
|
|
6328
6373
|
"references": {}
|
|
6329
6374
|
},
|
|
6330
6375
|
"mutable": true,
|
|
6331
|
-
"attr": "hide-
|
|
6376
|
+
"attr": "hide-input-button",
|
|
6332
6377
|
"reflectToAttr": false,
|
|
6333
6378
|
"docs": "",
|
|
6334
6379
|
"docsTags": [],
|
|
@@ -6623,8 +6668,13 @@
|
|
|
6623
6668
|
"mutable": true,
|
|
6624
6669
|
"attr": "reference-element",
|
|
6625
6670
|
"reflectToAttr": false,
|
|
6626
|
-
"docs": "",
|
|
6627
|
-
"docsTags": [
|
|
6671
|
+
"docs": "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.",
|
|
6672
|
+
"docsTags": [
|
|
6673
|
+
{
|
|
6674
|
+
"name": "see",
|
|
6675
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
6676
|
+
}
|
|
6677
|
+
],
|
|
6628
6678
|
"values": [
|
|
6629
6679
|
{
|
|
6630
6680
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -6753,7 +6803,7 @@
|
|
|
6753
6803
|
"docsTags": [
|
|
6754
6804
|
{
|
|
6755
6805
|
"name": "example",
|
|
6756
|
-
"text": "
|
|
6806
|
+
"text": "```js\nconst arcgisCoordinateConversion = document.querySelector(\"arcgis-coordinate-conversion\");\ndocument.body.append(arcgisCoordinateConversion);\nawait arcgisCoordinateConversion.componentOnReady();\nconsole.log(\"arcgis-coordinate-conversion is ready to go!\");\n```"
|
|
6757
6807
|
},
|
|
6758
6808
|
{
|
|
6759
6809
|
"name": "inheritedFrom",
|
|
@@ -6881,7 +6931,7 @@
|
|
|
6881
6931
|
"overview": "",
|
|
6882
6932
|
"readme": "",
|
|
6883
6933
|
"usage": {},
|
|
6884
|
-
"docs": "The Daylight component can be used to manipulate the lighting conditions of a [
|
|
6934
|
+
"docs": "The Daylight component can be used to manipulate the lighting conditions of a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\n**Known limitations**\n\nDaylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [Environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)\n- [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)",
|
|
6885
6935
|
"docsTags": [
|
|
6886
6936
|
{
|
|
6887
6937
|
"name": "superclass",
|
|
@@ -6960,7 +7010,7 @@
|
|
|
6960
7010
|
"mutable": true,
|
|
6961
7011
|
"attr": "date-or-season",
|
|
6962
7012
|
"reflectToAttr": false,
|
|
6963
|
-
"docs": "Controls whether the
|
|
7013
|
+
"docs": "Controls whether the component displays a date or a season picker.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason)",
|
|
6964
7014
|
"docsTags": [],
|
|
6965
7015
|
"default": "\"date\"",
|
|
6966
7016
|
"values": [
|
|
@@ -7009,7 +7059,7 @@
|
|
|
7009
7059
|
"mutable": true,
|
|
7010
7060
|
"attr": "heading-level",
|
|
7011
7061
|
"reflectToAttr": false,
|
|
7012
|
-
"docs": "Indicates the heading level to use for the
|
|
7062
|
+
"docs": "Indicates the heading level to use for the component title.",
|
|
7013
7063
|
"docsTags": [],
|
|
7014
7064
|
"default": "3",
|
|
7015
7065
|
"values": [
|
|
@@ -7163,13 +7213,8 @@
|
|
|
7163
7213
|
"mutable": true,
|
|
7164
7214
|
"attr": "icon",
|
|
7165
7215
|
"reflectToAttr": false,
|
|
7166
|
-
"docs": "Icon which represents the
|
|
7167
|
-
"docsTags": [
|
|
7168
|
-
{
|
|
7169
|
-
"name": "see",
|
|
7170
|
-
"text": "[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"
|
|
7171
|
-
}
|
|
7172
|
-
],
|
|
7216
|
+
"docs": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
7217
|
+
"docsTags": [],
|
|
7173
7218
|
"default": "\"brightness\"",
|
|
7174
7219
|
"values": [
|
|
7175
7220
|
{
|
|
@@ -7190,7 +7235,7 @@
|
|
|
7190
7235
|
"mutable": true,
|
|
7191
7236
|
"attr": "label",
|
|
7192
7237
|
"reflectToAttr": false,
|
|
7193
|
-
"docs": "The
|
|
7238
|
+
"docs": "The component's default label.",
|
|
7194
7239
|
"docsTags": [],
|
|
7195
7240
|
"values": [
|
|
7196
7241
|
{
|
|
@@ -7304,8 +7349,13 @@
|
|
|
7304
7349
|
"mutable": true,
|
|
7305
7350
|
"attr": "reference-element",
|
|
7306
7351
|
"reflectToAttr": false,
|
|
7307
|
-
"docs": "",
|
|
7308
|
-
"docsTags": [
|
|
7352
|
+
"docs": "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.",
|
|
7353
|
+
"docsTags": [
|
|
7354
|
+
{
|
|
7355
|
+
"name": "see",
|
|
7356
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
7357
|
+
}
|
|
7358
|
+
],
|
|
7309
7359
|
"values": [
|
|
7310
7360
|
{
|
|
7311
7361
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -7340,7 +7390,7 @@
|
|
|
7340
7390
|
"mutable": true,
|
|
7341
7391
|
"attr": "time-slider-steps",
|
|
7342
7392
|
"reflectToAttr": false,
|
|
7343
|
-
"docs": "Sets steps, or intervals, on the time slider to restrict the times
|
|
7393
|
+
"docs": "Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#timeSliderSteps)",
|
|
7344
7394
|
"docsTags": [],
|
|
7345
7395
|
"default": "5",
|
|
7346
7396
|
"values": [
|
|
@@ -7402,7 +7452,7 @@
|
|
|
7402
7452
|
"docsTags": [
|
|
7403
7453
|
{
|
|
7404
7454
|
"name": "example",
|
|
7405
|
-
"text": "
|
|
7455
|
+
"text": "```js\nconst arcgisDaylight = document.querySelector(\"arcgis-daylight\");\ndocument.body.append(arcgisDaylight);\nawait arcgisDaylight.componentOnReady();\nconsole.log(\"arcgis-daylight is ready to go!\");\n```"
|
|
7406
7456
|
},
|
|
7407
7457
|
{
|
|
7408
7458
|
"name": "inheritedFrom",
|
|
@@ -7460,7 +7510,7 @@
|
|
|
7460
7510
|
},
|
|
7461
7511
|
"cancelable": true,
|
|
7462
7512
|
"composed": true,
|
|
7463
|
-
"docs": "Fires when the user changes the date or time in the
|
|
7513
|
+
"docs": "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.",
|
|
7464
7514
|
"docsTags": [
|
|
7465
7515
|
{
|
|
7466
7516
|
"name": "since",
|
|
@@ -7616,7 +7666,7 @@
|
|
|
7616
7666
|
},
|
|
7617
7667
|
"mutable": true,
|
|
7618
7668
|
"reflectToAttr": false,
|
|
7619
|
-
"docs": "Replace localized message strings with your own strings
|
|
7669
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7620
7670
|
"docsTags": [],
|
|
7621
7671
|
"values": [],
|
|
7622
7672
|
"optional": true,
|
|
@@ -7704,8 +7754,13 @@
|
|
|
7704
7754
|
"mutable": true,
|
|
7705
7755
|
"attr": "reference-element",
|
|
7706
7756
|
"reflectToAttr": false,
|
|
7707
|
-
"docs": "",
|
|
7708
|
-
"docsTags": [
|
|
7757
|
+
"docs": "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.",
|
|
7758
|
+
"docsTags": [
|
|
7759
|
+
{
|
|
7760
|
+
"name": "see",
|
|
7761
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
7762
|
+
}
|
|
7763
|
+
],
|
|
7709
7764
|
"values": [
|
|
7710
7765
|
{
|
|
7711
7766
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -7859,7 +7914,7 @@
|
|
|
7859
7914
|
"docsTags": [
|
|
7860
7915
|
{
|
|
7861
7916
|
"name": "example",
|
|
7862
|
-
"text": "
|
|
7917
|
+
"text": "```js\nconst arcgisDirectionalPad = document.querySelector(\"arcgis-directional-pad\");\ndocument.body.append(arcgisDirectionalPad);\nawait arcgisDirectionalPad.componentOnReady();\nconsole.log(\"arcgis-directional-pad is ready to go!\");\n```"
|
|
7863
7918
|
},
|
|
7864
7919
|
{
|
|
7865
7920
|
"name": "inheritedFrom",
|
|
@@ -8298,8 +8353,13 @@
|
|
|
8298
8353
|
"mutable": true,
|
|
8299
8354
|
"attr": "reference-element",
|
|
8300
8355
|
"reflectToAttr": false,
|
|
8301
|
-
"docs": "",
|
|
8302
|
-
"docsTags": [
|
|
8356
|
+
"docs": "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.",
|
|
8357
|
+
"docsTags": [
|
|
8358
|
+
{
|
|
8359
|
+
"name": "see",
|
|
8360
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
8361
|
+
}
|
|
8362
|
+
],
|
|
8303
8363
|
"values": [
|
|
8304
8364
|
{
|
|
8305
8365
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -8354,7 +8414,7 @@
|
|
|
8354
8414
|
},
|
|
8355
8415
|
"mutable": true,
|
|
8356
8416
|
"reflectToAttr": false,
|
|
8357
|
-
"docs": "Controls the default properties used when
|
|
8417
|
+
"docs": "Controls the default properties used when searching.",
|
|
8358
8418
|
"docsTags": [],
|
|
8359
8419
|
"default": "null",
|
|
8360
8420
|
"values": [],
|
|
@@ -8527,7 +8587,7 @@
|
|
|
8527
8587
|
"docsTags": [
|
|
8528
8588
|
{
|
|
8529
8589
|
"name": "example",
|
|
8530
|
-
"text": "
|
|
8590
|
+
"text": "```js\nconst arcgisDirections = document.querySelector(\"arcgis-directions\");\ndocument.body.append(arcgisDirections);\nawait arcgisDirections.componentOnReady();\nconsole.log(\"arcgis-directions is ready to go!\");\n```"
|
|
8531
8591
|
},
|
|
8532
8592
|
{
|
|
8533
8593
|
"name": "inheritedFrom",
|
|
@@ -8729,7 +8789,7 @@
|
|
|
8729
8789
|
"overview": "",
|
|
8730
8790
|
"readme": "",
|
|
8731
8791
|
"usage": {},
|
|
8732
|
-
"docs": "The Direct Line Measurement 3D component
|
|
8792
|
+
"docs": "The Direct Line Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent to calculate and display vertical, horizontal, and direct distances between two points.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow distances are computed depends on the scene's spatial reference.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- Direct distance is computed in a Euclidean manner, in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets);\n- Horizontal distance is computed geodetically, taking into consideration the curvature of the planet;\n- Vertical distance is computed as an elevation difference.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, all three distances (direct, horizontal, and vertical)\n are computed in a Euclidean manner (in their respective PCS).\n\nDirect Line Measurement 3D component visualizes and labels the direct, horizontal, and vertical distances and displays the same values\nin the UI panel. When the distance between the points is greater than 100 kilometers,\nthe measurement visualization is simplified, and only the horizontal and vertical distances are calculated.\nThe direct distance option becomes unavailable.\n\n\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\nA second laser line shows the intersection of the scene with the vertical plane that passes through the checkered line.\n\n**Things to consider**\n\n* Direct Line Measurement 3D is designed to work in the Scene component. For measurements in the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Distance Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/).\n* Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n- [Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)",
|
|
8733
8793
|
"docsTags": [
|
|
8734
8794
|
{
|
|
8735
8795
|
"name": "superclass",
|
|
@@ -8757,13 +8817,8 @@
|
|
|
8757
8817
|
},
|
|
8758
8818
|
"mutable": true,
|
|
8759
8819
|
"reflectToAttr": false,
|
|
8760
|
-
"docs": "",
|
|
8761
|
-
"docsTags": [
|
|
8762
|
-
{
|
|
8763
|
-
"name": "readonly",
|
|
8764
|
-
"text": ""
|
|
8765
|
-
}
|
|
8766
|
-
],
|
|
8820
|
+
"docs": "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```",
|
|
8821
|
+
"docsTags": [],
|
|
8767
8822
|
"values": [],
|
|
8768
8823
|
"optional": true,
|
|
8769
8824
|
"required": false
|
|
@@ -8920,8 +8975,13 @@
|
|
|
8920
8975
|
"mutable": true,
|
|
8921
8976
|
"attr": "reference-element",
|
|
8922
8977
|
"reflectToAttr": false,
|
|
8923
|
-
"docs": "",
|
|
8924
|
-
"docsTags": [
|
|
8978
|
+
"docs": "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.",
|
|
8979
|
+
"docsTags": [
|
|
8980
|
+
{
|
|
8981
|
+
"name": "see",
|
|
8982
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
8983
|
+
}
|
|
8984
|
+
],
|
|
8925
8985
|
"values": [
|
|
8926
8986
|
{
|
|
8927
8987
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -8949,9 +9009,14 @@
|
|
|
8949
9009
|
},
|
|
8950
9010
|
"mutable": true,
|
|
8951
9011
|
"attr": "state",
|
|
8952
|
-
"reflectToAttr":
|
|
8953
|
-
"docs": "",
|
|
8954
|
-
"docsTags": [
|
|
9012
|
+
"reflectToAttr": true,
|
|
9013
|
+
"docs": "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",
|
|
9014
|
+
"docsTags": [
|
|
9015
|
+
{
|
|
9016
|
+
"name": "readonly",
|
|
9017
|
+
"text": ""
|
|
9018
|
+
}
|
|
9019
|
+
],
|
|
8955
9020
|
"values": [
|
|
8956
9021
|
{
|
|
8957
9022
|
"value": "disabled",
|
|
@@ -8984,7 +9049,7 @@
|
|
|
8984
9049
|
"mutable": true,
|
|
8985
9050
|
"attr": "unit",
|
|
8986
9051
|
"reflectToAttr": false,
|
|
8987
|
-
"docs": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
9052
|
+
"docs": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
8988
9053
|
"docsTags": [],
|
|
8989
9054
|
"values": [
|
|
8990
9055
|
{
|
|
@@ -9059,7 +9124,7 @@
|
|
|
9059
9124
|
},
|
|
9060
9125
|
"mutable": true,
|
|
9061
9126
|
"reflectToAttr": false,
|
|
9062
|
-
"docs": "List of unit systems (imperial, metric)
|
|
9127
|
+
"docs": "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.",
|
|
9063
9128
|
"docsTags": [],
|
|
9064
9129
|
"values": [],
|
|
9065
9130
|
"optional": true,
|
|
@@ -9087,7 +9152,7 @@
|
|
|
9087
9152
|
},
|
|
9088
9153
|
"signature": "clear(): Promise<void>",
|
|
9089
9154
|
"parameters": [],
|
|
9090
|
-
"docs": "",
|
|
9155
|
+
"docs": "Clears the current measurement.",
|
|
9091
9156
|
"docsTags": []
|
|
9092
9157
|
},
|
|
9093
9158
|
{
|
|
@@ -9114,7 +9179,7 @@
|
|
|
9114
9179
|
"docsTags": [
|
|
9115
9180
|
{
|
|
9116
9181
|
"name": "example",
|
|
9117
|
-
"text": "
|
|
9182
|
+
"text": "```js\nconst arcgisDirectLineMeasurement3d = document.querySelector(\"arcgis-direct-line-measurement-3d\");\ndocument.body.append(arcgisDirectLineMeasurement3d);\nawait arcgisDirectLineMeasurement3d.componentOnReady();\nconsole.log(\"arcgis-direct-line-measurement-3d is ready to go!\");\n```"
|
|
9118
9183
|
},
|
|
9119
9184
|
{
|
|
9120
9185
|
"name": "inheritedFrom",
|
|
@@ -9165,7 +9230,7 @@
|
|
|
9165
9230
|
},
|
|
9166
9231
|
"signature": "start(): Promise<void>",
|
|
9167
9232
|
"parameters": [],
|
|
9168
|
-
"docs": "",
|
|
9233
|
+
"docs": "Starts a new measurement.",
|
|
9169
9234
|
"docsTags": []
|
|
9170
9235
|
}
|
|
9171
9236
|
],
|
|
@@ -9210,7 +9275,7 @@
|
|
|
9210
9275
|
"overview": "",
|
|
9211
9276
|
"readme": "",
|
|
9212
9277
|
"usage": {},
|
|
9213
|
-
"docs": "The
|
|
9278
|
+
"docs": "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.",
|
|
9214
9279
|
"docsTags": [
|
|
9215
9280
|
{
|
|
9216
9281
|
"name": "internal"
|
|
@@ -9242,12 +9307,8 @@
|
|
|
9242
9307
|
},
|
|
9243
9308
|
"mutable": true,
|
|
9244
9309
|
"reflectToAttr": false,
|
|
9245
|
-
"docs": "",
|
|
9310
|
+
"docs": "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```",
|
|
9246
9311
|
"docsTags": [
|
|
9247
|
-
{
|
|
9248
|
-
"name": "readonly",
|
|
9249
|
-
"text": ""
|
|
9250
|
-
},
|
|
9251
9312
|
{
|
|
9252
9313
|
"name": "inheritedFrom",
|
|
9253
9314
|
"text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
|
|
@@ -9428,8 +9489,12 @@
|
|
|
9428
9489
|
"mutable": true,
|
|
9429
9490
|
"attr": "reference-element",
|
|
9430
9491
|
"reflectToAttr": false,
|
|
9431
|
-
"docs": "",
|
|
9492
|
+
"docs": "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.",
|
|
9432
9493
|
"docsTags": [
|
|
9494
|
+
{
|
|
9495
|
+
"name": "see",
|
|
9496
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
9497
|
+
},
|
|
9433
9498
|
{
|
|
9434
9499
|
"name": "inheritedFrom",
|
|
9435
9500
|
"text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
|
|
@@ -9462,9 +9527,13 @@
|
|
|
9462
9527
|
},
|
|
9463
9528
|
"mutable": true,
|
|
9464
9529
|
"attr": "state",
|
|
9465
|
-
"reflectToAttr":
|
|
9466
|
-
"docs": "",
|
|
9530
|
+
"reflectToAttr": true,
|
|
9531
|
+
"docs": "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",
|
|
9467
9532
|
"docsTags": [
|
|
9533
|
+
{
|
|
9534
|
+
"name": "readonly",
|
|
9535
|
+
"text": ""
|
|
9536
|
+
},
|
|
9468
9537
|
{
|
|
9469
9538
|
"name": "inheritedFrom",
|
|
9470
9539
|
"text": "{\"name\":\"ArcgisDirectLineMeasurement3d\",\"module\":\"components/arcgis-direct-line-measurement-3d\"}"
|
|
@@ -9502,7 +9571,7 @@
|
|
|
9502
9571
|
"mutable": true,
|
|
9503
9572
|
"attr": "unit",
|
|
9504
9573
|
"reflectToAttr": false,
|
|
9505
|
-
"docs": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
9574
|
+
"docs": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
9506
9575
|
"docsTags": [
|
|
9507
9576
|
{
|
|
9508
9577
|
"name": "inheritedFrom",
|
|
@@ -9582,7 +9651,7 @@
|
|
|
9582
9651
|
},
|
|
9583
9652
|
"mutable": true,
|
|
9584
9653
|
"reflectToAttr": false,
|
|
9585
|
-
"docs": "List of unit systems (imperial, metric)
|
|
9654
|
+
"docs": "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.",
|
|
9586
9655
|
"docsTags": [
|
|
9587
9656
|
{
|
|
9588
9657
|
"name": "inheritedFrom",
|
|
@@ -9615,7 +9684,7 @@
|
|
|
9615
9684
|
},
|
|
9616
9685
|
"signature": "clear(): Promise<void>",
|
|
9617
9686
|
"parameters": [],
|
|
9618
|
-
"docs": "",
|
|
9687
|
+
"docs": "Clears the current measurement.",
|
|
9619
9688
|
"docsTags": [
|
|
9620
9689
|
{
|
|
9621
9690
|
"name": "inheritedFrom",
|
|
@@ -9647,7 +9716,7 @@
|
|
|
9647
9716
|
"docsTags": [
|
|
9648
9717
|
{
|
|
9649
9718
|
"name": "example",
|
|
9650
|
-
"text": "
|
|
9719
|
+
"text": "```js\nconst deprecatedArcgisDirectLineMeasurement3d = document.querySelector(\"arcgis-directline-measurement-3d\");\ndocument.body.append(deprecatedArcgisDirectLineMeasurement3d);\nawait deprecatedArcgisDirectLineMeasurement3d.componentOnReady();\nconsole.log(\"arcgis-directline-measurement-3d is ready to go!\");\n```"
|
|
9651
9720
|
},
|
|
9652
9721
|
{
|
|
9653
9722
|
"name": "inheritedFrom",
|
|
@@ -9703,7 +9772,7 @@
|
|
|
9703
9772
|
},
|
|
9704
9773
|
"signature": "start(): Promise<void>",
|
|
9705
9774
|
"parameters": [],
|
|
9706
|
-
"docs": "",
|
|
9775
|
+
"docs": "Starts a new measurement.",
|
|
9707
9776
|
"docsTags": [
|
|
9708
9777
|
{
|
|
9709
9778
|
"name": "inheritedFrom",
|
|
@@ -9927,8 +9996,13 @@
|
|
|
9927
9996
|
"mutable": true,
|
|
9928
9997
|
"attr": "reference-element",
|
|
9929
9998
|
"reflectToAttr": false,
|
|
9930
|
-
"docs": "",
|
|
9931
|
-
"docsTags": [
|
|
9999
|
+
"docs": "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.",
|
|
10000
|
+
"docsTags": [
|
|
10001
|
+
{
|
|
10002
|
+
"name": "see",
|
|
10003
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
10004
|
+
}
|
|
10005
|
+
],
|
|
9932
10006
|
"values": [
|
|
9933
10007
|
{
|
|
9934
10008
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -10149,7 +10223,7 @@
|
|
|
10149
10223
|
"docsTags": [
|
|
10150
10224
|
{
|
|
10151
10225
|
"name": "example",
|
|
10152
|
-
"text": "
|
|
10226
|
+
"text": "```js\nconst arcgisDistanceMeasurement2d = document.querySelector(\"arcgis-distance-measurement-2d\");\ndocument.body.append(arcgisDistanceMeasurement2d);\nawait arcgisDistanceMeasurement2d.componentOnReady();\nconsole.log(\"arcgis-distance-measurement-2d is ready to go!\");\n```"
|
|
10153
10227
|
},
|
|
10154
10228
|
{
|
|
10155
10229
|
"name": "inheritedFrom",
|
|
@@ -10703,8 +10777,13 @@
|
|
|
10703
10777
|
"mutable": true,
|
|
10704
10778
|
"attr": "reference-element",
|
|
10705
10779
|
"reflectToAttr": false,
|
|
10706
|
-
"docs": "",
|
|
10707
|
-
"docsTags": [
|
|
10780
|
+
"docs": "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.",
|
|
10781
|
+
"docsTags": [
|
|
10782
|
+
{
|
|
10783
|
+
"name": "see",
|
|
10784
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
10785
|
+
}
|
|
10786
|
+
],
|
|
10708
10787
|
"values": [
|
|
10709
10788
|
{
|
|
10710
10789
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -10950,7 +11029,7 @@
|
|
|
10950
11029
|
"docsTags": [
|
|
10951
11030
|
{
|
|
10952
11031
|
"name": "example",
|
|
10953
|
-
"text": "
|
|
11032
|
+
"text": "```js\nconst arcgisEditor = document.querySelector(\"arcgis-editor\");\ndocument.body.append(arcgisEditor);\nawait arcgisEditor.componentOnReady();\nconsole.log(\"arcgis-editor is ready to go!\");\n```"
|
|
10954
11033
|
},
|
|
10955
11034
|
{
|
|
10956
11035
|
"name": "inheritedFrom",
|
|
@@ -11217,7 +11296,7 @@
|
|
|
11217
11296
|
"overview": "",
|
|
11218
11297
|
"readme": "",
|
|
11219
11298
|
"usage": {},
|
|
11220
|
-
"docs": "The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).",
|
|
11299
|
+
"docs": "The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).\n\n**See also**\n\n- [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)",
|
|
11221
11300
|
"docsTags": [
|
|
11222
11301
|
{
|
|
11223
11302
|
"name": "superclass",
|
|
@@ -11267,7 +11346,7 @@
|
|
|
11267
11346
|
},
|
|
11268
11347
|
"mutable": true,
|
|
11269
11348
|
"reflectToAttr": false,
|
|
11270
|
-
"docs": "Units which have been selected according to the magnitude of the elevations and distances
|
|
11349
|
+
"docs": "Units which have been selected according to the magnitude of the elevations and distances that are to be displayed in the component, according to the selected unit or unit system.",
|
|
11271
11350
|
"docsTags": [
|
|
11272
11351
|
{
|
|
11273
11352
|
"name": "readonly",
|
|
@@ -11508,13 +11587,8 @@
|
|
|
11508
11587
|
"mutable": true,
|
|
11509
11588
|
"attr": "icon",
|
|
11510
11589
|
"reflectToAttr": false,
|
|
11511
|
-
"docs": "Icon which represents the
|
|
11512
|
-
"docsTags": [
|
|
11513
|
-
{
|
|
11514
|
-
"name": "see",
|
|
11515
|
-
"text": "[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"
|
|
11516
|
-
}
|
|
11517
|
-
],
|
|
11590
|
+
"docs": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
11591
|
+
"docsTags": [],
|
|
11518
11592
|
"default": "\"altitude\"",
|
|
11519
11593
|
"values": [
|
|
11520
11594
|
{
|
|
@@ -11540,7 +11614,7 @@
|
|
|
11540
11614
|
},
|
|
11541
11615
|
"mutable": true,
|
|
11542
11616
|
"reflectToAttr": false,
|
|
11543
|
-
"docs": "The input
|
|
11617
|
+
"docs": "The input path along which elevation will be queried in order to generate an elevation profile.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input)",
|
|
11544
11618
|
"docsTags": [],
|
|
11545
11619
|
"default": "null",
|
|
11546
11620
|
"values": [],
|
|
@@ -11558,7 +11632,7 @@
|
|
|
11558
11632
|
"mutable": true,
|
|
11559
11633
|
"attr": "label",
|
|
11560
11634
|
"reflectToAttr": false,
|
|
11561
|
-
"docs": "The
|
|
11635
|
+
"docs": "The component's default label.",
|
|
11562
11636
|
"docsTags": [],
|
|
11563
11637
|
"values": [
|
|
11564
11638
|
{
|
|
@@ -11659,7 +11733,7 @@
|
|
|
11659
11733
|
},
|
|
11660
11734
|
"mutable": true,
|
|
11661
11735
|
"reflectToAttr": false,
|
|
11662
|
-
"docs": "Collection of elevation profile lines which are to be generated and displayed in the
|
|
11736
|
+
"docs": "Collection of elevation profile lines which are to be generated and displayed in the component's chart.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#profiles)",
|
|
11663
11737
|
"docsTags": [],
|
|
11664
11738
|
"values": [],
|
|
11665
11739
|
"optional": true,
|
|
@@ -11717,8 +11791,13 @@
|
|
|
11717
11791
|
"mutable": true,
|
|
11718
11792
|
"attr": "reference-element",
|
|
11719
11793
|
"reflectToAttr": false,
|
|
11720
|
-
"docs": "",
|
|
11721
|
-
"docsTags": [
|
|
11794
|
+
"docs": "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.",
|
|
11795
|
+
"docsTags": [
|
|
11796
|
+
{
|
|
11797
|
+
"name": "see",
|
|
11798
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
11799
|
+
}
|
|
11800
|
+
],
|
|
11722
11801
|
"values": [
|
|
11723
11802
|
{
|
|
11724
11803
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -11747,7 +11826,7 @@
|
|
|
11747
11826
|
"mutable": true,
|
|
11748
11827
|
"attr": "state",
|
|
11749
11828
|
"reflectToAttr": true,
|
|
11750
|
-
"docs": "The
|
|
11829
|
+
"docs": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready; no path configured and no interactive operation ongoing\n* `creating` - user is creating a new input path\n* `created` - input path is configured but no interactive operation is ongoing\n* `selecting` - user is selecting an existing input path\n* `selected` - user selected an existing input path",
|
|
11751
11830
|
"docsTags": [
|
|
11752
11831
|
{
|
|
11753
11832
|
"name": "readonly",
|
|
@@ -11924,7 +12003,7 @@
|
|
|
11924
12003
|
"docsTags": [
|
|
11925
12004
|
{
|
|
11926
12005
|
"name": "example",
|
|
11927
|
-
"text": "
|
|
12006
|
+
"text": "```js\nconst arcgisElevationProfile = document.querySelector(\"arcgis-elevation-profile\");\ndocument.body.append(arcgisElevationProfile);\nawait arcgisElevationProfile.componentOnReady();\nconsole.log(\"arcgis-elevation-profile is ready to go!\");\n```"
|
|
11928
12007
|
},
|
|
11929
12008
|
{
|
|
11930
12009
|
"name": "inheritedFrom",
|
|
@@ -11975,7 +12054,7 @@
|
|
|
11975
12054
|
},
|
|
11976
12055
|
"signature": "start(): Promise<void>",
|
|
11977
12056
|
"parameters": [],
|
|
11978
|
-
"docs": "",
|
|
12057
|
+
"docs": "Switches to the \"creating\" state in which the user can draw a new line.",
|
|
11979
12058
|
"docsTags": []
|
|
11980
12059
|
},
|
|
11981
12060
|
{
|
|
@@ -11998,7 +12077,7 @@
|
|
|
11998
12077
|
},
|
|
11999
12078
|
"signature": "stop(): Promise<void>",
|
|
12000
12079
|
"parameters": [],
|
|
12001
|
-
"docs": "",
|
|
12080
|
+
"docs": "Stops the creation operation.",
|
|
12002
12081
|
"docsTags": []
|
|
12003
12082
|
}
|
|
12004
12083
|
],
|
|
@@ -12043,7 +12122,7 @@
|
|
|
12043
12122
|
"overview": "",
|
|
12044
12123
|
"readme": "",
|
|
12045
12124
|
"usage": {},
|
|
12046
|
-
"docs": "The Expand component acts as a clickable button for
|
|
12125
|
+
"docs": "The Expand component acts as a clickable button for displaying interactive content, most commonly other components.",
|
|
12047
12126
|
"docsTags": [
|
|
12048
12127
|
{
|
|
12049
12128
|
"name": "superclass",
|
|
@@ -12252,7 +12331,12 @@
|
|
|
12252
12331
|
"attr": "focus-trap-disabled",
|
|
12253
12332
|
"reflectToAttr": false,
|
|
12254
12333
|
"docs": "Disables focus trapping within the expand component.",
|
|
12255
|
-
"docsTags": [
|
|
12334
|
+
"docsTags": [
|
|
12335
|
+
{
|
|
12336
|
+
"name": "since",
|
|
12337
|
+
"text": "4.33"
|
|
12338
|
+
}
|
|
12339
|
+
],
|
|
12256
12340
|
"default": "false",
|
|
12257
12341
|
"values": [
|
|
12258
12342
|
{
|
|
@@ -12276,7 +12360,7 @@
|
|
|
12276
12360
|
"docs": "Disables focus trapping within the expand widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#focusTrapDisabled)",
|
|
12277
12361
|
"docsTags": [],
|
|
12278
12362
|
"default": "false",
|
|
12279
|
-
"deprecation": "since 4.33
|
|
12363
|
+
"deprecation": "since 4.33, use [`focusTrapDisabled`](#focusTrapDisabled) instead.",
|
|
12280
12364
|
"values": [
|
|
12281
12365
|
{
|
|
12282
12366
|
"type": "boolean"
|
|
@@ -12564,8 +12648,13 @@
|
|
|
12564
12648
|
"mutable": true,
|
|
12565
12649
|
"attr": "reference-element",
|
|
12566
12650
|
"reflectToAttr": false,
|
|
12567
|
-
"docs": "",
|
|
12568
|
-
"docsTags": [
|
|
12651
|
+
"docs": "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.",
|
|
12652
|
+
"docsTags": [
|
|
12653
|
+
{
|
|
12654
|
+
"name": "see",
|
|
12655
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
12656
|
+
}
|
|
12657
|
+
],
|
|
12569
12658
|
"values": [
|
|
12570
12659
|
{
|
|
12571
12660
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -12632,7 +12721,7 @@
|
|
|
12632
12721
|
"docsTags": [
|
|
12633
12722
|
{
|
|
12634
12723
|
"name": "example",
|
|
12635
|
-
"text": "
|
|
12724
|
+
"text": "```js\nconst arcgisExpand = document.querySelector(\"arcgis-expand\");\ndocument.body.append(arcgisExpand);\nawait arcgisExpand.componentOnReady();\nconsole.log(\"arcgis-expand is ready to go!\");\n```"
|
|
12636
12725
|
},
|
|
12637
12726
|
{
|
|
12638
12727
|
"name": "inheritedFrom",
|
|
@@ -12984,7 +13073,7 @@
|
|
|
12984
13073
|
"docs": "",
|
|
12985
13074
|
"docsTags": [],
|
|
12986
13075
|
"default": "false",
|
|
12987
|
-
"deprecation": "since 4.33
|
|
13076
|
+
"deprecation": "since 4.33, use [hideLastEditedInfo](#hideLastEditedInfo) instead.",
|
|
12988
13077
|
"values": [
|
|
12989
13078
|
{
|
|
12990
13079
|
"type": "boolean"
|
|
@@ -13191,8 +13280,13 @@
|
|
|
13191
13280
|
"mutable": true,
|
|
13192
13281
|
"attr": "reference-element",
|
|
13193
13282
|
"reflectToAttr": false,
|
|
13194
|
-
"docs": "",
|
|
13195
|
-
"docsTags": [
|
|
13283
|
+
"docs": "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.",
|
|
13284
|
+
"docsTags": [
|
|
13285
|
+
{
|
|
13286
|
+
"name": "see",
|
|
13287
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
13288
|
+
}
|
|
13289
|
+
],
|
|
13196
13290
|
"values": [
|
|
13197
13291
|
{
|
|
13198
13292
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -13320,7 +13414,7 @@
|
|
|
13320
13414
|
"docsTags": [
|
|
13321
13415
|
{
|
|
13322
13416
|
"name": "example",
|
|
13323
|
-
"text": "
|
|
13417
|
+
"text": "```js\nconst arcgisFeature = document.querySelector(\"arcgis-feature\");\ndocument.body.append(arcgisFeature);\nawait arcgisFeature.componentOnReady();\nconsole.log(\"arcgis-feature is ready to go!\");\n```"
|
|
13324
13418
|
},
|
|
13325
13419
|
{
|
|
13326
13420
|
"name": "inheritedFrom",
|
|
@@ -13685,10 +13779,10 @@
|
|
|
13685
13779
|
},
|
|
13686
13780
|
{
|
|
13687
13781
|
"name": "layer",
|
|
13688
|
-
"type": "FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer",
|
|
13782
|
+
"type": "FeatureLayer | GeoJSONLayer | KnowledgeGraphSublayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer",
|
|
13689
13783
|
"complexType": {
|
|
13690
|
-
"original": "FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer",
|
|
13691
|
-
"resolved": "FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer",
|
|
13784
|
+
"original": "FeatureLayer | GeoJSONLayer | KnowledgeGraphSublayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer",
|
|
13785
|
+
"resolved": "FeatureLayer | GeoJSONLayer | KnowledgeGraphSublayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer",
|
|
13692
13786
|
"references": {
|
|
13693
13787
|
"FeatureLayer": {
|
|
13694
13788
|
"location": "import",
|
|
@@ -13700,6 +13794,11 @@
|
|
|
13700
13794
|
"path": "@arcgis/core/interfaces.d.ts",
|
|
13701
13795
|
"id": "notImplemented"
|
|
13702
13796
|
},
|
|
13797
|
+
"KnowledgeGraphSublayer": {
|
|
13798
|
+
"location": "import",
|
|
13799
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
13800
|
+
"id": "notImplemented"
|
|
13801
|
+
},
|
|
13703
13802
|
"OrientedImageryLayer": {
|
|
13704
13803
|
"location": "import",
|
|
13705
13804
|
"path": "@arcgis/core/interfaces.d.ts",
|
|
@@ -13728,6 +13827,9 @@
|
|
|
13728
13827
|
{
|
|
13729
13828
|
"type": "GeoJSONLayer"
|
|
13730
13829
|
},
|
|
13830
|
+
{
|
|
13831
|
+
"type": "KnowledgeGraphSublayer"
|
|
13832
|
+
},
|
|
13731
13833
|
{
|
|
13732
13834
|
"type": "OrientedImageryLayer"
|
|
13733
13835
|
},
|
|
@@ -13823,8 +13925,13 @@
|
|
|
13823
13925
|
"mutable": true,
|
|
13824
13926
|
"attr": "reference-element",
|
|
13825
13927
|
"reflectToAttr": false,
|
|
13826
|
-
"docs": "",
|
|
13827
|
-
"docsTags": [
|
|
13928
|
+
"docs": "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.",
|
|
13929
|
+
"docsTags": [
|
|
13930
|
+
{
|
|
13931
|
+
"name": "see",
|
|
13932
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
13933
|
+
}
|
|
13934
|
+
],
|
|
13828
13935
|
"values": [
|
|
13829
13936
|
{
|
|
13830
13937
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -13921,7 +14028,7 @@
|
|
|
13921
14028
|
"docsTags": [
|
|
13922
14029
|
{
|
|
13923
14030
|
"name": "example",
|
|
13924
|
-
"text": "
|
|
14031
|
+
"text": "```js\nconst arcgisFeatureForm = document.querySelector(\"arcgis-feature-form\");\ndocument.body.append(arcgisFeatureForm);\nawait arcgisFeatureForm.componentOnReady();\nconsole.log(\"arcgis-feature-form is ready to go!\");\n```"
|
|
13925
14032
|
},
|
|
13926
14033
|
{
|
|
13927
14034
|
"name": "inheritedFrom",
|
|
@@ -15967,8 +16074,13 @@
|
|
|
15967
16074
|
"mutable": true,
|
|
15968
16075
|
"attr": "reference-element",
|
|
15969
16076
|
"reflectToAttr": false,
|
|
15970
|
-
"docs": "",
|
|
15971
|
-
"docsTags": [
|
|
16077
|
+
"docs": "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.",
|
|
16078
|
+
"docsTags": [
|
|
16079
|
+
{
|
|
16080
|
+
"name": "see",
|
|
16081
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
16082
|
+
}
|
|
16083
|
+
],
|
|
15972
16084
|
"values": [
|
|
15973
16085
|
{
|
|
15974
16086
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -16357,7 +16469,7 @@
|
|
|
16357
16469
|
},
|
|
16358
16470
|
"mutable": true,
|
|
16359
16471
|
"reflectToAttr": false,
|
|
16360
|
-
"docs": "
|
|
16472
|
+
"docs": "Defines whether or not the feature supports resizing\nattachments.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#supportsResizeAttachments)",
|
|
16361
16473
|
"docsTags": [
|
|
16362
16474
|
{
|
|
16363
16475
|
"name": "readonly",
|
|
@@ -16610,7 +16722,7 @@
|
|
|
16610
16722
|
"docsTags": [
|
|
16611
16723
|
{
|
|
16612
16724
|
"name": "example",
|
|
16613
|
-
"text": "
|
|
16725
|
+
"text": "```js\nconst arcgisFeatureTable = document.querySelector(\"arcgis-feature-table\");\ndocument.body.append(arcgisFeatureTable);\nawait arcgisFeatureTable.componentOnReady();\nconsole.log(\"arcgis-feature-table is ready to go!\");\n```"
|
|
16614
16726
|
},
|
|
16615
16727
|
{
|
|
16616
16728
|
"name": "inheritedFrom",
|
|
@@ -17684,8 +17796,13 @@
|
|
|
17684
17796
|
"mutable": true,
|
|
17685
17797
|
"attr": "reference-element",
|
|
17686
17798
|
"reflectToAttr": false,
|
|
17687
|
-
"docs": "",
|
|
17688
|
-
"docsTags": [
|
|
17799
|
+
"docs": "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.",
|
|
17800
|
+
"docsTags": [
|
|
17801
|
+
{
|
|
17802
|
+
"name": "see",
|
|
17803
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
17804
|
+
}
|
|
17805
|
+
],
|
|
17689
17806
|
"values": [
|
|
17690
17807
|
{
|
|
17691
17808
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -17791,7 +17908,7 @@
|
|
|
17791
17908
|
"docsTags": [
|
|
17792
17909
|
{
|
|
17793
17910
|
"name": "example",
|
|
17794
|
-
"text": "
|
|
17911
|
+
"text": "```js\nconst arcgisFeatureTemplates = document.querySelector(\"arcgis-feature-templates\");\ndocument.body.append(arcgisFeatureTemplates);\nawait arcgisFeatureTemplates.componentOnReady();\nconsole.log(\"arcgis-feature-templates is ready to go!\");\n```"
|
|
17795
17912
|
},
|
|
17796
17913
|
{
|
|
17797
17914
|
"name": "inheritedFrom",
|
|
@@ -18625,8 +18742,13 @@
|
|
|
18625
18742
|
"mutable": true,
|
|
18626
18743
|
"attr": "reference-element",
|
|
18627
18744
|
"reflectToAttr": false,
|
|
18628
|
-
"docs": "",
|
|
18629
|
-
"docsTags": [
|
|
18745
|
+
"docs": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
18746
|
+
"docsTags": [
|
|
18747
|
+
{
|
|
18748
|
+
"name": "see",
|
|
18749
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
18750
|
+
}
|
|
18751
|
+
],
|
|
18630
18752
|
"values": [
|
|
18631
18753
|
{
|
|
18632
18754
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -18862,7 +18984,7 @@
|
|
|
18862
18984
|
"docsTags": [
|
|
18863
18985
|
{
|
|
18864
18986
|
"name": "example",
|
|
18865
|
-
"text": "
|
|
18987
|
+
"text": "```js\nconst arcgisFeatures = document.querySelector(\"arcgis-features\");\ndocument.body.append(arcgisFeatures);\nawait arcgisFeatures.componentOnReady();\nconsole.log(\"arcgis-features is ready to go!\");\n```"
|
|
18866
18988
|
},
|
|
18867
18989
|
{
|
|
18868
18990
|
"name": "inheritedFrom",
|
|
@@ -19415,8 +19537,13 @@
|
|
|
19415
19537
|
"mutable": true,
|
|
19416
19538
|
"attr": "reference-element",
|
|
19417
19539
|
"reflectToAttr": false,
|
|
19418
|
-
"docs": "",
|
|
19419
|
-
"docsTags": [
|
|
19540
|
+
"docs": "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.",
|
|
19541
|
+
"docsTags": [
|
|
19542
|
+
{
|
|
19543
|
+
"name": "see",
|
|
19544
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
19545
|
+
}
|
|
19546
|
+
],
|
|
19420
19547
|
"values": [
|
|
19421
19548
|
{
|
|
19422
19549
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -19481,7 +19608,7 @@
|
|
|
19481
19608
|
"docsTags": [
|
|
19482
19609
|
{
|
|
19483
19610
|
"name": "example",
|
|
19484
|
-
"text": "
|
|
19611
|
+
"text": "```js\nconst arcgisFloorFilter = document.querySelector(\"arcgis-floor-filter\");\ndocument.body.append(arcgisFloorFilter);\nawait arcgisFloorFilter.componentOnReady();\nconsole.log(\"arcgis-floor-filter is ready to go!\");\n```"
|
|
19485
19612
|
},
|
|
19486
19613
|
{
|
|
19487
19614
|
"name": "inheritedFrom",
|
|
@@ -19580,7 +19707,7 @@
|
|
|
19580
19707
|
"overview": "",
|
|
19581
19708
|
"readme": "",
|
|
19582
19709
|
"usage": {},
|
|
19583
|
-
"docs": "The Fullscreen component allows users to toggle the map or scene to fullscreen mode.",
|
|
19710
|
+
"docs": "The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\nUse the escape key (`esc`) to exit fullscreen mode.\n\n**Known limitations**\n\n* The Fullscreen widget only works with browsers that implement the [Fullscreen](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API) API.\n Thus, iOS Safari is not supported.",
|
|
19584
19711
|
"docsTags": [
|
|
19585
19712
|
{
|
|
19586
19713
|
"name": "superclass",
|
|
@@ -19645,7 +19772,7 @@
|
|
|
19645
19772
|
},
|
|
19646
19773
|
"mutable": true,
|
|
19647
19774
|
"reflectToAttr": false,
|
|
19648
|
-
"docs": "Replace localized message strings with your own strings
|
|
19775
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
19649
19776
|
"docsTags": [],
|
|
19650
19777
|
"values": [],
|
|
19651
19778
|
"optional": true,
|
|
@@ -19733,8 +19860,13 @@
|
|
|
19733
19860
|
"mutable": true,
|
|
19734
19861
|
"attr": "reference-element",
|
|
19735
19862
|
"reflectToAttr": false,
|
|
19736
|
-
"docs": "",
|
|
19737
|
-
"docsTags": [
|
|
19863
|
+
"docs": "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.",
|
|
19864
|
+
"docsTags": [
|
|
19865
|
+
{
|
|
19866
|
+
"name": "see",
|
|
19867
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
19868
|
+
}
|
|
19869
|
+
],
|
|
19738
19870
|
"values": [
|
|
19739
19871
|
{
|
|
19740
19872
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -19817,7 +19949,7 @@
|
|
|
19817
19949
|
"docsTags": [
|
|
19818
19950
|
{
|
|
19819
19951
|
"name": "example",
|
|
19820
|
-
"text": "
|
|
19952
|
+
"text": "```js\nconst arcgisFullscreen = document.querySelector(\"arcgis-fullscreen\");\ndocument.body.append(arcgisFullscreen);\nawait arcgisFullscreen.componentOnReady();\nconsole.log(\"arcgis-fullscreen is ready to go!\");\n```"
|
|
19821
19953
|
},
|
|
19822
19954
|
{
|
|
19823
19955
|
"name": "inheritedFrom",
|
|
@@ -20383,7 +20515,7 @@
|
|
|
20383
20515
|
},
|
|
20384
20516
|
"mutable": true,
|
|
20385
20517
|
"reflectToAttr": false,
|
|
20386
|
-
"docs": "Replace localized message strings with your own strings
|
|
20518
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
20387
20519
|
"docsTags": [],
|
|
20388
20520
|
"values": [],
|
|
20389
20521
|
"optional": true,
|
|
@@ -20493,8 +20625,13 @@
|
|
|
20493
20625
|
"mutable": true,
|
|
20494
20626
|
"attr": "reference-element",
|
|
20495
20627
|
"reflectToAttr": false,
|
|
20496
|
-
"docs": "",
|
|
20497
|
-
"docsTags": [
|
|
20628
|
+
"docs": "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.",
|
|
20629
|
+
"docsTags": [
|
|
20630
|
+
{
|
|
20631
|
+
"name": "see",
|
|
20632
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
20633
|
+
}
|
|
20634
|
+
],
|
|
20498
20635
|
"values": [
|
|
20499
20636
|
{
|
|
20500
20637
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -20740,7 +20877,7 @@
|
|
|
20740
20877
|
"docsTags": [
|
|
20741
20878
|
{
|
|
20742
20879
|
"name": "example",
|
|
20743
|
-
"text": "
|
|
20880
|
+
"text": "```js\nconst arcgisGridControls = document.querySelector(\"arcgis-grid-controls\");\ndocument.body.append(arcgisGridControls);\nawait arcgisGridControls.componentOnReady();\nconsole.log(\"arcgis-grid-controls is ready to go!\");\n```"
|
|
20744
20881
|
},
|
|
20745
20882
|
{
|
|
20746
20883
|
"name": "inheritedFrom",
|
|
@@ -21319,8 +21456,13 @@
|
|
|
21319
21456
|
"mutable": true,
|
|
21320
21457
|
"attr": "reference-element",
|
|
21321
21458
|
"reflectToAttr": false,
|
|
21322
|
-
"docs": "",
|
|
21323
|
-
"docsTags": [
|
|
21459
|
+
"docs": "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.",
|
|
21460
|
+
"docsTags": [
|
|
21461
|
+
{
|
|
21462
|
+
"name": "see",
|
|
21463
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
21464
|
+
}
|
|
21465
|
+
],
|
|
21324
21466
|
"values": [
|
|
21325
21467
|
{
|
|
21326
21468
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -21460,7 +21602,7 @@
|
|
|
21460
21602
|
"docsTags": [
|
|
21461
21603
|
{
|
|
21462
21604
|
"name": "example",
|
|
21463
|
-
"text": "
|
|
21605
|
+
"text": "```js\nconst arcgisHistogramRangeSlider = document.querySelector(\"arcgis-histogram-range-slider\");\ndocument.body.append(arcgisHistogramRangeSlider);\nawait arcgisHistogramRangeSlider.componentOnReady();\nconsole.log(\"arcgis-histogram-range-slider is ready to go!\");\n```"
|
|
21464
21606
|
},
|
|
21465
21607
|
{
|
|
21466
21608
|
"name": "inheritedFrom",
|
|
@@ -21676,7 +21818,7 @@
|
|
|
21676
21818
|
},
|
|
21677
21819
|
"mutable": true,
|
|
21678
21820
|
"reflectToAttr": false,
|
|
21679
|
-
"docs": "Replace localized message strings with your own strings
|
|
21821
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
21680
21822
|
"docsTags": [],
|
|
21681
21823
|
"values": [],
|
|
21682
21824
|
"optional": true,
|
|
@@ -21764,8 +21906,13 @@
|
|
|
21764
21906
|
"mutable": true,
|
|
21765
21907
|
"attr": "reference-element",
|
|
21766
21908
|
"reflectToAttr": false,
|
|
21767
|
-
"docs": "",
|
|
21768
|
-
"docsTags": [
|
|
21909
|
+
"docs": "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.",
|
|
21910
|
+
"docsTags": [
|
|
21911
|
+
{
|
|
21912
|
+
"name": "see",
|
|
21913
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
21914
|
+
}
|
|
21915
|
+
],
|
|
21769
21916
|
"values": [
|
|
21770
21917
|
{
|
|
21771
21918
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -21835,11 +21982,11 @@
|
|
|
21835
21982
|
},
|
|
21836
21983
|
"mutable": true,
|
|
21837
21984
|
"reflectToAttr": false,
|
|
21838
|
-
"docs": "The esri
|
|
21985
|
+
"docs": "The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nto go to when going \"home\".\nThe initial value is determined in a few different ways:\n\nIf no referenceElement is provided, the value is `null`.\nOnce the referenceElement is ready, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html).",
|
|
21839
21986
|
"docsTags": [
|
|
21840
21987
|
{
|
|
21841
21988
|
"name": "example",
|
|
21842
|
-
"text": "//
|
|
21989
|
+
"text": " ```js\n// Create viewpoint centered on extent of a polygon geometry\n\nlet vp = new Viewpoint({\n targetGeometry: geom.extent\n});\n\n// Sets the Home's viewpoint to that Viewpoint\nhome.viewpoint = vp;\n```"
|
|
21843
21990
|
}
|
|
21844
21991
|
],
|
|
21845
21992
|
"default": "null",
|
|
@@ -21870,12 +22017,7 @@
|
|
|
21870
22017
|
"signature": "cancelGo(): Promise<void>",
|
|
21871
22018
|
"parameters": [],
|
|
21872
22019
|
"docs": "This function provides the ability to interrupt and cancel the process\nof navigating the view back to the view's initial extent.",
|
|
21873
|
-
"docsTags": [
|
|
21874
|
-
{
|
|
21875
|
-
"name": "since",
|
|
21876
|
-
"text": "4.9"
|
|
21877
|
-
}
|
|
21878
|
-
]
|
|
22020
|
+
"docsTags": []
|
|
21879
22021
|
},
|
|
21880
22022
|
{
|
|
21881
22023
|
"name": "componentOnReady",
|
|
@@ -21901,7 +22043,7 @@
|
|
|
21901
22043
|
"docsTags": [
|
|
21902
22044
|
{
|
|
21903
22045
|
"name": "example",
|
|
21904
|
-
"text": "
|
|
22046
|
+
"text": "```js\nconst arcgisHome = document.querySelector(\"arcgis-home\");\ndocument.body.append(arcgisHome);\nawait arcgisHome.componentOnReady();\nconsole.log(\"arcgis-home is ready to go!\");\n```"
|
|
21905
22047
|
},
|
|
21906
22048
|
{
|
|
21907
22049
|
"name": "inheritedFrom",
|
|
@@ -21978,7 +22120,7 @@
|
|
|
21978
22120
|
"docsTags": [
|
|
21979
22121
|
{
|
|
21980
22122
|
"name": "example",
|
|
21981
|
-
"text": "
|
|
22123
|
+
"text": "```js\nhome.addEventListener(\"arcgisGo\", (event) => {\n console.log(\"updating viewpoint\");\n});\n```"
|
|
21982
22124
|
}
|
|
21983
22125
|
]
|
|
21984
22126
|
},
|
|
@@ -22605,8 +22747,13 @@
|
|
|
22605
22747
|
"mutable": true,
|
|
22606
22748
|
"attr": "reference-element",
|
|
22607
22749
|
"reflectToAttr": false,
|
|
22608
|
-
"docs": "",
|
|
22609
|
-
"docsTags": [
|
|
22750
|
+
"docs": "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.",
|
|
22751
|
+
"docsTags": [
|
|
22752
|
+
{
|
|
22753
|
+
"name": "see",
|
|
22754
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
22755
|
+
}
|
|
22756
|
+
],
|
|
22610
22757
|
"values": [
|
|
22611
22758
|
{
|
|
22612
22759
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -22934,7 +23081,7 @@
|
|
|
22934
23081
|
"docsTags": [
|
|
22935
23082
|
{
|
|
22936
23083
|
"name": "example",
|
|
22937
|
-
"text": "
|
|
23084
|
+
"text": "```js\nconst arcgisLayerList = document.querySelector(\"arcgis-layer-list\");\ndocument.body.append(arcgisLayerList);\nawait arcgisLayerList.componentOnReady();\nconsole.log(\"arcgis-layer-list is ready to go!\");\n```"
|
|
22938
23085
|
},
|
|
22939
23086
|
{
|
|
22940
23087
|
"name": "inheritedFrom",
|
|
@@ -23421,8 +23568,13 @@
|
|
|
23421
23568
|
"mutable": true,
|
|
23422
23569
|
"attr": "reference-element",
|
|
23423
23570
|
"reflectToAttr": false,
|
|
23424
|
-
"docs": "",
|
|
23425
|
-
"docsTags": [
|
|
23571
|
+
"docs": "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.",
|
|
23572
|
+
"docsTags": [
|
|
23573
|
+
{
|
|
23574
|
+
"name": "see",
|
|
23575
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
23576
|
+
}
|
|
23577
|
+
],
|
|
23426
23578
|
"values": [
|
|
23427
23579
|
{
|
|
23428
23580
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -23542,7 +23694,7 @@
|
|
|
23542
23694
|
"docsTags": [
|
|
23543
23695
|
{
|
|
23544
23696
|
"name": "example",
|
|
23545
|
-
"text": "
|
|
23697
|
+
"text": "```js\nconst arcgisLegend = document.querySelector(\"arcgis-legend\");\ndocument.body.append(arcgisLegend);\nawait arcgisLegend.componentOnReady();\nconsole.log(\"arcgis-legend is ready to go!\");\n```"
|
|
23546
23698
|
},
|
|
23547
23699
|
{
|
|
23548
23700
|
"name": "inheritedFrom",
|
|
@@ -23615,7 +23767,7 @@
|
|
|
23615
23767
|
"overview": "",
|
|
23616
23768
|
"readme": "",
|
|
23617
23769
|
"usage": {},
|
|
23618
|
-
"docs": "The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a
|
|
23770
|
+
"docs": "The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including the ground, integrated meshes, and 3D objects such as buildings or trees.\n\n\n\nThe analysis results are displayed as colored lines, where areas visible to the observer are\nshown green and occluded parts are marked in red. Also, the color of the target points indicates their visibility.\nWhen the line of sight cannot be calculated, it will be displayed with a gray color. This may happen if either\nthe target or the observer is not in the view.\n\nWhen creating a new line of sight analysis, the first click in the Scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html)\nand subsequent clicks place the [targets](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html).\nBoth the observer and target points can be moved by dragging. Additionally, the target points can be removed with a right click.\n\n**Known limitation**\n\nLine Of Sight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\n- [Sample - Line of sight component](https://developers.arcgis.com/javascript/latest/sample-code/line-of-sight/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)",
|
|
23619
23771
|
"docsTags": [
|
|
23620
23772
|
{
|
|
23621
23773
|
"name": "superclass",
|
|
@@ -23643,13 +23795,8 @@
|
|
|
23643
23795
|
},
|
|
23644
23796
|
"mutable": true,
|
|
23645
23797
|
"reflectToAttr": false,
|
|
23646
|
-
"docs": "The [
|
|
23647
|
-
"docsTags": [
|
|
23648
|
-
{
|
|
23649
|
-
"name": "readonly",
|
|
23650
|
-
"text": ""
|
|
23651
|
-
}
|
|
23652
|
-
],
|
|
23798
|
+
"docs": "The [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Line Of Sight component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n//Create the analysis.\nconst lineOfSightAnalysis = new LineOfSightAnalysis({\n observer: new LineOfSightAnalysisObserver({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624828.3377593,\n y: 4550305.319405007,\n z: 105.55410975124687\n }),\n }),\n targets: [ new LineOfSightAnalysisTarget({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624944.17687458,\n y: 4550420.577689567,\n z: 0\n }),\n })\n]\n});\n// Get the Scene and Line Of Sight component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst lineOfSight = document.querySelector(\"arcgis-line-of-sight\");\nawait lineOfSight.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(lineOfSightAnalysis);\n// Connect the analysis to the component:\nlineOfSight.analysis = lineOfSightAnalysis;\n```",
|
|
23799
|
+
"docsTags": [],
|
|
23653
23800
|
"values": [],
|
|
23654
23801
|
"optional": true,
|
|
23655
23802
|
"required": false
|
|
@@ -23734,7 +23881,7 @@
|
|
|
23734
23881
|
},
|
|
23735
23882
|
"mutable": true,
|
|
23736
23883
|
"reflectToAttr": false,
|
|
23737
|
-
"docs": "Replace localized message strings with your own strings
|
|
23884
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
23738
23885
|
"docsTags": [],
|
|
23739
23886
|
"values": [],
|
|
23740
23887
|
"optional": true,
|
|
@@ -23822,8 +23969,13 @@
|
|
|
23822
23969
|
"mutable": true,
|
|
23823
23970
|
"attr": "reference-element",
|
|
23824
23971
|
"reflectToAttr": false,
|
|
23825
|
-
"docs": "",
|
|
23826
|
-
"docsTags": [
|
|
23972
|
+
"docs": "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.",
|
|
23973
|
+
"docsTags": [
|
|
23974
|
+
{
|
|
23975
|
+
"name": "see",
|
|
23976
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
23977
|
+
}
|
|
23978
|
+
],
|
|
23827
23979
|
"values": [
|
|
23828
23980
|
{
|
|
23829
23981
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -23850,7 +24002,8 @@
|
|
|
23850
24002
|
"references": {}
|
|
23851
24003
|
},
|
|
23852
24004
|
"mutable": true,
|
|
23853
|
-
"
|
|
24005
|
+
"attr": "state",
|
|
24006
|
+
"reflectToAttr": true,
|
|
23854
24007
|
"docs": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for analysis\n* `creating` - observer/target points are being placed\n* `created` - finished analysis",
|
|
23855
24008
|
"docsTags": [
|
|
23856
24009
|
{
|
|
@@ -23928,7 +24081,7 @@
|
|
|
23928
24081
|
"docsTags": [
|
|
23929
24082
|
{
|
|
23930
24083
|
"name": "example",
|
|
23931
|
-
"text": "
|
|
24084
|
+
"text": "```js\nconst arcgisLineOfSight = document.querySelector(\"arcgis-line-of-sight\");\ndocument.body.append(arcgisLineOfSight);\nawait arcgisLineOfSight.componentOnReady();\nconsole.log(\"arcgis-line-of-sight is ready to go!\");\n```"
|
|
23932
24085
|
},
|
|
23933
24086
|
{
|
|
23934
24087
|
"name": "inheritedFrom",
|
|
@@ -23956,7 +24109,7 @@
|
|
|
23956
24109
|
},
|
|
23957
24110
|
"signature": "continue(): Promise<void>",
|
|
23958
24111
|
"parameters": [],
|
|
23959
|
-
"docs": "After [stop()](
|
|
24112
|
+
"docs": "After [stop()](#stop) was called, this method allows to continue the line of sight analysis and add more targets.",
|
|
23960
24113
|
"docsTags": []
|
|
23961
24114
|
},
|
|
23962
24115
|
{
|
|
@@ -24025,7 +24178,7 @@
|
|
|
24025
24178
|
},
|
|
24026
24179
|
"signature": "stop(): Promise<void>",
|
|
24027
24180
|
"parameters": [],
|
|
24028
|
-
"docs": "Stop the current line of sight analysis
|
|
24181
|
+
"docs": "Stop the current placing of line of sight analysis. Any lines added this far are kept in the view.\nUsers can still interact with existing targets and the observer, but they cannot place new target points.",
|
|
24029
24182
|
"docsTags": []
|
|
24030
24183
|
}
|
|
24031
24184
|
],
|
|
@@ -24358,8 +24511,17 @@
|
|
|
24358
24511
|
},
|
|
24359
24512
|
"mutable": true,
|
|
24360
24513
|
"reflectToAttr": false,
|
|
24361
|
-
"docs": "Allows for adding graphics directly to the default graphics in the View
|
|
24362
|
-
"docsTags": [
|
|
24514
|
+
"docs": "Allows for adding graphics directly to the default graphics in the View.",
|
|
24515
|
+
"docsTags": [
|
|
24516
|
+
{
|
|
24517
|
+
"name": "example",
|
|
24518
|
+
"text": "```js\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n```"
|
|
24519
|
+
},
|
|
24520
|
+
{
|
|
24521
|
+
"name": "example",
|
|
24522
|
+
"text": "```js\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```"
|
|
24523
|
+
}
|
|
24524
|
+
],
|
|
24363
24525
|
"values": [],
|
|
24364
24526
|
"optional": true,
|
|
24365
24527
|
"required": false
|
|
@@ -25074,7 +25236,7 @@
|
|
|
25074
25236
|
],
|
|
25075
25237
|
"docs": "",
|
|
25076
25238
|
"docsTags": [],
|
|
25077
|
-
"deprecation": "since 4.33
|
|
25239
|
+
"deprecation": "since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection."
|
|
25078
25240
|
},
|
|
25079
25241
|
{
|
|
25080
25242
|
"name": "addLayers",
|
|
@@ -25130,7 +25292,7 @@
|
|
|
25130
25292
|
],
|
|
25131
25293
|
"docs": "",
|
|
25132
25294
|
"docsTags": [],
|
|
25133
|
-
"deprecation": "since 4.33
|
|
25295
|
+
"deprecation": "since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection."
|
|
25134
25296
|
},
|
|
25135
25297
|
{
|
|
25136
25298
|
"name": "closePopup",
|
|
@@ -25179,7 +25341,7 @@
|
|
|
25179
25341
|
"docsTags": [
|
|
25180
25342
|
{
|
|
25181
25343
|
"name": "example",
|
|
25182
|
-
"text": "
|
|
25344
|
+
"text": "```js\nconst arcgisLinkChart = document.querySelector(\"arcgis-link-chart\");\ndocument.body.append(arcgisLinkChart);\nawait arcgisLinkChart.componentOnReady();\nconsole.log(\"arcgis-link-chart is ready to go!\");\n```"
|
|
25183
25345
|
},
|
|
25184
25346
|
{
|
|
25185
25347
|
"name": "inheritedFrom",
|
|
@@ -25470,8 +25632,21 @@
|
|
|
25470
25632
|
"docs": ""
|
|
25471
25633
|
}
|
|
25472
25634
|
],
|
|
25473
|
-
"docs": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters
|
|
25474
|
-
"docsTags": [
|
|
25635
|
+
"docs": "`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.",
|
|
25636
|
+
"docsTags": [
|
|
25637
|
+
{
|
|
25638
|
+
"name": "since",
|
|
25639
|
+
"text": "4.33"
|
|
25640
|
+
},
|
|
25641
|
+
{
|
|
25642
|
+
"name": "see",
|
|
25643
|
+
"text": "[Watch for changes - waiting for components or views to be ready](https://developers.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
|
|
25644
|
+
},
|
|
25645
|
+
{
|
|
25646
|
+
"name": "example",
|
|
25647
|
+
"text": "```js\nconst viewElement = document.querySelector(\"arcgis-link-chart\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\n```"
|
|
25648
|
+
}
|
|
25649
|
+
]
|
|
25475
25650
|
},
|
|
25476
25651
|
{
|
|
25477
25652
|
"name": "whenLayerView",
|
|
@@ -26009,10 +26184,6 @@
|
|
|
26009
26184
|
{
|
|
26010
26185
|
"name": "see",
|
|
26011
26186
|
"text": "[Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)"
|
|
26012
|
-
},
|
|
26013
|
-
{
|
|
26014
|
-
"name": "since",
|
|
26015
|
-
"text": "4.28"
|
|
26016
26187
|
}
|
|
26017
26188
|
],
|
|
26018
26189
|
"default": "\"nodes-link\"",
|
|
@@ -26114,7 +26285,7 @@
|
|
|
26114
26285
|
},
|
|
26115
26286
|
"mutable": true,
|
|
26116
26287
|
"reflectToAttr": false,
|
|
26117
|
-
"docs": "Replace localized message strings with your own strings
|
|
26288
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
26118
26289
|
"docsTags": [],
|
|
26119
26290
|
"values": [],
|
|
26120
26291
|
"optional": true,
|
|
@@ -26224,7 +26395,7 @@
|
|
|
26224
26395
|
"mutable": true,
|
|
26225
26396
|
"attr": "reference-element",
|
|
26226
26397
|
"reflectToAttr": false,
|
|
26227
|
-
"docs": "",
|
|
26398
|
+
"docs": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)",
|
|
26228
26399
|
"docsTags": [],
|
|
26229
26400
|
"values": [
|
|
26230
26401
|
{
|
|
@@ -26305,7 +26476,7 @@
|
|
|
26305
26476
|
"docsTags": [
|
|
26306
26477
|
{
|
|
26307
26478
|
"name": "example",
|
|
26308
|
-
"text": "
|
|
26479
|
+
"text": "```js\nconst arcgisLinkChartLayoutSwitcher = document.querySelector(\"arcgis-link-chart-layout-switcher\");\ndocument.body.append(arcgisLinkChartLayoutSwitcher);\nawait arcgisLinkChartLayoutSwitcher.componentOnReady();\nconsole.log(\"arcgis-link-chart-layout-switcher is ready to go!\");\n```"
|
|
26309
26480
|
},
|
|
26310
26481
|
{
|
|
26311
26482
|
"name": "inheritedFrom",
|
|
@@ -26422,7 +26593,7 @@
|
|
|
26422
26593
|
"docsTags": [
|
|
26423
26594
|
{
|
|
26424
26595
|
"name": "example",
|
|
26425
|
-
"text": "
|
|
26596
|
+
"text": "```js\nlayoutswitcher.addEventListener(\"arcgisSwitchLayout\", (event) => {\n console.log(\"Layout Switched\");\n});\n```"
|
|
26426
26597
|
}
|
|
26427
26598
|
]
|
|
26428
26599
|
}
|
|
@@ -26438,7 +26609,7 @@
|
|
|
26438
26609
|
"overview": "",
|
|
26439
26610
|
"readme": "",
|
|
26440
26611
|
"usage": {},
|
|
26441
|
-
"docs": "The Locate component animates the Map or Scene to the user's current location.",
|
|
26612
|
+
"docs": "The Locate component animates the Map or Scene to the user's current location.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that support\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility).",
|
|
26442
26613
|
"docsTags": [
|
|
26443
26614
|
{
|
|
26444
26615
|
"name": "superclass",
|
|
@@ -26607,7 +26778,7 @@
|
|
|
26607
26778
|
},
|
|
26608
26779
|
"mutable": true,
|
|
26609
26780
|
"reflectToAttr": false,
|
|
26610
|
-
"docs": "Replace localized message strings with your own strings
|
|
26781
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
26611
26782
|
"docsTags": [],
|
|
26612
26783
|
"values": [],
|
|
26613
26784
|
"optional": true,
|
|
@@ -26717,8 +26888,13 @@
|
|
|
26717
26888
|
"mutable": true,
|
|
26718
26889
|
"attr": "reference-element",
|
|
26719
26890
|
"reflectToAttr": false,
|
|
26720
|
-
"docs": "",
|
|
26721
|
-
"docsTags": [
|
|
26891
|
+
"docs": "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.",
|
|
26892
|
+
"docsTags": [
|
|
26893
|
+
{
|
|
26894
|
+
"name": "see",
|
|
26895
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
26896
|
+
}
|
|
26897
|
+
],
|
|
26722
26898
|
"values": [
|
|
26723
26899
|
{
|
|
26724
26900
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -26845,7 +27021,7 @@
|
|
|
26845
27021
|
"docsTags": [
|
|
26846
27022
|
{
|
|
26847
27023
|
"name": "example",
|
|
26848
|
-
"text": "
|
|
27024
|
+
"text": "```js\nconst arcgisLocate = document.querySelector(\"arcgis-locate\");\ndocument.body.append(arcgisLocate);\nawait arcgisLocate.componentOnReady();\nconsole.log(\"arcgis-locate is ready to go!\");\n```"
|
|
26849
27025
|
},
|
|
26850
27026
|
{
|
|
26851
27027
|
"name": "inheritedFrom",
|
|
@@ -26974,7 +27150,7 @@
|
|
|
26974
27150
|
"overview": "",
|
|
26975
27151
|
"readme": "",
|
|
26976
27152
|
"usage": {},
|
|
26977
|
-
"docs": "The ArcGIS Map
|
|
27153
|
+
"docs": "The ArcGIS Map component is used to add 2D maps to web applications. For 3D maps, use the\n[ArcGIS Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and loads a WebMap from either [ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\"></arcgis-map>\n```\n\nAlternatively, the Map component can be initialized without a WebMap item.\n\n```html\n<arcgis-map basemap=\"satellite\" center=\"-154.88, 19.46\" zoom=\"15\"></arcgis-map>\n```\n\nOther components can be added and connected to the Map component.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\">\n <arcgis-zoom position=\"top-left\"></arcgis-zoom>\n <arcgis-legend position=\"bottom-left\"></arcgis-legend>\n</arcgis-map>\n```\n\nThe Map component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/) of the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My Layer\" });\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Map component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-map)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)",
|
|
26978
27154
|
"docsTags": [
|
|
26979
27155
|
{
|
|
26980
27156
|
"name": "superclass",
|
|
@@ -27311,8 +27487,17 @@
|
|
|
27311
27487
|
},
|
|
27312
27488
|
"mutable": true,
|
|
27313
27489
|
"reflectToAttr": false,
|
|
27314
|
-
"docs": "Allows for adding graphics directly to the default graphics in the View
|
|
27315
|
-
"docsTags": [
|
|
27490
|
+
"docs": "Allows for adding graphics directly to the default graphics in the View.",
|
|
27491
|
+
"docsTags": [
|
|
27492
|
+
{
|
|
27493
|
+
"name": "example",
|
|
27494
|
+
"text": "```js\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n```"
|
|
27495
|
+
},
|
|
27496
|
+
{
|
|
27497
|
+
"name": "example",
|
|
27498
|
+
"text": "```js\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```"
|
|
27499
|
+
}
|
|
27500
|
+
],
|
|
27316
27501
|
"values": [],
|
|
27317
27502
|
"optional": true,
|
|
27318
27503
|
"required": false
|
|
@@ -27365,7 +27550,7 @@
|
|
|
27365
27550
|
"reflectToAttr": false,
|
|
27366
27551
|
"docs": "Options for configuring the highlight.",
|
|
27367
27552
|
"docsTags": [],
|
|
27368
|
-
"deprecation": "
|
|
27553
|
+
"deprecation": "since 4.33, use [highlights](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#highlights) instead.\n\nOptions for configuring the highlight. Use the highlight method on the\nappropriate esri/views/layers/LayerView to highlight a feature.\nThe layerView's `highlightOptions` will take precedence over the MapView's `highlightOptions` if both properties are set.",
|
|
27369
27554
|
"values": [],
|
|
27370
27555
|
"optional": true,
|
|
27371
27556
|
"required": false
|
|
@@ -28129,7 +28314,7 @@
|
|
|
28129
28314
|
],
|
|
28130
28315
|
"docs": "",
|
|
28131
28316
|
"docsTags": [],
|
|
28132
|
-
"deprecation": "since 4.33
|
|
28317
|
+
"deprecation": "since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection."
|
|
28133
28318
|
},
|
|
28134
28319
|
{
|
|
28135
28320
|
"name": "addLayers",
|
|
@@ -28185,7 +28370,7 @@
|
|
|
28185
28370
|
],
|
|
28186
28371
|
"docs": "",
|
|
28187
28372
|
"docsTags": [],
|
|
28188
|
-
"deprecation": "since 4.33
|
|
28373
|
+
"deprecation": "since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection."
|
|
28189
28374
|
},
|
|
28190
28375
|
{
|
|
28191
28376
|
"name": "addTable",
|
|
@@ -28226,7 +28411,7 @@
|
|
|
28226
28411
|
],
|
|
28227
28412
|
"docs": "",
|
|
28228
28413
|
"docsTags": [],
|
|
28229
|
-
"deprecation": "since 4.33
|
|
28414
|
+
"deprecation": "since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the map tables collection."
|
|
28230
28415
|
},
|
|
28231
28416
|
{
|
|
28232
28417
|
"name": "addTables",
|
|
@@ -28282,7 +28467,7 @@
|
|
|
28282
28467
|
],
|
|
28283
28468
|
"docs": "",
|
|
28284
28469
|
"docsTags": [],
|
|
28285
|
-
"deprecation": "since 4.33
|
|
28470
|
+
"deprecation": "since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the map tables collection."
|
|
28286
28471
|
},
|
|
28287
28472
|
{
|
|
28288
28473
|
"name": "closePopup",
|
|
@@ -28331,7 +28516,7 @@
|
|
|
28331
28516
|
"docsTags": [
|
|
28332
28517
|
{
|
|
28333
28518
|
"name": "example",
|
|
28334
|
-
"text": "
|
|
28519
|
+
"text": "```js\nconst arcgisMap = document.querySelector(\"arcgis-map\");\ndocument.body.append(arcgisMap);\nawait arcgisMap.componentOnReady();\nconsole.log(\"arcgis-map is ready to go!\");\n```"
|
|
28335
28520
|
},
|
|
28336
28521
|
{
|
|
28337
28522
|
"name": "inheritedFrom",
|
|
@@ -28732,8 +28917,21 @@
|
|
|
28732
28917
|
"docs": ""
|
|
28733
28918
|
}
|
|
28734
28919
|
],
|
|
28735
|
-
"docs": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters
|
|
28736
|
-
"docsTags": [
|
|
28920
|
+
"docs": "`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.",
|
|
28921
|
+
"docsTags": [
|
|
28922
|
+
{
|
|
28923
|
+
"name": "since",
|
|
28924
|
+
"text": "4.33"
|
|
28925
|
+
},
|
|
28926
|
+
{
|
|
28927
|
+
"name": "see",
|
|
28928
|
+
"text": "[Watch for changes - waiting for components or views to be ready](https://developers.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
|
|
28929
|
+
},
|
|
28930
|
+
{
|
|
28931
|
+
"name": "example",
|
|
28932
|
+
"text": "```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nviewElement.map.add(new FeatureLayer({...}));\n```"
|
|
28933
|
+
}
|
|
28934
|
+
]
|
|
28737
28935
|
},
|
|
28738
28936
|
{
|
|
28739
28937
|
"name": "whenLayerView",
|
|
@@ -29568,8 +29766,13 @@
|
|
|
29568
29766
|
"mutable": true,
|
|
29569
29767
|
"attr": "reference-element",
|
|
29570
29768
|
"reflectToAttr": false,
|
|
29571
|
-
"docs": "",
|
|
29572
|
-
"docsTags": [
|
|
29769
|
+
"docs": "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.",
|
|
29770
|
+
"docsTags": [
|
|
29771
|
+
{
|
|
29772
|
+
"name": "see",
|
|
29773
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
29774
|
+
}
|
|
29775
|
+
],
|
|
29573
29776
|
"values": [
|
|
29574
29777
|
{
|
|
29575
29778
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -29676,7 +29879,7 @@
|
|
|
29676
29879
|
"docsTags": [
|
|
29677
29880
|
{
|
|
29678
29881
|
"name": "example",
|
|
29679
|
-
"text": "
|
|
29882
|
+
"text": "```js\nconst arcgisMeasurement = document.querySelector(\"arcgis-measurement\");\ndocument.body.append(arcgisMeasurement);\nawait arcgisMeasurement.componentOnReady();\nconsole.log(\"arcgis-measurement is ready to go!\");\n```"
|
|
29680
29883
|
},
|
|
29681
29884
|
{
|
|
29682
29885
|
"name": "inheritedFrom",
|
|
@@ -29772,7 +29975,7 @@
|
|
|
29772
29975
|
"overview": "",
|
|
29773
29976
|
"readme": "",
|
|
29774
29977
|
"usage": {},
|
|
29775
|
-
"docs": "The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\
|
|
29978
|
+
"docs": "The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\n**Known limitations**\n\nNavigation Toggle is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.",
|
|
29776
29979
|
"docsTags": [
|
|
29777
29980
|
{
|
|
29778
29981
|
"name": "superclass",
|
|
@@ -29868,7 +30071,7 @@
|
|
|
29868
30071
|
},
|
|
29869
30072
|
"mutable": true,
|
|
29870
30073
|
"reflectToAttr": false,
|
|
29871
|
-
"docs": "Replace localized message strings with your own strings
|
|
30074
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
29872
30075
|
"docsTags": [],
|
|
29873
30076
|
"values": [],
|
|
29874
30077
|
"optional": true,
|
|
@@ -29885,7 +30088,7 @@
|
|
|
29885
30088
|
"mutable": true,
|
|
29886
30089
|
"attr": "navigation-mode",
|
|
29887
30090
|
"reflectToAttr": true,
|
|
29888
|
-
"docs": "The navigation mode of the view.
|
|
30091
|
+
"docs": "The navigation mode of the view. The possible values:\n\n* `pan` - The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\n* `rotate` - The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.",
|
|
29889
30092
|
"docsTags": [],
|
|
29890
30093
|
"default": "\"pan\"",
|
|
29891
30094
|
"values": [
|
|
@@ -29983,8 +30186,13 @@
|
|
|
29983
30186
|
"mutable": true,
|
|
29984
30187
|
"attr": "reference-element",
|
|
29985
30188
|
"reflectToAttr": false,
|
|
29986
|
-
"docs": "",
|
|
29987
|
-
"docsTags": [
|
|
30189
|
+
"docs": "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.",
|
|
30190
|
+
"docsTags": [
|
|
30191
|
+
{
|
|
30192
|
+
"name": "see",
|
|
30193
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
30194
|
+
}
|
|
30195
|
+
],
|
|
29988
30196
|
"values": [
|
|
29989
30197
|
{
|
|
29990
30198
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -30014,8 +30222,12 @@
|
|
|
30014
30222
|
"attr": "state",
|
|
30015
30223
|
"reflectToAttr": true,
|
|
30016
30224
|
"docs": "The current state of the component.",
|
|
30017
|
-
"docsTags": [
|
|
30018
|
-
|
|
30225
|
+
"docsTags": [
|
|
30226
|
+
{
|
|
30227
|
+
"name": "readonly",
|
|
30228
|
+
"text": ""
|
|
30229
|
+
}
|
|
30230
|
+
],
|
|
30019
30231
|
"values": [
|
|
30020
30232
|
{
|
|
30021
30233
|
"value": "disabled",
|
|
@@ -30055,7 +30267,7 @@
|
|
|
30055
30267
|
"docsTags": [
|
|
30056
30268
|
{
|
|
30057
30269
|
"name": "example",
|
|
30058
|
-
"text": "
|
|
30270
|
+
"text": "```js\nconst arcgisNavigationToggle = document.querySelector(\"arcgis-navigation-toggle\");\ndocument.body.append(arcgisNavigationToggle);\nawait arcgisNavigationToggle.componentOnReady();\nconsole.log(\"arcgis-navigation-toggle is ready to go!\");\n```"
|
|
30059
30271
|
},
|
|
30060
30272
|
{
|
|
30061
30273
|
"name": "inheritedFrom",
|
|
@@ -30581,8 +30793,13 @@
|
|
|
30581
30793
|
"mutable": true,
|
|
30582
30794
|
"attr": "reference-element",
|
|
30583
30795
|
"reflectToAttr": false,
|
|
30584
|
-
"docs": "",
|
|
30585
|
-
"docsTags": [
|
|
30796
|
+
"docs": "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.",
|
|
30797
|
+
"docsTags": [
|
|
30798
|
+
{
|
|
30799
|
+
"name": "see",
|
|
30800
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
30801
|
+
}
|
|
30802
|
+
],
|
|
30586
30803
|
"values": [
|
|
30587
30804
|
{
|
|
30588
30805
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -30653,7 +30870,7 @@
|
|
|
30653
30870
|
"docsTags": [
|
|
30654
30871
|
{
|
|
30655
30872
|
"name": "example",
|
|
30656
|
-
"text": "
|
|
30873
|
+
"text": "```js\nconst arcgisOrientedImageryViewer = document.querySelector(\"arcgis-oriented-imagery-viewer\");\ndocument.body.append(arcgisOrientedImageryViewer);\nawait arcgisOrientedImageryViewer.componentOnReady();\nconsole.log(\"arcgis-oriented-imagery-viewer is ready to go!\");\n```"
|
|
30657
30874
|
},
|
|
30658
30875
|
{
|
|
30659
30876
|
"name": "inheritedFrom",
|
|
@@ -30820,8 +31037,13 @@
|
|
|
30820
31037
|
"mutable": true,
|
|
30821
31038
|
"attr": "reference-element",
|
|
30822
31039
|
"reflectToAttr": false,
|
|
30823
|
-
"docs": "",
|
|
30824
|
-
"docsTags": [
|
|
31040
|
+
"docs": "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.",
|
|
31041
|
+
"docsTags": [
|
|
31042
|
+
{
|
|
31043
|
+
"name": "see",
|
|
31044
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
31045
|
+
}
|
|
31046
|
+
],
|
|
30825
31047
|
"values": [
|
|
30826
31048
|
{
|
|
30827
31049
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -30865,7 +31087,7 @@
|
|
|
30865
31087
|
"docsTags": [
|
|
30866
31088
|
{
|
|
30867
31089
|
"name": "example",
|
|
30868
|
-
"text": "
|
|
31090
|
+
"text": "```js\nconst arcgisPlacement = document.querySelector(\"arcgis-placement\");\ndocument.body.append(arcgisPlacement);\nawait arcgisPlacement.componentOnReady();\nconsole.log(\"arcgis-placement is ready to go!\");\n```"
|
|
30869
31091
|
},
|
|
30870
31092
|
{
|
|
30871
31093
|
"name": "inheritedFrom",
|
|
@@ -30901,7 +31123,7 @@
|
|
|
30901
31123
|
"overview": "",
|
|
30902
31124
|
"readme": "",
|
|
30903
31125
|
"usage": {},
|
|
30904
|
-
"docs": "The Print
|
|
31126
|
+
"docs": "The Print component connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed.\nIt takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS,\nwhich can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc.\nThe Print component works with the [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) module, which generates a printer-ready version of the map.\n\nThe Print component uses the ArcGIS Online print service by default, but it can be configured to use a custom print service with the [printServiceUrl](#printServiceUrl) property.\nThe component can preserve map scale or map extent in the printout. By default, the map extent is preserved. Use\n[TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) to preserve scale instead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layout)\nexcept `map-only`. If using a custom print service, then `customTextElements` are supported for each print\ntemplate. Values found there will be populated in the Print component under `Advanced options`. These values can\nbe overwritten in the Print component UI, or programmatically using the\n[templateCustomTextElements](#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions).\n\n**Known limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) for a detailed list of known limitations.\n\n```html\n<arcgis-map item-id=\"45725ba7d9fb47a0925398919b13d1fa\">\n <arcgis-print position=\"top-right\"></arcgis-print>\n</arcgis-map>\n```\n\n```js\n// get a reference to the component\nconst components = document.querySelectorAll(\"arcgis-print\");\n\nconst portal = new Portal({\n url: \"https://user.maps.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://user.maps.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```",
|
|
30905
31127
|
"docsTags": [
|
|
30906
31128
|
{
|
|
30907
31129
|
"name": "superclass",
|
|
@@ -30961,7 +31183,7 @@
|
|
|
30961
31183
|
"mutable": true,
|
|
30962
31184
|
"attr": "allowed-formats-for-saving",
|
|
30963
31185
|
"reflectToAttr": false,
|
|
30964
|
-
"docs": "",
|
|
31186
|
+
"docs": "Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.",
|
|
30965
31187
|
"docsTags": [],
|
|
30966
31188
|
"values": [
|
|
30967
31189
|
{
|
|
@@ -31039,7 +31261,11 @@
|
|
|
31039
31261
|
"mutable": true,
|
|
31040
31262
|
"reflectToAttr": false,
|
|
31041
31263
|
"docs": "",
|
|
31042
|
-
"docsTags": [
|
|
31264
|
+
"docsTags": [
|
|
31265
|
+
{
|
|
31266
|
+
"name": "internal"
|
|
31267
|
+
}
|
|
31268
|
+
],
|
|
31043
31269
|
"values": [],
|
|
31044
31270
|
"optional": true,
|
|
31045
31271
|
"required": false
|
|
@@ -31109,7 +31335,7 @@
|
|
|
31109
31335
|
},
|
|
31110
31336
|
"mutable": true,
|
|
31111
31337
|
"reflectToAttr": false,
|
|
31112
|
-
"docs": "The collection of links exported from the Print
|
|
31338
|
+
"docs": "The collection of links exported from the Print component.",
|
|
31113
31339
|
"docsTags": [],
|
|
31114
31340
|
"values": [],
|
|
31115
31341
|
"optional": true,
|
|
@@ -31147,7 +31373,7 @@
|
|
|
31147
31373
|
"mutable": true,
|
|
31148
31374
|
"attr": "heading-level",
|
|
31149
31375
|
"reflectToAttr": false,
|
|
31150
|
-
"docs": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the
|
|
31376
|
+
"docs": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
|
|
31151
31377
|
"docsTags": [],
|
|
31152
31378
|
"default": "3",
|
|
31153
31379
|
"values": [
|
|
@@ -31190,7 +31416,7 @@
|
|
|
31190
31416
|
"mutable": true,
|
|
31191
31417
|
"attr": "hide-header",
|
|
31192
31418
|
"reflectToAttr": false,
|
|
31193
|
-
"docs": "",
|
|
31419
|
+
"docs": "Indicates whether the component's header is hidden.",
|
|
31194
31420
|
"docsTags": [],
|
|
31195
31421
|
"default": "false",
|
|
31196
31422
|
"values": [
|
|
@@ -31259,7 +31485,7 @@
|
|
|
31259
31485
|
},
|
|
31260
31486
|
"mutable": true,
|
|
31261
31487
|
"reflectToAttr": false,
|
|
31262
|
-
"docs": "Replace localized message strings with your own strings
|
|
31488
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
31263
31489
|
"docsTags": [],
|
|
31264
31490
|
"values": [],
|
|
31265
31491
|
"optional": true,
|
|
@@ -31281,7 +31507,7 @@
|
|
|
31281
31507
|
},
|
|
31282
31508
|
"mutable": true,
|
|
31283
31509
|
"reflectToAttr": false,
|
|
31284
|
-
"docs": "The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) used to render
|
|
31510
|
+
"docs": "The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) used to render the printed map on the server.",
|
|
31285
31511
|
"docsTags": [],
|
|
31286
31512
|
"values": [],
|
|
31287
31513
|
"optional": true,
|
|
@@ -31303,7 +31529,7 @@
|
|
|
31303
31529
|
},
|
|
31304
31530
|
"mutable": true,
|
|
31305
31531
|
"reflectToAttr": false,
|
|
31306
|
-
"docs": "It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm).\nUse this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search.\nThis is especially helpful when working with a [custom](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html).\n\nIf this property is set, it is not necessary to set the [printServiceUrl](#printServiceUrl) property.",
|
|
31532
|
+
"docs": "It is possible to search a specified portal instance's [locator services](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm).\nUse this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search.\nThis is especially helpful when working with a [custom template](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-CustomTemplate.html).\n\nIf this property is set, it is not necessary to set the [printServiceUrl](#printServiceUrl) property.",
|
|
31307
31533
|
"docsTags": [],
|
|
31308
31534
|
"values": [],
|
|
31309
31535
|
"optional": true,
|
|
@@ -31320,7 +31546,7 @@
|
|
|
31320
31546
|
"mutable": true,
|
|
31321
31547
|
"attr": "position",
|
|
31322
31548
|
"reflectToAttr": true,
|
|
31323
|
-
"docs": "",
|
|
31549
|
+
"docs": "The UI position of a component.",
|
|
31324
31550
|
"docsTags": [],
|
|
31325
31551
|
"default": "\"top-left\"",
|
|
31326
31552
|
"values": [
|
|
@@ -31375,7 +31601,7 @@
|
|
|
31375
31601
|
"mutable": true,
|
|
31376
31602
|
"attr": "print-service-url",
|
|
31377
31603
|
"reflectToAttr": false,
|
|
31378
|
-
"docs": "The URL of the REST endpoint of the Export Web Map Task.\nIf the [portal](#portal) property is set,
|
|
31604
|
+
"docs": "The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](#portal) property is set, this property will use the portal's print service URL.",
|
|
31379
31605
|
"docsTags": [],
|
|
31380
31606
|
"values": [
|
|
31381
31607
|
{
|
|
@@ -31412,7 +31638,7 @@
|
|
|
31412
31638
|
"mutable": true,
|
|
31413
31639
|
"attr": "reference-element",
|
|
31414
31640
|
"reflectToAttr": false,
|
|
31415
|
-
"docs": "",
|
|
31641
|
+
"docs": "By passing the `id` of the Map or Scene component into this property, you can position components from the `@arcgis/map-components`\npackage anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component).",
|
|
31416
31642
|
"docsTags": [],
|
|
31417
31643
|
"values": [
|
|
31418
31644
|
{
|
|
@@ -31458,7 +31684,11 @@
|
|
|
31458
31684
|
"mutable": true,
|
|
31459
31685
|
"reflectToAttr": false,
|
|
31460
31686
|
"docs": "",
|
|
31461
|
-
"docsTags": [
|
|
31687
|
+
"docsTags": [
|
|
31688
|
+
{
|
|
31689
|
+
"name": "internal"
|
|
31690
|
+
}
|
|
31691
|
+
],
|
|
31462
31692
|
"values": [],
|
|
31463
31693
|
"optional": true,
|
|
31464
31694
|
"required": false
|
|
@@ -31474,7 +31704,7 @@
|
|
|
31474
31704
|
"mutable": true,
|
|
31475
31705
|
"attr": "show-print-area-enabled",
|
|
31476
31706
|
"reflectToAttr": false,
|
|
31477
|
-
"docs": "The initial state of the print area toggle in the Print
|
|
31707
|
+
"docs": "The initial state of the print area toggle in the Print component UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.",
|
|
31478
31708
|
"docsTags": [],
|
|
31479
31709
|
"default": "false",
|
|
31480
31710
|
"values": [
|
|
@@ -31496,7 +31726,7 @@
|
|
|
31496
31726
|
"mutable": true,
|
|
31497
31727
|
"attr": "state",
|
|
31498
31728
|
"reflectToAttr": true,
|
|
31499
|
-
"docs": "The
|
|
31729
|
+
"docs": "The state of the Print component.",
|
|
31500
31730
|
"docsTags": [
|
|
31501
31731
|
{
|
|
31502
31732
|
"name": "readonly",
|
|
@@ -31541,7 +31771,7 @@
|
|
|
31541
31771
|
},
|
|
31542
31772
|
"mutable": true,
|
|
31543
31773
|
"reflectToAttr": false,
|
|
31544
|
-
"docs": "An object containing an array of `customTextElements` name-value pair objects\nfor each print template in a custom print service. Use this property to update\nthe text for custom text elements on the page layout.\n\nThe Print
|
|
31774
|
+
"docs": "An object containing an array of `customTextElements` name-value pair objects\nfor each print template in a custom print service. Use this property to update\nthe text for custom text elements on the page layout.\n\nThe Print component calls the `Get Layout Templates Info` task on the GPServer\nto discover possible `customTextElements` values for each template. The name of\nthe task must match `Get Layout Templates Info`, templates must be published\nwith `customTextElements`, and values must be strings. Values found there will be\npopulated in the Print component under `Advanced options`. These values can be\noverwritten in the Print component UI, or programmatically using this property.\nTo list all print templates available on the print service to see\nsee which templates were published with `customTextElements`, use the\n[effectiveTemplateCustomTextElements](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#effectiveTemplateCustomTextElements)\nproperty.",
|
|
31545
31775
|
"docsTags": [],
|
|
31546
31776
|
"values": [],
|
|
31547
31777
|
"optional": true,
|
|
@@ -31563,7 +31793,7 @@
|
|
|
31563
31793
|
},
|
|
31564
31794
|
"mutable": true,
|
|
31565
31795
|
"reflectToAttr": false,
|
|
31566
|
-
"docs": "Defines the layout template options used by the
|
|
31796
|
+
"docs": "Defines the layout template options used by the Print component to generate the print page.",
|
|
31567
31797
|
"docsTags": [],
|
|
31568
31798
|
"values": [],
|
|
31569
31799
|
"optional": true,
|
|
@@ -31595,7 +31825,7 @@
|
|
|
31595
31825
|
"docsTags": [
|
|
31596
31826
|
{
|
|
31597
31827
|
"name": "example",
|
|
31598
|
-
"text": "
|
|
31828
|
+
"text": "```js\nconst arcgisPrint = document.querySelector(\"arcgis-print\");\ndocument.body.append(arcgisPrint);\nawait arcgisPrint.componentOnReady();\nconsole.log(\"arcgis-print is ready to go!\");\n```"
|
|
31599
31829
|
},
|
|
31600
31830
|
{
|
|
31601
31831
|
"name": "inheritedFrom",
|
|
@@ -31630,16 +31860,22 @@
|
|
|
31630
31860
|
"events": [
|
|
31631
31861
|
{
|
|
31632
31862
|
"event": "arcgisComplete",
|
|
31633
|
-
"detail": "
|
|
31863
|
+
"detail": "PrintCompleteEvent",
|
|
31634
31864
|
"bubbles": true,
|
|
31635
31865
|
"complexType": {
|
|
31636
|
-
"original": "
|
|
31637
|
-
"resolved": "
|
|
31638
|
-
"references": {
|
|
31866
|
+
"original": "PrintCompleteEvent",
|
|
31867
|
+
"resolved": "PrintCompleteEvent",
|
|
31868
|
+
"references": {
|
|
31869
|
+
"PrintCompleteEvent": {
|
|
31870
|
+
"location": "import",
|
|
31871
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
31872
|
+
"id": "notImplemented"
|
|
31873
|
+
}
|
|
31874
|
+
}
|
|
31639
31875
|
},
|
|
31640
31876
|
"cancelable": true,
|
|
31641
31877
|
"composed": true,
|
|
31642
|
-
"docs": "",
|
|
31878
|
+
"docs": "Emitted when the component is complete.",
|
|
31643
31879
|
"docsTags": []
|
|
31644
31880
|
},
|
|
31645
31881
|
{
|
|
@@ -31672,16 +31908,22 @@
|
|
|
31672
31908
|
},
|
|
31673
31909
|
{
|
|
31674
31910
|
"event": "arcgisSubmit",
|
|
31675
|
-
"detail": "
|
|
31911
|
+
"detail": "PrintSubmitEvent",
|
|
31676
31912
|
"bubbles": true,
|
|
31677
31913
|
"complexType": {
|
|
31678
|
-
"original": "
|
|
31679
|
-
"resolved": "
|
|
31680
|
-
"references": {
|
|
31914
|
+
"original": "PrintSubmitEvent",
|
|
31915
|
+
"resolved": "PrintSubmitEvent",
|
|
31916
|
+
"references": {
|
|
31917
|
+
"PrintSubmitEvent": {
|
|
31918
|
+
"location": "import",
|
|
31919
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
31920
|
+
"id": "notImplemented"
|
|
31921
|
+
}
|
|
31922
|
+
}
|
|
31681
31923
|
},
|
|
31682
31924
|
"cancelable": true,
|
|
31683
31925
|
"composed": true,
|
|
31684
|
-
"docs": "",
|
|
31926
|
+
"docs": "Emitted when the component is submitted.",
|
|
31685
31927
|
"docsTags": []
|
|
31686
31928
|
}
|
|
31687
31929
|
],
|
|
@@ -31696,7 +31938,7 @@
|
|
|
31696
31938
|
"overview": "",
|
|
31697
31939
|
"readme": "",
|
|
31698
31940
|
"usage": {},
|
|
31699
|
-
"docs": "The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known
|
|
31941
|
+
"docs": "The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.",
|
|
31700
31942
|
"docsTags": [
|
|
31701
31943
|
{
|
|
31702
31944
|
"name": "superclass",
|
|
@@ -31815,7 +32057,7 @@
|
|
|
31815
32057
|
},
|
|
31816
32058
|
"mutable": true,
|
|
31817
32059
|
"reflectToAttr": false,
|
|
31818
|
-
"docs": "Replace localized message strings with your own strings
|
|
32060
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
31819
32061
|
"docsTags": [],
|
|
31820
32062
|
"values": [],
|
|
31821
32063
|
"optional": true,
|
|
@@ -31903,8 +32145,13 @@
|
|
|
31903
32145
|
"mutable": true,
|
|
31904
32146
|
"attr": "reference-element",
|
|
31905
32147
|
"reflectToAttr": false,
|
|
31906
|
-
"docs": "",
|
|
31907
|
-
"docsTags": [
|
|
32148
|
+
"docs": "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.",
|
|
32149
|
+
"docsTags": [
|
|
32150
|
+
{
|
|
32151
|
+
"name": "see",
|
|
32152
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
32153
|
+
}
|
|
32154
|
+
],
|
|
31908
32155
|
"values": [
|
|
31909
32156
|
{
|
|
31910
32157
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -31978,7 +32225,7 @@
|
|
|
31978
32225
|
"docsTags": [
|
|
31979
32226
|
{
|
|
31980
32227
|
"name": "example",
|
|
31981
|
-
"text": "
|
|
32228
|
+
"text": "```js\nconst arcgisScaleBar = document.querySelector(\"arcgis-scale-bar\");\ndocument.body.append(arcgisScaleBar);\nawait arcgisScaleBar.componentOnReady();\nconsole.log(\"arcgis-scale-bar is ready to go!\");\n```"
|
|
31982
32229
|
},
|
|
31983
32230
|
{
|
|
31984
32231
|
"name": "inheritedFrom",
|
|
@@ -32438,8 +32685,13 @@
|
|
|
32438
32685
|
"mutable": true,
|
|
32439
32686
|
"attr": "reference-element",
|
|
32440
32687
|
"reflectToAttr": false,
|
|
32441
|
-
"docs": "",
|
|
32442
|
-
"docsTags": [
|
|
32688
|
+
"docs": "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.",
|
|
32689
|
+
"docsTags": [
|
|
32690
|
+
{
|
|
32691
|
+
"name": "see",
|
|
32692
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
32693
|
+
}
|
|
32694
|
+
],
|
|
32443
32695
|
"values": [
|
|
32444
32696
|
{
|
|
32445
32697
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -32538,7 +32790,7 @@
|
|
|
32538
32790
|
"docsTags": [
|
|
32539
32791
|
{
|
|
32540
32792
|
"name": "example",
|
|
32541
|
-
"text": "
|
|
32793
|
+
"text": "```js\nconst arcgisScaleRangeSlider = document.querySelector(\"arcgis-scale-range-slider\");\ndocument.body.append(arcgisScaleRangeSlider);\nawait arcgisScaleRangeSlider.componentOnReady();\nconsole.log(\"arcgis-scale-range-slider is ready to go!\");\n```"
|
|
32542
32794
|
},
|
|
32543
32795
|
{
|
|
32544
32796
|
"name": "inheritedFrom",
|
|
@@ -32611,7 +32863,7 @@
|
|
|
32611
32863
|
"overview": "",
|
|
32612
32864
|
"readme": "",
|
|
32613
32865
|
"usage": {},
|
|
32614
|
-
"docs": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\
|
|
32866
|
+
"docs": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nconst layer = new GraphicsLayer({ title: \"My layer\"});\nviewElement.map.add(layer);\n```\n\n**See also**\n\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)",
|
|
32615
32867
|
"docsTags": [
|
|
32616
32868
|
{
|
|
32617
32869
|
"name": "superclass",
|
|
@@ -32819,7 +33071,7 @@
|
|
|
32819
33071
|
},
|
|
32820
33072
|
"mutable": true,
|
|
32821
33073
|
"reflectToAttr": false,
|
|
32822
|
-
"docs": "The [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html) allows to set the observation point from which the visible portion (or perspective)\nof the view is determined. When set in the constructor, this property overrides the
|
|
33074
|
+
"docs": "The [camera](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html) allows to set the observation point from which the visible portion (or perspective)\nof the view is determined. When set in the constructor, this property overrides the [center](#center), [extent](#extent), [scale](#scale), [viewpoint](#viewpoint), and [zoom](#zoom) properties.\n\nSetting the camera immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.",
|
|
32823
33075
|
"docsTags": [],
|
|
32824
33076
|
"values": [],
|
|
32825
33077
|
"optional": true,
|
|
@@ -32836,7 +33088,7 @@
|
|
|
32836
33088
|
"mutable": true,
|
|
32837
33089
|
"attr": "camera-fov",
|
|
32838
33090
|
"reflectToAttr": false,
|
|
32839
|
-
"docs": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
33091
|
+
"docs": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov)",
|
|
32840
33092
|
"docsTags": [],
|
|
32841
33093
|
"values": [
|
|
32842
33094
|
{
|
|
@@ -32857,7 +33109,7 @@
|
|
|
32857
33109
|
"mutable": true,
|
|
32858
33110
|
"attr": "camera-heading",
|
|
32859
33111
|
"reflectToAttr": false,
|
|
32860
|
-
"docs": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
33112
|
+
"docs": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading)",
|
|
32861
33113
|
"docsTags": [],
|
|
32862
33114
|
"values": [
|
|
32863
33115
|
{
|
|
@@ -32889,7 +33141,7 @@
|
|
|
32889
33141
|
"mutable": true,
|
|
32890
33142
|
"attr": "camera-position",
|
|
32891
33143
|
"reflectToAttr": false,
|
|
32892
|
-
"docs": "The position of the camera defined by a map point. It can be
|
|
33144
|
+
"docs": "The position of the camera defined by a map point. It can either be set with a\n[Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)",
|
|
32893
33145
|
"docsTags": [],
|
|
32894
33146
|
"values": [
|
|
32895
33147
|
{
|
|
@@ -32916,7 +33168,7 @@
|
|
|
32916
33168
|
"mutable": true,
|
|
32917
33169
|
"attr": "camera-tilt",
|
|
32918
33170
|
"reflectToAttr": false,
|
|
32919
|
-
"docs": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
33171
|
+
"docs": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt)",
|
|
32920
33172
|
"docsTags": [],
|
|
32921
33173
|
"values": [
|
|
32922
33174
|
{
|
|
@@ -32948,7 +33200,7 @@
|
|
|
32948
33200
|
"mutable": true,
|
|
32949
33201
|
"attr": "center",
|
|
32950
33202
|
"reflectToAttr": false,
|
|
32951
|
-
"docs": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
33203
|
+
"docs": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)",
|
|
32952
33204
|
"docsTags": [],
|
|
32953
33205
|
"values": [
|
|
32954
33206
|
{
|
|
@@ -32980,7 +33232,7 @@
|
|
|
32980
33232
|
},
|
|
32981
33233
|
"mutable": true,
|
|
32982
33234
|
"reflectToAttr": false,
|
|
32983
|
-
"docs": "Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html)\nof a
|
|
33235
|
+
"docs": "Represents an optional clipping area used to define the visible [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html)\nof a Scene in `local` [viewingMode](#viewingMode).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea)",
|
|
32984
33236
|
"docsTags": [],
|
|
32985
33237
|
"values": [],
|
|
32986
33238
|
"optional": true,
|
|
@@ -33046,7 +33298,7 @@
|
|
|
33046
33298
|
},
|
|
33047
33299
|
"mutable": true,
|
|
33048
33300
|
"reflectToAttr": false,
|
|
33049
|
-
"docs": "Specifies various properties of the environment's visualization
|
|
33301
|
+
"docs": "Specifies various properties of the environment's visualization within the view, including lighting, background, weather, and more.\nThe Scene will redraw automatically when any property of environment changes.\n\nModifying the lighting:\n\n```js\nviewElement.environment.lighting = {\n type: \"sun\", // autocasts as new SunLighting()\n date: new Date(), // sets the lighting to reflect the current time of day\n directShadowsEnabled: true,\n};\n```\n\nSetting the background:\n\n```js\nviewElement.environment = {\n background: {\n type: \"color\",\n color: [255, 252, 244, 1]\n },\n starsEnabled: false,\n atmosphereEnabled: false\n};\n```\n\nChanging the weather in the scene:\n\n```js\nviewElement.environment.weather = {\n type: \"rainy\", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })\n cloudCover: 0.7,\n precipitation: 0.3\n};\n```\n\n**See also**\n\n- [SunLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)\n- [VirtualLighting](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html)\n- [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n- [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#environment)",
|
|
33050
33302
|
"docsTags": [],
|
|
33051
33303
|
"values": [],
|
|
33052
33304
|
"optional": true,
|
|
@@ -33068,7 +33320,7 @@
|
|
|
33068
33320
|
},
|
|
33069
33321
|
"mutable": true,
|
|
33070
33322
|
"reflectToAttr": false,
|
|
33071
|
-
"docs": "The extent represents the visible portion of a map within the view as an instance of\n[Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html).\n\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's [goTo()](
|
|
33323
|
+
"docs": "The extent represents the visible portion of a [map](#map) within the view as an instance of\n[Extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html).\n\nSetting the extent immediately changes the view without animation. To animate\nthe view, see this component's [goTo()](#goTo) method.\nWhen the view is rotated, the extent does not update to include the newly visible portions of the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#extent)",
|
|
33072
33324
|
"docsTags": [],
|
|
33073
33325
|
"values": [],
|
|
33074
33326
|
"optional": true,
|
|
@@ -33118,6 +33370,33 @@
|
|
|
33118
33370
|
"optional": true,
|
|
33119
33371
|
"required": false
|
|
33120
33372
|
},
|
|
33373
|
+
{
|
|
33374
|
+
"name": "focusAreas",
|
|
33375
|
+
"type": "FocusAreas",
|
|
33376
|
+
"complexType": {
|
|
33377
|
+
"original": "FocusAreas",
|
|
33378
|
+
"resolved": "FocusAreas",
|
|
33379
|
+
"references": {
|
|
33380
|
+
"FocusAreas": {
|
|
33381
|
+
"location": "import",
|
|
33382
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
33383
|
+
"id": "notImplemented"
|
|
33384
|
+
}
|
|
33385
|
+
}
|
|
33386
|
+
},
|
|
33387
|
+
"mutable": true,
|
|
33388
|
+
"reflectToAttr": false,
|
|
33389
|
+
"docs": "A container of all [focus areas](https://developers.arcgis.com/javascript/latest/api-reference/esri-effects-FocusAreas.html) present in the map.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#focusAreas)",
|
|
33390
|
+
"docsTags": [
|
|
33391
|
+
{
|
|
33392
|
+
"name": "since",
|
|
33393
|
+
"text": "4.33"
|
|
33394
|
+
}
|
|
33395
|
+
],
|
|
33396
|
+
"values": [],
|
|
33397
|
+
"optional": true,
|
|
33398
|
+
"required": false
|
|
33399
|
+
},
|
|
33121
33400
|
{
|
|
33122
33401
|
"name": "gamepad",
|
|
33123
33402
|
"type": "GamepadSettings",
|
|
@@ -33166,8 +33445,13 @@
|
|
|
33166
33445
|
},
|
|
33167
33446
|
"mutable": true,
|
|
33168
33447
|
"reflectToAttr": false,
|
|
33169
|
-
"docs": "Allows for adding graphics directly to the default graphics in the view
|
|
33170
|
-
"docsTags": [
|
|
33448
|
+
"docs": "Allows for adding graphics directly to the default graphics in the view.",
|
|
33449
|
+
"docsTags": [
|
|
33450
|
+
{
|
|
33451
|
+
"name": "example",
|
|
33452
|
+
"text": "```js\n// Adds a graphic to the View\ngraphics.add(pointGraphic);\n// Removes a graphic from the View\ngraphics.remove(pointGraphic);\n```"
|
|
33453
|
+
}
|
|
33454
|
+
],
|
|
33171
33455
|
"values": [],
|
|
33172
33456
|
"optional": true,
|
|
33173
33457
|
"required": false
|
|
@@ -33189,7 +33473,7 @@
|
|
|
33189
33473
|
"mutable": true,
|
|
33190
33474
|
"attr": "ground",
|
|
33191
33475
|
"reflectToAttr": false,
|
|
33192
|
-
"docs": "Specifies the surface properties for the map. It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
|
|
33476
|
+
"docs": "Specifies the surface properties for the [map](#map). It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
|
|
33193
33477
|
"docsTags": [],
|
|
33194
33478
|
"values": [
|
|
33195
33479
|
{
|
|
@@ -33247,7 +33531,7 @@
|
|
|
33247
33531
|
"reflectToAttr": false,
|
|
33248
33532
|
"docs": "Options for configuring the highlight.",
|
|
33249
33533
|
"docsTags": [],
|
|
33250
|
-
"deprecation": "since 4.32
|
|
33534
|
+
"deprecation": "since 4.32, use [highlights](https://next.sites.afd.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#highlights) property instead.",
|
|
33251
33535
|
"values": [],
|
|
33252
33536
|
"optional": true,
|
|
33253
33537
|
"required": false
|
|
@@ -33347,7 +33631,7 @@
|
|
|
33347
33631
|
},
|
|
33348
33632
|
"mutable": true,
|
|
33349
33633
|
"reflectToAttr": false,
|
|
33350
|
-
"docs": "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.",
|
|
33634
|
+
"docs": "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).",
|
|
33351
33635
|
"docsTags": [
|
|
33352
33636
|
{
|
|
33353
33637
|
"name": "readonly",
|
|
@@ -33521,7 +33805,7 @@
|
|
|
33521
33805
|
},
|
|
33522
33806
|
"mutable": true,
|
|
33523
33807
|
"reflectToAttr": false,
|
|
33524
|
-
"docs": "A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html)
|
|
33808
|
+
"docs": "A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html)\nobject that displays general content or attributes from [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers)\nin the [map](#map).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#popup)",
|
|
33525
33809
|
"docsTags": [],
|
|
33526
33810
|
"values": [],
|
|
33527
33811
|
"optional": true,
|
|
@@ -33560,7 +33844,7 @@
|
|
|
33560
33844
|
"mutable": true,
|
|
33561
33845
|
"attr": "quality-profile",
|
|
33562
33846
|
"reflectToAttr": false,
|
|
33563
|
-
"docs": "
|
|
33847
|
+
"docs": "Scenes can be drawn in three different quality modes: `high`, `medium` and `low`.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile)",
|
|
33564
33848
|
"docsTags": [],
|
|
33565
33849
|
"values": [
|
|
33566
33850
|
{
|
|
@@ -33615,7 +33899,7 @@
|
|
|
33615
33899
|
},
|
|
33616
33900
|
"mutable": true,
|
|
33617
33901
|
"reflectToAttr": false,
|
|
33618
|
-
"docs": "Represents the current value of one pixel in the unit of the view's\n[spatialReference](
|
|
33902
|
+
"docs": "Represents the current value of one pixel in the unit of the view's\n[spatialReference](#spatialReference).\nThe resolution is calculated by dividing the [Scene's extent](#extent) [width](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#width)\nby [its width](#width).",
|
|
33619
33903
|
"docsTags": [
|
|
33620
33904
|
{
|
|
33621
33905
|
"name": "readonly",
|
|
@@ -33641,7 +33925,7 @@
|
|
|
33641
33925
|
"mutable": true,
|
|
33642
33926
|
"attr": "scale",
|
|
33643
33927
|
"reflectToAttr": false,
|
|
33644
|
-
"docs": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](
|
|
33928
|
+
"docs": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)",
|
|
33645
33929
|
"docsTags": [],
|
|
33646
33930
|
"values": [
|
|
33647
33931
|
{
|
|
@@ -33743,7 +34027,7 @@
|
|
|
33743
34027
|
},
|
|
33744
34028
|
"mutable": true,
|
|
33745
34029
|
"reflectToAttr": false,
|
|
33746
|
-
"docs": "This property specifies the base colors used by some
|
|
34030
|
+
"docs": "This property specifies the base colors used by some components to render graphics and labels.\nThis only affects those elements that would otherwise use the default orange pattern.",
|
|
33747
34031
|
"docsTags": [],
|
|
33748
34032
|
"default": "null",
|
|
33749
34033
|
"values": [],
|
|
@@ -33869,7 +34153,7 @@
|
|
|
33869
34153
|
},
|
|
33870
34154
|
"mutable": true,
|
|
33871
34155
|
"reflectToAttr": false,
|
|
33872
|
-
"docs": "Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nor point of observation on the view.\n\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's [goTo()](
|
|
34156
|
+
"docs": "Represents the current view as a [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nor point of observation on the view.\n\nSetting the viewpoint immediately changes the current view. For animating\nthe view, see this component's [goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewpoint)",
|
|
33873
34157
|
"docsTags": [],
|
|
33874
34158
|
"values": [],
|
|
33875
34159
|
"optional": true,
|
|
@@ -33891,7 +34175,7 @@
|
|
|
33891
34175
|
},
|
|
33892
34176
|
"mutable": true,
|
|
33893
34177
|
"reflectToAttr": false,
|
|
33894
|
-
"docs": "The visibleArea represents the visible portion of a [map](
|
|
34178
|
+
"docs": "The visibleArea represents the visible portion of a [map](#map) within the view as an instance of a\n[Polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#visibleArea)",
|
|
33895
34179
|
"docsTags": [
|
|
33896
34180
|
{
|
|
33897
34181
|
"name": "readonly",
|
|
@@ -33913,7 +34197,7 @@
|
|
|
33913
34197
|
"mutable": true,
|
|
33914
34198
|
"attr": "zoom",
|
|
33915
34199
|
"reflectToAttr": false,
|
|
33916
|
-
"docs": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](
|
|
34200
|
+
"docs": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\nSetting this property in conjunction with [center](#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom)",
|
|
33917
34201
|
"docsTags": [],
|
|
33918
34202
|
"values": [
|
|
33919
34203
|
{
|
|
@@ -33974,7 +34258,7 @@
|
|
|
33974
34258
|
],
|
|
33975
34259
|
"docs": "",
|
|
33976
34260
|
"docsTags": [],
|
|
33977
|
-
"deprecation": "since 4.33
|
|
34261
|
+
"deprecation": "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."
|
|
33978
34262
|
},
|
|
33979
34263
|
{
|
|
33980
34264
|
"name": "addLayers",
|
|
@@ -34030,7 +34314,7 @@
|
|
|
34030
34314
|
],
|
|
34031
34315
|
"docs": "",
|
|
34032
34316
|
"docsTags": [],
|
|
34033
|
-
"deprecation": "since 4.33
|
|
34317
|
+
"deprecation": "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."
|
|
34034
34318
|
},
|
|
34035
34319
|
{
|
|
34036
34320
|
"name": "addTable",
|
|
@@ -34071,7 +34355,7 @@
|
|
|
34071
34355
|
],
|
|
34072
34356
|
"docs": "",
|
|
34073
34357
|
"docsTags": [],
|
|
34074
|
-
"deprecation": "since 4.33
|
|
34358
|
+
"deprecation": "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."
|
|
34075
34359
|
},
|
|
34076
34360
|
{
|
|
34077
34361
|
"name": "addTables",
|
|
@@ -34127,7 +34411,7 @@
|
|
|
34127
34411
|
],
|
|
34128
34412
|
"docs": "",
|
|
34129
34413
|
"docsTags": [],
|
|
34130
|
-
"deprecation": "since 4.33
|
|
34414
|
+
"deprecation": "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."
|
|
34131
34415
|
},
|
|
34132
34416
|
{
|
|
34133
34417
|
"name": "closePopup",
|
|
@@ -34149,7 +34433,7 @@
|
|
|
34149
34433
|
},
|
|
34150
34434
|
"signature": "closePopup(): Promise<void>",
|
|
34151
34435
|
"parameters": [],
|
|
34152
|
-
"docs": "Closes the [popup](
|
|
34436
|
+
"docs": "Closes the [popup](#popup).",
|
|
34153
34437
|
"docsTags": []
|
|
34154
34438
|
},
|
|
34155
34439
|
{
|
|
@@ -34176,7 +34460,7 @@
|
|
|
34176
34460
|
"docsTags": [
|
|
34177
34461
|
{
|
|
34178
34462
|
"name": "example",
|
|
34179
|
-
"text": "
|
|
34463
|
+
"text": "```js\nconst arcgisScene = document.querySelector(\"arcgis-scene\");\ndocument.body.append(arcgisScene);\nawait arcgisScene.componentOnReady();\nconsole.log(\"arcgis-scene is ready to go!\");\n```"
|
|
34180
34464
|
},
|
|
34181
34465
|
{
|
|
34182
34466
|
"name": "inheritedFrom",
|
|
@@ -34204,7 +34488,7 @@
|
|
|
34204
34488
|
},
|
|
34205
34489
|
"signature": "destroy(): Promise<void>",
|
|
34206
34490
|
"parameters": [],
|
|
34207
|
-
"docs": "Destroys the Scene component, and any associated resources, including its
|
|
34491
|
+
"docs": "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.",
|
|
34208
34492
|
"docsTags": []
|
|
34209
34493
|
},
|
|
34210
34494
|
{
|
|
@@ -34319,7 +34603,7 @@
|
|
|
34319
34603
|
"docs": ""
|
|
34320
34604
|
}
|
|
34321
34605
|
],
|
|
34322
|
-
"docs": "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
|
|
34606
|
+
"docs": "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)",
|
|
34323
34607
|
"docsTags": []
|
|
34324
34608
|
},
|
|
34325
34609
|
{
|
|
@@ -34577,8 +34861,21 @@
|
|
|
34577
34861
|
"docs": ""
|
|
34578
34862
|
}
|
|
34579
34863
|
],
|
|
34580
|
-
"docs": "`viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters
|
|
34581
|
-
"docsTags": [
|
|
34864
|
+
"docs": "`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.",
|
|
34865
|
+
"docsTags": [
|
|
34866
|
+
{
|
|
34867
|
+
"name": "since",
|
|
34868
|
+
"text": "4.33"
|
|
34869
|
+
},
|
|
34870
|
+
{
|
|
34871
|
+
"name": "see",
|
|
34872
|
+
"text": "[Watch for changes - waiting for components or views to be ready](https://developers.arcgis.com/javascript/latest/watch-for-changes/#waiting-for-components-or-views-to-be-ready)"
|
|
34873
|
+
},
|
|
34874
|
+
{
|
|
34875
|
+
"name": "example",
|
|
34876
|
+
"text": "```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nviewElement.map.add(new FeatureLayer({...}));\n```"
|
|
34877
|
+
}
|
|
34878
|
+
]
|
|
34582
34879
|
},
|
|
34583
34880
|
{
|
|
34584
34881
|
"name": "whenAnalysisView",
|
|
@@ -34722,6 +35019,66 @@
|
|
|
34722
35019
|
}
|
|
34723
35020
|
],
|
|
34724
35021
|
"events": [
|
|
35022
|
+
{
|
|
35023
|
+
"event": "arcgisViewAnalysisViewCreate",
|
|
35024
|
+
"detail": "ViewAnalysisViewCreateEvent",
|
|
35025
|
+
"bubbles": true,
|
|
35026
|
+
"complexType": {
|
|
35027
|
+
"original": "ViewAnalysisViewCreateEvent",
|
|
35028
|
+
"resolved": "ViewAnalysisViewCreateEvent",
|
|
35029
|
+
"references": {
|
|
35030
|
+
"ViewAnalysisViewCreateEvent": {
|
|
35031
|
+
"location": "import",
|
|
35032
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
35033
|
+
"id": "notImplemented"
|
|
35034
|
+
}
|
|
35035
|
+
}
|
|
35036
|
+
},
|
|
35037
|
+
"cancelable": true,
|
|
35038
|
+
"composed": true,
|
|
35039
|
+
"docs": "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)",
|
|
35040
|
+
"docsTags": []
|
|
35041
|
+
},
|
|
35042
|
+
{
|
|
35043
|
+
"event": "arcgisViewAnalysisViewCreateError",
|
|
35044
|
+
"detail": "ViewAnalysisViewCreateErrorEvent",
|
|
35045
|
+
"bubbles": true,
|
|
35046
|
+
"complexType": {
|
|
35047
|
+
"original": "ViewAnalysisViewCreateErrorEvent",
|
|
35048
|
+
"resolved": "ViewAnalysisViewCreateErrorEvent",
|
|
35049
|
+
"references": {
|
|
35050
|
+
"ViewAnalysisViewCreateErrorEvent": {
|
|
35051
|
+
"location": "import",
|
|
35052
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
35053
|
+
"id": "notImplemented"
|
|
35054
|
+
}
|
|
35055
|
+
}
|
|
35056
|
+
},
|
|
35057
|
+
"cancelable": true,
|
|
35058
|
+
"composed": true,
|
|
35059
|
+
"docs": "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)",
|
|
35060
|
+
"docsTags": []
|
|
35061
|
+
},
|
|
35062
|
+
{
|
|
35063
|
+
"event": "arcgisViewAnalysisViewDestroy",
|
|
35064
|
+
"detail": "ViewAnalysisViewDestroyEvent",
|
|
35065
|
+
"bubbles": true,
|
|
35066
|
+
"complexType": {
|
|
35067
|
+
"original": "ViewAnalysisViewDestroyEvent",
|
|
35068
|
+
"resolved": "ViewAnalysisViewDestroyEvent",
|
|
35069
|
+
"references": {
|
|
35070
|
+
"ViewAnalysisViewDestroyEvent": {
|
|
35071
|
+
"location": "import",
|
|
35072
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
35073
|
+
"id": "notImplemented"
|
|
35074
|
+
}
|
|
35075
|
+
}
|
|
35076
|
+
},
|
|
35077
|
+
"cancelable": true,
|
|
35078
|
+
"composed": true,
|
|
35079
|
+
"docs": "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)",
|
|
35080
|
+
"docsTags": []
|
|
35081
|
+
},
|
|
34725
35082
|
{
|
|
34726
35083
|
"event": "arcgisViewChange",
|
|
34727
35084
|
"detail": "void",
|
|
@@ -34733,7 +35090,7 @@
|
|
|
34733
35090
|
},
|
|
34734
35091
|
"cancelable": true,
|
|
34735
35092
|
"composed": true,
|
|
34736
|
-
"docs": "This event is for view related property changes
|
|
35093
|
+
"docs": "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`.",
|
|
34737
35094
|
"docsTags": []
|
|
34738
35095
|
},
|
|
34739
35096
|
{
|
|
@@ -34753,7 +35110,7 @@
|
|
|
34753
35110
|
},
|
|
34754
35111
|
"cancelable": true,
|
|
34755
35112
|
"composed": true,
|
|
34756
|
-
"docs": "Fires after a user clicks on the view.\n\n
|
|
35113
|
+
"docs": "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)",
|
|
34757
35114
|
"docsTags": []
|
|
34758
35115
|
},
|
|
34759
35116
|
{
|
|
@@ -35087,7 +35444,7 @@
|
|
|
35087
35444
|
},
|
|
35088
35445
|
"cancelable": true,
|
|
35089
35446
|
"composed": true,
|
|
35090
|
-
"docs": "This event is for the [ready](
|
|
35447
|
+
"docs": "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.",
|
|
35091
35448
|
"docsTags": []
|
|
35092
35449
|
}
|
|
35093
35450
|
],
|
|
@@ -35289,7 +35646,7 @@
|
|
|
35289
35646
|
"required": false
|
|
35290
35647
|
},
|
|
35291
35648
|
{
|
|
35292
|
-
"name": "
|
|
35649
|
+
"name": "autoSelectDisabled",
|
|
35293
35650
|
"type": "boolean",
|
|
35294
35651
|
"complexType": {
|
|
35295
35652
|
"original": "boolean",
|
|
@@ -35297,11 +35654,11 @@
|
|
|
35297
35654
|
"references": {}
|
|
35298
35655
|
},
|
|
35299
35656
|
"mutable": true,
|
|
35300
|
-
"attr": "auto-select",
|
|
35657
|
+
"attr": "auto-select-disabled",
|
|
35301
35658
|
"reflectToAttr": false,
|
|
35302
35659
|
"docs": "Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
|
|
35303
35660
|
"docsTags": [],
|
|
35304
|
-
"default": "
|
|
35661
|
+
"default": "false",
|
|
35305
35662
|
"values": [
|
|
35306
35663
|
{
|
|
35307
35664
|
"type": "boolean"
|
|
@@ -35418,7 +35775,7 @@
|
|
|
35418
35775
|
"required": false
|
|
35419
35776
|
},
|
|
35420
35777
|
{
|
|
35421
|
-
"name": "
|
|
35778
|
+
"name": "includeDefaultSourcesDisabled",
|
|
35422
35779
|
"type": "Function | boolean",
|
|
35423
35780
|
"complexType": {
|
|
35424
35781
|
"original": "Function | boolean",
|
|
@@ -35432,11 +35789,11 @@
|
|
|
35432
35789
|
}
|
|
35433
35790
|
},
|
|
35434
35791
|
"mutable": true,
|
|
35435
|
-
"attr": "include-default-sources",
|
|
35792
|
+
"attr": "include-default-sources-disabled",
|
|
35436
35793
|
"reflectToAttr": false,
|
|
35437
35794
|
"docs": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).",
|
|
35438
35795
|
"docsTags": [],
|
|
35439
|
-
"default": "
|
|
35796
|
+
"default": "false",
|
|
35440
35797
|
"values": [
|
|
35441
35798
|
{
|
|
35442
35799
|
"type": "Function"
|
|
@@ -35470,7 +35827,7 @@
|
|
|
35470
35827
|
"required": false
|
|
35471
35828
|
},
|
|
35472
35829
|
{
|
|
35473
|
-
"name": "
|
|
35830
|
+
"name": "locationDisabled",
|
|
35474
35831
|
"type": "boolean",
|
|
35475
35832
|
"complexType": {
|
|
35476
35833
|
"original": "boolean",
|
|
@@ -35478,11 +35835,11 @@
|
|
|
35478
35835
|
"references": {}
|
|
35479
35836
|
},
|
|
35480
35837
|
"mutable": true,
|
|
35481
|
-
"attr": "location-
|
|
35838
|
+
"attr": "location-disabled",
|
|
35482
35839
|
"reflectToAttr": false,
|
|
35483
35840
|
"docs": "Enables location services within the component.\n\n\n\n::: esri-md class=\"warning\"\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).\n:::",
|
|
35484
35841
|
"docsTags": [],
|
|
35485
|
-
"default": "
|
|
35842
|
+
"default": "false",
|
|
35486
35843
|
"values": [
|
|
35487
35844
|
{
|
|
35488
35845
|
"type": "boolean"
|
|
@@ -35545,7 +35902,7 @@
|
|
|
35545
35902
|
},
|
|
35546
35903
|
"mutable": true,
|
|
35547
35904
|
"reflectToAttr": false,
|
|
35548
|
-
"docs": "Replace localized message strings with your own strings
|
|
35905
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
35549
35906
|
"docsTags": [],
|
|
35550
35907
|
"values": [],
|
|
35551
35908
|
"optional": true,
|
|
@@ -35574,7 +35931,7 @@
|
|
|
35574
35931
|
"required": false
|
|
35575
35932
|
},
|
|
35576
35933
|
{
|
|
35577
|
-
"name": "
|
|
35934
|
+
"name": "popupDisabled",
|
|
35578
35935
|
"type": "boolean",
|
|
35579
35936
|
"complexType": {
|
|
35580
35937
|
"original": "boolean",
|
|
@@ -35582,11 +35939,11 @@
|
|
|
35582
35939
|
"references": {}
|
|
35583
35940
|
},
|
|
35584
35941
|
"mutable": true,
|
|
35585
|
-
"attr": "popup-
|
|
35942
|
+
"attr": "popup-disabled",
|
|
35586
35943
|
"reflectToAttr": false,
|
|
35587
35944
|
"docs": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can\nbe clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).",
|
|
35588
35945
|
"docsTags": [],
|
|
35589
|
-
"default": "
|
|
35946
|
+
"default": "false",
|
|
35590
35947
|
"values": [
|
|
35591
35948
|
{
|
|
35592
35949
|
"type": "boolean"
|
|
@@ -35726,8 +36083,13 @@
|
|
|
35726
36083
|
"mutable": true,
|
|
35727
36084
|
"attr": "reference-element",
|
|
35728
36085
|
"reflectToAttr": false,
|
|
35729
|
-
"docs": "",
|
|
35730
|
-
"docsTags": [
|
|
36086
|
+
"docs": "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.",
|
|
36087
|
+
"docsTags": [
|
|
36088
|
+
{
|
|
36089
|
+
"name": "see",
|
|
36090
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
36091
|
+
}
|
|
36092
|
+
],
|
|
35731
36093
|
"values": [
|
|
35732
36094
|
{
|
|
35733
36095
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -35774,7 +36136,7 @@
|
|
|
35774
36136
|
"required": false
|
|
35775
36137
|
},
|
|
35776
36138
|
{
|
|
35777
|
-
"name": "
|
|
36139
|
+
"name": "resultGraphicDisabled",
|
|
35778
36140
|
"type": "boolean",
|
|
35779
36141
|
"complexType": {
|
|
35780
36142
|
"original": "boolean",
|
|
@@ -35782,11 +36144,11 @@
|
|
|
35782
36144
|
"references": {}
|
|
35783
36145
|
},
|
|
35784
36146
|
"mutable": true,
|
|
35785
|
-
"attr": "result-graphic-
|
|
36147
|
+
"attr": "result-graphic-disabled",
|
|
35786
36148
|
"reflectToAttr": false,
|
|
35787
36149
|
"docs": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
|
|
35788
36150
|
"docsTags": [],
|
|
35789
|
-
"default": "
|
|
36151
|
+
"default": "false",
|
|
35790
36152
|
"values": [
|
|
35791
36153
|
{
|
|
35792
36154
|
"type": "boolean"
|
|
@@ -35829,7 +36191,7 @@
|
|
|
35829
36191
|
"required": false
|
|
35830
36192
|
},
|
|
35831
36193
|
{
|
|
35832
|
-
"name": "
|
|
36194
|
+
"name": "searchAllDisabled",
|
|
35833
36195
|
"type": "boolean",
|
|
35834
36196
|
"complexType": {
|
|
35835
36197
|
"original": "boolean",
|
|
@@ -35837,11 +36199,11 @@
|
|
|
35837
36199
|
"references": {}
|
|
35838
36200
|
},
|
|
35839
36201
|
"mutable": true,
|
|
35840
|
-
"attr": "search-all-
|
|
36202
|
+
"attr": "search-all-disabled",
|
|
35841
36203
|
"reflectToAttr": false,
|
|
35842
36204
|
"docs": "Indicates whether to display the option to search all sources. When `true`, the \"All\" option\nis displayed by default:\n\n\n\nWhen `false`, no option to search all sources at once is available:\n\n",
|
|
35843
36205
|
"docsTags": [],
|
|
35844
|
-
"default": "
|
|
36206
|
+
"default": "false",
|
|
35845
36207
|
"values": [
|
|
35846
36208
|
{
|
|
35847
36209
|
"type": "boolean"
|
|
@@ -35955,7 +36317,7 @@
|
|
|
35955
36317
|
"mutable": true,
|
|
35956
36318
|
"attr": "state",
|
|
35957
36319
|
"reflectToAttr": true,
|
|
35958
|
-
"docs": "The current state
|
|
36320
|
+
"docs": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
35959
36321
|
"docsTags": [
|
|
35960
36322
|
{
|
|
35961
36323
|
"name": "readonly",
|
|
@@ -36018,7 +36380,7 @@
|
|
|
36018
36380
|
"required": false
|
|
36019
36381
|
},
|
|
36020
36382
|
{
|
|
36021
|
-
"name": "
|
|
36383
|
+
"name": "suggestionsDisabled",
|
|
36022
36384
|
"type": "boolean",
|
|
36023
36385
|
"complexType": {
|
|
36024
36386
|
"original": "boolean",
|
|
@@ -36026,11 +36388,11 @@
|
|
|
36026
36388
|
"references": {}
|
|
36027
36389
|
},
|
|
36028
36390
|
"mutable": true,
|
|
36029
|
-
"attr": "suggestions-
|
|
36391
|
+
"attr": "suggestions-disabled",
|
|
36030
36392
|
"reflectToAttr": false,
|
|
36031
36393
|
"docs": "Enable suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
|
|
36032
36394
|
"docsTags": [],
|
|
36033
|
-
"default": "
|
|
36395
|
+
"default": "false",
|
|
36034
36396
|
"values": [
|
|
36035
36397
|
{
|
|
36036
36398
|
"type": "boolean"
|
|
@@ -36041,6 +36403,23 @@
|
|
|
36041
36403
|
}
|
|
36042
36404
|
],
|
|
36043
36405
|
"methods": [
|
|
36406
|
+
{
|
|
36407
|
+
"name": "clear",
|
|
36408
|
+
"returns": {
|
|
36409
|
+
"type": "void",
|
|
36410
|
+
"docs": ""
|
|
36411
|
+
},
|
|
36412
|
+
"complexType": {
|
|
36413
|
+
"signature": "(): void",
|
|
36414
|
+
"parameters": [],
|
|
36415
|
+
"return": "void",
|
|
36416
|
+
"references": {}
|
|
36417
|
+
},
|
|
36418
|
+
"signature": "clear(): void",
|
|
36419
|
+
"parameters": [],
|
|
36420
|
+
"docs": "Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.\nIt also hides any open menus.",
|
|
36421
|
+
"docsTags": []
|
|
36422
|
+
},
|
|
36044
36423
|
{
|
|
36045
36424
|
"name": "componentOnReady",
|
|
36046
36425
|
"returns": {
|
|
@@ -36065,7 +36444,7 @@
|
|
|
36065
36444
|
"docsTags": [
|
|
36066
36445
|
{
|
|
36067
36446
|
"name": "example",
|
|
36068
|
-
"text": "
|
|
36447
|
+
"text": "```js\nconst arcgisSearch = document.querySelector(\"arcgis-search\");\ndocument.body.append(arcgisSearch);\nawait arcgisSearch.componentOnReady();\nconsole.log(\"arcgis-search is ready to go!\");\n```"
|
|
36069
36448
|
},
|
|
36070
36449
|
{
|
|
36071
36450
|
"name": "inheritedFrom",
|
|
@@ -36096,6 +36475,66 @@
|
|
|
36096
36475
|
"docs": "Permanently destroy the component.",
|
|
36097
36476
|
"docsTags": []
|
|
36098
36477
|
},
|
|
36478
|
+
{
|
|
36479
|
+
"name": "search",
|
|
36480
|
+
"returns": {
|
|
36481
|
+
"type": "Promise<SearchResponse | null | undefined>",
|
|
36482
|
+
"docs": ""
|
|
36483
|
+
},
|
|
36484
|
+
"complexType": {
|
|
36485
|
+
"signature": "(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | Nil | number[] | string): Promise<__esri.SearchResponse | Nil>",
|
|
36486
|
+
"parameters": [
|
|
36487
|
+
{
|
|
36488
|
+
"name": "searchItem",
|
|
36489
|
+
"type": "Array<number> | Graphic | Point | SuggestResult | null | string | undefined",
|
|
36490
|
+
"docs": ""
|
|
36491
|
+
}
|
|
36492
|
+
],
|
|
36493
|
+
"return": "Promise<SearchResponse | null | undefined>",
|
|
36494
|
+
"references": {
|
|
36495
|
+
"Promise": {
|
|
36496
|
+
"location": "import",
|
|
36497
|
+
"path": "typescript/lib/lib.es5.d.ts",
|
|
36498
|
+
"id": "notImplemented"
|
|
36499
|
+
},
|
|
36500
|
+
"SearchResponse": {
|
|
36501
|
+
"location": "import",
|
|
36502
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
36503
|
+
"id": "notImplemented"
|
|
36504
|
+
},
|
|
36505
|
+
"Array": {
|
|
36506
|
+
"location": "import",
|
|
36507
|
+
"path": "typescript/lib/lib.es5.d.ts",
|
|
36508
|
+
"id": "notImplemented"
|
|
36509
|
+
},
|
|
36510
|
+
"Graphic": {
|
|
36511
|
+
"location": "import",
|
|
36512
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
36513
|
+
"id": "notImplemented"
|
|
36514
|
+
},
|
|
36515
|
+
"Point": {
|
|
36516
|
+
"location": "import",
|
|
36517
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
36518
|
+
"id": "notImplemented"
|
|
36519
|
+
},
|
|
36520
|
+
"SuggestResult": {
|
|
36521
|
+
"location": "import",
|
|
36522
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
36523
|
+
"id": "notImplemented"
|
|
36524
|
+
}
|
|
36525
|
+
}
|
|
36526
|
+
},
|
|
36527
|
+
"signature": "search(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | Nil | number[] | string): Promise<__esri.SearchResponse | Nil>",
|
|
36528
|
+
"parameters": [
|
|
36529
|
+
{
|
|
36530
|
+
"name": "searchItem",
|
|
36531
|
+
"type": "Array<number> | Graphic | Point | SuggestResult | null | string | undefined",
|
|
36532
|
+
"docs": ""
|
|
36533
|
+
}
|
|
36534
|
+
],
|
|
36535
|
+
"docs": "Depending on the sources specified, search() queries the feature layer(s) and/or performs\naddress matching using any specified [locator(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) and\nreturns any applicable results.",
|
|
36536
|
+
"docsTags": []
|
|
36537
|
+
},
|
|
36099
36538
|
{
|
|
36100
36539
|
"name": "setFocus",
|
|
36101
36540
|
"returns": {
|
|
@@ -36118,6 +36557,46 @@
|
|
|
36118
36557
|
"parameters": [],
|
|
36119
36558
|
"docs": "Brings focus to the component's text input.",
|
|
36120
36559
|
"docsTags": []
|
|
36560
|
+
},
|
|
36561
|
+
{
|
|
36562
|
+
"name": "suggest",
|
|
36563
|
+
"returns": {
|
|
36564
|
+
"type": "Promise<SuggestResponse | null | undefined>",
|
|
36565
|
+
"docs": ""
|
|
36566
|
+
},
|
|
36567
|
+
"complexType": {
|
|
36568
|
+
"signature": "(query?: string): Promise<__esri.SuggestResponse | Nil>",
|
|
36569
|
+
"parameters": [
|
|
36570
|
+
{
|
|
36571
|
+
"name": "query",
|
|
36572
|
+
"type": "string | undefined",
|
|
36573
|
+
"docs": ""
|
|
36574
|
+
}
|
|
36575
|
+
],
|
|
36576
|
+
"return": "Promise<SuggestResponse | null | undefined>",
|
|
36577
|
+
"references": {
|
|
36578
|
+
"Promise": {
|
|
36579
|
+
"location": "import",
|
|
36580
|
+
"path": "typescript/lib/lib.es5.d.ts",
|
|
36581
|
+
"id": "notImplemented"
|
|
36582
|
+
},
|
|
36583
|
+
"SuggestResponse": {
|
|
36584
|
+
"location": "import",
|
|
36585
|
+
"path": "@arcgis/core/interfaces.d.ts",
|
|
36586
|
+
"id": "notImplemented"
|
|
36587
|
+
}
|
|
36588
|
+
}
|
|
36589
|
+
},
|
|
36590
|
+
"signature": "suggest(query?: string): Promise<__esri.SuggestResponse | Nil>",
|
|
36591
|
+
"parameters": [
|
|
36592
|
+
{
|
|
36593
|
+
"name": "query",
|
|
36594
|
+
"type": "string | undefined",
|
|
36595
|
+
"docs": ""
|
|
36596
|
+
}
|
|
36597
|
+
],
|
|
36598
|
+
"docs": "Performs a suggest() request on the active Locator. It also uses the current value of\nthe component or one that is passed in.\n\nSuggestions are available if working with a 10.3 or greater geocoding service that has\n[suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e.\n`supportsPagination = true`.",
|
|
36599
|
+
"docsTags": []
|
|
36121
36600
|
}
|
|
36122
36601
|
],
|
|
36123
36602
|
"events": [
|
|
@@ -36317,10 +36796,10 @@
|
|
|
36317
36796
|
},
|
|
36318
36797
|
{
|
|
36319
36798
|
"name": "messages",
|
|
36320
|
-
"type": "({\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n} & {\n _lang: string;\n _t9nLocale: \"id\" | \"el\" | \"hr\" | \"th\" | \"tr\" | \"sl\" | \"it\" | \"ca\" | \"de\" | \"fi\" | \"ar\" | \"da\" | \"vi\" | \"pl\" | \"et\" | \"bs\" | \"sk\" | \"es\" | \"en\" | \"ru\" | \"ro\" | \"no\" | \"lt\" | \"cs\" | \"
|
|
36799
|
+
"type": "({\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n} & {\n _lang: string;\n _t9nLocale: \"id\" | \"el\" | \"hr\" | \"th\" | \"tr\" | \"sl\" | \"it\" | \"ca\" | \"de\" | \"fi\" | \"ar\" | \"da\" | \"vi\" | \"pl\" | \"he\" | \"et\" | \"bs\" | \"sk\" | \"es\" | \"en\" | \"ru\" | \"ro\" | \"no\" | \"lt\" | \"cs\" | \"fr\" | \"sv\" | \"bg\" | \"lv\" | \"nl\" | \"sr\" | \"hu\" | \"ja\" | \"ko\" | \"nb\" | \"pt-BR\" | \"pt-PT\" | \"uk\" | \"zh-CN\" | \"zh-HK\" | \"zh-TW\";\n _loading: boolean;\n _overrides: {\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n };\n _original?: {\n componentLabel: string;\n searchButtonTitle: string;\n placeholder: string;\n searchIn: string;\n all: string;\n allPlaceholder: string;\n locateError: string;\n untitledResult: string;\n untitledSource: string;\n noResults: string;\n noResultsFound: string;\n noResultsFoundForValue: string;\n showMoreResults: string;\n hideMoreResults: string;\n searchResult: string;\n moreResultsHeader: string;\n useCurrentLocation: string;\n } | undefined;\n})",
|
|
36321
36800
|
"complexType": {
|
|
36322
|
-
"original": "({\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n} & {\n _lang: string;\n _t9nLocale: \"id\" | \"el\" | \"hr\" | \"th\" | \"tr\" | \"sl\" | \"it\" | \"ca\" | \"de\" | \"fi\" | \"ar\" | \"da\" | \"vi\" | \"pl\" | \"et\" | \"bs\" | \"sk\" | \"es\" | \"en\" | \"ru\" | \"ro\" | \"no\" | \"lt\" | \"cs\" | \"
|
|
36323
|
-
"resolved": "({\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n} & {\n _lang: string;\n _t9nLocale: \"id\" | \"el\" | \"hr\" | \"th\" | \"tr\" | \"sl\" | \"it\" | \"ca\" | \"de\" | \"fi\" | \"ar\" | \"da\" | \"vi\" | \"pl\" | \"et\" | \"bs\" | \"sk\" | \"es\" | \"en\" | \"ru\" | \"ro\" | \"no\" | \"lt\" | \"cs\" | \"
|
|
36801
|
+
"original": "({\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n} & {\n _lang: string;\n _t9nLocale: \"id\" | \"el\" | \"hr\" | \"th\" | \"tr\" | \"sl\" | \"it\" | \"ca\" | \"de\" | \"fi\" | \"ar\" | \"da\" | \"vi\" | \"pl\" | \"he\" | \"et\" | \"bs\" | \"sk\" | \"es\" | \"en\" | \"ru\" | \"ro\" | \"no\" | \"lt\" | \"cs\" | \"fr\" | \"sv\" | \"bg\" | \"lv\" | \"nl\" | \"sr\" | \"hu\" | \"ja\" | \"ko\" | \"nb\" | \"pt-BR\" | \"pt-PT\" | \"uk\" | \"zh-CN\" | \"zh-HK\" | \"zh-TW\";\n _loading: boolean;\n _overrides: {\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n };\n _original?: {\n componentLabel: string;\n searchButtonTitle: string;\n placeholder: string;\n searchIn: string;\n all: string;\n allPlaceholder: string;\n locateError: string;\n untitledResult: string;\n untitledSource: string;\n noResults: string;\n noResultsFound: string;\n noResultsFoundForValue: string;\n showMoreResults: string;\n hideMoreResults: string;\n searchResult: string;\n moreResultsHeader: string;\n useCurrentLocation: string;\n } | undefined;\n})",
|
|
36802
|
+
"resolved": "({\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n} & {\n _lang: string;\n _t9nLocale: \"id\" | \"el\" | \"hr\" | \"th\" | \"tr\" | \"sl\" | \"it\" | \"ca\" | \"de\" | \"fi\" | \"ar\" | \"da\" | \"vi\" | \"pl\" | \"he\" | \"et\" | \"bs\" | \"sk\" | \"es\" | \"en\" | \"ru\" | \"ro\" | \"no\" | \"lt\" | \"cs\" | \"fr\" | \"sv\" | \"bg\" | \"lv\" | \"nl\" | \"sr\" | \"hu\" | \"ja\" | \"ko\" | \"nb\" | \"pt-BR\" | \"pt-PT\" | \"uk\" | \"zh-CN\" | \"zh-HK\" | \"zh-TW\";\n _loading: boolean;\n _overrides: {\n componentLabel?: string | undefined;\n searchButtonTitle?: string | undefined;\n placeholder?: string | undefined;\n searchIn?: string | undefined;\n all?: string | undefined;\n allPlaceholder?: string | undefined;\n locateError?: string | undefined;\n untitledResult?: string | undefined;\n untitledSource?: string | undefined;\n noResults?: string | undefined;\n noResultsFound?: string | undefined;\n noResultsFoundForValue?: string | undefined;\n showMoreResults?: string | undefined;\n hideMoreResults?: string | undefined;\n searchResult?: string | undefined;\n moreResultsHeader?: string | undefined;\n useCurrentLocation?: string | undefined;\n };\n _original?: {\n componentLabel: string;\n searchButtonTitle: string;\n placeholder: string;\n searchIn: string;\n all: string;\n allPlaceholder: string;\n locateError: string;\n untitledResult: string;\n untitledSource: string;\n noResults: string;\n noResultsFound: string;\n noResultsFoundForValue: string;\n showMoreResults: string;\n hideMoreResults: string;\n searchResult: string;\n moreResultsHeader: string;\n useCurrentLocation: string;\n } | undefined;\n})",
|
|
36324
36803
|
"references": {}
|
|
36325
36804
|
},
|
|
36326
36805
|
"mutable": true,
|
|
@@ -36379,7 +36858,7 @@
|
|
|
36379
36858
|
"docsTags": [
|
|
36380
36859
|
{
|
|
36381
36860
|
"name": "example",
|
|
36382
|
-
"text": "
|
|
36861
|
+
"text": "```js\nconst arcgisSearchResultRenderer = document.querySelector(\"arcgis-search-result-renderer\");\ndocument.body.append(arcgisSearchResultRenderer);\nawait arcgisSearchResultRenderer.componentOnReady();\nconsole.log(\"arcgis-search-result-renderer is ready to go!\");\n```"
|
|
36383
36862
|
},
|
|
36384
36863
|
{
|
|
36385
36864
|
"name": "inheritedFrom",
|
|
@@ -36438,7 +36917,7 @@
|
|
|
36438
36917
|
"overview": "",
|
|
36439
36918
|
"readme": "",
|
|
36440
36919
|
"usage": {},
|
|
36441
|
-
"docs": "The Shadow Cast component displays the cumulative shadows of 3D features in a [
|
|
36920
|
+
"docs": "The Shadow Cast component displays the cumulative shadows of 3D features in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nThis type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.\n\nThe component calculates the cumulative shadows for a time range during a single day. The user can\nconfigure the time range and select a calendar date. This time range and calendar date are only used\nfor the shadow analysis and are not connected to the lighting in the scene.\nTo control the lighting in the scene, the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component can be used.\nChanging the timezone in the component updates the visualization by interpreting the time range as being\nin that timezone. This behavior is different from the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component,\nwhere selecting a timezone updates the [environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) date and time according to the camera position.\n\nThe component provides three [visualization modes](#visualizationType): threshold, duration, and discrete mode.\n\nIn the **threshold** mode, only the areas that receive\nshadows for more than a certain amount of time are displayed. In the image below, on May 1, 2021 the red areas receive\nshadow for more than 4 hours within the time interval of 10AM to 4PM.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Total shadow duration** mode displays the duration of the cumulative shadow using opacity: areas that don't\nreceive any shadow are fully transparent and areas that receive a maximum amount of shadow have a default opacity\nof 0.7. The values in between are interpolated. Hovering over the Scene will display a tooltip showing the\namount of time that location is in shadow, rounded to 15-minute intervals. In this mode, the visualization\ncan display shadow cast in a continuous way or in 1-hour intervals.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Discrete shadows** is a third visualization mode which displays individual shadows at a given time interval.\nFor example, setting the time range to 10AM-11AM and the visualization time interval to 30 minutes will display\nshadows for 10AM, 10:30AM and 11:00AM.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\nThe defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay), [endTimeOfDay](#endTimeOfDay), and [visualizationType](#visualizationType) properties.\n\n**Known limitations**\n\n* Shadow Cast is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* Terrain does not cast shadows and it is therefore not taken into account in this analysis.\n* The component does not take into account the daylight savings.\nUse the timezone dropdown to adjust the offset from the Coordinated Universal Time (UTC) and account for the daylight saving time.\n* The timezone is automatically detected by the component based on the camera location. In some situations, this might not be accurate.\nIn case of an inaccurate timezone, users can set it manually using the timezone dropdown.\n\n**See also**\n\n- [Sample - Shadow cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)",
|
|
36442
36921
|
"docsTags": [
|
|
36443
36922
|
{
|
|
36444
36923
|
"name": "superclass",
|
|
@@ -36489,7 +36968,7 @@
|
|
|
36489
36968
|
"mutable": true,
|
|
36490
36969
|
"attr": "date",
|
|
36491
36970
|
"reflectToAttr": false,
|
|
36492
|
-
"docs": "",
|
|
36971
|
+
"docs": "The calendar date used to calculate the shadow cast. This date excludes the time. If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.\nIf no date is set, then it defaults to the current date in local system time.\n\n_See also_\n\n* [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)",
|
|
36493
36972
|
"docsTags": [],
|
|
36494
36973
|
"values": [
|
|
36495
36974
|
{
|
|
@@ -36521,7 +37000,7 @@
|
|
|
36521
37000
|
},
|
|
36522
37001
|
"mutable": true,
|
|
36523
37002
|
"reflectToAttr": false,
|
|
36524
|
-
"docs": "The configuration used when the
|
|
37003
|
+
"docs": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"discrete\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DiscreteOptions.html)",
|
|
36525
37004
|
"docsTags": [],
|
|
36526
37005
|
"values": [],
|
|
36527
37006
|
"optional": true,
|
|
@@ -36543,7 +37022,7 @@
|
|
|
36543
37022
|
},
|
|
36544
37023
|
"mutable": true,
|
|
36545
37024
|
"reflectToAttr": false,
|
|
36546
|
-
"docs": "The configuration used when the
|
|
37025
|
+
"docs": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"duration\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-DurationOptions.html)",
|
|
36547
37026
|
"docsTags": [],
|
|
36548
37027
|
"values": [],
|
|
36549
37028
|
"optional": true,
|
|
@@ -36560,7 +37039,7 @@
|
|
|
36560
37039
|
"mutable": true,
|
|
36561
37040
|
"attr": "end-time-of-day",
|
|
36562
37041
|
"reflectToAttr": false,
|
|
36563
|
-
"docs": "Time (in milliseconds from midnight of the [date](
|
|
37042
|
+
"docs": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)",
|
|
36564
37043
|
"docsTags": [],
|
|
36565
37044
|
"default": "16 * 3600 * 1000",
|
|
36566
37045
|
"values": [
|
|
@@ -36824,13 +37303,8 @@
|
|
|
36824
37303
|
"mutable": true,
|
|
36825
37304
|
"attr": "icon",
|
|
36826
37305
|
"reflectToAttr": false,
|
|
36827
|
-
"docs": "Icon which represents the
|
|
36828
|
-
"docsTags": [
|
|
36829
|
-
{
|
|
36830
|
-
"name": "see",
|
|
36831
|
-
"text": "[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"
|
|
36832
|
-
}
|
|
36833
|
-
],
|
|
37306
|
+
"docs": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
37307
|
+
"docsTags": [],
|
|
36834
37308
|
"default": "\"measure-building-height-shadow\"",
|
|
36835
37309
|
"values": [
|
|
36836
37310
|
{
|
|
@@ -36851,7 +37325,7 @@
|
|
|
36851
37325
|
"mutable": true,
|
|
36852
37326
|
"attr": "label",
|
|
36853
37327
|
"reflectToAttr": false,
|
|
36854
|
-
"docs": "The
|
|
37328
|
+
"docs": "The component's default label.",
|
|
36855
37329
|
"docsTags": [],
|
|
36856
37330
|
"values": [
|
|
36857
37331
|
{
|
|
@@ -36943,8 +37417,13 @@
|
|
|
36943
37417
|
"mutable": true,
|
|
36944
37418
|
"attr": "reference-element",
|
|
36945
37419
|
"reflectToAttr": false,
|
|
36946
|
-
"docs": "",
|
|
36947
|
-
"docsTags": [
|
|
37420
|
+
"docs": "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.",
|
|
37421
|
+
"docsTags": [
|
|
37422
|
+
{
|
|
37423
|
+
"name": "see",
|
|
37424
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
37425
|
+
}
|
|
37426
|
+
],
|
|
36948
37427
|
"values": [
|
|
36949
37428
|
{
|
|
36950
37429
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -36973,7 +37452,7 @@
|
|
|
36973
37452
|
"mutable": true,
|
|
36974
37453
|
"attr": "start-time-of-day",
|
|
36975
37454
|
"reflectToAttr": false,
|
|
36976
|
-
"docs": "Time (in milliseconds from midnight of the [date](
|
|
37455
|
+
"docs": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)",
|
|
36977
37456
|
"docsTags": [],
|
|
36978
37457
|
"default": "10 * 3600 * 1000",
|
|
36979
37458
|
"values": [
|
|
@@ -36995,7 +37474,7 @@
|
|
|
36995
37474
|
"mutable": true,
|
|
36996
37475
|
"attr": "state",
|
|
36997
37476
|
"reflectToAttr": true,
|
|
36998
|
-
"docs": "The
|
|
37477
|
+
"docs": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
36999
37478
|
"docsTags": [
|
|
37000
37479
|
{
|
|
37001
37480
|
"name": "readonly",
|
|
@@ -37032,7 +37511,7 @@
|
|
|
37032
37511
|
},
|
|
37033
37512
|
"mutable": true,
|
|
37034
37513
|
"reflectToAttr": false,
|
|
37035
|
-
"docs": "The configuration used when the
|
|
37514
|
+
"docs": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"threshold\".\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ThresholdOptions.html)",
|
|
37036
37515
|
"docsTags": [],
|
|
37037
37516
|
"values": [],
|
|
37038
37517
|
"optional": true,
|
|
@@ -37049,7 +37528,7 @@
|
|
|
37049
37528
|
"mutable": true,
|
|
37050
37529
|
"attr": "utc-offset",
|
|
37051
37530
|
"reflectToAttr": false,
|
|
37052
|
-
"docs": "The difference in hours between UTC time and the times displayed in the
|
|
37531
|
+
"docs": "The difference in hours between UTC time and the times displayed in the component.",
|
|
37053
37532
|
"docsTags": [],
|
|
37054
37533
|
"values": [
|
|
37055
37534
|
{
|
|
@@ -37070,7 +37549,7 @@
|
|
|
37070
37549
|
"mutable": true,
|
|
37071
37550
|
"attr": "visualization-type",
|
|
37072
37551
|
"reflectToAttr": false,
|
|
37073
|
-
"docs": "Type of visualization to use when showing the shadows
|
|
37552
|
+
"docs": "Type of visualization to use when showing the shadows. There are 3 types of visualization:\n* `threshold` - only displays areas that receive shadows for a period longer than a given threshold value\n* `duration` - displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals\n* `discrete` - displays individual shadows cast at a given time interval",
|
|
37074
37553
|
"docsTags": [],
|
|
37075
37554
|
"default": "\"threshold\"",
|
|
37076
37555
|
"values": [
|
|
@@ -37116,7 +37595,7 @@
|
|
|
37116
37595
|
"docsTags": [
|
|
37117
37596
|
{
|
|
37118
37597
|
"name": "example",
|
|
37119
|
-
"text": "
|
|
37598
|
+
"text": "```js\nconst arcgisShadowCast = document.querySelector(\"arcgis-shadow-cast\");\ndocument.body.append(arcgisShadowCast);\nawait arcgisShadowCast.componentOnReady();\nconsole.log(\"arcgis-shadow-cast is ready to go!\");\n```"
|
|
37120
37599
|
},
|
|
37121
37600
|
{
|
|
37122
37601
|
"name": "inheritedFrom",
|
|
@@ -37184,7 +37663,7 @@
|
|
|
37184
37663
|
"docs": ""
|
|
37185
37664
|
}
|
|
37186
37665
|
],
|
|
37187
|
-
"docs": "",
|
|
37666
|
+
"docs": "Returns the time (in milliseconds) spent in shadow for a certain point on the screen.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#getDuration)",
|
|
37188
37667
|
"docsTags": []
|
|
37189
37668
|
},
|
|
37190
37669
|
{
|
|
@@ -37207,7 +37686,7 @@
|
|
|
37207
37686
|
},
|
|
37208
37687
|
"signature": "start(): Promise<void>",
|
|
37209
37688
|
"parameters": [],
|
|
37210
|
-
"docs": "",
|
|
37689
|
+
"docs": "Starts the component. While running, it will automatically perform shadow accumulation.",
|
|
37211
37690
|
"docsTags": []
|
|
37212
37691
|
},
|
|
37213
37692
|
{
|
|
@@ -37230,7 +37709,7 @@
|
|
|
37230
37709
|
},
|
|
37231
37710
|
"signature": "stop(): Promise<void>",
|
|
37232
37711
|
"parameters": [],
|
|
37233
|
-
"docs": "",
|
|
37712
|
+
"docs": "Stops the component.",
|
|
37234
37713
|
"docsTags": []
|
|
37235
37714
|
}
|
|
37236
37715
|
],
|
|
@@ -38308,8 +38787,13 @@
|
|
|
38308
38787
|
"mutable": true,
|
|
38309
38788
|
"attr": "reference-element",
|
|
38310
38789
|
"reflectToAttr": false,
|
|
38311
|
-
"docs": "",
|
|
38312
|
-
"docsTags": [
|
|
38790
|
+
"docs": "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.",
|
|
38791
|
+
"docsTags": [
|
|
38792
|
+
{
|
|
38793
|
+
"name": "see",
|
|
38794
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
38795
|
+
}
|
|
38796
|
+
],
|
|
38313
38797
|
"values": [
|
|
38314
38798
|
{
|
|
38315
38799
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -38590,7 +39074,7 @@
|
|
|
38590
39074
|
"docsTags": [
|
|
38591
39075
|
{
|
|
38592
39076
|
"name": "example",
|
|
38593
|
-
"text": "
|
|
39077
|
+
"text": "```js\nconst arcgisSketch = document.querySelector(\"arcgis-sketch\");\ndocument.body.append(arcgisSketch);\nawait arcgisSketch.componentOnReady();\nconsole.log(\"arcgis-sketch is ready to go!\");\n```"
|
|
38594
39078
|
},
|
|
38595
39079
|
{
|
|
38596
39080
|
"name": "inheritedFrom",
|
|
@@ -38965,7 +39449,7 @@
|
|
|
38965
39449
|
"overview": "",
|
|
38966
39450
|
"readme": "",
|
|
38967
39451
|
"usage": {},
|
|
38968
|
-
"docs": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a
|
|
39452
|
+
"docs": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). It applies\n[slice analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\nto any layer type, making it possible to see inside buildings or to explore geological surfaces.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nThe slicing [shape](#shape)\nis always a [plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).\nBy default, the plane is either horizontal or vertical. To allow a tilt angle for the plane, set\n[tiltEnabled](#tiltEnabled)\nto `true`. The slice hides any content in front of the surface. The handles on the sides of the plane can be used to adjust\nthe size, heading, tilt, and position of the slice plane.\nThe [SlicePlane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html)\ncan be set or retrieved using the [shape](#shape) property.\n\nOnce the slice plane is applied, layers can be excluded from the slicing. For example, by excluding the sublayers which include\ncolumns and floor slabs, the inner structure of a building can investigated.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nHolding the `Shift` key while creating a new slice applies it vertically.\n\n**Known limitation**\n\nSlice is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)",
|
|
38969
39453
|
"docsTags": [
|
|
38970
39454
|
{
|
|
38971
39455
|
"name": "superclass",
|
|
@@ -38993,7 +39477,7 @@
|
|
|
38993
39477
|
},
|
|
38994
39478
|
"mutable": true,
|
|
38995
39479
|
"reflectToAttr": false,
|
|
38996
|
-
"docs": "The [
|
|
39480
|
+
"docs": "The [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Slice component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst sliceAnalysis = new SliceAnalysis({\n shape: new SlicePlane({\n position: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624925.727820931,\n y: 4550341.695170021,\n z: 56\n }),\n tilt: 270,\n width: 310,\n height: 190,\n heading: 45\n })\n});\n// Get the Scene and Slice component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst slice = document.querySelector(\"arcgis-slice\");\nawait slice.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(sliceAnalysis);\n// Connect the analysis to the slice component:\nslice.analysis = sliceAnalysis;\n```",
|
|
38997
39481
|
"docsTags": [],
|
|
38998
39482
|
"values": [],
|
|
38999
39483
|
"optional": true,
|
|
@@ -39176,7 +39660,7 @@
|
|
|
39176
39660
|
},
|
|
39177
39661
|
"mutable": true,
|
|
39178
39662
|
"reflectToAttr": false,
|
|
39179
|
-
"docs": "Replace localized message strings with your own strings
|
|
39663
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
39180
39664
|
"docsTags": [],
|
|
39181
39665
|
"values": [],
|
|
39182
39666
|
"optional": true,
|
|
@@ -39264,8 +39748,13 @@
|
|
|
39264
39748
|
"mutable": true,
|
|
39265
39749
|
"attr": "reference-element",
|
|
39266
39750
|
"reflectToAttr": false,
|
|
39267
|
-
"docs": "",
|
|
39268
|
-
"docsTags": [
|
|
39751
|
+
"docs": "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.",
|
|
39752
|
+
"docsTags": [
|
|
39753
|
+
{
|
|
39754
|
+
"name": "see",
|
|
39755
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
39756
|
+
}
|
|
39757
|
+
],
|
|
39269
39758
|
"values": [
|
|
39270
39759
|
{
|
|
39271
39760
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -39299,8 +39788,13 @@
|
|
|
39299
39788
|
},
|
|
39300
39789
|
"mutable": true,
|
|
39301
39790
|
"reflectToAttr": false,
|
|
39302
|
-
"docs": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a
|
|
39303
|
-
"docsTags": [
|
|
39791
|
+
"docs": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a\n[plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).",
|
|
39792
|
+
"docsTags": [
|
|
39793
|
+
{
|
|
39794
|
+
"name": "example",
|
|
39795
|
+
"text": "```js\n// Clone the shape to modify its properties\nconst shape = slice.shape.clone();\n// Set new values for heading and tilt\nshape.heading = 180;\nshape.tilt = 45;\n// Apply the new shape to the slice component's shape\nslice.shape = shape;\n```"
|
|
39796
|
+
}
|
|
39797
|
+
],
|
|
39304
39798
|
"values": [],
|
|
39305
39799
|
"optional": true,
|
|
39306
39800
|
"required": false
|
|
@@ -39317,7 +39811,12 @@
|
|
|
39317
39811
|
"attr": "state",
|
|
39318
39812
|
"reflectToAttr": true,
|
|
39319
39813
|
"docs": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for slicing\n* `slicing` - currently slicing\n* `sliced` - finished slicing",
|
|
39320
|
-
"docsTags": [
|
|
39814
|
+
"docsTags": [
|
|
39815
|
+
{
|
|
39816
|
+
"name": "readonly",
|
|
39817
|
+
"text": ""
|
|
39818
|
+
}
|
|
39819
|
+
],
|
|
39321
39820
|
"values": [
|
|
39322
39821
|
{
|
|
39323
39822
|
"value": "disabled",
|
|
@@ -39387,7 +39886,7 @@
|
|
|
39387
39886
|
},
|
|
39388
39887
|
"signature": "clear(): Promise<void>",
|
|
39389
39888
|
"parameters": [],
|
|
39390
|
-
"docs": "Clear the [shape](
|
|
39889
|
+
"docs": "Clear the [shape](#shape) of the slice, effectively removing it from the view. Other properties like [excludedLayers](#excludedLayers)\nand [excludeGroundSurface](#excludeGroundSurface) are not modified.",
|
|
39391
39890
|
"docsTags": []
|
|
39392
39891
|
},
|
|
39393
39892
|
{
|
|
@@ -39414,7 +39913,7 @@
|
|
|
39414
39913
|
"docsTags": [
|
|
39415
39914
|
{
|
|
39416
39915
|
"name": "example",
|
|
39417
|
-
"text": "
|
|
39916
|
+
"text": "```js\nconst arcgisSlice = document.querySelector(\"arcgis-slice\");\ndocument.body.append(arcgisSlice);\nawait arcgisSlice.componentOnReady();\nconsole.log(\"arcgis-slice is ready to go!\");\n```"
|
|
39418
39917
|
},
|
|
39419
39918
|
{
|
|
39420
39919
|
"name": "inheritedFrom",
|
|
@@ -39465,7 +39964,7 @@
|
|
|
39465
39964
|
},
|
|
39466
39965
|
"signature": "start(): Promise<void>",
|
|
39467
39966
|
"parameters": [],
|
|
39468
|
-
"docs": "Start the interactive creation of a new slice, clearing the previous
|
|
39967
|
+
"docs": "Start the interactive creation of a new slice, clearing the previous [shape](#shape).",
|
|
39469
39968
|
"docsTags": []
|
|
39470
39969
|
}
|
|
39471
39970
|
],
|
|
@@ -40029,8 +40528,13 @@
|
|
|
40029
40528
|
"mutable": true,
|
|
40030
40529
|
"attr": "reference-element",
|
|
40031
40530
|
"reflectToAttr": false,
|
|
40032
|
-
"docs": "",
|
|
40033
|
-
"docsTags": [
|
|
40531
|
+
"docs": "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.",
|
|
40532
|
+
"docsTags": [
|
|
40533
|
+
{
|
|
40534
|
+
"name": "see",
|
|
40535
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
40536
|
+
}
|
|
40537
|
+
],
|
|
40034
40538
|
"values": [
|
|
40035
40539
|
{
|
|
40036
40540
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -40382,7 +40886,7 @@
|
|
|
40382
40886
|
"docsTags": [
|
|
40383
40887
|
{
|
|
40384
40888
|
"name": "example",
|
|
40385
|
-
"text": "
|
|
40889
|
+
"text": "```js\nconst arcgisSlider = document.querySelector(\"arcgis-slider\");\ndocument.body.append(arcgisSlider);\nawait arcgisSlider.componentOnReady();\nconsole.log(\"arcgis-slider is ready to go!\");\n```"
|
|
40386
40890
|
},
|
|
40387
40891
|
{
|
|
40388
40892
|
"name": "inheritedFrom",
|
|
@@ -40675,7 +41179,7 @@
|
|
|
40675
41179
|
"overview": "",
|
|
40676
41180
|
"readme": "",
|
|
40677
41181
|
"usage": {},
|
|
40678
|
-
"docs": "The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known
|
|
41182
|
+
"docs": "The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.",
|
|
40679
41183
|
"docsTags": [
|
|
40680
41184
|
{
|
|
40681
41185
|
"name": "superclass",
|
|
@@ -40888,7 +41392,7 @@
|
|
|
40888
41392
|
},
|
|
40889
41393
|
"mutable": true,
|
|
40890
41394
|
"reflectToAttr": false,
|
|
40891
|
-
"docs": "Replace localized message strings with your own strings
|
|
41395
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
40892
41396
|
"docsTags": [],
|
|
40893
41397
|
"values": [],
|
|
40894
41398
|
"optional": true,
|
|
@@ -40976,8 +41480,13 @@
|
|
|
40976
41480
|
"mutable": true,
|
|
40977
41481
|
"attr": "reference-element",
|
|
40978
41482
|
"reflectToAttr": false,
|
|
40979
|
-
"docs": "",
|
|
40980
|
-
"docsTags": [
|
|
41483
|
+
"docs": "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.",
|
|
41484
|
+
"docsTags": [
|
|
41485
|
+
{
|
|
41486
|
+
"name": "see",
|
|
41487
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
41488
|
+
}
|
|
41489
|
+
],
|
|
40981
41490
|
"values": [
|
|
40982
41491
|
{
|
|
40983
41492
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -41102,7 +41611,7 @@
|
|
|
41102
41611
|
"docsTags": [
|
|
41103
41612
|
{
|
|
41104
41613
|
"name": "example",
|
|
41105
|
-
"text": "
|
|
41614
|
+
"text": "```js\nconst arcgisSwipe = document.querySelector(\"arcgis-swipe\");\ndocument.body.append(arcgisSwipe);\nawait arcgisSwipe.componentOnReady();\nconsole.log(\"arcgis-swipe is ready to go!\");\n```"
|
|
41106
41615
|
},
|
|
41107
41616
|
{
|
|
41108
41617
|
"name": "inheritedFrom",
|
|
@@ -41575,8 +42084,13 @@
|
|
|
41575
42084
|
"mutable": true,
|
|
41576
42085
|
"attr": "reference-element",
|
|
41577
42086
|
"reflectToAttr": false,
|
|
41578
|
-
"docs": "",
|
|
41579
|
-
"docsTags": [
|
|
42087
|
+
"docs": "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.",
|
|
42088
|
+
"docsTags": [
|
|
42089
|
+
{
|
|
42090
|
+
"name": "see",
|
|
42091
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
42092
|
+
}
|
|
42093
|
+
],
|
|
41580
42094
|
"values": [
|
|
41581
42095
|
{
|
|
41582
42096
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -41882,7 +42396,7 @@
|
|
|
41882
42396
|
"docsTags": [
|
|
41883
42397
|
{
|
|
41884
42398
|
"name": "example",
|
|
41885
|
-
"text": "
|
|
42399
|
+
"text": "```js\nconst arcgisTableList = document.querySelector(\"arcgis-table-list\");\ndocument.body.append(arcgisTableList);\nawait arcgisTableList.componentOnReady();\nconsole.log(\"arcgis-table-list is ready to go!\");\n```"
|
|
41886
42400
|
},
|
|
41887
42401
|
{
|
|
41888
42402
|
"name": "inheritedFrom",
|
|
@@ -42372,8 +42886,13 @@
|
|
|
42372
42886
|
"mutable": true,
|
|
42373
42887
|
"attr": "reference-element",
|
|
42374
42888
|
"reflectToAttr": false,
|
|
42375
|
-
"docs": "",
|
|
42376
|
-
"docsTags": [
|
|
42889
|
+
"docs": "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.",
|
|
42890
|
+
"docsTags": [
|
|
42891
|
+
{
|
|
42892
|
+
"name": "see",
|
|
42893
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
42894
|
+
}
|
|
42895
|
+
],
|
|
42377
42896
|
"values": [
|
|
42378
42897
|
{
|
|
42379
42898
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -42625,7 +43144,7 @@
|
|
|
42625
43144
|
"docsTags": [
|
|
42626
43145
|
{
|
|
42627
43146
|
"name": "example",
|
|
42628
|
-
"text": "
|
|
43147
|
+
"text": "```js\nconst arcgisTimeSlider = document.querySelector(\"arcgis-time-slider\");\ndocument.body.append(arcgisTimeSlider);\nawait arcgisTimeSlider.componentOnReady();\nconsole.log(\"arcgis-time-slider is ready to go!\");\n```"
|
|
42629
43148
|
},
|
|
42630
43149
|
{
|
|
42631
43150
|
"name": "inheritedFrom",
|
|
@@ -42963,7 +43482,7 @@
|
|
|
42963
43482
|
},
|
|
42964
43483
|
"mutable": true,
|
|
42965
43484
|
"reflectToAttr": false,
|
|
42966
|
-
"docs": "Replace localized message strings with your own strings
|
|
43485
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
42967
43486
|
"docsTags": [
|
|
42968
43487
|
{
|
|
42969
43488
|
"name": "property",
|
|
@@ -43136,7 +43655,7 @@
|
|
|
43136
43655
|
"docsTags": [
|
|
43137
43656
|
{
|
|
43138
43657
|
"name": "example",
|
|
43139
|
-
"text": "
|
|
43658
|
+
"text": "```js\nconst arcgisTimeZoneLabel = document.querySelector(\"arcgis-time-zone-label\");\ndocument.body.append(arcgisTimeZoneLabel);\nawait arcgisTimeZoneLabel.componentOnReady();\nconsole.log(\"arcgis-time-zone-label is ready to go!\");\n```"
|
|
43140
43659
|
},
|
|
43141
43660
|
{
|
|
43142
43661
|
"name": "inheritedFrom",
|
|
@@ -43186,7 +43705,7 @@
|
|
|
43186
43705
|
"overview": "",
|
|
43187
43706
|
"readme": "",
|
|
43188
43707
|
"usage": {},
|
|
43189
|
-
"docs": "The Track component is a button that animates the
|
|
43708
|
+
"docs": "The Track component is a button that when activated continuously animates the Map or Scene\nto the user's location as the user moves.\nThe view rotates based on device heading, and the default heading symbol will display\nwhen speed is greater than zero and the browser provides heading information.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that support\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility).\n\n**Known limitations**\n\n- The heading symbol is not currently supported within a [Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).",
|
|
43190
43709
|
"docsTags": [
|
|
43191
43710
|
{
|
|
43192
43711
|
"name": "superclass",
|
|
@@ -43377,7 +43896,7 @@
|
|
|
43377
43896
|
},
|
|
43378
43897
|
"mutable": true,
|
|
43379
43898
|
"reflectToAttr": false,
|
|
43380
|
-
"docs": "Replace localized message strings with your own strings
|
|
43899
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
43381
43900
|
"docsTags": [],
|
|
43382
43901
|
"values": [],
|
|
43383
43902
|
"optional": true,
|
|
@@ -43488,8 +44007,13 @@
|
|
|
43488
44007
|
"mutable": true,
|
|
43489
44008
|
"attr": "reference-element",
|
|
43490
44009
|
"reflectToAttr": false,
|
|
43491
|
-
"docs": "",
|
|
43492
|
-
"docsTags": [
|
|
44010
|
+
"docs": "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.",
|
|
44011
|
+
"docsTags": [
|
|
44012
|
+
{
|
|
44013
|
+
"name": "see",
|
|
44014
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
44015
|
+
}
|
|
44016
|
+
],
|
|
43493
44017
|
"values": [
|
|
43494
44018
|
{
|
|
43495
44019
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -43562,8 +44086,19 @@
|
|
|
43562
44086
|
"mutable": true,
|
|
43563
44087
|
"attr": "state",
|
|
43564
44088
|
"reflectToAttr": true,
|
|
43565
|
-
"docs": "The current state of the
|
|
44089
|
+
"docs": "The current state of the component.",
|
|
43566
44090
|
"docsTags": [
|
|
44091
|
+
{
|
|
44092
|
+
"name": "name",
|
|
44093
|
+
"text": "state"
|
|
44094
|
+
},
|
|
44095
|
+
{
|
|
44096
|
+
"name": "instance"
|
|
44097
|
+
},
|
|
44098
|
+
{
|
|
44099
|
+
"name": "type",
|
|
44100
|
+
"text": "{\"disabled\" | \"ready\" | \"tracking\" | \"waiting\" | \"feature-unsupported\" | \"error\"}"
|
|
44101
|
+
},
|
|
43567
44102
|
{
|
|
43568
44103
|
"name": "readonly",
|
|
43569
44104
|
"text": ""
|
|
@@ -43651,7 +44186,7 @@
|
|
|
43651
44186
|
"docsTags": [
|
|
43652
44187
|
{
|
|
43653
44188
|
"name": "example",
|
|
43654
|
-
"text": "
|
|
44189
|
+
"text": "```js\nconst arcgisTrack = document.querySelector(\"arcgis-track\");\ndocument.body.append(arcgisTrack);\nawait arcgisTrack.componentOnReady();\nconsole.log(\"arcgis-track is ready to go!\");\n```"
|
|
43655
44190
|
},
|
|
43656
44191
|
{
|
|
43657
44192
|
"name": "inheritedFrom",
|
|
@@ -43702,7 +44237,7 @@
|
|
|
43702
44237
|
},
|
|
43703
44238
|
"signature": "start(): Promise<void>",
|
|
43704
44239
|
"parameters": [],
|
|
43705
|
-
"docs": "",
|
|
44240
|
+
"docs": "Start tracking the user's location. Only start the component on a user gesture such as a click event.",
|
|
43706
44241
|
"docsTags": []
|
|
43707
44242
|
},
|
|
43708
44243
|
{
|
|
@@ -43725,7 +44260,7 @@
|
|
|
43725
44260
|
},
|
|
43726
44261
|
"signature": "stop(): Promise<void>",
|
|
43727
44262
|
"parameters": [],
|
|
43728
|
-
"docs": "",
|
|
44263
|
+
"docs": "Stop tracking the user's location.",
|
|
43729
44264
|
"docsTags": []
|
|
43730
44265
|
}
|
|
43731
44266
|
],
|
|
@@ -43810,7 +44345,7 @@
|
|
|
43810
44345
|
"overview": "",
|
|
43811
44346
|
"readme": "",
|
|
43812
44347
|
"usage": {},
|
|
43813
|
-
"docs": "The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials
|
|
44348
|
+
"docs": "The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials.",
|
|
43814
44349
|
"docsTags": [
|
|
43815
44350
|
{
|
|
43816
44351
|
"name": "superclass",
|
|
@@ -44279,8 +44814,13 @@
|
|
|
44279
44814
|
"mutable": true,
|
|
44280
44815
|
"attr": "reference-element",
|
|
44281
44816
|
"reflectToAttr": false,
|
|
44282
|
-
"docs": "",
|
|
44283
|
-
"docsTags": [
|
|
44817
|
+
"docs": "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.",
|
|
44818
|
+
"docsTags": [
|
|
44819
|
+
{
|
|
44820
|
+
"name": "see",
|
|
44821
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
44822
|
+
}
|
|
44823
|
+
],
|
|
44284
44824
|
"values": [
|
|
44285
44825
|
{
|
|
44286
44826
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -44532,7 +45072,7 @@
|
|
|
44532
45072
|
"docs": "",
|
|
44533
45073
|
"docsTags": [],
|
|
44534
45074
|
"default": "false",
|
|
44535
|
-
"deprecation": "since 4.32
|
|
45075
|
+
"deprecation": "since 4.32, use hideConnectivityAssociationsSettingsArrowsToggle instead",
|
|
44536
45076
|
"values": [
|
|
44537
45077
|
{
|
|
44538
45078
|
"type": "boolean"
|
|
@@ -44555,7 +45095,7 @@
|
|
|
44555
45095
|
"docs": "",
|
|
44556
45096
|
"docsTags": [],
|
|
44557
45097
|
"default": "false",
|
|
44558
|
-
"deprecation": "since 4.32
|
|
45098
|
+
"deprecation": "since 4.32, use hideConnectivityAssociationsSettingsCapSelect instead",
|
|
44559
45099
|
"values": [
|
|
44560
45100
|
{
|
|
44561
45101
|
"type": "boolean"
|
|
@@ -44578,7 +45118,7 @@
|
|
|
44578
45118
|
"docs": "",
|
|
44579
45119
|
"docsTags": [],
|
|
44580
45120
|
"default": "true",
|
|
44581
|
-
"deprecation": "since 4.32
|
|
45121
|
+
"deprecation": "since 4.32, use hideConnectivityAssociationsSettingsColorPicker instead",
|
|
44582
45122
|
"values": [
|
|
44583
45123
|
{
|
|
44584
45124
|
"type": "boolean"
|
|
@@ -44601,7 +45141,7 @@
|
|
|
44601
45141
|
"docs": "",
|
|
44602
45142
|
"docsTags": [],
|
|
44603
45143
|
"default": "true",
|
|
44604
|
-
"deprecation": "since 4.32
|
|
45144
|
+
"deprecation": "since 4.32, use hideConnectivityAssociationsSettingsStylePicker instead",
|
|
44605
45145
|
"values": [
|
|
44606
45146
|
{
|
|
44607
45147
|
"type": "boolean"
|
|
@@ -44624,7 +45164,7 @@
|
|
|
44624
45164
|
"docs": "",
|
|
44625
45165
|
"docsTags": [],
|
|
44626
45166
|
"default": "true",
|
|
44627
|
-
"deprecation": "since 4.32
|
|
45167
|
+
"deprecation": "since 4.32, use hideConnectivityAssociationsSettingsWidthInput instead",
|
|
44628
45168
|
"values": [
|
|
44629
45169
|
{
|
|
44630
45170
|
"type": "boolean"
|
|
@@ -44647,7 +45187,7 @@
|
|
|
44647
45187
|
"docs": "",
|
|
44648
45188
|
"docsTags": [],
|
|
44649
45189
|
"default": "false",
|
|
44650
|
-
"deprecation": "since 4.32
|
|
45190
|
+
"deprecation": "since 4.32, use hideMaxAllowableAssociationsSlider instead",
|
|
44651
45191
|
"values": [
|
|
44652
45192
|
{
|
|
44653
45193
|
"type": "boolean"
|
|
@@ -44670,7 +45210,7 @@
|
|
|
44670
45210
|
"docs": "",
|
|
44671
45211
|
"docsTags": [],
|
|
44672
45212
|
"default": "false",
|
|
44673
|
-
"deprecation": "since 4.32
|
|
45213
|
+
"deprecation": "since 4.32, use hideStructuralAttachmentAssociationsSettingsArrowsToggle instead",
|
|
44674
45214
|
"values": [
|
|
44675
45215
|
{
|
|
44676
45216
|
"type": "boolean"
|
|
@@ -44693,7 +45233,7 @@
|
|
|
44693
45233
|
"docs": "",
|
|
44694
45234
|
"docsTags": [],
|
|
44695
45235
|
"default": "false",
|
|
44696
|
-
"deprecation": "since 4.32
|
|
45236
|
+
"deprecation": "since 4.32, use hideStructuralAttachmentAssociationsSettingsCapSelect instead",
|
|
44697
45237
|
"values": [
|
|
44698
45238
|
{
|
|
44699
45239
|
"type": "boolean"
|
|
@@ -44716,7 +45256,7 @@
|
|
|
44716
45256
|
"docs": "",
|
|
44717
45257
|
"docsTags": [],
|
|
44718
45258
|
"default": "true",
|
|
44719
|
-
"deprecation": "since 4.32
|
|
45259
|
+
"deprecation": "since 4.32, use hideStructuralAttachmentAssociationsSettingsColorPicker instead",
|
|
44720
45260
|
"values": [
|
|
44721
45261
|
{
|
|
44722
45262
|
"type": "boolean"
|
|
@@ -44739,7 +45279,7 @@
|
|
|
44739
45279
|
"docs": "",
|
|
44740
45280
|
"docsTags": [],
|
|
44741
45281
|
"default": "true",
|
|
44742
|
-
"deprecation": "since 4.32
|
|
45282
|
+
"deprecation": "since 4.32, use hideStructuralAttachmentAssociationsSettingsStylePicker instead",
|
|
44743
45283
|
"values": [
|
|
44744
45284
|
{
|
|
44745
45285
|
"type": "boolean"
|
|
@@ -44762,7 +45302,7 @@
|
|
|
44762
45302
|
"docs": "",
|
|
44763
45303
|
"docsTags": [],
|
|
44764
45304
|
"default": "true",
|
|
44765
|
-
"deprecation": "since 4.32
|
|
45305
|
+
"deprecation": "since 4.32, use hideStructuralAttachmentAssociationsSettingsWidthInput instead",
|
|
44766
45306
|
"values": [
|
|
44767
45307
|
{
|
|
44768
45308
|
"type": "boolean"
|
|
@@ -44797,7 +45337,7 @@
|
|
|
44797
45337
|
"docsTags": [
|
|
44798
45338
|
{
|
|
44799
45339
|
"name": "example",
|
|
44800
|
-
"text": "
|
|
45340
|
+
"text": "```js\nconst arcgisUtilityNetworkAssociations = document.querySelector(\"arcgis-utility-network-associations\");\ndocument.body.append(arcgisUtilityNetworkAssociations);\nawait arcgisUtilityNetworkAssociations.componentOnReady();\nconsole.log(\"arcgis-utility-network-associations is ready to go!\");\n```"
|
|
44801
45341
|
},
|
|
44802
45342
|
{
|
|
44803
45343
|
"name": "inheritedFrom",
|
|
@@ -44999,7 +45539,7 @@
|
|
|
44999
45539
|
"docs": "The Geodatabase version to pass into the trace.",
|
|
45000
45540
|
"docsTags": [],
|
|
45001
45541
|
"default": "\"sde.DEFAULT\"",
|
|
45002
|
-
"deprecation": "since version 4.31
|
|
45542
|
+
"deprecation": "`gdbVersion` is deprecated since version 4.31.",
|
|
45003
45543
|
"values": [
|
|
45004
45544
|
{
|
|
45005
45545
|
"type": "string"
|
|
@@ -45166,8 +45706,13 @@
|
|
|
45166
45706
|
"mutable": true,
|
|
45167
45707
|
"attr": "reference-element",
|
|
45168
45708
|
"reflectToAttr": false,
|
|
45169
|
-
"docs": "",
|
|
45170
|
-
"docsTags": [
|
|
45709
|
+
"docs": "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.",
|
|
45710
|
+
"docsTags": [
|
|
45711
|
+
{
|
|
45712
|
+
"name": "see",
|
|
45713
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
45714
|
+
}
|
|
45715
|
+
],
|
|
45171
45716
|
"values": [
|
|
45172
45717
|
{
|
|
45173
45718
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -45378,7 +45923,7 @@
|
|
|
45378
45923
|
"docsTags": [
|
|
45379
45924
|
{
|
|
45380
45925
|
"name": "example",
|
|
45381
|
-
"text": "
|
|
45926
|
+
"text": "```js\nconst arcgisUtilityNetworkTrace = document.querySelector(\"arcgis-utility-network-trace\");\ndocument.body.append(arcgisUtilityNetworkTrace);\nawait arcgisUtilityNetworkTrace.componentOnReady();\nconsole.log(\"arcgis-utility-network-trace is ready to go!\");\n```"
|
|
45382
45927
|
},
|
|
45383
45928
|
{
|
|
45384
45929
|
"name": "inheritedFrom",
|
|
@@ -45765,8 +46310,13 @@
|
|
|
45765
46310
|
"mutable": true,
|
|
45766
46311
|
"attr": "reference-element",
|
|
45767
46312
|
"reflectToAttr": false,
|
|
45768
|
-
"docs": "",
|
|
45769
|
-
"docsTags": [
|
|
46313
|
+
"docs": "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.",
|
|
46314
|
+
"docsTags": [
|
|
46315
|
+
{
|
|
46316
|
+
"name": "see",
|
|
46317
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
46318
|
+
}
|
|
46319
|
+
],
|
|
45770
46320
|
"values": [
|
|
45771
46321
|
{
|
|
45772
46322
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -45880,7 +46430,7 @@
|
|
|
45880
46430
|
"docsTags": [
|
|
45881
46431
|
{
|
|
45882
46432
|
"name": "example",
|
|
45883
|
-
"text": "
|
|
46433
|
+
"text": "```js\nconst arcgisUtilityNetworkValidateTopology = document.querySelector(\"arcgis-utility-network-validate-topology\");\ndocument.body.append(arcgisUtilityNetworkValidateTopology);\nawait arcgisUtilityNetworkValidateTopology.componentOnReady();\nconsole.log(\"arcgis-utility-network-validate-topology is ready to go!\");\n```"
|
|
45884
46434
|
},
|
|
45885
46435
|
{
|
|
45886
46436
|
"name": "inheritedFrom",
|
|
@@ -46396,8 +46946,13 @@
|
|
|
46396
46946
|
"mutable": true,
|
|
46397
46947
|
"attr": "reference-element",
|
|
46398
46948
|
"reflectToAttr": false,
|
|
46399
|
-
"docs": "",
|
|
46400
|
-
"docsTags": [
|
|
46949
|
+
"docs": "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.",
|
|
46950
|
+
"docsTags": [
|
|
46951
|
+
{
|
|
46952
|
+
"name": "see",
|
|
46953
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
46954
|
+
}
|
|
46955
|
+
],
|
|
46401
46956
|
"values": [
|
|
46402
46957
|
{
|
|
46403
46958
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -46474,7 +47029,7 @@
|
|
|
46474
47029
|
"docsTags": [
|
|
46475
47030
|
{
|
|
46476
47031
|
"name": "example",
|
|
46477
|
-
"text": "
|
|
47032
|
+
"text": "```js\nconst arcgisValuePicker = document.querySelector(\"arcgis-value-picker\");\ndocument.body.append(arcgisValuePicker);\nawait arcgisValuePicker.componentOnReady();\nconsole.log(\"arcgis-value-picker is ready to go!\");\n```"
|
|
46478
47033
|
},
|
|
46479
47034
|
{
|
|
46480
47035
|
"name": "inheritedFrom",
|
|
@@ -46854,7 +47409,7 @@
|
|
|
46854
47409
|
},
|
|
46855
47410
|
"mutable": true,
|
|
46856
47411
|
"reflectToAttr": false,
|
|
46857
|
-
"docs": "The `initialVersionInfos` property enables users to initialize the Version Management
|
|
47412
|
+
"docs": "The `initialVersionInfos` property enables users to initialize the Version Management component with a predefined set of versions.\nBy providing an array of `InitialVersionInfo`, the component displays a specified version for each feature service upon initialization.",
|
|
46858
47413
|
"docsTags": [],
|
|
46859
47414
|
"values": [],
|
|
46860
47415
|
"optional": true,
|
|
@@ -46891,7 +47446,7 @@
|
|
|
46891
47446
|
},
|
|
46892
47447
|
"mutable": true,
|
|
46893
47448
|
"reflectToAttr": false,
|
|
46894
|
-
"docs": "Replace localized message strings with your own strings
|
|
47449
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
46895
47450
|
"docsTags": [],
|
|
46896
47451
|
"values": [],
|
|
46897
47452
|
"optional": true,
|
|
@@ -46929,7 +47484,7 @@
|
|
|
46929
47484
|
"mutable": true,
|
|
46930
47485
|
"attr": "page-size",
|
|
46931
47486
|
"reflectToAttr": false,
|
|
46932
|
-
"docs": "Specifies the number of versions displayed on each page of the Version Management
|
|
47487
|
+
"docs": "Specifies the number of versions displayed on each page of the Version Management component.",
|
|
46933
47488
|
"docsTags": [],
|
|
46934
47489
|
"default": "5",
|
|
46935
47490
|
"values": [
|
|
@@ -47022,8 +47577,13 @@
|
|
|
47022
47577
|
"mutable": true,
|
|
47023
47578
|
"attr": "reference-element",
|
|
47024
47579
|
"reflectToAttr": false,
|
|
47025
|
-
"docs": "",
|
|
47026
|
-
"docsTags": [
|
|
47580
|
+
"docs": "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.",
|
|
47581
|
+
"docsTags": [
|
|
47582
|
+
{
|
|
47583
|
+
"name": "see",
|
|
47584
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
47585
|
+
}
|
|
47586
|
+
],
|
|
47027
47587
|
"values": [
|
|
47028
47588
|
{
|
|
47029
47589
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -47109,7 +47669,7 @@
|
|
|
47109
47669
|
},
|
|
47110
47670
|
"mutable": true,
|
|
47111
47671
|
"reflectToAttr": false,
|
|
47112
|
-
"docs": "This class provides functionality for managing versions in a versioned geodatabase.\nIn the event that the Version Management component is destroyed, the VersioningStates can be utilized to maintain the current state of the Version Management
|
|
47672
|
+
"docs": "This class provides functionality for managing versions in a versioned geodatabase.\nIn the event that the Version Management component is destroyed, the VersioningStates can be utilized to maintain the current state of the Version Management component.\nThe Version Management component can be reinitialized using a `Collection<VersioningState>`, or a predefined `Collection<VersioningState>` can be provided during the initial instantiation of the Version Management component.",
|
|
47113
47673
|
"docsTags": [],
|
|
47114
47674
|
"values": [],
|
|
47115
47675
|
"optional": true,
|
|
@@ -47141,7 +47701,7 @@
|
|
|
47141
47701
|
"docsTags": [
|
|
47142
47702
|
{
|
|
47143
47703
|
"name": "example",
|
|
47144
|
-
"text": "
|
|
47704
|
+
"text": "```js\nconst arcgisVersionManagement = document.querySelector(\"arcgis-version-management\");\ndocument.body.append(arcgisVersionManagement);\nawait arcgisVersionManagement.componentOnReady();\nconsole.log(\"arcgis-version-management is ready to go!\");\n```"
|
|
47145
47705
|
},
|
|
47146
47706
|
{
|
|
47147
47707
|
"name": "inheritedFrom",
|
|
@@ -47220,8 +47780,16 @@
|
|
|
47220
47780
|
"overview": "",
|
|
47221
47781
|
"readme": "",
|
|
47222
47782
|
"usage": {},
|
|
47223
|
-
"docs": "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
|
|
47783
|
+
"docs": "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.",
|
|
47224
47784
|
"docsTags": [
|
|
47785
|
+
{
|
|
47786
|
+
"name": "example",
|
|
47787
|
+
"text": "```html\n<arcgis-video></arcgis-video>\n```\n\n```js\nconst VideoLayer = await $arcgis.import(\"@arcgis/core/layers/VideoLayer.js\");\nconst videoElement = document.querySelector(\"arcgis-video\");\n\nconst videoLayer = new VideoLayer({\n url: \"YOUR_VIDEO_LAYER_URL\",\n});\n\nawait videoLayer.load();\nif (videoLayer.loaded) {\n videoElement.layer = videoLayer;\n}\n```"
|
|
47788
|
+
},
|
|
47789
|
+
{
|
|
47790
|
+
"name": "since",
|
|
47791
|
+
"text": "4.33"
|
|
47792
|
+
},
|
|
47225
47793
|
{
|
|
47226
47794
|
"name": "superclass",
|
|
47227
47795
|
"text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
|
|
@@ -47276,27 +47844,6 @@
|
|
|
47276
47844
|
"optional": true,
|
|
47277
47845
|
"required": false
|
|
47278
47846
|
},
|
|
47279
|
-
{
|
|
47280
|
-
"name": "layerUrl",
|
|
47281
|
-
"type": "string",
|
|
47282
|
-
"complexType": {
|
|
47283
|
-
"original": "string",
|
|
47284
|
-
"resolved": "string",
|
|
47285
|
-
"references": {}
|
|
47286
|
-
},
|
|
47287
|
-
"mutable": true,
|
|
47288
|
-
"attr": "layer-url",
|
|
47289
|
-
"reflectToAttr": true,
|
|
47290
|
-
"docs": "",
|
|
47291
|
-
"docsTags": [],
|
|
47292
|
-
"values": [
|
|
47293
|
-
{
|
|
47294
|
-
"type": "string"
|
|
47295
|
-
}
|
|
47296
|
-
],
|
|
47297
|
-
"optional": true,
|
|
47298
|
-
"required": false
|
|
47299
|
-
},
|
|
47300
47847
|
{
|
|
47301
47848
|
"name": "ready",
|
|
47302
47849
|
"type": "boolean",
|
|
@@ -47376,7 +47923,7 @@
|
|
|
47376
47923
|
"docsTags": [
|
|
47377
47924
|
{
|
|
47378
47925
|
"name": "example",
|
|
47379
|
-
"text": "
|
|
47926
|
+
"text": "```js\nconst arcgisVideo = document.querySelector(\"arcgis-video\");\ndocument.body.append(arcgisVideo);\nawait arcgisVideo.componentOnReady();\nconsole.log(\"arcgis-video is ready to go!\");\n```"
|
|
47380
47927
|
},
|
|
47381
47928
|
{
|
|
47382
47929
|
"name": "inheritedFrom",
|
|
@@ -47435,8 +47982,16 @@
|
|
|
47435
47982
|
"overview": "",
|
|
47436
47983
|
"readme": "",
|
|
47437
47984
|
"usage": {},
|
|
47438
|
-
"docs": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known
|
|
47985
|
+
"docs": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[](https://mediaspace.esri.com/media/1_ctc3psfr)",
|
|
47439
47986
|
"docsTags": [
|
|
47987
|
+
{
|
|
47988
|
+
"name": "example",
|
|
47989
|
+
"text": "```html\n<arcgis-map>\n <arcgis-video-player></arcgis-video-player>\n</arcgis-map>\n```\n\n```js\nconst [Map, VideoLayer] = await $arcgis.import([\n \"@arcgis/core/Map.js\",\n \"@arcgis/core/layers/VideoLayer.js\",\n]);\n\nconst viewElement = document.querySelector(\"arcgis-map\");\nconst videoPlayerElement = document.querySelector(\"arcgis-video-player\");\n\nconst videoLayer = new VideoLayer({\n url: \"YOUR_VIDEO_LAYER_URL\",\n});\n\nviewElement.map = new Map({\n basemap: \"topo-vector\",\n layers: [videoLayer],\n});\nawait viewElement.viewOnReady();\n\nawait videoLayer.load();\nif (videoLayer.loaded) {\n videoPlayerElement.layer = videoLayer;\n}\n\nawait viewElement.whenLayerView(videoLayer);\nviewElement.goTo(videoLayer.fullExtent);\n```"
|
|
47990
|
+
},
|
|
47991
|
+
{
|
|
47992
|
+
"name": "since",
|
|
47993
|
+
"text": "4.33"
|
|
47994
|
+
},
|
|
47440
47995
|
{
|
|
47441
47996
|
"name": "superclass",
|
|
47442
47997
|
"text": "{\"name\":\"LitElement\",\"package\":\"@arcgis/lumina\"}"
|
|
@@ -47469,6 +48024,41 @@
|
|
|
47469
48024
|
"optional": true,
|
|
47470
48025
|
"required": false
|
|
47471
48026
|
},
|
|
48027
|
+
{
|
|
48028
|
+
"name": "followingMode",
|
|
48029
|
+
"type": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\"",
|
|
48030
|
+
"complexType": {
|
|
48031
|
+
"original": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\"",
|
|
48032
|
+
"resolved": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\"",
|
|
48033
|
+
"references": {}
|
|
48034
|
+
},
|
|
48035
|
+
"mutable": true,
|
|
48036
|
+
"attr": "following-mode",
|
|
48037
|
+
"reflectToAttr": false,
|
|
48038
|
+
"docs": "Determines which telemetry elements to follow when the video layer is playing.",
|
|
48039
|
+
"docsTags": [],
|
|
48040
|
+
"default": "\"follow-both\"",
|
|
48041
|
+
"values": [
|
|
48042
|
+
{
|
|
48043
|
+
"value": "follow-both",
|
|
48044
|
+
"type": "string"
|
|
48045
|
+
},
|
|
48046
|
+
{
|
|
48047
|
+
"value": "follow-frame",
|
|
48048
|
+
"type": "string"
|
|
48049
|
+
},
|
|
48050
|
+
{
|
|
48051
|
+
"value": "follow-sensor",
|
|
48052
|
+
"type": "string"
|
|
48053
|
+
},
|
|
48054
|
+
{
|
|
48055
|
+
"value": "none",
|
|
48056
|
+
"type": "string"
|
|
48057
|
+
}
|
|
48058
|
+
],
|
|
48059
|
+
"optional": true,
|
|
48060
|
+
"required": false
|
|
48061
|
+
},
|
|
47472
48062
|
{
|
|
47473
48063
|
"name": "hideHeader",
|
|
47474
48064
|
"type": "boolean",
|
|
@@ -47574,7 +48164,7 @@
|
|
|
47574
48164
|
},
|
|
47575
48165
|
{
|
|
47576
48166
|
"name": "example",
|
|
47577
|
-
"text": "// Create a new Video Player with a VideoLayer\nvideoPlayer.layer = videoLayer
|
|
48167
|
+
"text": "```js\n// Create a new Video Player with a VideoLayer\nvideoPlayer.layer = videoLayer;\n```"
|
|
47578
48168
|
}
|
|
47579
48169
|
],
|
|
47580
48170
|
"default": "null",
|
|
@@ -47592,7 +48182,7 @@
|
|
|
47592
48182
|
},
|
|
47593
48183
|
"mutable": true,
|
|
47594
48184
|
"reflectToAttr": false,
|
|
47595
|
-
"docs": "Replace localized message strings with your own strings
|
|
48185
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
47596
48186
|
"docsTags": [],
|
|
47597
48187
|
"values": [],
|
|
47598
48188
|
"optional": true,
|
|
@@ -47680,8 +48270,13 @@
|
|
|
47680
48270
|
"mutable": true,
|
|
47681
48271
|
"attr": "reference-element",
|
|
47682
48272
|
"reflectToAttr": false,
|
|
47683
|
-
"docs": "",
|
|
47684
|
-
"docsTags": [
|
|
48273
|
+
"docs": "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.",
|
|
48274
|
+
"docsTags": [
|
|
48275
|
+
{
|
|
48276
|
+
"name": "see",
|
|
48277
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
48278
|
+
}
|
|
48279
|
+
],
|
|
47685
48280
|
"values": [
|
|
47686
48281
|
{
|
|
47687
48282
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -47780,7 +48375,7 @@
|
|
|
47780
48375
|
"docsTags": [
|
|
47781
48376
|
{
|
|
47782
48377
|
"name": "example",
|
|
47783
|
-
"text": "
|
|
48378
|
+
"text": "```js\nconst arcgisVideoPlayer = document.querySelector(\"arcgis-video-player\");\ndocument.body.append(arcgisVideoPlayer);\nawait arcgisVideoPlayer.componentOnReady();\nconsole.log(\"arcgis-video-player is ready to go!\");\n```"
|
|
47784
48379
|
},
|
|
47785
48380
|
{
|
|
47786
48381
|
"name": "inheritedFrom",
|
|
@@ -47867,7 +48462,7 @@
|
|
|
47867
48462
|
"overview": "",
|
|
47868
48463
|
"readme": "",
|
|
47869
48464
|
"usage": {},
|
|
47870
|
-
"docs": "The Weather component
|
|
48465
|
+
"docs": "The Weather component allows easy selection and configuration of weather effects in a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThe available weather types are:\n[sunny](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html),\n[cloudy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html),\n[rainy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html),\n[snowy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html), and\n[foggy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html).\n\nTo set the weather programmatically, apply the desired weather type to the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) property of the Scene component.\n\n```js\n// Access the Scene component.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// Specify the weather settings.\nviewElement.environment.weather = {\n type: \"rainy\", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })\n cloudCover: 0.7,\n precipitation: 0.3\n};\n```\n\nTo determine if the weather visualization is available, check the boolean value of `viewElement.environment.weatherAvailable`. The weather is only available:\n * in `global` [viewing mode](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewingMode),\n * when `atmosphereEnabled` property on [environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) is `true`,\n * at lower altitudes, near the ground.\n\n**Known limitations**\n\nWeather is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html)\n- [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)",
|
|
47871
48466
|
"docsTags": [
|
|
47872
48467
|
{
|
|
47873
48468
|
"name": "superclass",
|
|
@@ -48037,7 +48632,7 @@
|
|
|
48037
48632
|
},
|
|
48038
48633
|
"mutable": true,
|
|
48039
48634
|
"reflectToAttr": false,
|
|
48040
|
-
"docs": "Replace localized message strings with your own strings
|
|
48635
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
48041
48636
|
"docsTags": [],
|
|
48042
48637
|
"values": [],
|
|
48043
48638
|
"optional": true,
|
|
@@ -48125,8 +48720,13 @@
|
|
|
48125
48720
|
"mutable": true,
|
|
48126
48721
|
"attr": "reference-element",
|
|
48127
48722
|
"reflectToAttr": false,
|
|
48128
|
-
"docs": "",
|
|
48129
|
-
"docsTags": [
|
|
48723
|
+
"docs": "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.",
|
|
48724
|
+
"docsTags": [
|
|
48725
|
+
{
|
|
48726
|
+
"name": "see",
|
|
48727
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
48728
|
+
}
|
|
48729
|
+
],
|
|
48130
48730
|
"values": [
|
|
48131
48731
|
{
|
|
48132
48732
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -48156,7 +48756,12 @@
|
|
|
48156
48756
|
"attr": "state",
|
|
48157
48757
|
"reflectToAttr": true,
|
|
48158
48758
|
"docs": "The current state of the component.",
|
|
48159
|
-
"docsTags": [
|
|
48759
|
+
"docsTags": [
|
|
48760
|
+
{
|
|
48761
|
+
"name": "readonly",
|
|
48762
|
+
"text": ""
|
|
48763
|
+
}
|
|
48764
|
+
],
|
|
48160
48765
|
"values": [
|
|
48161
48766
|
{
|
|
48162
48767
|
"value": "disabled",
|
|
@@ -48200,7 +48805,7 @@
|
|
|
48200
48805
|
"docsTags": [
|
|
48201
48806
|
{
|
|
48202
48807
|
"name": "example",
|
|
48203
|
-
"text": "
|
|
48808
|
+
"text": "```js\nconst arcgisWeather = document.querySelector(\"arcgis-weather\");\ndocument.body.append(arcgisWeather);\nawait arcgisWeather.componentOnReady();\nconsole.log(\"arcgis-weather is ready to go!\");\n```"
|
|
48204
48809
|
},
|
|
48205
48810
|
{
|
|
48206
48811
|
"name": "inheritedFrom",
|
|
@@ -48392,7 +48997,7 @@
|
|
|
48392
48997
|
},
|
|
48393
48998
|
"mutable": true,
|
|
48394
48999
|
"reflectToAttr": false,
|
|
48395
|
-
"docs": "Replace localized message strings with your own strings
|
|
49000
|
+
"docs": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
48396
49001
|
"docsTags": [],
|
|
48397
49002
|
"values": [],
|
|
48398
49003
|
"optional": true,
|
|
@@ -48480,8 +49085,13 @@
|
|
|
48480
49085
|
"mutable": true,
|
|
48481
49086
|
"attr": "reference-element",
|
|
48482
49087
|
"reflectToAttr": false,
|
|
48483
|
-
"docs": "",
|
|
48484
|
-
"docsTags": [
|
|
49088
|
+
"docs": "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.",
|
|
49089
|
+
"docsTags": [
|
|
49090
|
+
{
|
|
49091
|
+
"name": "see",
|
|
49092
|
+
"text": "[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"
|
|
49093
|
+
}
|
|
49094
|
+
],
|
|
48485
49095
|
"values": [
|
|
48486
49096
|
{
|
|
48487
49097
|
"type": "HTMLArcgisLinkChartElement"
|
|
@@ -48552,7 +49162,7 @@
|
|
|
48552
49162
|
"docsTags": [
|
|
48553
49163
|
{
|
|
48554
49164
|
"name": "example",
|
|
48555
|
-
"text": "
|
|
49165
|
+
"text": "```js\nconst arcgisZoom = document.querySelector(\"arcgis-zoom\");\ndocument.body.append(arcgisZoom);\nawait arcgisZoom.componentOnReady();\nconsole.log(\"arcgis-zoom is ready to go!\");\n```"
|
|
48556
49166
|
},
|
|
48557
49167
|
{
|
|
48558
49168
|
"name": "inheritedFrom",
|