@arcgis/map-components 4.34.0-next.4 → 4.34.0-next.40
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/2G25KKQ7.js +4 -0
- package/dist/cdn/{7LVS3WYQ.js → 2MYUN5AX.js} +1 -1
- package/dist/cdn/2O5U5EPE.js +4 -0
- package/dist/cdn/2RYNVEQ6.js +4 -0
- package/dist/cdn/2Z3HJLSO.js +4 -0
- package/dist/cdn/{Z56QLV5B.js → 344IW43G.js} +2 -2
- package/dist/cdn/36556HIR.js +4 -0
- package/dist/cdn/3BO6QCBL.js +4 -0
- package/dist/cdn/3IZLGMBU.js +4 -0
- package/dist/cdn/{23HVPN5Y.js → 3LQ353K4.js} +1 -1
- package/dist/cdn/3PMUZCO7.js +4 -0
- package/dist/cdn/{SBFO6UJ3.js → 3SQPHMUO.js} +2 -2
- package/dist/cdn/3TDFVW75.js +4 -0
- package/dist/cdn/3VAME4X3.js +4 -0
- package/dist/cdn/3WZLKNMR.js +4 -0
- package/dist/cdn/{6Q2QPWAU.js → 3Z3S3Q4P.js} +2 -2
- package/dist/cdn/4A2U6566.js +4 -0
- package/dist/cdn/4CB4DKZ3.js +4 -0
- package/dist/cdn/{ZNYIHOBS.js → 4HCZAXMY.js} +2 -2
- package/dist/cdn/4I4HUQYS.js +4 -0
- package/dist/cdn/4PSCIFK7.js +4 -0
- package/dist/cdn/4R2ASZBP.js +4 -0
- package/dist/cdn/4XEKGZTO.js +4 -0
- package/dist/cdn/54PQW27H.js +4 -0
- package/dist/cdn/{LEPO6MP3.js → 57OYIV44.js} +2 -2
- package/dist/cdn/5JISY5GY.js +4 -0
- package/dist/cdn/5KIEBLWJ.js +4 -0
- package/dist/cdn/5Q3BHGUF.js +4 -0
- package/dist/cdn/5SNFGRK7.js +4 -0
- package/dist/cdn/5WWYWINX.js +4 -0
- package/dist/cdn/5YJAZAWE.js +4 -0
- package/dist/cdn/63OTOECK.js +4 -0
- package/dist/cdn/6A77EQJ7.js +4 -0
- package/dist/cdn/{3L3QQBXT.js → 6MKSXDOB.js} +2 -2
- package/dist/cdn/6OVPKQBU.js +4 -0
- package/dist/cdn/6SDJS76D.js +4 -0
- package/dist/cdn/7KYRHL7B.js +4 -0
- package/dist/cdn/7SXTOJRV.js +4 -0
- package/dist/cdn/7U23MXDK.js +4 -0
- package/dist/cdn/A3AWOIW2.js +4 -0
- package/dist/cdn/AIOIF72H.js +4 -0
- package/dist/cdn/AVVDUMMF.js +4 -0
- package/dist/cdn/BDGRTNF4.js +4 -0
- package/dist/cdn/BGKCJWBL.js +4 -0
- package/dist/cdn/BKJQO6FJ.js +4 -0
- package/dist/cdn/BNINW57F.js +4 -0
- package/dist/cdn/BU6CK36L.js +4 -0
- package/dist/cdn/BXH3MFUD.js +4 -0
- package/dist/cdn/C5AP2BUA.js +4 -0
- package/dist/cdn/CBC3T45B.js +4 -0
- package/dist/cdn/CGKOBQRW.js +4 -0
- package/dist/cdn/{W47LCTBG.js → CGOS6G3P.js} +2 -2
- package/dist/cdn/{VCDM3JXH.js → CISHKQZT.js} +1 -1
- package/dist/cdn/CJXQKVG2.js +4 -0
- package/dist/cdn/CTIPMOE4.js +6 -0
- package/dist/cdn/CU4YQ46R.js +4 -0
- package/dist/cdn/{4HGMI6ZO.js → CULGUUN2.js} +2 -2
- package/dist/cdn/D4NG5TI7.js +4 -0
- package/dist/cdn/DDMA7MKS.js +4 -0
- package/dist/cdn/DDW6GQVZ.js +4 -0
- package/dist/cdn/DIP2K36D.js +4 -0
- package/dist/cdn/DMHT5UNA.js +4 -0
- package/dist/cdn/DNDHT2N5.js +4 -0
- package/dist/cdn/DNZSOKT7.js +4 -0
- package/dist/cdn/DWKT6TI4.js +4 -0
- package/dist/cdn/E3CGCG5A.js +4 -0
- package/dist/cdn/EBJTGGCQ.js +4 -0
- package/dist/cdn/EBNMY3CX.js +4 -0
- package/dist/cdn/ED3SCFNT.js +4 -0
- package/dist/cdn/EGM2QPQ5.js +4 -0
- package/dist/cdn/EJHMB3QF.js +4 -0
- package/dist/cdn/{AIBT7DAE.js → EN7FL4PC.js} +2 -2
- package/dist/cdn/ESKA4SWS.js +4 -0
- package/dist/cdn/F34EVHXG.js +4 -0
- package/dist/cdn/FF6NDWSM.js +4 -0
- package/dist/cdn/FVT323HL.js +4 -0
- package/dist/cdn/{TD2GCLNS.js → G4XKAX2D.js} +1 -1
- package/dist/cdn/G7JMOGSQ.js +4 -0
- package/dist/cdn/GIR3LJ47.js +4 -0
- package/dist/cdn/GIX2LZAQ.js +4 -0
- package/dist/cdn/GLBLJGC6.js +4 -0
- package/dist/cdn/GPNU4ZZ4.js +4 -0
- package/dist/cdn/GS4CDQTC.js +4 -0
- package/dist/cdn/GUCP6NF2.js +4 -0
- package/dist/cdn/HA3XT7EN.js +4 -0
- package/dist/cdn/HMEBVYIV.js +4 -0
- package/dist/cdn/HYD3MOJY.js +4 -0
- package/dist/cdn/IAZ2PJDO.js +4 -0
- package/dist/cdn/{HKQYPN7I.js → IKTZGVCY.js} +1 -1
- package/dist/cdn/IM3B6OHN.js +4 -0
- package/dist/cdn/INC5XWFI.js +4 -0
- package/dist/cdn/IPDEUPJR.js +4 -0
- package/dist/cdn/IS42Y5CF.js +4 -0
- package/dist/cdn/IUGC3R52.js +4 -0
- package/dist/cdn/IZQKCS7I.js +4 -0
- package/dist/cdn/J4JQSW22.js +4 -0
- package/dist/cdn/JAHZHASL.js +4 -0
- package/dist/cdn/JK3X3736.js +4 -0
- package/dist/cdn/JX7CDVXU.js +4 -0
- package/dist/cdn/JXTR7GDI.js +4 -0
- package/dist/cdn/K2LNOCQB.js +4 -0
- package/dist/cdn/KRMGV5X7.js +4 -0
- package/dist/cdn/{QQSFIVFC.js → KS2XVOMO.js} +2 -2
- package/dist/cdn/KTZKO4YL.js +4 -0
- package/dist/cdn/KV7DNFPR.js +4 -0
- package/dist/cdn/LM7WD37H.js +4 -0
- package/dist/cdn/LN3G5UWC.js +4 -0
- package/dist/cdn/LNN4EY3E.js +4 -0
- package/dist/cdn/LNPY5TPT.js +4 -0
- package/dist/cdn/LON4LZUN.js +4 -0
- package/dist/cdn/LRXB52MM.js +4 -0
- package/dist/cdn/LV5CPKTQ.js +4 -0
- package/dist/cdn/M2J2LVPP.js +4 -0
- package/dist/cdn/M3JLT2RZ.js +4 -0
- package/dist/cdn/M7O3KYOD.js +4 -0
- package/dist/cdn/MBDDLD6V.js +4 -0
- package/dist/cdn/MKAEHASH.js +4 -0
- package/dist/cdn/MZIM2HC7.js +4 -0
- package/dist/cdn/N7KOO3W5.js +4 -0
- package/dist/cdn/NIC7Q7DB.js +4 -0
- package/dist/cdn/NNQOZZM4.js +4 -0
- package/dist/cdn/NOMDCCLG.js +4 -0
- package/dist/cdn/O5CXUD6M.js +4 -0
- package/dist/cdn/OCYEDVBE.js +4 -0
- package/dist/cdn/OVYOPSDQ.js +4 -0
- package/dist/cdn/P3GTRUGG.js +4 -0
- package/dist/cdn/Q7HUVMW3.js +4 -0
- package/dist/cdn/QCF3FZ7O.js +4 -0
- package/dist/cdn/QETNFXJP.js +4 -0
- package/dist/cdn/QGYBZCXI.js +5 -0
- package/dist/cdn/QMKOIVFS.js +4 -0
- package/dist/cdn/QNRVGA6I.js +4 -0
- package/dist/cdn/QPBXRYCD.js +4 -0
- package/dist/cdn/QQBACVKP.js +4 -0
- package/dist/cdn/QQPG4QWI.js +4 -0
- package/dist/cdn/{PAOQYXUG.js → QUS6DTO6.js} +1 -1
- package/dist/cdn/QWFTHY7X.js +4 -0
- package/dist/cdn/QXNRGC25.js +4 -0
- package/dist/cdn/QY2A6R2I.js +4 -0
- package/dist/cdn/R5TM4FKT.js +4 -0
- package/dist/cdn/SBSRH3SM.js +4 -0
- package/dist/cdn/{6MFND45L.js → SN4KGEJN.js} +2 -2
- package/dist/cdn/T74Z2NZM.js +4 -0
- package/dist/cdn/T7QNVRSW.js +4 -0
- package/dist/cdn/TISHWYSQ.js +4 -0
- package/dist/cdn/TKUIR56W.js +4 -0
- package/dist/cdn/TUNZY5WR.js +4 -0
- package/dist/cdn/UBYIYSHB.js +4 -0
- package/dist/cdn/UNHYJ5FM.js +4 -0
- package/dist/cdn/VA2KKANL.js +4 -0
- package/dist/cdn/VANPMF74.js +4 -0
- package/dist/cdn/VC3RX4AG.js +4 -0
- package/dist/cdn/VEEBJSTE.js +4 -0
- package/dist/cdn/VN7KZF6S.js +4 -0
- package/dist/cdn/VQMWXEBT.js +4 -0
- package/dist/cdn/VRDBT24P.js +4 -0
- package/dist/cdn/VROBMM6D.js +4 -0
- package/dist/cdn/W3KCHPCM.js +4 -0
- package/dist/cdn/W3LY457I.js +4 -0
- package/dist/cdn/W7DVWJ7T.js +4 -0
- package/dist/cdn/W7NTOZTL.js +4 -0
- package/dist/cdn/W7SVVLPE.js +4 -0
- package/dist/cdn/WEYUU2IF.js +4 -0
- package/dist/cdn/WIKCAY7H.js +4 -0
- package/dist/cdn/WL5RVZFW.js +4 -0
- package/dist/cdn/WNF5CJNE.js +4 -0
- package/dist/cdn/X52Z3HIU.js +4 -0
- package/dist/cdn/XHRMCWZT.js +4 -0
- package/dist/cdn/XIGWI45G.js +4 -0
- package/dist/cdn/XJKRZLFM.js +4 -0
- package/dist/cdn/XKILNUQN.js +4 -0
- package/dist/cdn/XVYLIU52.js +4 -0
- package/dist/cdn/Y7GSEAQU.js +4 -0
- package/dist/cdn/YDYVVWBO.js +4 -0
- package/dist/cdn/YQ2G76WP.js +4 -0
- package/dist/cdn/YTQWWLJJ.js +4 -0
- package/dist/cdn/YXRO4UNU.js +4 -0
- package/dist/cdn/YZYFUMRA.js +4 -0
- package/dist/cdn/Z4U6KGUV.js +4 -0
- package/dist/cdn/{SUW77QCI.js → Z7OWBB5L.js} +2 -2
- package/dist/cdn/{VEN3DMN6.js → ZGBWJOFH.js} +1 -1
- package/dist/cdn/ZMBYBGSF.js +4 -0
- package/dist/cdn/ZWQY4GPL.js +4 -0
- package/dist/cdn/assets/feature/t9n/messages.ar.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.bg.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.bs.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ca.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.cs.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.da.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.de.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.el.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.en.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.es.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.et.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.fi.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.fr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.he.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.hr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.hu.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.id.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.it.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ja.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ko.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.lt.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.lv.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.nl.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.no.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.pl.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.pt-BR.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.pt-PT.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ro.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.ru.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sk.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sl.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.sv.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.th.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.tr.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.uk.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.vi.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.zh-CN.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.zh-HK.json +1 -0
- package/dist/cdn/assets/feature/t9n/messages.zh-TW.json +1 -0
- package/dist/cdn/index.js +2 -2
- package/dist/chunks/AnalysisViewModel.js +4 -4
- package/dist/chunks/async-utils.js +3 -3
- package/dist/chunks/basemap-gallery-resources.js +1 -1
- package/dist/chunks/chart-utils.js +66 -0
- package/dist/chunks/chartCommon.js +19 -0
- package/dist/chunks/component-utils.js +1 -1
- package/dist/chunks/createCloseEvent.js +1 -1
- package/dist/chunks/feature-utils.js +145 -0
- package/dist/chunks/globalCss.js +1 -1
- package/dist/chunks/heading.js +13 -13
- 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 +7 -2
- 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 +6 -1
- 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 +10 -4
- 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 +16 -0
- package/dist/components/arcgis-feature-attachments/customElement.js +31 -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 +43 -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-expression/customElement.d.ts +19 -0
- package/dist/components/arcgis-feature-expression/customElement.js +242 -0
- package/dist/components/arcgis-feature-expression/index.d.ts +5 -0
- package/dist/components/arcgis-feature-expression/index.js +5 -0
- package/dist/components/arcgis-feature-fields/customElement.d.ts +17 -0
- package/dist/components/arcgis-feature-fields/customElement.js +143 -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 +7 -2
- 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 +38 -0
- package/dist/components/arcgis-feature-media/customElement.js +577 -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 +21 -2
- package/dist/components/arcgis-fullscreen/customElement.js +33 -19
- 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 +39 -16
- 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 +20 -10
- package/dist/components/arcgis-link-chart/customElement.js +19 -8
- 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/LocateViewModel.d.ts +4 -5
- package/dist/components/arcgis-locate/customElement.d.ts +17 -5
- package/dist/components/arcgis-locate/customElement.js +45 -45
- 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 +144 -81
- package/dist/components/arcgis-scene/customElement.js +27 -16
- package/dist/components/arcgis-search/customElement.d.ts +52 -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/SliceViewModel.d.ts +0 -1
- package/dist/components/arcgis-slice/customElement.d.ts +77 -18
- package/dist/components/arcgis-slice/customElement.js +33 -41
- 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 +28 -2
- package/dist/components/arcgis-swipe/customElement.js +39 -39
- 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 +6 -2
- package/dist/components/arcgis-unit-select/customElement.js +15 -8
- 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 +27 -10
- package/dist/components/arcgis-video/customElement.js +15 -24
- package/dist/components/arcgis-video-player/customElement.d.ts +23 -5
- package/dist/components/arcgis-video-player/customElement.js +36 -29
- 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/WeatherViewModel.d.ts +1 -1
- package/dist/components/arcgis-weather/customElement.d.ts +52 -3
- package/dist/components/arcgis-weather/customElement.js +3 -3
- 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 +1544 -516
- package/dist/docs/docs.json +1469 -737
- package/dist/docs/vscode.html-custom-data.json +208 -108
- package/dist/docs/web-types.json +472 -239
- package/dist/geolocation/GeolocationPositioning.d.ts +5 -6
- package/dist/index.d.ts +5 -0
- package/dist/index.js +1 -1
- package/dist/loader.js +23 -17
- package/dist/support/heading.d.ts +2 -1
- package/dist/types/lumina.d.ts +19 -13
- package/dist/types/preact.d.ts +19 -13
- package/dist/types/react.d.ts +19 -13
- package/dist/types/stencil.d.ts +19 -13
- 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/24QCAR23.js +0 -4
- package/dist/cdn/2F3VHU6V.js +0 -4
- package/dist/cdn/2ZMNNXHS.js +0 -4
- package/dist/cdn/3PFMM57M.js +0 -4
- package/dist/cdn/4F36IAZ7.js +0 -4
- package/dist/cdn/4NG4JOQP.js +0 -4
- package/dist/cdn/55FCKHUW.js +0 -4
- package/dist/cdn/5DWV4QYU.js +0 -4
- package/dist/cdn/637V7MBM.js +0 -4
- package/dist/cdn/6LL6GANH.js +0 -4
- package/dist/cdn/6MJTJDVW.js +0 -4
- package/dist/cdn/6RDZEEQ3.js +0 -4
- package/dist/cdn/6ROCC4GF.js +0 -4
- package/dist/cdn/6RSZZWDZ.js +0 -4
- package/dist/cdn/7GYK2I76.js +0 -4
- package/dist/cdn/7IET7A5H.js +0 -4
- package/dist/cdn/7ODPBN7V.js +0 -4
- package/dist/cdn/7QQAGBLE.js +0 -4
- package/dist/cdn/7ZAX32TI.js +0 -4
- package/dist/cdn/A4ULRWZG.js +0 -4
- package/dist/cdn/AC5U3NYZ.js +0 -4
- package/dist/cdn/ANZO55OT.js +0 -4
- package/dist/cdn/BQ4U6UMN.js +0 -4
- package/dist/cdn/BUCVAAEN.js +0 -4
- package/dist/cdn/CMBNVRX4.js +0 -4
- package/dist/cdn/D6MGY4ZG.js +0 -4
- package/dist/cdn/DOURUCK4.js +0 -4
- package/dist/cdn/DUCTZYWY.js +0 -4
- package/dist/cdn/EAIBQGHI.js +0 -4
- package/dist/cdn/EFGCTCBU.js +0 -4
- package/dist/cdn/F7S6WPMH.js +0 -4
- package/dist/cdn/FJLEVPNO.js +0 -4
- package/dist/cdn/FKAPKNBK.js +0 -4
- package/dist/cdn/FMUBO2SM.js +0 -4
- package/dist/cdn/FP272N3B.js +0 -4
- package/dist/cdn/FR5GZWQ6.js +0 -4
- package/dist/cdn/FTMB44PL.js +0 -4
- package/dist/cdn/FUVKUX3F.js +0 -4
- package/dist/cdn/G4CXV4NF.js +0 -4
- package/dist/cdn/GFL63DN7.js +0 -4
- package/dist/cdn/GL7SUTZC.js +0 -4
- package/dist/cdn/GLFXDT4O.js +0 -4
- package/dist/cdn/GR4O6BEU.js +0 -4
- package/dist/cdn/GUHP2PZF.js +0 -4
- package/dist/cdn/GZPGD27B.js +0 -6
- package/dist/cdn/HUV7GHIN.js +0 -4
- package/dist/cdn/IAXNFEPP.js +0 -4
- package/dist/cdn/IGWPHMX5.js +0 -4
- package/dist/cdn/ILGO5YVA.js +0 -4
- package/dist/cdn/IZNGYRHV.js +0 -4
- package/dist/cdn/J7QN3PZF.js +0 -4
- package/dist/cdn/JVVOVQFU.js +0 -4
- package/dist/cdn/KGHAGZY4.js +0 -4
- package/dist/cdn/KO6DPIWR.js +0 -4
- package/dist/cdn/L4YRXMVR.js +0 -4
- package/dist/cdn/L7ML76QM.js +0 -4
- package/dist/cdn/L7PXJ66C.js +0 -4
- package/dist/cdn/LHISUI6W.js +0 -4
- package/dist/cdn/LHKNQO6E.js +0 -4
- package/dist/cdn/LQ2SBKQY.js +0 -4
- package/dist/cdn/LVUAE6PC.js +0 -4
- package/dist/cdn/M4TXLEZN.js +0 -4
- package/dist/cdn/MF2DQEZU.js +0 -4
- package/dist/cdn/NCM6TOGJ.js +0 -4
- package/dist/cdn/NKEZIJO5.js +0 -4
- package/dist/cdn/NRVD3YPY.js +0 -4
- package/dist/cdn/OJUNMDUD.js +0 -4
- package/dist/cdn/OMDERSQZ.js +0 -4
- package/dist/cdn/PTTXNCL2.js +0 -4
- package/dist/cdn/PZKQVM4A.js +0 -4
- package/dist/cdn/Q5C26WCX.js +0 -4
- package/dist/cdn/Q77K3LVO.js +0 -4
- package/dist/cdn/QF4MHKQN.js +0 -4
- package/dist/cdn/QFFUI3FI.js +0 -4
- package/dist/cdn/QKFIJZ6Y.js +0 -4
- package/dist/cdn/QMATOY57.js +0 -4
- package/dist/cdn/QNDB6SQ6.js +0 -4
- package/dist/cdn/QNUXQPPT.js +0 -4
- package/dist/cdn/QYOYVCWC.js +0 -4
- package/dist/cdn/R5VIFHLX.js +0 -4
- package/dist/cdn/RBYK77JC.js +0 -4
- package/dist/cdn/SBVPQITU.js +0 -4
- package/dist/cdn/SOUISCIY.js +0 -4
- package/dist/cdn/SR67U4DI.js +0 -4
- package/dist/cdn/TMP2IYQ2.js +0 -4
- package/dist/cdn/TXQ2JI7T.js +0 -4
- package/dist/cdn/UC5VZITI.js +0 -4
- package/dist/cdn/UFNFAWDA.js +0 -4
- package/dist/cdn/UMZJE6UL.js +0 -4
- package/dist/cdn/VDTUN3EA.js +0 -4
- package/dist/cdn/VI4PPH6M.js +0 -4
- package/dist/cdn/VNUITTUC.js +0 -4
- package/dist/cdn/VRCJUC36.js +0 -4
- package/dist/cdn/WF5UHW5E.js +0 -4
- package/dist/cdn/WTF7JDXK.js +0 -4
- package/dist/cdn/Y7WJXUDZ.js +0 -4
- package/dist/cdn/YDINXYCI.js +0 -4
- package/dist/cdn/YKZKDYG3.js +0 -4
- package/dist/cdn/YPWZFYOY.js +0 -4
- package/dist/cdn/YU37LD7Q.js +0 -4
package/dist/docs/web-types.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
|
|
3
3
|
"name": "@arcgis/map-components",
|
|
4
|
-
"version": "4.34.0-next.
|
|
4
|
+
"version": "4.34.0-next.40",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -53,6 +53,7 @@
|
|
|
53
53
|
},
|
|
54
54
|
{
|
|
55
55
|
"name": "reference-element",
|
|
56
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
56
57
|
"value": {
|
|
57
58
|
"type": "string"
|
|
58
59
|
}
|
|
@@ -130,6 +131,7 @@
|
|
|
130
131
|
},
|
|
131
132
|
{
|
|
132
133
|
"name": "referenceElement",
|
|
134
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
133
135
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
134
136
|
},
|
|
135
137
|
{
|
|
@@ -169,7 +171,7 @@
|
|
|
169
171
|
},
|
|
170
172
|
{
|
|
171
173
|
"name": "arcgis-area-measurement-3d",
|
|
172
|
-
"description": "The Area Measurement 3D component
|
|
174
|
+
"description": "The Area Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent to calculate and display area and perimeter of polygons.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow the area and perimeter are computed depends on the scene's spatial reference and the length of the measured perimeter.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- If the measurement's perimeter is below 100 km, they are computed in a Euclidean manner,\n in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets).\n- If the perimeter is above 100 km, they are computed geodetically, and the visualization takes\n the curvature of the planet into consideration.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, the area and perimeter\nare always calculated in a Euclidean manner (in their respective PCS).\n\nThe area may be visualized and calculated in two ways:\n1. If all the vertices are mostly coplanar (lying on the same plane),\n the measurement polygon is formed on that plane, and area and perimeter are calculated from its geometry.\n2. If the vertices don't form a planar surface, the measurement polygon\n is projected to a horizontal plane, and area and perimeter are calculated from its geometry.\n\n\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\n\n**Things to consider**\n\n* Area Measurement 3D is designed to work in the Scene component. For measurements in the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Area Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/).\n* Snapping is enabled by default. Holding the `CTRL` key disables it.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
|
|
173
175
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/",
|
|
174
176
|
"attributes": [
|
|
175
177
|
{
|
|
@@ -214,13 +216,14 @@
|
|
|
214
216
|
},
|
|
215
217
|
{
|
|
216
218
|
"name": "reference-element",
|
|
219
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
217
220
|
"value": {
|
|
218
221
|
"type": "string"
|
|
219
222
|
}
|
|
220
223
|
},
|
|
221
224
|
{
|
|
222
225
|
"name": "state",
|
|
223
|
-
"description": "The
|
|
226
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
224
227
|
"value": {
|
|
225
228
|
"type": [
|
|
226
229
|
"\"disabled\"",
|
|
@@ -232,7 +235,7 @@
|
|
|
232
235
|
},
|
|
233
236
|
{
|
|
234
237
|
"name": "unit",
|
|
235
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the
|
|
238
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
236
239
|
"value": {
|
|
237
240
|
"type": [
|
|
238
241
|
"\"acres\"",
|
|
@@ -271,6 +274,7 @@
|
|
|
271
274
|
"properties": [
|
|
272
275
|
{
|
|
273
276
|
"name": "analysis",
|
|
277
|
+
"description": "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```",
|
|
274
278
|
"type": "AreaMeasurementAnalysis"
|
|
275
279
|
},
|
|
276
280
|
{
|
|
@@ -294,21 +298,22 @@
|
|
|
294
298
|
},
|
|
295
299
|
{
|
|
296
300
|
"name": "referenceElement",
|
|
301
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
297
302
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
298
303
|
},
|
|
299
304
|
{
|
|
300
305
|
"name": "state",
|
|
301
|
-
"description": "The
|
|
306
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
302
307
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
303
308
|
},
|
|
304
309
|
{
|
|
305
310
|
"name": "unit",
|
|
306
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the
|
|
311
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
307
312
|
"type": "\"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\" | \"square-centimeters\" | \"square-decimeters\" | \"square-feet\" | \"square-inches\" | \"square-kilometers\" | \"square-meters\" | \"square-miles\" | \"square-millimeters\" | \"square-nautical-miles\" | \"square-us-feet\" | \"square-yards\""
|
|
308
313
|
},
|
|
309
314
|
{
|
|
310
315
|
"name": "unitOptions",
|
|
311
|
-
"description": "List of unit systems (imperial, metric)
|
|
316
|
+
"description": "List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [unit](#unit) values can only be a subset of this list.",
|
|
312
317
|
"type": "Array<\"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\">"
|
|
313
318
|
}
|
|
314
319
|
],
|
|
@@ -441,6 +446,7 @@
|
|
|
441
446
|
},
|
|
442
447
|
{
|
|
443
448
|
"name": "reference-element",
|
|
449
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
444
450
|
"value": {
|
|
445
451
|
"type": "string"
|
|
446
452
|
}
|
|
@@ -540,6 +546,7 @@
|
|
|
540
546
|
},
|
|
541
547
|
{
|
|
542
548
|
"name": "referenceElement",
|
|
549
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
543
550
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
544
551
|
},
|
|
545
552
|
{
|
|
@@ -645,6 +652,7 @@
|
|
|
645
652
|
},
|
|
646
653
|
{
|
|
647
654
|
"name": "reference-element",
|
|
655
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
648
656
|
"value": {
|
|
649
657
|
"type": "string"
|
|
650
658
|
}
|
|
@@ -709,7 +717,7 @@
|
|
|
709
717
|
},
|
|
710
718
|
{
|
|
711
719
|
"name": "messageOverrides",
|
|
712
|
-
"description": "Replace localized message strings with your own strings
|
|
720
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
713
721
|
"type": "Record<string, unknown>"
|
|
714
722
|
},
|
|
715
723
|
{
|
|
@@ -718,6 +726,7 @@
|
|
|
718
726
|
},
|
|
719
727
|
{
|
|
720
728
|
"name": "referenceElement",
|
|
729
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
721
730
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
722
731
|
},
|
|
723
732
|
{
|
|
@@ -898,6 +907,7 @@
|
|
|
898
907
|
},
|
|
899
908
|
{
|
|
900
909
|
"name": "reference-element",
|
|
910
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
901
911
|
"value": {
|
|
902
912
|
"type": "string"
|
|
903
913
|
}
|
|
@@ -1124,6 +1134,7 @@
|
|
|
1124
1134
|
},
|
|
1125
1135
|
{
|
|
1126
1136
|
"name": "referenceElement",
|
|
1137
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1127
1138
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
1128
1139
|
},
|
|
1129
1140
|
{
|
|
@@ -1269,6 +1280,7 @@
|
|
|
1269
1280
|
},
|
|
1270
1281
|
{
|
|
1271
1282
|
"name": "reference-element",
|
|
1283
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1272
1284
|
"value": {
|
|
1273
1285
|
"type": "string"
|
|
1274
1286
|
}
|
|
@@ -1298,7 +1310,7 @@
|
|
|
1298
1310
|
"events": [
|
|
1299
1311
|
{
|
|
1300
1312
|
"name": "arcgisPropertyChange",
|
|
1301
|
-
"type": "{ name: \"state\" | \"nextBasemap\"; }",
|
|
1313
|
+
"type": "{ name: \"state\" | \"activeBasemap\" | \"nextBasemap\"; }",
|
|
1302
1314
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
1303
1315
|
},
|
|
1304
1316
|
{
|
|
@@ -1331,7 +1343,7 @@
|
|
|
1331
1343
|
},
|
|
1332
1344
|
{
|
|
1333
1345
|
"name": "messageOverrides",
|
|
1334
|
-
"description": "Replace localized message strings with your own strings
|
|
1346
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
1335
1347
|
"type": "Record<string, unknown>"
|
|
1336
1348
|
},
|
|
1337
1349
|
{
|
|
@@ -1345,6 +1357,7 @@
|
|
|
1345
1357
|
},
|
|
1346
1358
|
{
|
|
1347
1359
|
"name": "referenceElement",
|
|
1360
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1348
1361
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
1349
1362
|
},
|
|
1350
1363
|
{
|
|
@@ -1361,7 +1374,7 @@
|
|
|
1361
1374
|
"events": [
|
|
1362
1375
|
{
|
|
1363
1376
|
"name": "arcgisPropertyChange",
|
|
1364
|
-
"type": "{ name: \"state\" | \"nextBasemap\"; }",
|
|
1377
|
+
"type": "{ name: \"state\" | \"activeBasemap\" | \"nextBasemap\"; }",
|
|
1365
1378
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
1366
1379
|
},
|
|
1367
1380
|
{
|
|
@@ -1478,6 +1491,7 @@
|
|
|
1478
1491
|
},
|
|
1479
1492
|
{
|
|
1480
1493
|
"name": "reference-element",
|
|
1494
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1481
1495
|
"value": {
|
|
1482
1496
|
"type": "string"
|
|
1483
1497
|
}
|
|
@@ -1641,6 +1655,7 @@
|
|
|
1641
1655
|
},
|
|
1642
1656
|
{
|
|
1643
1657
|
"name": "referenceElement",
|
|
1658
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1644
1659
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
1645
1660
|
},
|
|
1646
1661
|
{
|
|
@@ -1702,7 +1717,7 @@
|
|
|
1702
1717
|
},
|
|
1703
1718
|
{
|
|
1704
1719
|
"name": "arcgis-building-explorer",
|
|
1705
|
-
"description": "The Building Explorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
1720
|
+
"description": "The Building Explorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.\n\n**Known limitations**\n\nBuilding Explorer is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
1706
1721
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/",
|
|
1707
1722
|
"attributes": [
|
|
1708
1723
|
{
|
|
@@ -1715,7 +1730,7 @@
|
|
|
1715
1730
|
},
|
|
1716
1731
|
{
|
|
1717
1732
|
"name": "heading-level",
|
|
1718
|
-
"description": "Indicates the heading level to use for the
|
|
1733
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1719
1734
|
"default": "3",
|
|
1720
1735
|
"value": {
|
|
1721
1736
|
"type": "number"
|
|
@@ -1744,7 +1759,7 @@
|
|
|
1744
1759
|
},
|
|
1745
1760
|
{
|
|
1746
1761
|
"name": "icon",
|
|
1747
|
-
"description": "Icon which represents the
|
|
1762
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
1748
1763
|
"default": "\"organization\"",
|
|
1749
1764
|
"value": {
|
|
1750
1765
|
"type": "string"
|
|
@@ -1752,7 +1767,7 @@
|
|
|
1752
1767
|
},
|
|
1753
1768
|
{
|
|
1754
1769
|
"name": "label",
|
|
1755
|
-
"description": "The
|
|
1770
|
+
"description": "The component's default label.",
|
|
1756
1771
|
"value": {
|
|
1757
1772
|
"type": "string"
|
|
1758
1773
|
}
|
|
@@ -1776,13 +1791,14 @@
|
|
|
1776
1791
|
},
|
|
1777
1792
|
{
|
|
1778
1793
|
"name": "reference-element",
|
|
1794
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1779
1795
|
"value": {
|
|
1780
1796
|
"type": "string"
|
|
1781
1797
|
}
|
|
1782
1798
|
},
|
|
1783
1799
|
{
|
|
1784
1800
|
"name": "state",
|
|
1785
|
-
"description": "The
|
|
1801
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - \tcomponent is being created\n* `loading` - layers and statistics are loading\n* `ready` - component is ready\n* `failed` - component failed to load data",
|
|
1786
1802
|
"default": "\"disabled\"",
|
|
1787
1803
|
"value": {
|
|
1788
1804
|
"type": [
|
|
@@ -1815,7 +1831,7 @@
|
|
|
1815
1831
|
},
|
|
1816
1832
|
{
|
|
1817
1833
|
"name": "headingLevel",
|
|
1818
|
-
"description": "Indicates the heading level to use for the
|
|
1834
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1819
1835
|
"type": "number"
|
|
1820
1836
|
},
|
|
1821
1837
|
{
|
|
@@ -1832,17 +1848,17 @@
|
|
|
1832
1848
|
},
|
|
1833
1849
|
{
|
|
1834
1850
|
"name": "icon",
|
|
1835
|
-
"description": "Icon which represents the
|
|
1851
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
1836
1852
|
"type": "string"
|
|
1837
1853
|
},
|
|
1838
1854
|
{
|
|
1839
1855
|
"name": "label",
|
|
1840
|
-
"description": "The
|
|
1856
|
+
"description": "The component's default label.",
|
|
1841
1857
|
"type": "string"
|
|
1842
1858
|
},
|
|
1843
1859
|
{
|
|
1844
1860
|
"name": "layers",
|
|
1845
|
-
"description": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)
|
|
1861
|
+
"description": "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)",
|
|
1846
1862
|
"type": "Collection<BuildingSceneLayer>"
|
|
1847
1863
|
},
|
|
1848
1864
|
{
|
|
@@ -1861,11 +1877,12 @@
|
|
|
1861
1877
|
},
|
|
1862
1878
|
{
|
|
1863
1879
|
"name": "referenceElement",
|
|
1880
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1864
1881
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
1865
1882
|
},
|
|
1866
1883
|
{
|
|
1867
1884
|
"name": "state",
|
|
1868
|
-
"description": "The
|
|
1885
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - \tcomponent is being created\n* `loading` - layers and statistics are loading\n* `ready` - component is ready\n* `failed` - component failed to load data",
|
|
1869
1886
|
"type": "\"disabled\" | \"failed\" | \"loading\" | \"ready\""
|
|
1870
1887
|
}
|
|
1871
1888
|
],
|
|
@@ -1992,6 +2009,7 @@
|
|
|
1992
2009
|
},
|
|
1993
2010
|
{
|
|
1994
2011
|
"name": "reference-element",
|
|
2012
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
1995
2013
|
"value": {
|
|
1996
2014
|
"type": "string"
|
|
1997
2015
|
}
|
|
@@ -2178,6 +2196,7 @@
|
|
|
2178
2196
|
},
|
|
2179
2197
|
{
|
|
2180
2198
|
"name": "referenceElement",
|
|
2199
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2181
2200
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2182
2201
|
},
|
|
2183
2202
|
{
|
|
@@ -2295,6 +2314,7 @@
|
|
|
2295
2314
|
},
|
|
2296
2315
|
{
|
|
2297
2316
|
"name": "reference-element",
|
|
2317
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2298
2318
|
"value": {
|
|
2299
2319
|
"type": "string"
|
|
2300
2320
|
}
|
|
@@ -2348,7 +2368,7 @@
|
|
|
2348
2368
|
},
|
|
2349
2369
|
{
|
|
2350
2370
|
"name": "messageOverrides",
|
|
2351
|
-
"description": "Replace localized message strings with your own strings
|
|
2371
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
2352
2372
|
"type": "Record<string, unknown>"
|
|
2353
2373
|
},
|
|
2354
2374
|
{
|
|
@@ -2362,6 +2382,7 @@
|
|
|
2362
2382
|
},
|
|
2363
2383
|
{
|
|
2364
2384
|
"name": "referenceElement",
|
|
2385
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2365
2386
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2366
2387
|
},
|
|
2367
2388
|
{
|
|
@@ -2413,14 +2434,14 @@
|
|
|
2413
2434
|
}
|
|
2414
2435
|
},
|
|
2415
2436
|
{
|
|
2416
|
-
"name": "hide-
|
|
2437
|
+
"name": "hide-expand-button",
|
|
2417
2438
|
"default": "false",
|
|
2418
2439
|
"value": {
|
|
2419
2440
|
"type": "boolean"
|
|
2420
2441
|
}
|
|
2421
2442
|
},
|
|
2422
2443
|
{
|
|
2423
|
-
"name": "hide-
|
|
2444
|
+
"name": "hide-input-button",
|
|
2424
2445
|
"default": "false",
|
|
2425
2446
|
"value": {
|
|
2426
2447
|
"type": "boolean"
|
|
@@ -2498,6 +2519,7 @@
|
|
|
2498
2519
|
},
|
|
2499
2520
|
{
|
|
2500
2521
|
"name": "reference-element",
|
|
2522
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2501
2523
|
"value": {
|
|
2502
2524
|
"type": "string"
|
|
2503
2525
|
}
|
|
@@ -2583,11 +2605,11 @@
|
|
|
2583
2605
|
"type": "boolean"
|
|
2584
2606
|
},
|
|
2585
2607
|
{
|
|
2586
|
-
"name": "
|
|
2608
|
+
"name": "hideExpandButton",
|
|
2587
2609
|
"type": "boolean"
|
|
2588
2610
|
},
|
|
2589
2611
|
{
|
|
2590
|
-
"name": "
|
|
2612
|
+
"name": "hideInputButton",
|
|
2591
2613
|
"type": "boolean"
|
|
2592
2614
|
},
|
|
2593
2615
|
{
|
|
@@ -2630,6 +2652,7 @@
|
|
|
2630
2652
|
},
|
|
2631
2653
|
{
|
|
2632
2654
|
"name": "referenceElement",
|
|
2655
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2633
2656
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2634
2657
|
},
|
|
2635
2658
|
{
|
|
@@ -2664,7 +2687,7 @@
|
|
|
2664
2687
|
},
|
|
2665
2688
|
{
|
|
2666
2689
|
"name": "arcgis-daylight",
|
|
2667
|
-
"description": "The Daylight component can be used to manipulate the lighting conditions of a [
|
|
2690
|
+
"description": "The Daylight component can be used to manipulate the lighting conditions of a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\n**Known limitations**\n\nDaylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [Environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)\n- [Sample - Daylight component](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisUserDateTimeChange** - Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
2668
2691
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/",
|
|
2669
2692
|
"attributes": [
|
|
2670
2693
|
{
|
|
@@ -2689,7 +2712,7 @@
|
|
|
2689
2712
|
},
|
|
2690
2713
|
{
|
|
2691
2714
|
"name": "date-or-season",
|
|
2692
|
-
"description": "Controls whether the
|
|
2715
|
+
"description": "Controls whether the component displays a date or a season picker.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason)",
|
|
2693
2716
|
"default": "\"date\"",
|
|
2694
2717
|
"value": {
|
|
2695
2718
|
"type": [
|
|
@@ -2708,7 +2731,7 @@
|
|
|
2708
2731
|
},
|
|
2709
2732
|
{
|
|
2710
2733
|
"name": "heading-level",
|
|
2711
|
-
"description": "Indicates the heading level to use for the
|
|
2734
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
2712
2735
|
"default": "3",
|
|
2713
2736
|
"value": {
|
|
2714
2737
|
"type": "number"
|
|
@@ -2758,7 +2781,7 @@
|
|
|
2758
2781
|
},
|
|
2759
2782
|
{
|
|
2760
2783
|
"name": "icon",
|
|
2761
|
-
"description": "Icon which represents the
|
|
2784
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
2762
2785
|
"default": "\"brightness\"",
|
|
2763
2786
|
"value": {
|
|
2764
2787
|
"type": "string"
|
|
@@ -2766,7 +2789,7 @@
|
|
|
2766
2789
|
},
|
|
2767
2790
|
{
|
|
2768
2791
|
"name": "label",
|
|
2769
|
-
"description": "The
|
|
2792
|
+
"description": "The component's default label.",
|
|
2770
2793
|
"value": {
|
|
2771
2794
|
"type": "string"
|
|
2772
2795
|
}
|
|
@@ -2798,13 +2821,14 @@
|
|
|
2798
2821
|
},
|
|
2799
2822
|
{
|
|
2800
2823
|
"name": "reference-element",
|
|
2824
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2801
2825
|
"value": {
|
|
2802
2826
|
"type": "string"
|
|
2803
2827
|
}
|
|
2804
2828
|
},
|
|
2805
2829
|
{
|
|
2806
2830
|
"name": "time-slider-steps",
|
|
2807
|
-
"description": "Sets steps, or intervals, on the time slider to restrict the times
|
|
2831
|
+
"description": "Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#timeSliderSteps)",
|
|
2808
2832
|
"default": "5",
|
|
2809
2833
|
"value": {
|
|
2810
2834
|
"type": "number"
|
|
@@ -2828,7 +2852,7 @@
|
|
|
2828
2852
|
{
|
|
2829
2853
|
"name": "arcgisUserDateTimeChange",
|
|
2830
2854
|
"type": "void",
|
|
2831
|
-
"description": "Fires when the user changes the date or time in the
|
|
2855
|
+
"description": "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."
|
|
2832
2856
|
}
|
|
2833
2857
|
],
|
|
2834
2858
|
"js": {
|
|
@@ -2845,7 +2869,7 @@
|
|
|
2845
2869
|
},
|
|
2846
2870
|
{
|
|
2847
2871
|
"name": "dateOrSeason",
|
|
2848
|
-
"description": "Controls whether the
|
|
2872
|
+
"description": "Controls whether the component displays a date or a season picker.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#dateOrSeason)",
|
|
2849
2873
|
"type": "\"date\" | \"season\""
|
|
2850
2874
|
},
|
|
2851
2875
|
{
|
|
@@ -2855,7 +2879,7 @@
|
|
|
2855
2879
|
},
|
|
2856
2880
|
{
|
|
2857
2881
|
"name": "headingLevel",
|
|
2858
|
-
"description": "Indicates the heading level to use for the
|
|
2882
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
2859
2883
|
"type": "number"
|
|
2860
2884
|
},
|
|
2861
2885
|
{
|
|
@@ -2884,12 +2908,12 @@
|
|
|
2884
2908
|
},
|
|
2885
2909
|
{
|
|
2886
2910
|
"name": "icon",
|
|
2887
|
-
"description": "Icon which represents the
|
|
2911
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
2888
2912
|
"type": "string"
|
|
2889
2913
|
},
|
|
2890
2914
|
{
|
|
2891
2915
|
"name": "label",
|
|
2892
|
-
"description": "The
|
|
2916
|
+
"description": "The component's default label.",
|
|
2893
2917
|
"type": "string"
|
|
2894
2918
|
},
|
|
2895
2919
|
{
|
|
@@ -2903,11 +2927,12 @@
|
|
|
2903
2927
|
},
|
|
2904
2928
|
{
|
|
2905
2929
|
"name": "referenceElement",
|
|
2930
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2906
2931
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2907
2932
|
},
|
|
2908
2933
|
{
|
|
2909
2934
|
"name": "timeSliderSteps",
|
|
2910
|
-
"description": "Sets steps, or intervals, on the time slider to restrict the times
|
|
2935
|
+
"description": "Sets steps, or intervals, on the time slider to restrict the times of the day that can be selected when dragging the thumb.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Daylight.html#timeSliderSteps)",
|
|
2911
2936
|
"type": "Array<number> | number"
|
|
2912
2937
|
},
|
|
2913
2938
|
{
|
|
@@ -2925,7 +2950,7 @@
|
|
|
2925
2950
|
{
|
|
2926
2951
|
"name": "arcgisUserDateTimeChange",
|
|
2927
2952
|
"type": "void",
|
|
2928
|
-
"description": "Fires when the user changes the date or time in the
|
|
2953
|
+
"description": "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."
|
|
2929
2954
|
}
|
|
2930
2955
|
]
|
|
2931
2956
|
}
|
|
@@ -2993,6 +3018,7 @@
|
|
|
2993
3018
|
},
|
|
2994
3019
|
{
|
|
2995
3020
|
"name": "reference-element",
|
|
3021
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
2996
3022
|
"value": {
|
|
2997
3023
|
"type": "string"
|
|
2998
3024
|
}
|
|
@@ -3078,7 +3104,7 @@
|
|
|
3078
3104
|
},
|
|
3079
3105
|
{
|
|
3080
3106
|
"name": "messageOverrides",
|
|
3081
|
-
"description": "Replace localized message strings with your own strings
|
|
3107
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
3082
3108
|
"type": "Record<string, unknown>"
|
|
3083
3109
|
},
|
|
3084
3110
|
{
|
|
@@ -3087,6 +3113,7 @@
|
|
|
3087
3113
|
},
|
|
3088
3114
|
{
|
|
3089
3115
|
"name": "referenceElement",
|
|
3116
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3090
3117
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3091
3118
|
},
|
|
3092
3119
|
{
|
|
@@ -3215,6 +3242,7 @@
|
|
|
3215
3242
|
},
|
|
3216
3243
|
{
|
|
3217
3244
|
"name": "reference-element",
|
|
3245
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3218
3246
|
"value": {
|
|
3219
3247
|
"type": "string"
|
|
3220
3248
|
}
|
|
@@ -3346,6 +3374,7 @@
|
|
|
3346
3374
|
},
|
|
3347
3375
|
{
|
|
3348
3376
|
"name": "referenceElement",
|
|
3377
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3349
3378
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3350
3379
|
},
|
|
3351
3380
|
{
|
|
@@ -3354,7 +3383,7 @@
|
|
|
3354
3383
|
},
|
|
3355
3384
|
{
|
|
3356
3385
|
"name": "searchProperties",
|
|
3357
|
-
"description": "Controls the default properties used when
|
|
3386
|
+
"description": "Controls the default properties used when searching.",
|
|
3358
3387
|
"type": "DirectionsSearchProperties"
|
|
3359
3388
|
},
|
|
3360
3389
|
{
|
|
@@ -3388,7 +3417,7 @@
|
|
|
3388
3417
|
},
|
|
3389
3418
|
{
|
|
3390
3419
|
"name": "arcgis-direct-line-measurement-3d",
|
|
3391
|
-
"description": "The Direct Line Measurement 3D component
|
|
3420
|
+
"description": "The Direct Line Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent to calculate and display vertical, horizontal, and direct distances between two points.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow distances are computed depends on the scene's spatial reference.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- Direct distance is computed in a Euclidean manner, in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets);\n- Horizontal distance is computed geodetically, taking into consideration the curvature of the planet;\n- Vertical distance is computed as an elevation difference.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, all three distances (direct, horizontal, and vertical)\n are computed in a Euclidean manner (in their respective PCS).\n\nDirect Line Measurement 3D component visualizes and labels the direct, horizontal, and vertical distances and displays the same values\nin the UI panel. When the distance between the points is greater than 100 kilometers,\nthe measurement visualization is simplified, and only the horizontal and vertical distances are calculated.\nThe direct distance option becomes unavailable.\n\n\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\nA second laser line shows the intersection of the scene with the vertical plane that passes through the checkered line.\n\n**Things to consider**\n\n* Direct Line Measurement 3D is designed to work in the Scene component. For measurements in the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Distance Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/).\n* Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n- [Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
|
|
3392
3421
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/",
|
|
3393
3422
|
"attributes": [
|
|
3394
3423
|
{
|
|
@@ -3433,12 +3462,14 @@
|
|
|
3433
3462
|
},
|
|
3434
3463
|
{
|
|
3435
3464
|
"name": "reference-element",
|
|
3465
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3436
3466
|
"value": {
|
|
3437
3467
|
"type": "string"
|
|
3438
3468
|
}
|
|
3439
3469
|
},
|
|
3440
3470
|
{
|
|
3441
3471
|
"name": "state",
|
|
3472
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3442
3473
|
"value": {
|
|
3443
3474
|
"type": [
|
|
3444
3475
|
"\"disabled\"",
|
|
@@ -3450,7 +3481,7 @@
|
|
|
3450
3481
|
},
|
|
3451
3482
|
{
|
|
3452
3483
|
"name": "unit",
|
|
3453
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3484
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3454
3485
|
"value": {
|
|
3455
3486
|
"type": [
|
|
3456
3487
|
"\"centimeters\"",
|
|
@@ -3486,6 +3517,7 @@
|
|
|
3486
3517
|
"properties": [
|
|
3487
3518
|
{
|
|
3488
3519
|
"name": "analysis",
|
|
3520
|
+
"description": "The [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Direct Line Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst directLineAnalysis = new DirectLineMeasurementAnalysis({\n startPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624995.61798748,\n y: 4550334.030096778,\n z: 63.378210234455764\n }),\n endPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624921.53589075,\n y: 4550407.42357004,\n z: 63.3783810287714\n }),\n});\n// Get the Scene and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst directLineMeasurement3d = document.querySelector(\"arcgis-direct-line-measurement-3d\");\nawait directLineMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(directLineAnalysis);\n// Connect the analysis to the measurement component:\ndirectLineMeasurement3d.analysis = directLineAnalysis;\n```",
|
|
3489
3521
|
"type": "DirectLineMeasurementAnalysis"
|
|
3490
3522
|
},
|
|
3491
3523
|
{
|
|
@@ -3509,20 +3541,22 @@
|
|
|
3509
3541
|
},
|
|
3510
3542
|
{
|
|
3511
3543
|
"name": "referenceElement",
|
|
3544
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3512
3545
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3513
3546
|
},
|
|
3514
3547
|
{
|
|
3515
3548
|
"name": "state",
|
|
3549
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3516
3550
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
3517
3551
|
},
|
|
3518
3552
|
{
|
|
3519
3553
|
"name": "unit",
|
|
3520
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3554
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3521
3555
|
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
3522
3556
|
},
|
|
3523
3557
|
{
|
|
3524
3558
|
"name": "unitOptions",
|
|
3525
|
-
"description": "List of unit systems (imperial, metric)
|
|
3559
|
+
"description": "List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `inches`, `feet`, `us-feet`, `yards`, `miles`, `nautical-miles`, `meters`, `kilometers`.\nPossible [unit](#unit) values can only be a subset of this list.",
|
|
3526
3560
|
"type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
|
|
3527
3561
|
}
|
|
3528
3562
|
],
|
|
@@ -3542,7 +3576,7 @@
|
|
|
3542
3576
|
},
|
|
3543
3577
|
{
|
|
3544
3578
|
"name": "arcgis-directline-measurement-3d",
|
|
3545
|
-
"description": "**Deprecated**. The
|
|
3579
|
+
"description": "**Deprecated**. The Directline Measurement 3D component calculates and displays the 3D distance between two points. It can be used in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component to measure the vertical, horizontal, and direct distance between two points.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
|
|
3546
3580
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directline-measurement-3d/",
|
|
3547
3581
|
"attributes": [
|
|
3548
3582
|
{
|
|
@@ -3587,12 +3621,14 @@
|
|
|
3587
3621
|
},
|
|
3588
3622
|
{
|
|
3589
3623
|
"name": "reference-element",
|
|
3624
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3590
3625
|
"value": {
|
|
3591
3626
|
"type": "string"
|
|
3592
3627
|
}
|
|
3593
3628
|
},
|
|
3594
3629
|
{
|
|
3595
3630
|
"name": "state",
|
|
3631
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3596
3632
|
"value": {
|
|
3597
3633
|
"type": [
|
|
3598
3634
|
"\"disabled\"",
|
|
@@ -3604,7 +3640,7 @@
|
|
|
3604
3640
|
},
|
|
3605
3641
|
{
|
|
3606
3642
|
"name": "unit",
|
|
3607
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3643
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3608
3644
|
"value": {
|
|
3609
3645
|
"type": [
|
|
3610
3646
|
"\"centimeters\"",
|
|
@@ -3640,6 +3676,7 @@
|
|
|
3640
3676
|
"properties": [
|
|
3641
3677
|
{
|
|
3642
3678
|
"name": "analysis",
|
|
3679
|
+
"description": "The [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\ncreated or modified by the component.\n\nWhen connecting the Direct Line Measurement 3D component to the [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#analyses) collection.\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created analysis can be provided to the component.\nThen, the application itself needs to add it to and later remove it from the Scene's analyses collection.\n\n```js\n// Create the analysis.\nconst directLineAnalysis = new DirectLineMeasurementAnalysis({\n startPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624995.61798748,\n y: 4550334.030096778,\n z: 63.378210234455764\n }),\n endPoint: new Point({\n spatialReference: { latestWkid: 3857, wkid: 102100 },\n x: -13624921.53589075,\n y: 4550407.42357004,\n z: 63.3783810287714\n }),\n});\n// Get the Scene and measurement component and wait until they are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst directLineMeasurement3d = document.querySelector(\"arcgis-direct-line-measurement-3d\");\nawait directLineMeasurement3d.componentOnReady();\n// Add the analysis to the Scene component.\nviewElement.analyses.add(directLineAnalysis);\n// Connect the analysis to the measurement component:\ndirectLineMeasurement3d.analysis = directLineAnalysis;\n```",
|
|
3643
3680
|
"type": "DirectLineMeasurementAnalysis"
|
|
3644
3681
|
},
|
|
3645
3682
|
{
|
|
@@ -3663,20 +3700,22 @@
|
|
|
3663
3700
|
},
|
|
3664
3701
|
{
|
|
3665
3702
|
"name": "referenceElement",
|
|
3703
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3666
3704
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3667
3705
|
},
|
|
3668
3706
|
{
|
|
3669
3707
|
"name": "state",
|
|
3708
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3670
3709
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
3671
3710
|
},
|
|
3672
3711
|
{
|
|
3673
3712
|
"name": "unit",
|
|
3674
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3713
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3675
3714
|
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
3676
3715
|
},
|
|
3677
3716
|
{
|
|
3678
3717
|
"name": "unitOptions",
|
|
3679
|
-
"description": "List of unit systems (imperial, metric)
|
|
3718
|
+
"description": "List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `inches`, `feet`, `us-feet`, `yards`, `miles`, `nautical-miles`, `meters`, `kilometers`.\nPossible [unit](#unit) values can only be a subset of this list.",
|
|
3680
3719
|
"type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
|
|
3681
3720
|
}
|
|
3682
3721
|
],
|
|
@@ -3741,6 +3780,7 @@
|
|
|
3741
3780
|
},
|
|
3742
3781
|
{
|
|
3743
3782
|
"name": "reference-element",
|
|
3783
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3744
3784
|
"value": {
|
|
3745
3785
|
"type": "string"
|
|
3746
3786
|
}
|
|
@@ -3815,6 +3855,7 @@
|
|
|
3815
3855
|
},
|
|
3816
3856
|
{
|
|
3817
3857
|
"name": "referenceElement",
|
|
3858
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3818
3859
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3819
3860
|
},
|
|
3820
3861
|
{
|
|
@@ -3963,6 +4004,7 @@
|
|
|
3963
4004
|
},
|
|
3964
4005
|
{
|
|
3965
4006
|
"name": "reference-element",
|
|
4007
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
3966
4008
|
"value": {
|
|
3967
4009
|
"type": "string"
|
|
3968
4010
|
}
|
|
@@ -3993,7 +4035,6 @@
|
|
|
3993
4035
|
"\"editing-attributes\"",
|
|
3994
4036
|
"\"editing-existing-feature\"",
|
|
3995
4037
|
"\"editing-features\"",
|
|
3996
|
-
"\"editing-new-feature\"",
|
|
3997
4038
|
"\"ready\"",
|
|
3998
4039
|
"\"viewing-selection-list\""
|
|
3999
4040
|
]
|
|
@@ -4087,6 +4128,7 @@
|
|
|
4087
4128
|
},
|
|
4088
4129
|
{
|
|
4089
4130
|
"name": "referenceElement",
|
|
4131
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4090
4132
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4091
4133
|
},
|
|
4092
4134
|
{
|
|
@@ -4101,7 +4143,7 @@
|
|
|
4101
4143
|
{
|
|
4102
4144
|
"name": "state",
|
|
4103
4145
|
"description": "The widget's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-EditorViewModel.html#state)",
|
|
4104
|
-
"type": "\"add-association-create-association\" | \"add-association-select-feature\" | \"add-association-select-layer\" | \"adding-attachment\" | \"awaiting-feature-creation-info\" | \"awaiting-feature-to-create\" | \"awaiting-feature-to-update\" | \"awaiting-update-feature-candidate\" | \"creating-features\" | \"disabled\" | \"editing-attachment\" | \"editing-attributes\" | \"editing-existing-feature\" | \"editing-features\" | \"
|
|
4146
|
+
"type": "\"add-association-create-association\" | \"add-association-select-feature\" | \"add-association-select-layer\" | \"adding-attachment\" | \"awaiting-feature-creation-info\" | \"awaiting-feature-to-create\" | \"awaiting-feature-to-update\" | \"awaiting-update-feature-candidate\" | \"creating-features\" | \"disabled\" | \"editing-attachment\" | \"editing-attributes\" | \"editing-existing-feature\" | \"editing-features\" | \"ready\" | \"viewing-selection-list\""
|
|
4105
4147
|
},
|
|
4106
4148
|
{
|
|
4107
4149
|
"name": "supportingWidgetDefaults",
|
|
@@ -4130,7 +4172,7 @@
|
|
|
4130
4172
|
},
|
|
4131
4173
|
{
|
|
4132
4174
|
"name": "arcgis-elevation-profile",
|
|
4133
|
-
"description": "The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void
|
|
4175
|
+
"description": "The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).\n\n**See also**\n\n- [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Switches to the \"creating\" state in which the user can draw a new line.\n- `stop(): Promise<void>` - Stops the creation operation.",
|
|
4134
4176
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/",
|
|
4135
4177
|
"attributes": [
|
|
4136
4178
|
{
|
|
@@ -4214,7 +4256,7 @@
|
|
|
4214
4256
|
},
|
|
4215
4257
|
{
|
|
4216
4258
|
"name": "icon",
|
|
4217
|
-
"description": "Icon which represents the
|
|
4259
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
4218
4260
|
"default": "\"altitude\"",
|
|
4219
4261
|
"value": {
|
|
4220
4262
|
"type": "string"
|
|
@@ -4222,7 +4264,7 @@
|
|
|
4222
4264
|
},
|
|
4223
4265
|
{
|
|
4224
4266
|
"name": "label",
|
|
4225
|
-
"description": "The
|
|
4267
|
+
"description": "The component's default label.",
|
|
4226
4268
|
"value": {
|
|
4227
4269
|
"type": "string"
|
|
4228
4270
|
}
|
|
@@ -4246,13 +4288,14 @@
|
|
|
4246
4288
|
},
|
|
4247
4289
|
{
|
|
4248
4290
|
"name": "reference-element",
|
|
4291
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4249
4292
|
"value": {
|
|
4250
4293
|
"type": "string"
|
|
4251
4294
|
}
|
|
4252
4295
|
},
|
|
4253
4296
|
{
|
|
4254
4297
|
"name": "state",
|
|
4255
|
-
"description": "The
|
|
4298
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready; no path configured and no interactive operation ongoing\n* `creating` - user is creating a new input path\n* `created` - input path is configured but no interactive operation is ongoing\n* `selecting` - user is selecting an existing input path\n* `selected` - user selected an existing input path",
|
|
4256
4299
|
"default": "\"disabled\"",
|
|
4257
4300
|
"value": {
|
|
4258
4301
|
"type": [
|
|
@@ -4316,7 +4359,7 @@
|
|
|
4316
4359
|
},
|
|
4317
4360
|
{
|
|
4318
4361
|
"name": "effectiveUnits",
|
|
4319
|
-
"description": "Units which have been selected according to the magnitude of the elevations and distances
|
|
4362
|
+
"description": "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.",
|
|
4320
4363
|
"type": "EffectiveUnits"
|
|
4321
4364
|
},
|
|
4322
4365
|
{
|
|
@@ -4363,17 +4406,17 @@
|
|
|
4363
4406
|
},
|
|
4364
4407
|
{
|
|
4365
4408
|
"name": "icon",
|
|
4366
|
-
"description": "Icon which represents the
|
|
4409
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
4367
4410
|
"type": "string"
|
|
4368
4411
|
},
|
|
4369
4412
|
{
|
|
4370
4413
|
"name": "input",
|
|
4371
|
-
"description": "The input
|
|
4414
|
+
"description": "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)",
|
|
4372
4415
|
"type": "Graphic"
|
|
4373
4416
|
},
|
|
4374
4417
|
{
|
|
4375
4418
|
"name": "label",
|
|
4376
|
-
"description": "The
|
|
4419
|
+
"description": "The component's default label.",
|
|
4377
4420
|
"type": "string"
|
|
4378
4421
|
},
|
|
4379
4422
|
{
|
|
@@ -4382,7 +4425,7 @@
|
|
|
4382
4425
|
},
|
|
4383
4426
|
{
|
|
4384
4427
|
"name": "profiles",
|
|
4385
|
-
"description": "Collection of elevation profile lines which are to be generated and displayed in the
|
|
4428
|
+
"description": "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)",
|
|
4386
4429
|
"type": "Collection<ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineView>"
|
|
4387
4430
|
},
|
|
4388
4431
|
{
|
|
@@ -4392,11 +4435,12 @@
|
|
|
4392
4435
|
},
|
|
4393
4436
|
{
|
|
4394
4437
|
"name": "referenceElement",
|
|
4438
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4395
4439
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4396
4440
|
},
|
|
4397
4441
|
{
|
|
4398
4442
|
"name": "state",
|
|
4399
|
-
"description": "The
|
|
4443
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready; no path configured and no interactive operation ongoing\n* `creating` - user is creating a new input path\n* `created` - input path is configured but no interactive operation is ongoing\n* `selecting` - user is selecting an existing input path\n* `selected` - user selected an existing input path",
|
|
4400
4444
|
"type": "\"created\" | \"creating\" | \"disabled\" | \"ready\" | \"selected\" | \"selecting\""
|
|
4401
4445
|
},
|
|
4402
4446
|
{
|
|
@@ -4431,7 +4475,7 @@
|
|
|
4431
4475
|
},
|
|
4432
4476
|
{
|
|
4433
4477
|
"name": "arcgis-expand",
|
|
4434
|
-
"description": "The Expand component acts as a clickable button for
|
|
4478
|
+
"description": "The Expand component acts as a clickable button for displaying interactive content, most commonly other components.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `collapse(): Promise<void>`\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `expand(): Promise<void>`\n- `toggle(): Promise<void>`",
|
|
4435
4479
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/",
|
|
4436
4480
|
"attributes": [
|
|
4437
4481
|
{
|
|
@@ -4468,8 +4512,7 @@
|
|
|
4468
4512
|
},
|
|
4469
4513
|
{
|
|
4470
4514
|
"name": "collapse-tooltip",
|
|
4471
|
-
"description": "Tooltip to display to indicate Expand widget can be collapsed.",
|
|
4472
|
-
"default": "\"Collapse\" (English locale)",
|
|
4515
|
+
"description": "Tooltip to display to indicate Expand widget can be collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseTooltip)",
|
|
4473
4516
|
"value": {
|
|
4474
4517
|
"type": "string"
|
|
4475
4518
|
}
|
|
@@ -4484,8 +4527,7 @@
|
|
|
4484
4527
|
},
|
|
4485
4528
|
{
|
|
4486
4529
|
"name": "expand-tooltip",
|
|
4487
|
-
"description": "Tooltip to display to indicate Expand widget can be expanded.",
|
|
4488
|
-
"default": "\"Expand\" (English locale)",
|
|
4530
|
+
"description": "Tooltip to display to indicate Expand widget can be expanded.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandTooltip)",
|
|
4489
4531
|
"value": {
|
|
4490
4532
|
"type": "string"
|
|
4491
4533
|
}
|
|
@@ -4508,7 +4550,7 @@
|
|
|
4508
4550
|
},
|
|
4509
4551
|
{
|
|
4510
4552
|
"name": "focus-trap-enabled",
|
|
4511
|
-
"description": "**Deprecated**: since 4.33
|
|
4553
|
+
"description": "**Deprecated**: since 4.33, use [`focusTrapDisabled`](#focusTrapDisabled) instead.. Disables focus trapping within the expand widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#focusTrapDisabled)",
|
|
4512
4554
|
"default": "false",
|
|
4513
4555
|
"value": {
|
|
4514
4556
|
"type": "boolean"
|
|
@@ -4596,6 +4638,7 @@
|
|
|
4596
4638
|
},
|
|
4597
4639
|
{
|
|
4598
4640
|
"name": "reference-element",
|
|
4641
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4599
4642
|
"value": {
|
|
4600
4643
|
"type": "string"
|
|
4601
4644
|
}
|
|
@@ -4632,7 +4675,7 @@
|
|
|
4632
4675
|
},
|
|
4633
4676
|
{
|
|
4634
4677
|
"name": "collapseTooltip",
|
|
4635
|
-
"description": "Tooltip to display to indicate Expand widget can be collapsed.",
|
|
4678
|
+
"description": "Tooltip to display to indicate Expand widget can be collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseTooltip)",
|
|
4636
4679
|
"type": "string"
|
|
4637
4680
|
},
|
|
4638
4681
|
{
|
|
@@ -4647,7 +4690,7 @@
|
|
|
4647
4690
|
},
|
|
4648
4691
|
{
|
|
4649
4692
|
"name": "expandTooltip",
|
|
4650
|
-
"description": "Tooltip to display to indicate Expand widget can be expanded.",
|
|
4693
|
+
"description": "Tooltip to display to indicate Expand widget can be expanded.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandTooltip)",
|
|
4651
4694
|
"type": "string"
|
|
4652
4695
|
},
|
|
4653
4696
|
{
|
|
@@ -4691,6 +4734,7 @@
|
|
|
4691
4734
|
},
|
|
4692
4735
|
{
|
|
4693
4736
|
"name": "referenceElement",
|
|
4737
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4694
4738
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4695
4739
|
}
|
|
4696
4740
|
],
|
|
@@ -4774,7 +4818,7 @@
|
|
|
4774
4818
|
},
|
|
4775
4819
|
{
|
|
4776
4820
|
"name": "hide-last-edit-info",
|
|
4777
|
-
"description": "**Deprecated**: since 4.33
|
|
4821
|
+
"description": "**Deprecated**: since 4.33, use [hideLastEditedInfo](#hideLastEditedInfo) instead.. ",
|
|
4778
4822
|
"default": "false",
|
|
4779
4823
|
"value": {
|
|
4780
4824
|
"type": "boolean"
|
|
@@ -4830,6 +4874,7 @@
|
|
|
4830
4874
|
},
|
|
4831
4875
|
{
|
|
4832
4876
|
"name": "reference-element",
|
|
4877
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4833
4878
|
"value": {
|
|
4834
4879
|
"type": "string"
|
|
4835
4880
|
}
|
|
@@ -4954,6 +4999,7 @@
|
|
|
4954
4999
|
},
|
|
4955
5000
|
{
|
|
4956
5001
|
"name": "referenceElement",
|
|
5002
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
4957
5003
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4958
5004
|
},
|
|
4959
5005
|
{
|
|
@@ -5052,6 +5098,7 @@
|
|
|
5052
5098
|
},
|
|
5053
5099
|
{
|
|
5054
5100
|
"name": "reference-element",
|
|
5101
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
5055
5102
|
"value": {
|
|
5056
5103
|
"type": "string"
|
|
5057
5104
|
}
|
|
@@ -5136,7 +5183,7 @@
|
|
|
5136
5183
|
{
|
|
5137
5184
|
"name": "layer",
|
|
5138
5185
|
"description": "Layer containing the editable feature attributes.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureForm.html#layer)",
|
|
5139
|
-
"type": "FeatureLayer | GeoJSONLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer"
|
|
5186
|
+
"type": "FeatureLayer | GeoJSONLayer | KnowledgeGraphSublayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer"
|
|
5140
5187
|
},
|
|
5141
5188
|
{
|
|
5142
5189
|
"name": "position",
|
|
@@ -5144,6 +5191,7 @@
|
|
|
5144
5191
|
},
|
|
5145
5192
|
{
|
|
5146
5193
|
"name": "referenceElement",
|
|
5194
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
5147
5195
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
5148
5196
|
},
|
|
5149
5197
|
{
|
|
@@ -5537,6 +5585,7 @@
|
|
|
5537
5585
|
},
|
|
5538
5586
|
{
|
|
5539
5587
|
"name": "reference-element",
|
|
5588
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
5540
5589
|
"value": {
|
|
5541
5590
|
"type": "string"
|
|
5542
5591
|
}
|
|
@@ -5998,6 +6047,7 @@
|
|
|
5998
6047
|
},
|
|
5999
6048
|
{
|
|
6000
6049
|
"name": "referenceElement",
|
|
6050
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
6001
6051
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6002
6052
|
},
|
|
6003
6053
|
{
|
|
@@ -6072,7 +6122,7 @@
|
|
|
6072
6122
|
},
|
|
6073
6123
|
{
|
|
6074
6124
|
"name": "supportsResizeAttachments",
|
|
6075
|
-
"description": "
|
|
6125
|
+
"description": "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)",
|
|
6076
6126
|
"type": "boolean"
|
|
6077
6127
|
},
|
|
6078
6128
|
{
|
|
@@ -6244,6 +6294,7 @@
|
|
|
6244
6294
|
},
|
|
6245
6295
|
{
|
|
6246
6296
|
"name": "reference-element",
|
|
6297
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
6247
6298
|
"value": {
|
|
6248
6299
|
"type": "string"
|
|
6249
6300
|
}
|
|
@@ -6344,6 +6395,7 @@
|
|
|
6344
6395
|
},
|
|
6345
6396
|
{
|
|
6346
6397
|
"name": "referenceElement",
|
|
6398
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
6347
6399
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6348
6400
|
},
|
|
6349
6401
|
{
|
|
@@ -6558,6 +6610,7 @@
|
|
|
6558
6610
|
},
|
|
6559
6611
|
{
|
|
6560
6612
|
"name": "reference-element",
|
|
6613
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
6561
6614
|
"value": {
|
|
6562
6615
|
"type": "string"
|
|
6563
6616
|
}
|
|
@@ -6760,6 +6813,7 @@
|
|
|
6760
6813
|
},
|
|
6761
6814
|
{
|
|
6762
6815
|
"name": "referenceElement",
|
|
6816
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
6763
6817
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6764
6818
|
},
|
|
6765
6819
|
{
|
|
@@ -6893,6 +6947,7 @@
|
|
|
6893
6947
|
},
|
|
6894
6948
|
{
|
|
6895
6949
|
"name": "reference-element",
|
|
6950
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
6896
6951
|
"value": {
|
|
6897
6952
|
"type": "string"
|
|
6898
6953
|
}
|
|
@@ -6955,6 +7010,7 @@
|
|
|
6955
7010
|
},
|
|
6956
7011
|
{
|
|
6957
7012
|
"name": "referenceElement",
|
|
7013
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
6958
7014
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6959
7015
|
},
|
|
6960
7016
|
{
|
|
@@ -6974,9 +7030,16 @@
|
|
|
6974
7030
|
},
|
|
6975
7031
|
{
|
|
6976
7032
|
"name": "arcgis-fullscreen",
|
|
6977
|
-
"description": "The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
|
|
7033
|
+
"description": "The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\nUse the escape key (`esc`) to exit fullscreen mode.\n\n**Known limitations**\n\n* The Fullscreen widget only works with browsers that implement the [Fullscreen](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API) API.\n Thus, iOS Safari is not supported.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.",
|
|
6978
7034
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-fullscreen/",
|
|
6979
7035
|
"attributes": [
|
|
7036
|
+
{
|
|
7037
|
+
"name": "element",
|
|
7038
|
+
"description": "The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode.",
|
|
7039
|
+
"value": {
|
|
7040
|
+
"type": "string"
|
|
7041
|
+
}
|
|
7042
|
+
},
|
|
6980
7043
|
{
|
|
6981
7044
|
"name": "label",
|
|
6982
7045
|
"description": "The component's default label.",
|
|
@@ -7003,6 +7066,7 @@
|
|
|
7003
7066
|
},
|
|
7004
7067
|
{
|
|
7005
7068
|
"name": "reference-element",
|
|
7069
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7006
7070
|
"value": {
|
|
7007
7071
|
"type": "string"
|
|
7008
7072
|
}
|
|
@@ -7036,7 +7100,7 @@
|
|
|
7036
7100
|
{
|
|
7037
7101
|
"name": "element",
|
|
7038
7102
|
"description": "The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode.",
|
|
7039
|
-
"type": "
|
|
7103
|
+
"type": "Element | string"
|
|
7040
7104
|
},
|
|
7041
7105
|
{
|
|
7042
7106
|
"name": "label",
|
|
@@ -7045,7 +7109,7 @@
|
|
|
7045
7109
|
},
|
|
7046
7110
|
{
|
|
7047
7111
|
"name": "messageOverrides",
|
|
7048
|
-
"description": "Replace localized message strings with your own strings
|
|
7112
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7049
7113
|
"type": "Record<string, unknown>"
|
|
7050
7114
|
},
|
|
7051
7115
|
{
|
|
@@ -7054,6 +7118,7 @@
|
|
|
7054
7118
|
},
|
|
7055
7119
|
{
|
|
7056
7120
|
"name": "referenceElement",
|
|
7121
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7057
7122
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7058
7123
|
},
|
|
7059
7124
|
{
|
|
@@ -7255,6 +7320,7 @@
|
|
|
7255
7320
|
},
|
|
7256
7321
|
{
|
|
7257
7322
|
"name": "reference-element",
|
|
7323
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7258
7324
|
"value": {
|
|
7259
7325
|
"type": "string"
|
|
7260
7326
|
}
|
|
@@ -7443,7 +7509,7 @@
|
|
|
7443
7509
|
},
|
|
7444
7510
|
{
|
|
7445
7511
|
"name": "messageOverrides",
|
|
7446
|
-
"description": "Replace localized message strings with your own strings
|
|
7512
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7447
7513
|
"type": "Record<string, unknown>"
|
|
7448
7514
|
},
|
|
7449
7515
|
{
|
|
@@ -7457,6 +7523,7 @@
|
|
|
7457
7523
|
},
|
|
7458
7524
|
{
|
|
7459
7525
|
"name": "referenceElement",
|
|
7526
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7460
7527
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7461
7528
|
},
|
|
7462
7529
|
{
|
|
@@ -7617,6 +7684,7 @@
|
|
|
7617
7684
|
},
|
|
7618
7685
|
{
|
|
7619
7686
|
"name": "reference-element",
|
|
7687
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7620
7688
|
"value": {
|
|
7621
7689
|
"type": "string"
|
|
7622
7690
|
}
|
|
@@ -7742,6 +7810,7 @@
|
|
|
7742
7810
|
},
|
|
7743
7811
|
{
|
|
7744
7812
|
"name": "referenceElement",
|
|
7813
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7745
7814
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7746
7815
|
},
|
|
7747
7816
|
{
|
|
@@ -7781,7 +7850,7 @@
|
|
|
7781
7850
|
},
|
|
7782
7851
|
{
|
|
7783
7852
|
"name": "arcgis-home",
|
|
7784
|
-
"description": "The Home component is a button that
|
|
7853
|
+
"description": "The Home component is a button that navigates back to the\ninitial [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)\nor a previously defined `viewpoint`.\n--\n\n### Events\n- **arcgisGo** - Fires when the go() method is called.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `cancelGo(): Promise<void>` - This function provides the ability to interrupt and cancel the process\nof navigating back to the initial extent.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `go(): Promise<void>` - Animates the map or scene to its initial Viewpoint or the\nvalue of `viewpoint`.",
|
|
7785
7854
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-home/",
|
|
7786
7855
|
"attributes": [
|
|
7787
7856
|
{
|
|
@@ -7826,6 +7895,7 @@
|
|
|
7826
7895
|
},
|
|
7827
7896
|
{
|
|
7828
7897
|
"name": "reference-element",
|
|
7898
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7829
7899
|
"value": {
|
|
7830
7900
|
"type": "string"
|
|
7831
7901
|
}
|
|
@@ -7884,7 +7954,7 @@
|
|
|
7884
7954
|
},
|
|
7885
7955
|
{
|
|
7886
7956
|
"name": "messageOverrides",
|
|
7887
|
-
"description": "Replace localized message strings with your own strings
|
|
7957
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7888
7958
|
"type": "Record<string, unknown>"
|
|
7889
7959
|
},
|
|
7890
7960
|
{
|
|
@@ -7893,6 +7963,7 @@
|
|
|
7893
7963
|
},
|
|
7894
7964
|
{
|
|
7895
7965
|
"name": "referenceElement",
|
|
7966
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
7896
7967
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7897
7968
|
},
|
|
7898
7969
|
{
|
|
@@ -7902,7 +7973,7 @@
|
|
|
7902
7973
|
},
|
|
7903
7974
|
{
|
|
7904
7975
|
"name": "viewpoint",
|
|
7905
|
-
"description": "The esri
|
|
7976
|
+
"description": "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).",
|
|
7906
7977
|
"type": "Viewpoint"
|
|
7907
7978
|
}
|
|
7908
7979
|
],
|
|
@@ -8057,6 +8128,7 @@
|
|
|
8057
8128
|
},
|
|
8058
8129
|
{
|
|
8059
8130
|
"name": "reference-element",
|
|
8131
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8060
8132
|
"value": {
|
|
8061
8133
|
"type": "string"
|
|
8062
8134
|
}
|
|
@@ -8272,6 +8344,7 @@
|
|
|
8272
8344
|
},
|
|
8273
8345
|
{
|
|
8274
8346
|
"name": "referenceElement",
|
|
8347
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8275
8348
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
8276
8349
|
},
|
|
8277
8350
|
{
|
|
@@ -8427,6 +8500,7 @@
|
|
|
8427
8500
|
},
|
|
8428
8501
|
{
|
|
8429
8502
|
"name": "reference-element",
|
|
8503
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8430
8504
|
"value": {
|
|
8431
8505
|
"type": "string"
|
|
8432
8506
|
}
|
|
@@ -8524,6 +8598,7 @@
|
|
|
8524
8598
|
},
|
|
8525
8599
|
{
|
|
8526
8600
|
"name": "referenceElement",
|
|
8601
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8527
8602
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
8528
8603
|
},
|
|
8529
8604
|
{
|
|
@@ -8558,7 +8633,7 @@
|
|
|
8558
8633
|
},
|
|
8559
8634
|
{
|
|
8560
8635
|
"name": "arcgis-line-of-sight",
|
|
8561
|
-
"description": "The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a
|
|
8636
|
+
"description": "The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including the ground, integrated meshes, and 3D objects such as buildings or trees.\n\n\n\nThe analysis results are displayed as colored lines, where areas visible to the observer are\nshown green and occluded parts are marked in red. Also, the color of the target points indicates their visibility.\nWhen the line of sight cannot be calculated, it will be displayed with a gray color. This may happen if either\nthe target or the observer is not in the view.\n\nWhen creating a new line of sight analysis, the first click in the Scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html)\nand subsequent clicks place the [targets](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html).\nBoth the observer and target points can be moved by dragging. Additionally, the target points can be removed with a right click.\n\n**Known limitation**\n\nLine Of Sight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\n- [Sample - Line of sight component](https://developers.arcgis.com/javascript/latest/sample-code/line-of-sight/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current analysis results. After calling this method, the user can set a new observer and targets.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `continue(): Promise<void>` - After [stop()](#stop) was called, this method allows to continue the line of sight analysis and add more targets.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start a new line of sight analysis.\n- `stop(): Promise<void>` - Stop the current placing of line of sight analysis. Any lines added this far are kept in the view.\nUsers can still interact with existing targets and the observer, but they cannot place new target points.",
|
|
8562
8637
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-line-of-sight/",
|
|
8563
8638
|
"attributes": [
|
|
8564
8639
|
{
|
|
@@ -8603,9 +8678,22 @@
|
|
|
8603
8678
|
},
|
|
8604
8679
|
{
|
|
8605
8680
|
"name": "reference-element",
|
|
8681
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8606
8682
|
"value": {
|
|
8607
8683
|
"type": "string"
|
|
8608
8684
|
}
|
|
8685
|
+
},
|
|
8686
|
+
{
|
|
8687
|
+
"name": "state",
|
|
8688
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for analysis\n* `creating` - observer/target points are being placed\n* `created` - finished analysis",
|
|
8689
|
+
"value": {
|
|
8690
|
+
"type": [
|
|
8691
|
+
"\"created\"",
|
|
8692
|
+
"\"creating\"",
|
|
8693
|
+
"\"disabled\"",
|
|
8694
|
+
"\"ready\""
|
|
8695
|
+
]
|
|
8696
|
+
}
|
|
8609
8697
|
}
|
|
8610
8698
|
],
|
|
8611
8699
|
"events": [
|
|
@@ -8624,7 +8712,7 @@
|
|
|
8624
8712
|
"properties": [
|
|
8625
8713
|
{
|
|
8626
8714
|
"name": "analysis",
|
|
8627
|
-
"description": "The [
|
|
8715
|
+
"description": "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```",
|
|
8628
8716
|
"type": "LineOfSightAnalysis"
|
|
8629
8717
|
},
|
|
8630
8718
|
{
|
|
@@ -8644,7 +8732,7 @@
|
|
|
8644
8732
|
},
|
|
8645
8733
|
{
|
|
8646
8734
|
"name": "messageOverrides",
|
|
8647
|
-
"description": "Replace localized message strings with your own strings
|
|
8735
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
8648
8736
|
"type": "Record<string, unknown>"
|
|
8649
8737
|
},
|
|
8650
8738
|
{
|
|
@@ -8653,6 +8741,7 @@
|
|
|
8653
8741
|
},
|
|
8654
8742
|
{
|
|
8655
8743
|
"name": "referenceElement",
|
|
8744
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
8656
8745
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
8657
8746
|
},
|
|
8658
8747
|
{
|
|
@@ -8677,7 +8766,7 @@
|
|
|
8677
8766
|
},
|
|
8678
8767
|
{
|
|
8679
8768
|
"name": "arcgis-link-chart",
|
|
8680
|
-
"description": "Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html) from an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html).\n\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the link chart has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the link chart.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33
|
|
8769
|
+
"description": "Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html) from an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html).\n\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the link chart has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the link chart.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.",
|
|
8681
8770
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/",
|
|
8682
8771
|
"attributes": [
|
|
8683
8772
|
{
|
|
@@ -8933,7 +9022,7 @@
|
|
|
8933
9022
|
},
|
|
8934
9023
|
{
|
|
8935
9024
|
"name": "graphics",
|
|
8936
|
-
"description": "Allows for adding graphics directly to the default graphics in the View
|
|
9025
|
+
"description": "Allows for adding graphics directly to the default graphics in the View.",
|
|
8937
9026
|
"type": "Collection<Graphic>"
|
|
8938
9027
|
},
|
|
8939
9028
|
{
|
|
@@ -9240,6 +9329,7 @@
|
|
|
9240
9329
|
},
|
|
9241
9330
|
{
|
|
9242
9331
|
"name": "reference-element",
|
|
9332
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)",
|
|
9243
9333
|
"value": {
|
|
9244
9334
|
"type": "string"
|
|
9245
9335
|
}
|
|
@@ -9308,7 +9398,7 @@
|
|
|
9308
9398
|
},
|
|
9309
9399
|
{
|
|
9310
9400
|
"name": "messageOverrides",
|
|
9311
|
-
"description": "Replace localized message strings with your own strings
|
|
9401
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
9312
9402
|
"type": "Record<string, unknown>"
|
|
9313
9403
|
},
|
|
9314
9404
|
{
|
|
@@ -9322,6 +9412,7 @@
|
|
|
9322
9412
|
},
|
|
9323
9413
|
{
|
|
9324
9414
|
"name": "referenceElement",
|
|
9415
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)",
|
|
9325
9416
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
9326
9417
|
},
|
|
9327
9418
|
{
|
|
@@ -9351,7 +9442,7 @@
|
|
|
9351
9442
|
},
|
|
9352
9443
|
{
|
|
9353
9444
|
"name": "arcgis-locate",
|
|
9354
|
-
"description": "The Locate component animates the Map or Scene to the user's current location.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`",
|
|
9445
|
+
"description": "The Locate component animates the Map or Scene to the user's current location.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that support\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility).\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`",
|
|
9355
9446
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-locate/",
|
|
9356
9447
|
"attributes": [
|
|
9357
9448
|
{
|
|
@@ -9410,6 +9501,7 @@
|
|
|
9410
9501
|
},
|
|
9411
9502
|
{
|
|
9412
9503
|
"name": "reference-element",
|
|
9504
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
9413
9505
|
"value": {
|
|
9414
9506
|
"type": "string"
|
|
9415
9507
|
}
|
|
@@ -9492,7 +9584,7 @@
|
|
|
9492
9584
|
},
|
|
9493
9585
|
{
|
|
9494
9586
|
"name": "messageOverrides",
|
|
9495
|
-
"description": "Replace localized message strings with your own strings
|
|
9587
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
9496
9588
|
"type": "Record<string, unknown>"
|
|
9497
9589
|
},
|
|
9498
9590
|
{
|
|
@@ -9505,6 +9597,7 @@
|
|
|
9505
9597
|
},
|
|
9506
9598
|
{
|
|
9507
9599
|
"name": "referenceElement",
|
|
9600
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
9508
9601
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
9509
9602
|
},
|
|
9510
9603
|
{
|
|
@@ -9542,7 +9635,7 @@
|
|
|
9542
9635
|
},
|
|
9543
9636
|
{
|
|
9544
9637
|
"name": "arcgis-map",
|
|
9545
|
-
"description": "The ArcGIS Map
|
|
9638
|
+
"description": "The ArcGIS Map component is used to add 2D maps to web applications. For 3D maps, use the\n[ArcGIS Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) and loads a WebMap from either [ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\"></arcgis-map>\n```\n\nAlternatively, the Map component can be initialized without a WebMap item.\n\n```html\n<arcgis-map basemap=\"satellite\" center=\"-154.88, 19.46\" zoom=\"15\"></arcgis-map>\n```\n\nOther components can be added and connected to the Map component.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\">\n <arcgis-zoom position=\"top-left\"></arcgis-zoom>\n <arcgis-legend position=\"bottom-left\"></arcgis-legend>\n</arcgis-map>\n```\n\nThe Map component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/) of the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My Layer\" });\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Map component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-map)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the map tables collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the map tables collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `hitTest(screenPoint: __esri.MapViewScreenPoint | MouseEvent, options?: __esri.MapViewHitTestOptions): Promise<__esri.HitTestResult>` - Returns hit test results from each layer that intersects the specified screen coordinates.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `takeScreenshot(options?: __esri.MapViewTakeScreenshotOptions): Promise<__esri.Screenshot>` - Create a screenshot of the current view.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.",
|
|
9546
9639
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/",
|
|
9547
9640
|
"attributes": [
|
|
9548
9641
|
{
|
|
@@ -9815,7 +9908,7 @@
|
|
|
9815
9908
|
},
|
|
9816
9909
|
{
|
|
9817
9910
|
"name": "graphics",
|
|
9818
|
-
"description": "Allows for adding graphics directly to the default graphics in the View
|
|
9911
|
+
"description": "Allows for adding graphics directly to the default graphics in the View.",
|
|
9819
9912
|
"type": "Collection<Graphic>"
|
|
9820
9913
|
},
|
|
9821
9914
|
{
|
|
@@ -10172,6 +10265,7 @@
|
|
|
10172
10265
|
},
|
|
10173
10266
|
{
|
|
10174
10267
|
"name": "reference-element",
|
|
10268
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
10175
10269
|
"value": {
|
|
10176
10270
|
"type": "string"
|
|
10177
10271
|
}
|
|
@@ -10245,6 +10339,7 @@
|
|
|
10245
10339
|
},
|
|
10246
10340
|
{
|
|
10247
10341
|
"name": "referenceElement",
|
|
10342
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
10248
10343
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10249
10344
|
},
|
|
10250
10345
|
{
|
|
@@ -10269,7 +10364,7 @@
|
|
|
10269
10364
|
},
|
|
10270
10365
|
{
|
|
10271
10366
|
"name": "arcgis-navigation-toggle",
|
|
10272
|
-
"description": "The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\
|
|
10367
|
+
"description": "The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\n**Known limitations**\n\nNavigation Toggle is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `toggle(): Promise<void>`",
|
|
10273
10368
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-navigation-toggle/",
|
|
10274
10369
|
"attributes": [
|
|
10275
10370
|
{
|
|
@@ -10299,7 +10394,7 @@
|
|
|
10299
10394
|
},
|
|
10300
10395
|
{
|
|
10301
10396
|
"name": "navigation-mode",
|
|
10302
|
-
"description": "The navigation mode of the view.
|
|
10397
|
+
"description": "The navigation mode of the view. The possible values:\n\n* `pan` - The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\n* `rotate` - The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.",
|
|
10303
10398
|
"default": "\"pan\"",
|
|
10304
10399
|
"value": {
|
|
10305
10400
|
"type": [
|
|
@@ -10327,6 +10422,7 @@
|
|
|
10327
10422
|
},
|
|
10328
10423
|
{
|
|
10329
10424
|
"name": "reference-element",
|
|
10425
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
10330
10426
|
"value": {
|
|
10331
10427
|
"type": "string"
|
|
10332
10428
|
}
|
|
@@ -10334,7 +10430,6 @@
|
|
|
10334
10430
|
{
|
|
10335
10431
|
"name": "state",
|
|
10336
10432
|
"description": "The current state of the component.",
|
|
10337
|
-
"default": "\"disabled\"",
|
|
10338
10433
|
"value": {
|
|
10339
10434
|
"type": [
|
|
10340
10435
|
"\"disabled\"",
|
|
@@ -10374,12 +10469,12 @@
|
|
|
10374
10469
|
},
|
|
10375
10470
|
{
|
|
10376
10471
|
"name": "messageOverrides",
|
|
10377
|
-
"description": "Replace localized message strings with your own strings
|
|
10472
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
10378
10473
|
"type": "Record<string, unknown>"
|
|
10379
10474
|
},
|
|
10380
10475
|
{
|
|
10381
10476
|
"name": "navigationMode",
|
|
10382
|
-
"description": "The navigation mode of the view.
|
|
10477
|
+
"description": "The navigation mode of the view. The possible values:\n\n* `pan` - The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\n* `rotate` - The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.",
|
|
10383
10478
|
"type": "\"pan\" | \"rotate\""
|
|
10384
10479
|
},
|
|
10385
10480
|
{
|
|
@@ -10388,6 +10483,7 @@
|
|
|
10388
10483
|
},
|
|
10389
10484
|
{
|
|
10390
10485
|
"name": "referenceElement",
|
|
10486
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
10391
10487
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10392
10488
|
},
|
|
10393
10489
|
{
|
|
@@ -10543,6 +10639,7 @@
|
|
|
10543
10639
|
},
|
|
10544
10640
|
{
|
|
10545
10641
|
"name": "reference-element",
|
|
10642
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
10546
10643
|
"value": {
|
|
10547
10644
|
"type": "string"
|
|
10548
10645
|
}
|
|
@@ -10647,6 +10744,7 @@
|
|
|
10647
10744
|
},
|
|
10648
10745
|
{
|
|
10649
10746
|
"name": "referenceElement",
|
|
10747
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
10650
10748
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10651
10749
|
},
|
|
10652
10750
|
{
|
|
@@ -10693,6 +10791,7 @@
|
|
|
10693
10791
|
},
|
|
10694
10792
|
{
|
|
10695
10793
|
"name": "reference-element",
|
|
10794
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
10696
10795
|
"value": {
|
|
10697
10796
|
"type": "string"
|
|
10698
10797
|
}
|
|
@@ -10713,6 +10812,7 @@
|
|
|
10713
10812
|
},
|
|
10714
10813
|
{
|
|
10715
10814
|
"name": "referenceElement",
|
|
10815
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
10716
10816
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10717
10817
|
}
|
|
10718
10818
|
],
|
|
@@ -10727,7 +10827,7 @@
|
|
|
10727
10827
|
},
|
|
10728
10828
|
{
|
|
10729
10829
|
"name": "arcgis-print",
|
|
10730
|
-
"description": "The Print
|
|
10830
|
+
"description": "The Print component connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) to allow the map to be printed.\nIt takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS,\nwhich can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc.\nThe Print component works with the [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) module, which generates a printer-ready version of the map.\n\nThe Print component uses the ArcGIS Online print service by default, but it can be configured to use a custom print service with the [printServiceUrl](#printServiceUrl) property.\nThe component can preserve map scale or map extent in the printout. By default, the map extent is preserved. Use\n[TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) to preserve scale instead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#layout)\nexcept `map-only`. If using a custom print service, then `customTextElements` are supported for each print\ntemplate. Values found there will be populated in the Print component under `Advanced options`. These values can\nbe overwritten in the Print component UI, or programmatically using the\n[templateCustomTextElements](#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions).\n\n**Known limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) for a detailed list of known limitations.\n\n```html\n<arcgis-map item-id=\"45725ba7d9fb47a0925398919b13d1fa\">\n <arcgis-print position=\"top-right\"></arcgis-print>\n</arcgis-map>\n```\n\n```js\n// get a reference to the component\nconst components = document.querySelectorAll(\"arcgis-print\");\n\nconst portal = new Portal({\n url: \"https://user.maps.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://user.maps.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```\n--\n\n### Events\n- **arcgisComplete** - Emitted when the component is complete.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSubmit** - Emitted when the component is submitted.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
10731
10831
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-print/",
|
|
10732
10832
|
"attributes": [
|
|
10733
10833
|
{
|
|
@@ -10740,6 +10840,7 @@
|
|
|
10740
10840
|
},
|
|
10741
10841
|
{
|
|
10742
10842
|
"name": "allowed-formats-for-saving",
|
|
10843
|
+
"description": "Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.",
|
|
10743
10844
|
"value": {
|
|
10744
10845
|
"type": "\"all\""
|
|
10745
10846
|
}
|
|
@@ -10785,7 +10886,7 @@
|
|
|
10785
10886
|
},
|
|
10786
10887
|
{
|
|
10787
10888
|
"name": "heading-level",
|
|
10788
|
-
"description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the
|
|
10889
|
+
"description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
|
|
10789
10890
|
"default": "3",
|
|
10790
10891
|
"value": {
|
|
10791
10892
|
"type": [
|
|
@@ -10800,6 +10901,7 @@
|
|
|
10800
10901
|
},
|
|
10801
10902
|
{
|
|
10802
10903
|
"name": "hide-header",
|
|
10904
|
+
"description": "Indicates whether the component's header is hidden.",
|
|
10803
10905
|
"default": "false",
|
|
10804
10906
|
"value": {
|
|
10805
10907
|
"type": "boolean"
|
|
@@ -10822,6 +10924,7 @@
|
|
|
10822
10924
|
},
|
|
10823
10925
|
{
|
|
10824
10926
|
"name": "position",
|
|
10927
|
+
"description": "The UI position of a component.",
|
|
10825
10928
|
"default": "\"top-left\"",
|
|
10826
10929
|
"value": {
|
|
10827
10930
|
"type": [
|
|
@@ -10839,20 +10942,21 @@
|
|
|
10839
10942
|
},
|
|
10840
10943
|
{
|
|
10841
10944
|
"name": "print-service-url",
|
|
10842
|
-
"description": "The URL of the REST endpoint of the Export Web Map Task.\nIf the [portal](#portal) property is set,
|
|
10945
|
+
"description": "The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](#portal) property is set, this property will use the portal's print service URL.",
|
|
10843
10946
|
"value": {
|
|
10844
10947
|
"type": "string"
|
|
10845
10948
|
}
|
|
10846
10949
|
},
|
|
10847
10950
|
{
|
|
10848
10951
|
"name": "reference-element",
|
|
10952
|
+
"description": "By passing the `id` of the Map or Scene component into this property, you can position components from the `@arcgis/map-components`\npackage anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component).",
|
|
10849
10953
|
"value": {
|
|
10850
10954
|
"type": "string"
|
|
10851
10955
|
}
|
|
10852
10956
|
},
|
|
10853
10957
|
{
|
|
10854
10958
|
"name": "show-print-area-enabled",
|
|
10855
|
-
"description": "The initial state of the print area toggle in the Print
|
|
10959
|
+
"description": "The initial state of the print area toggle in the Print component UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.",
|
|
10856
10960
|
"default": "false",
|
|
10857
10961
|
"value": {
|
|
10858
10962
|
"type": "boolean"
|
|
@@ -10860,7 +10964,7 @@
|
|
|
10860
10964
|
},
|
|
10861
10965
|
{
|
|
10862
10966
|
"name": "state",
|
|
10863
|
-
"description": "The
|
|
10967
|
+
"description": "The state of the Print component.",
|
|
10864
10968
|
"default": "\"disabled\"",
|
|
10865
10969
|
"value": {
|
|
10866
10970
|
"type": [
|
|
@@ -10875,7 +10979,8 @@
|
|
|
10875
10979
|
"events": [
|
|
10876
10980
|
{
|
|
10877
10981
|
"name": "arcgisComplete",
|
|
10878
|
-
"type": "
|
|
10982
|
+
"type": "PrintCompleteEvent",
|
|
10983
|
+
"description": "Emitted when the component is complete."
|
|
10879
10984
|
},
|
|
10880
10985
|
{
|
|
10881
10986
|
"name": "arcgisPropertyChange",
|
|
@@ -10889,7 +10994,8 @@
|
|
|
10889
10994
|
},
|
|
10890
10995
|
{
|
|
10891
10996
|
"name": "arcgisSubmit",
|
|
10892
|
-
"type": "
|
|
10997
|
+
"type": "PrintSubmitEvent",
|
|
10998
|
+
"description": "Emitted when the component is submitted."
|
|
10893
10999
|
}
|
|
10894
11000
|
],
|
|
10895
11001
|
"js": {
|
|
@@ -10901,6 +11007,7 @@
|
|
|
10901
11007
|
},
|
|
10902
11008
|
{
|
|
10903
11009
|
"name": "allowedFormatsForSaving",
|
|
11010
|
+
"description": "Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.",
|
|
10904
11011
|
"type": "\"all\" | Array<string>"
|
|
10905
11012
|
},
|
|
10906
11013
|
{
|
|
@@ -10929,7 +11036,7 @@
|
|
|
10929
11036
|
},
|
|
10930
11037
|
{
|
|
10931
11038
|
"name": "exportedLinks",
|
|
10932
|
-
"description": "The collection of links exported from the Print
|
|
11039
|
+
"description": "The collection of links exported from the Print component.",
|
|
10933
11040
|
"type": "Collection<FileLink>"
|
|
10934
11041
|
},
|
|
10935
11042
|
{
|
|
@@ -10939,11 +11046,12 @@
|
|
|
10939
11046
|
},
|
|
10940
11047
|
{
|
|
10941
11048
|
"name": "headingLevel",
|
|
10942
|
-
"description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the
|
|
11049
|
+
"description": "Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
|
|
10943
11050
|
"type": "1 | 2 | 3 | 4 | 5 | 6"
|
|
10944
11051
|
},
|
|
10945
11052
|
{
|
|
10946
11053
|
"name": "hideHeader",
|
|
11054
|
+
"description": "Indicates whether the component's header is hidden.",
|
|
10947
11055
|
"type": "boolean"
|
|
10948
11056
|
},
|
|
10949
11057
|
{
|
|
@@ -10958,30 +11066,32 @@
|
|
|
10958
11066
|
},
|
|
10959
11067
|
{
|
|
10960
11068
|
"name": "messageOverrides",
|
|
10961
|
-
"description": "Replace localized message strings with your own strings
|
|
11069
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
10962
11070
|
"type": "Record<string, unknown>"
|
|
10963
11071
|
},
|
|
10964
11072
|
{
|
|
10965
11073
|
"name": "outSpatialReference",
|
|
10966
|
-
"description": "The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) used to render
|
|
11074
|
+
"description": "The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) used to render the printed map on the server.",
|
|
10967
11075
|
"type": "SpatialReference"
|
|
10968
11076
|
},
|
|
10969
11077
|
{
|
|
10970
11078
|
"name": "portal",
|
|
10971
|
-
"description": "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.",
|
|
11079
|
+
"description": "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.",
|
|
10972
11080
|
"type": "Portal"
|
|
10973
11081
|
},
|
|
10974
11082
|
{
|
|
10975
11083
|
"name": "position",
|
|
11084
|
+
"description": "The UI position of a component.",
|
|
10976
11085
|
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
|
|
10977
11086
|
},
|
|
10978
11087
|
{
|
|
10979
11088
|
"name": "printServiceUrl",
|
|
10980
|
-
"description": "The URL of the REST endpoint of the Export Web Map Task.\nIf the [portal](#portal) property is set,
|
|
11089
|
+
"description": "The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](#portal) property is set, this property will use the portal's print service URL.",
|
|
10981
11090
|
"type": "string"
|
|
10982
11091
|
},
|
|
10983
11092
|
{
|
|
10984
11093
|
"name": "referenceElement",
|
|
11094
|
+
"description": "By passing the `id` of the Map or Scene component into this property, you can position components from the `@arcgis/map-components`\npackage anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component).",
|
|
10985
11095
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10986
11096
|
},
|
|
10987
11097
|
{
|
|
@@ -10990,29 +11100,30 @@
|
|
|
10990
11100
|
},
|
|
10991
11101
|
{
|
|
10992
11102
|
"name": "showPrintAreaEnabled",
|
|
10993
|
-
"description": "The initial state of the print area toggle in the Print
|
|
11103
|
+
"description": "The initial state of the print area toggle in the Print component UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.",
|
|
10994
11104
|
"type": "boolean"
|
|
10995
11105
|
},
|
|
10996
11106
|
{
|
|
10997
11107
|
"name": "state",
|
|
10998
|
-
"description": "The
|
|
11108
|
+
"description": "The state of the Print component.",
|
|
10999
11109
|
"type": "\"disabled\" | \"error\" | \"initializing\" | \"ready\""
|
|
11000
11110
|
},
|
|
11001
11111
|
{
|
|
11002
11112
|
"name": "templateCustomTextElements",
|
|
11003
|
-
"description": "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
|
|
11113
|
+
"description": "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.",
|
|
11004
11114
|
"type": "{\n [x: string]: Array<HashMap<string>> | undefined;\n}"
|
|
11005
11115
|
},
|
|
11006
11116
|
{
|
|
11007
11117
|
"name": "templateOptions",
|
|
11008
|
-
"description": "Defines the layout template options used by the
|
|
11118
|
+
"description": "Defines the layout template options used by the Print component to generate the print page.",
|
|
11009
11119
|
"type": "TemplateOptions"
|
|
11010
11120
|
}
|
|
11011
11121
|
],
|
|
11012
11122
|
"events": [
|
|
11013
11123
|
{
|
|
11014
11124
|
"name": "arcgisComplete",
|
|
11015
|
-
"type": "
|
|
11125
|
+
"type": "PrintCompleteEvent",
|
|
11126
|
+
"description": "Emitted when the component is complete."
|
|
11016
11127
|
},
|
|
11017
11128
|
{
|
|
11018
11129
|
"name": "arcgisPropertyChange",
|
|
@@ -11026,14 +11137,15 @@
|
|
|
11026
11137
|
},
|
|
11027
11138
|
{
|
|
11028
11139
|
"name": "arcgisSubmit",
|
|
11029
|
-
"type": "
|
|
11140
|
+
"type": "PrintSubmitEvent",
|
|
11141
|
+
"description": "Emitted when the component is submitted."
|
|
11030
11142
|
}
|
|
11031
11143
|
]
|
|
11032
11144
|
}
|
|
11033
11145
|
},
|
|
11034
11146
|
{
|
|
11035
11147
|
"name": "arcgis-scale-bar",
|
|
11036
|
-
"description": "The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known
|
|
11148
|
+
"description": "The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
11037
11149
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-bar/",
|
|
11038
11150
|
"attributes": [
|
|
11039
11151
|
{
|
|
@@ -11089,6 +11201,7 @@
|
|
|
11089
11201
|
},
|
|
11090
11202
|
{
|
|
11091
11203
|
"name": "reference-element",
|
|
11204
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
11092
11205
|
"value": {
|
|
11093
11206
|
"type": "string"
|
|
11094
11207
|
}
|
|
@@ -11136,7 +11249,7 @@
|
|
|
11136
11249
|
},
|
|
11137
11250
|
{
|
|
11138
11251
|
"name": "messageOverrides",
|
|
11139
|
-
"description": "Replace localized message strings with your own strings
|
|
11252
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
11140
11253
|
"type": "Record<string, unknown>"
|
|
11141
11254
|
},
|
|
11142
11255
|
{
|
|
@@ -11145,6 +11258,7 @@
|
|
|
11145
11258
|
},
|
|
11146
11259
|
{
|
|
11147
11260
|
"name": "referenceElement",
|
|
11261
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
11148
11262
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
11149
11263
|
},
|
|
11150
11264
|
{
|
|
@@ -11278,6 +11392,7 @@
|
|
|
11278
11392
|
},
|
|
11279
11393
|
{
|
|
11280
11394
|
"name": "reference-element",
|
|
11395
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
11281
11396
|
"value": {
|
|
11282
11397
|
"type": "string"
|
|
11283
11398
|
}
|
|
@@ -11376,6 +11491,7 @@
|
|
|
11376
11491
|
},
|
|
11377
11492
|
{
|
|
11378
11493
|
"name": "referenceElement",
|
|
11494
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
11379
11495
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
11380
11496
|
},
|
|
11381
11497
|
{
|
|
@@ -11405,7 +11521,7 @@
|
|
|
11405
11521
|
},
|
|
11406
11522
|
{
|
|
11407
11523
|
"name": "arcgis-scene",
|
|
11408
|
-
"description": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Getting started](https://developers.arcgis.com/javascript/latest/get-started-overview/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewChange** - This event is for view related property changes:\n[zoom](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#zoom),\n[scale](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#scale),\n[center](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#center),\n[rotation](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#rotation),\n[extent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#camera),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewpoint).\nThis event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#stationary)\ntoggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#ready)\nproperty and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) property is changed.\n\n```\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33. Use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup).\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its\n[map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map),\n[popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component is created and ready.\nThis method takes two input parameters: a `callback` function and an `errback` function.\n- `whenAnalysisView(analysis: __esri.AreaMeasurementAnalysis | __esri.DimensionAnalysis | __esri.DirectLineMeasurementAnalysis | __esri.LineOfSightAnalysis | __esri.SliceAnalysis | __esri.ViewshedAnalysis): Promise<__esri.AreaMeasurementAnalysisView3D | __esri.DimensionAnalysisView3D | __esri.DirectLineMeasurementAnalysisView3D | __esri.LineOfSightAnalysisView3D | __esri.SliceAnalysisView3D | __esri.ViewshedAnalysisView3D>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)",
|
|
11524
|
+
"description": "The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[ArcGIS Map component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n basemap=\"satellite\"\n ground=\"world-elevation\"\n camera-position=\"12.3808, 46.3959, 4400\"\n camera-tilt=\"75\"\n camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n <arcgis-layer-list position=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/api-reference/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nconst layer = new GraphicsLayer({ title: \"My layer\"});\nviewElement.map.add(layer);\n```\n\n**See also**\n\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisViewAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create)\n- **arcgisViewAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes: [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[camera](#camera), [viewpoint](#viewpoint). This event will also emit if [stationary](#stationary) toggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n // ....\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed.\n\n### Methods\n- `addLayer(layer: __esri.Layer | Promise<any>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](#popup).\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its [map](#map), [popup](#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n viewElement.hitTest(event.detail).then((response) => {\n const result = response.results[0];\n if (result?.type === \"graphic\") {\n const { longitude, latitude } = result.mapPoint;\n console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n } else {\n console.log(\"Did not hit any graphic\");\n }\n });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: (): void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView(analysis: __esri.AreaMeasurementAnalysis | __esri.DimensionAnalysis | __esri.DirectLineMeasurementAnalysis | __esri.LineOfSightAnalysis | __esri.SliceAnalysis | __esri.ViewshedAnalysis | __esri.VolumeMeasurementAnalysis): Promise<__esri.AreaMeasurementAnalysisView3D | __esri.DimensionAnalysisView3D | __esri.DirectLineMeasurementAnalysisView3D | __esri.LineOfSightAnalysisView3D | __esri.SliceAnalysisView3D | __esri.ViewshedAnalysisView3D | __esri.VolumeMeasurementAnalysisView3D>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#whenLayerView)",
|
|
11409
11525
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/",
|
|
11410
11526
|
"attributes": [
|
|
11411
11527
|
{
|
|
@@ -11433,35 +11549,35 @@
|
|
|
11433
11549
|
},
|
|
11434
11550
|
{
|
|
11435
11551
|
"name": "camera-fov",
|
|
11436
|
-
"description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11552
|
+
"description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov)",
|
|
11437
11553
|
"value": {
|
|
11438
11554
|
"type": "number"
|
|
11439
11555
|
}
|
|
11440
11556
|
},
|
|
11441
11557
|
{
|
|
11442
11558
|
"name": "camera-heading",
|
|
11443
|
-
"description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11559
|
+
"description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading)",
|
|
11444
11560
|
"value": {
|
|
11445
11561
|
"type": "number"
|
|
11446
11562
|
}
|
|
11447
11563
|
},
|
|
11448
11564
|
{
|
|
11449
11565
|
"name": "camera-position",
|
|
11450
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
11566
|
+
"description": "The position of the camera defined by a map point. It can either be set with a\n[Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)",
|
|
11451
11567
|
"value": {
|
|
11452
11568
|
"type": "string"
|
|
11453
11569
|
}
|
|
11454
11570
|
},
|
|
11455
11571
|
{
|
|
11456
11572
|
"name": "camera-tilt",
|
|
11457
|
-
"description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11573
|
+
"description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt)",
|
|
11458
11574
|
"value": {
|
|
11459
11575
|
"type": "number"
|
|
11460
11576
|
}
|
|
11461
11577
|
},
|
|
11462
11578
|
{
|
|
11463
11579
|
"name": "center",
|
|
11464
|
-
"description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11580
|
+
"description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)",
|
|
11465
11581
|
"value": {
|
|
11466
11582
|
"type": "string"
|
|
11467
11583
|
}
|
|
@@ -11476,7 +11592,7 @@
|
|
|
11476
11592
|
},
|
|
11477
11593
|
{
|
|
11478
11594
|
"name": "ground",
|
|
11479
|
-
"description": "Specifies the surface properties for the map. It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
|
|
11595
|
+
"description": "Specifies the surface properties for the [map](#map). It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
|
|
11480
11596
|
"value": {
|
|
11481
11597
|
"type": "string"
|
|
11482
11598
|
}
|
|
@@ -11498,7 +11614,7 @@
|
|
|
11498
11614
|
},
|
|
11499
11615
|
{
|
|
11500
11616
|
"name": "quality-profile",
|
|
11501
|
-
"description": "
|
|
11617
|
+
"description": "Scenes can be drawn in three different quality modes: `high`, `medium` and `low`.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile)",
|
|
11502
11618
|
"value": {
|
|
11503
11619
|
"type": [
|
|
11504
11620
|
"\"high\"",
|
|
@@ -11509,7 +11625,7 @@
|
|
|
11509
11625
|
},
|
|
11510
11626
|
{
|
|
11511
11627
|
"name": "scale",
|
|
11512
|
-
"description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](
|
|
11628
|
+
"description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)",
|
|
11513
11629
|
"value": {
|
|
11514
11630
|
"type": "number"
|
|
11515
11631
|
}
|
|
@@ -11535,22 +11651,37 @@
|
|
|
11535
11651
|
},
|
|
11536
11652
|
{
|
|
11537
11653
|
"name": "zoom",
|
|
11538
|
-
"description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](
|
|
11654
|
+
"description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\nSetting this property in conjunction with [center](#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom)",
|
|
11539
11655
|
"value": {
|
|
11540
11656
|
"type": "number"
|
|
11541
11657
|
}
|
|
11542
11658
|
}
|
|
11543
11659
|
],
|
|
11544
11660
|
"events": [
|
|
11661
|
+
{
|
|
11662
|
+
"name": "arcgisViewAnalysisViewCreate",
|
|
11663
|
+
"type": "ViewAnalysisViewCreateEvent",
|
|
11664
|
+
"description": "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)"
|
|
11665
|
+
},
|
|
11666
|
+
{
|
|
11667
|
+
"name": "arcgisViewAnalysisViewCreateError",
|
|
11668
|
+
"type": "ViewAnalysisViewCreateErrorEvent",
|
|
11669
|
+
"description": "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)"
|
|
11670
|
+
},
|
|
11671
|
+
{
|
|
11672
|
+
"name": "arcgisViewAnalysisViewDestroy",
|
|
11673
|
+
"type": "ViewAnalysisViewDestroyEvent",
|
|
11674
|
+
"description": "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)"
|
|
11675
|
+
},
|
|
11545
11676
|
{
|
|
11546
11677
|
"name": "arcgisViewChange",
|
|
11547
11678
|
"type": "void",
|
|
11548
|
-
"description": "This event is for view related property changes
|
|
11679
|
+
"description": "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`."
|
|
11549
11680
|
},
|
|
11550
11681
|
{
|
|
11551
11682
|
"name": "arcgisViewClick",
|
|
11552
11683
|
"type": "ViewClickEvent",
|
|
11553
|
-
"description": "Fires after a user clicks on the view.\n\n
|
|
11684
|
+
"description": "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)"
|
|
11554
11685
|
},
|
|
11555
11686
|
{
|
|
11556
11687
|
"name": "arcgisViewDoubleClick",
|
|
@@ -11635,7 +11766,7 @@
|
|
|
11635
11766
|
{
|
|
11636
11767
|
"name": "arcgisViewReadyChange",
|
|
11637
11768
|
"type": "void",
|
|
11638
|
-
"description": "This event is for the [ready](
|
|
11769
|
+
"description": "This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed."
|
|
11639
11770
|
}
|
|
11640
11771
|
],
|
|
11641
11772
|
"js": {
|
|
@@ -11653,7 +11784,7 @@
|
|
|
11653
11784
|
{
|
|
11654
11785
|
"name": "analyses",
|
|
11655
11786
|
"description": "Allows for adding analyses directly to the default analyses in the View.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#analyses)",
|
|
11656
|
-
"type": "Collection<AreaMeasurementAnalysis | DimensionAnalysis | DirectLineMeasurementAnalysis | LineOfSightAnalysis | SliceAnalysis | ViewshedAnalysis>"
|
|
11787
|
+
"type": "Collection<AreaMeasurementAnalysis | DimensionAnalysis | DirectLineMeasurementAnalysis | LineOfSightAnalysis | SliceAnalysis | ViewshedAnalysis | VolumeMeasurementAnalysis>"
|
|
11657
11788
|
},
|
|
11658
11789
|
{
|
|
11659
11790
|
"name": "autoDestroyDisabled",
|
|
@@ -11672,37 +11803,37 @@
|
|
|
11672
11803
|
},
|
|
11673
11804
|
{
|
|
11674
11805
|
"name": "camera",
|
|
11675
|
-
"description": "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
|
|
11806
|
+
"description": "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.",
|
|
11676
11807
|
"type": "Camera"
|
|
11677
11808
|
},
|
|
11678
11809
|
{
|
|
11679
11810
|
"name": "cameraFov",
|
|
11680
|
-
"description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11811
|
+
"description": "The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#fov)",
|
|
11681
11812
|
"type": "number"
|
|
11682
11813
|
},
|
|
11683
11814
|
{
|
|
11684
11815
|
"name": "cameraHeading",
|
|
11685
|
-
"description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11816
|
+
"description": "The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#heading)",
|
|
11686
11817
|
"type": "number"
|
|
11687
11818
|
},
|
|
11688
11819
|
{
|
|
11689
11820
|
"name": "cameraPosition",
|
|
11690
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
11821
|
+
"description": "The position of the camera defined by a map point. It can either be set with a\n[Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)",
|
|
11691
11822
|
"type": "Array<number> | Point | string"
|
|
11692
11823
|
},
|
|
11693
11824
|
{
|
|
11694
11825
|
"name": "cameraTilt",
|
|
11695
|
-
"description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11826
|
+
"description": "The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#tilt)",
|
|
11696
11827
|
"type": "number"
|
|
11697
11828
|
},
|
|
11698
11829
|
{
|
|
11699
11830
|
"name": "center",
|
|
11700
|
-
"description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](
|
|
11831
|
+
"description": "Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)",
|
|
11701
11832
|
"type": "Array<number> | Point | string"
|
|
11702
11833
|
},
|
|
11703
11834
|
{
|
|
11704
11835
|
"name": "clippingArea",
|
|
11705
|
-
"description": "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
|
|
11836
|
+
"description": "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)",
|
|
11706
11837
|
"type": "Extent"
|
|
11707
11838
|
},
|
|
11708
11839
|
{
|
|
@@ -11717,12 +11848,12 @@
|
|
|
11717
11848
|
},
|
|
11718
11849
|
{
|
|
11719
11850
|
"name": "environment",
|
|
11720
|
-
"description": "Specifies various properties of the environment's visualization
|
|
11851
|
+
"description": "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)",
|
|
11721
11852
|
"type": "SceneViewEnvironment"
|
|
11722
11853
|
},
|
|
11723
11854
|
{
|
|
11724
11855
|
"name": "extent",
|
|
11725
|
-
"description": "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()](
|
|
11856
|
+
"description": "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)",
|
|
11726
11857
|
"type": "Extent"
|
|
11727
11858
|
},
|
|
11728
11859
|
{
|
|
@@ -11735,6 +11866,11 @@
|
|
|
11735
11866
|
"description": "Applies a display filter on the view for a specific set of floor levels.\nIt can filter the map display on floor-aware layers by zero or more level IDs.",
|
|
11736
11867
|
"type": "Collection<string>"
|
|
11737
11868
|
},
|
|
11869
|
+
{
|
|
11870
|
+
"name": "focusAreas",
|
|
11871
|
+
"description": "A container of all [focus areas](https://developers.arcgis.com/javascript/latest/api-reference/esri-effects-FocusAreas.html) present in the map.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#focusAreas)",
|
|
11872
|
+
"type": "FocusAreas"
|
|
11873
|
+
},
|
|
11738
11874
|
{
|
|
11739
11875
|
"name": "gamepad",
|
|
11740
11876
|
"description": "Gamepad input specific configuration settings.",
|
|
@@ -11742,12 +11878,12 @@
|
|
|
11742
11878
|
},
|
|
11743
11879
|
{
|
|
11744
11880
|
"name": "graphics",
|
|
11745
|
-
"description": "Allows for adding graphics directly to the default graphics in the view
|
|
11881
|
+
"description": "Allows for adding graphics directly to the default graphics in the view.",
|
|
11746
11882
|
"type": "Collection<Graphic>"
|
|
11747
11883
|
},
|
|
11748
11884
|
{
|
|
11749
11885
|
"name": "ground",
|
|
11750
|
-
"description": "Specifies the surface properties for the map. It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
|
|
11886
|
+
"description": "Specifies the surface properties for the [map](#map). It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\ninstance or a string with one of the following values:\n * `\"world-elevation\"`\n * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#ground)",
|
|
11751
11887
|
"type": "Ground | string"
|
|
11752
11888
|
},
|
|
11753
11889
|
{
|
|
@@ -11777,7 +11913,7 @@
|
|
|
11777
11913
|
},
|
|
11778
11914
|
{
|
|
11779
11915
|
"name": "layerViews",
|
|
11780
|
-
"description": "A collection containing a hierarchical list of all the created\n[LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the\n[operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the map.",
|
|
11916
|
+
"description": "A collection containing a hierarchical list of all the created\n[LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html) of the\n[operational layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers) in the [map](#map).",
|
|
11781
11917
|
"type": "Collection<LayerView>"
|
|
11782
11918
|
},
|
|
11783
11919
|
{
|
|
@@ -11812,7 +11948,7 @@
|
|
|
11812
11948
|
},
|
|
11813
11949
|
{
|
|
11814
11950
|
"name": "popup",
|
|
11815
|
-
"description": "A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html)
|
|
11951
|
+
"description": "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)",
|
|
11816
11952
|
"type": "Popup"
|
|
11817
11953
|
},
|
|
11818
11954
|
{
|
|
@@ -11822,7 +11958,7 @@
|
|
|
11822
11958
|
},
|
|
11823
11959
|
{
|
|
11824
11960
|
"name": "qualityProfile",
|
|
11825
|
-
"description": "
|
|
11961
|
+
"description": "Scenes can be drawn in three different quality modes: `high`, `medium` and `low`.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#qualityProfile)",
|
|
11826
11962
|
"type": "\"high\" | \"low\" | \"medium\""
|
|
11827
11963
|
},
|
|
11828
11964
|
{
|
|
@@ -11832,12 +11968,12 @@
|
|
|
11832
11968
|
},
|
|
11833
11969
|
{
|
|
11834
11970
|
"name": "resolution",
|
|
11835
|
-
"description": "Represents the current value of one pixel in the unit of the view's\n[spatialReference](
|
|
11971
|
+
"description": "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).",
|
|
11836
11972
|
"type": "number"
|
|
11837
11973
|
},
|
|
11838
11974
|
{
|
|
11839
11975
|
"name": "scale",
|
|
11840
|
-
"description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](
|
|
11976
|
+
"description": "Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)",
|
|
11841
11977
|
"type": "number"
|
|
11842
11978
|
},
|
|
11843
11979
|
{
|
|
@@ -11857,7 +11993,7 @@
|
|
|
11857
11993
|
},
|
|
11858
11994
|
{
|
|
11859
11995
|
"name": "theme",
|
|
11860
|
-
"description": "This property specifies the base colors used by some
|
|
11996
|
+
"description": "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.",
|
|
11861
11997
|
"type": "Theme"
|
|
11862
11998
|
},
|
|
11863
11999
|
{
|
|
@@ -11882,30 +12018,45 @@
|
|
|
11882
12018
|
},
|
|
11883
12019
|
{
|
|
11884
12020
|
"name": "viewpoint",
|
|
11885
|
-
"description": "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()](
|
|
12021
|
+
"description": "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)",
|
|
11886
12022
|
"type": "Viewpoint"
|
|
11887
12023
|
},
|
|
11888
12024
|
{
|
|
11889
12025
|
"name": "visibleArea",
|
|
11890
|
-
"description": "The visibleArea represents the visible portion of a [map](
|
|
12026
|
+
"description": "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)",
|
|
11891
12027
|
"type": "Polygon"
|
|
11892
12028
|
},
|
|
11893
12029
|
{
|
|
11894
12030
|
"name": "zoom",
|
|
11895
|
-
"description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](
|
|
12031
|
+
"description": "Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](#goTo) method.\nSetting this property in conjunction with [center](#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom)",
|
|
11896
12032
|
"type": "number"
|
|
11897
12033
|
}
|
|
11898
12034
|
],
|
|
11899
12035
|
"events": [
|
|
12036
|
+
{
|
|
12037
|
+
"name": "arcgisViewAnalysisViewCreate",
|
|
12038
|
+
"type": "ViewAnalysisViewCreateEvent",
|
|
12039
|
+
"description": "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)"
|
|
12040
|
+
},
|
|
12041
|
+
{
|
|
12042
|
+
"name": "arcgisViewAnalysisViewCreateError",
|
|
12043
|
+
"type": "ViewAnalysisViewCreateErrorEvent",
|
|
12044
|
+
"description": "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)"
|
|
12045
|
+
},
|
|
12046
|
+
{
|
|
12047
|
+
"name": "arcgisViewAnalysisViewDestroy",
|
|
12048
|
+
"type": "ViewAnalysisViewDestroyEvent",
|
|
12049
|
+
"description": "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)"
|
|
12050
|
+
},
|
|
11900
12051
|
{
|
|
11901
12052
|
"name": "arcgisViewChange",
|
|
11902
12053
|
"type": "void",
|
|
11903
|
-
"description": "This event is for view related property changes
|
|
12054
|
+
"description": "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`."
|
|
11904
12055
|
},
|
|
11905
12056
|
{
|
|
11906
12057
|
"name": "arcgisViewClick",
|
|
11907
12058
|
"type": "ViewClickEvent",
|
|
11908
|
-
"description": "Fires after a user clicks on the view.\n\n
|
|
12059
|
+
"description": "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)"
|
|
11909
12060
|
},
|
|
11910
12061
|
{
|
|
11911
12062
|
"name": "arcgisViewDoubleClick",
|
|
@@ -11990,14 +12141,14 @@
|
|
|
11990
12141
|
{
|
|
11991
12142
|
"name": "arcgisViewReadyChange",
|
|
11992
12143
|
"type": "void",
|
|
11993
|
-
"description": "This event is for the [ready](
|
|
12144
|
+
"description": "This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed."
|
|
11994
12145
|
}
|
|
11995
12146
|
]
|
|
11996
12147
|
}
|
|
11997
12148
|
},
|
|
11998
12149
|
{
|
|
11999
12150
|
"name": "arcgis-search",
|
|
12000
|
-
"description": "The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,\nBuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the\nfindAddressCandidates operation is used, whereas queries are used on feature layers.\n\nBy default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.\nIf a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey\nis present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property.\n\nThe Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data\nsources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property\nof the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.\nHowever, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a\nspecified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.\nThis behavior can be changed by using the localSearchDisabled property.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSearchClear** - Fires when a result is cleared from the input box or a new result is selected.\n- **arcgisSearchComplete** - Fires when the [search()](#search) method is called and returns its results.\n- **arcgisSearchStart** - Fires when the [search()](#search) method starts.\n- **arcgisSelectResult** - Fires when a search result is selected.\n- **arcgisSuggestComplete** - Fires when the [suggest](#suggest) method is called and returns its results.\n- **arcgisSuggestStart** - Fires when the [suggest()](#suggest) method starts.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `setFocus(): Promise<void>` - Brings focus to the component's text input.",
|
|
12151
|
+
"description": "The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,\nBuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the\nfindAddressCandidates operation is used, whereas queries are used on feature layers.\n\nBy default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.\nIf a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey\nis present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property.\n\nThe Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data\nsources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property\nof the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.\nHowever, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a\nspecified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.\nThis behavior can be changed by using the localSearchDisabled property.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSearchClear** - Fires when a result is cleared from the input box or a new result is selected.\n- **arcgisSearchComplete** - Fires when the [search()](#search) method is called and returns its results.\n- **arcgisSearchStart** - Fires when the [search()](#search) method starts.\n- **arcgisSelectResult** - Fires when a search result is selected.\n- **arcgisSuggestComplete** - Fires when the [suggest](#suggest) method is called and returns its results.\n- **arcgisSuggestStart** - Fires when the [suggest()](#suggest) method starts.\n\n### Methods\n- `clear(): void` - Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.\nIt also hides any open menus.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `search(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | Nil | number[] | string): Promise<__esri.SearchResponse | Nil>` - Depending on the sources specified, search() queries the feature layer(s) and/or performs\naddress matching using any specified [locator(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) and\nreturns any applicable results.\n- `setFocus(): Promise<void>` - Brings focus to the component's text input.\n- `suggest(query?: string): Promise<__esri.SuggestResponse | Nil>` - Performs a suggest() request on the active Locator. It also uses the current value of\nthe component or one that is passed in.\n\nSuggestions are available if working with a 10.3 or greater geocoding service that has\n[suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e.\n`supportsPagination = true`.",
|
|
12001
12152
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/",
|
|
12002
12153
|
"attributes": [
|
|
12003
12154
|
{
|
|
@@ -12037,9 +12188,17 @@
|
|
|
12037
12188
|
}
|
|
12038
12189
|
},
|
|
12039
12190
|
{
|
|
12040
|
-
"name": "auto-
|
|
12191
|
+
"name": "auto-navigate-disabled",
|
|
12192
|
+
"description": "Indicates whether to automatically navigate to the selected result.",
|
|
12193
|
+
"default": "false",
|
|
12194
|
+
"value": {
|
|
12195
|
+
"type": "boolean"
|
|
12196
|
+
}
|
|
12197
|
+
},
|
|
12198
|
+
{
|
|
12199
|
+
"name": "auto-select-disabled",
|
|
12041
12200
|
"description": "Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
|
|
12042
|
-
"default": "
|
|
12201
|
+
"default": "false",
|
|
12043
12202
|
"value": {
|
|
12044
12203
|
"type": "boolean"
|
|
12045
12204
|
}
|
|
@@ -12061,9 +12220,9 @@
|
|
|
12061
12220
|
}
|
|
12062
12221
|
},
|
|
12063
12222
|
{
|
|
12064
|
-
"name": "include-default-sources",
|
|
12223
|
+
"name": "include-default-sources-disabled",
|
|
12065
12224
|
"description": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).",
|
|
12066
|
-
"default": "
|
|
12225
|
+
"default": "false",
|
|
12067
12226
|
"value": {
|
|
12068
12227
|
"type": "boolean"
|
|
12069
12228
|
}
|
|
@@ -12076,9 +12235,9 @@
|
|
|
12076
12235
|
}
|
|
12077
12236
|
},
|
|
12078
12237
|
{
|
|
12079
|
-
"name": "location-
|
|
12238
|
+
"name": "location-disabled",
|
|
12080
12239
|
"description": "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:::",
|
|
12081
|
-
"default": "
|
|
12240
|
+
"default": "false",
|
|
12082
12241
|
"value": {
|
|
12083
12242
|
"type": "boolean"
|
|
12084
12243
|
}
|
|
@@ -12108,9 +12267,9 @@
|
|
|
12108
12267
|
}
|
|
12109
12268
|
},
|
|
12110
12269
|
{
|
|
12111
|
-
"name": "popup-
|
|
12270
|
+
"name": "popup-disabled",
|
|
12112
12271
|
"description": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can\nbe clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).",
|
|
12113
|
-
"default": "
|
|
12272
|
+
"default": "false",
|
|
12114
12273
|
"value": {
|
|
12115
12274
|
"type": "boolean"
|
|
12116
12275
|
}
|
|
@@ -12134,22 +12293,23 @@
|
|
|
12134
12293
|
},
|
|
12135
12294
|
{
|
|
12136
12295
|
"name": "reference-element",
|
|
12296
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
12137
12297
|
"value": {
|
|
12138
12298
|
"type": "string"
|
|
12139
12299
|
}
|
|
12140
12300
|
},
|
|
12141
12301
|
{
|
|
12142
|
-
"name": "result-graphic-
|
|
12302
|
+
"name": "result-graphic-disabled",
|
|
12143
12303
|
"description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
|
|
12144
|
-
"default": "
|
|
12304
|
+
"default": "false",
|
|
12145
12305
|
"value": {
|
|
12146
12306
|
"type": "boolean"
|
|
12147
12307
|
}
|
|
12148
12308
|
},
|
|
12149
12309
|
{
|
|
12150
|
-
"name": "search-all-
|
|
12310
|
+
"name": "search-all-disabled",
|
|
12151
12311
|
"description": "Indicates whether to display the option to search all sources. When `true`, the \"All\" option\nis displayed by default:\n\n\n\nWhen `false`, no option to search all sources at once is available:\n\n",
|
|
12152
|
-
"default": "
|
|
12312
|
+
"default": "false",
|
|
12153
12313
|
"value": {
|
|
12154
12314
|
"type": "boolean"
|
|
12155
12315
|
}
|
|
@@ -12163,7 +12323,7 @@
|
|
|
12163
12323
|
},
|
|
12164
12324
|
{
|
|
12165
12325
|
"name": "state",
|
|
12166
|
-
"description": "The current state
|
|
12326
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
12167
12327
|
"default": "\"ready\"",
|
|
12168
12328
|
"value": {
|
|
12169
12329
|
"type": [
|
|
@@ -12175,9 +12335,9 @@
|
|
|
12175
12335
|
}
|
|
12176
12336
|
},
|
|
12177
12337
|
{
|
|
12178
|
-
"name": "suggestions-
|
|
12338
|
+
"name": "suggestions-disabled",
|
|
12179
12339
|
"description": "Enable suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
|
|
12180
|
-
"default": "
|
|
12340
|
+
"default": "false",
|
|
12181
12341
|
"value": {
|
|
12182
12342
|
"type": "boolean"
|
|
12183
12343
|
}
|
|
@@ -12258,7 +12418,12 @@
|
|
|
12258
12418
|
"type": "boolean"
|
|
12259
12419
|
},
|
|
12260
12420
|
{
|
|
12261
|
-
"name": "
|
|
12421
|
+
"name": "autoNavigateDisabled",
|
|
12422
|
+
"description": "Indicates whether to automatically navigate to the selected result.",
|
|
12423
|
+
"type": "boolean"
|
|
12424
|
+
},
|
|
12425
|
+
{
|
|
12426
|
+
"name": "autoSelectDisabled",
|
|
12262
12427
|
"description": "Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.",
|
|
12263
12428
|
"type": "boolean"
|
|
12264
12429
|
},
|
|
@@ -12283,7 +12448,7 @@
|
|
|
12283
12448
|
"type": "string"
|
|
12284
12449
|
},
|
|
12285
12450
|
{
|
|
12286
|
-
"name": "
|
|
12451
|
+
"name": "includeDefaultSourcesDisabled",
|
|
12287
12452
|
"description": "Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).",
|
|
12288
12453
|
"type": "Function | boolean"
|
|
12289
12454
|
},
|
|
@@ -12293,7 +12458,7 @@
|
|
|
12293
12458
|
"type": "string"
|
|
12294
12459
|
},
|
|
12295
12460
|
{
|
|
12296
|
-
"name": "
|
|
12461
|
+
"name": "locationDisabled",
|
|
12297
12462
|
"description": "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:::",
|
|
12298
12463
|
"type": "boolean"
|
|
12299
12464
|
},
|
|
@@ -12309,7 +12474,7 @@
|
|
|
12309
12474
|
},
|
|
12310
12475
|
{
|
|
12311
12476
|
"name": "messageOverrides",
|
|
12312
|
-
"description": "Replace localized message strings with your own strings
|
|
12477
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
12313
12478
|
"type": "Record<string, unknown>"
|
|
12314
12479
|
},
|
|
12315
12480
|
{
|
|
@@ -12318,7 +12483,7 @@
|
|
|
12318
12483
|
"type": "number"
|
|
12319
12484
|
},
|
|
12320
12485
|
{
|
|
12321
|
-
"name": "
|
|
12486
|
+
"name": "popupDisabled",
|
|
12322
12487
|
"description": "Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can\nbe clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).",
|
|
12323
12488
|
"type": "boolean"
|
|
12324
12489
|
},
|
|
@@ -12338,6 +12503,7 @@
|
|
|
12338
12503
|
},
|
|
12339
12504
|
{
|
|
12340
12505
|
"name": "referenceElement",
|
|
12506
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
12341
12507
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
12342
12508
|
},
|
|
12343
12509
|
{
|
|
@@ -12346,7 +12512,7 @@
|
|
|
12346
12512
|
"type": "Graphic"
|
|
12347
12513
|
},
|
|
12348
12514
|
{
|
|
12349
|
-
"name": "
|
|
12515
|
+
"name": "resultGraphicDisabled",
|
|
12350
12516
|
"description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
|
|
12351
12517
|
"type": "boolean"
|
|
12352
12518
|
},
|
|
@@ -12356,7 +12522,7 @@
|
|
|
12356
12522
|
"type": "Array<SearchResults>"
|
|
12357
12523
|
},
|
|
12358
12524
|
{
|
|
12359
|
-
"name": "
|
|
12525
|
+
"name": "searchAllDisabled",
|
|
12360
12526
|
"description": "Indicates whether to display the option to search all sources. When `true`, the \"All\" option\nis displayed by default:\n\n\n\nWhen `false`, no option to search all sources at once is available:\n\n",
|
|
12361
12527
|
"type": "boolean"
|
|
12362
12528
|
},
|
|
@@ -12377,7 +12543,7 @@
|
|
|
12377
12543
|
},
|
|
12378
12544
|
{
|
|
12379
12545
|
"name": "state",
|
|
12380
|
-
"description": "The current state
|
|
12546
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
12381
12547
|
"type": "\"disabled\" | \"loading\" | \"ready\" | \"searching\""
|
|
12382
12548
|
},
|
|
12383
12549
|
{
|
|
@@ -12386,7 +12552,7 @@
|
|
|
12386
12552
|
"type": "Array<SuggestResults>"
|
|
12387
12553
|
},
|
|
12388
12554
|
{
|
|
12389
|
-
"name": "
|
|
12555
|
+
"name": "suggestionsDisabled",
|
|
12390
12556
|
"description": "Enable suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.",
|
|
12391
12557
|
"type": "boolean"
|
|
12392
12558
|
}
|
|
@@ -12465,7 +12631,7 @@
|
|
|
12465
12631
|
},
|
|
12466
12632
|
{
|
|
12467
12633
|
"name": "messages",
|
|
12468
|
-
"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\" | \"
|
|
12634
|
+
"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})"
|
|
12469
12635
|
},
|
|
12470
12636
|
{
|
|
12471
12637
|
"name": "viewModel",
|
|
@@ -12483,7 +12649,7 @@
|
|
|
12483
12649
|
},
|
|
12484
12650
|
{
|
|
12485
12651
|
"name": "arcgis-shadow-cast",
|
|
12486
|
-
"description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [
|
|
12652
|
+
"description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nThis type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.\n\nThe component calculates the cumulative shadows for a time range during a single day. The user can\nconfigure the time range and select a calendar date. This time range and calendar date are only used\nfor the shadow analysis and are not connected to the lighting in the scene.\nTo control the lighting in the scene, the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component can be used.\nChanging the timezone in the component updates the visualization by interpreting the time range as being\nin that timezone. This behavior is different from the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component,\nwhere selecting a timezone updates the [environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) date and time according to the camera position.\n\nThe component provides three [visualization modes](#visualizationType): threshold, duration, and discrete mode.\n\nIn the **threshold** mode, only the areas that receive\nshadows for more than a certain amount of time are displayed. In the image below, on May 1, 2021 the red areas receive\nshadow for more than 4 hours within the time interval of 10AM to 4PM.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Total shadow duration** mode displays the duration of the cumulative shadow using opacity: areas that don't\nreceive any shadow are fully transparent and areas that receive a maximum amount of shadow have a default opacity\nof 0.7. The values in between are interpolated. Hovering over the Scene will display a tooltip showing the\namount of time that location is in shadow, rounded to 15-minute intervals. In this mode, the visualization\ncan display shadow cast in a continuous way or in 1-hour intervals.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Discrete shadows** is a third visualization mode which displays individual shadows at a given time interval.\nFor example, setting the time range to 10AM-11AM and the visualization time interval to 30 minutes will display\nshadows for 10AM, 10:30AM and 11:00AM.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\nThe defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay), [endTimeOfDay](#endTimeOfDay), and [visualizationType](#visualizationType) properties.\n\n**Known limitations**\n\n* Shadow Cast is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* Terrain does not cast shadows and it is therefore not taken into account in this analysis.\n* The component does not take into account the daylight savings.\nUse the timezone dropdown to adjust the offset from the Coordinated Universal Time (UTC) and account for the daylight saving time.\n* The timezone is automatically detected by the component based on the camera location. In some situations, this might not be accurate.\nIn case of an inaccurate timezone, users can set it manually using the timezone dropdown.\n\n**See also**\n\n- [Sample - Shadow cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getDuration(point: __esri.Point): Promise<number>` - Returns the time (in milliseconds) spent in shadow for a certain point on the screen.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#getDuration)\n- `start(): Promise<void>` - Starts the component. While running, it will automatically perform shadow accumulation.\n- `stop(): Promise<void>` - Stops the component.",
|
|
12487
12653
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/",
|
|
12488
12654
|
"attributes": [
|
|
12489
12655
|
{
|
|
@@ -12496,6 +12662,7 @@
|
|
|
12496
12662
|
},
|
|
12497
12663
|
{
|
|
12498
12664
|
"name": "date",
|
|
12665
|
+
"description": "The calendar date used to calculate the shadow cast. This date excludes the time. If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.\nIf no date is set, then it defaults to the current date in local system time.\n\n_See also_\n\n* [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)",
|
|
12499
12666
|
"value": {
|
|
12500
12667
|
"type": [
|
|
12501
12668
|
"number",
|
|
@@ -12505,7 +12672,7 @@
|
|
|
12505
12672
|
},
|
|
12506
12673
|
{
|
|
12507
12674
|
"name": "end-time-of-day",
|
|
12508
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
12675
|
+
"description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)",
|
|
12509
12676
|
"default": "16 * 3600 * 1000",
|
|
12510
12677
|
"value": {
|
|
12511
12678
|
"type": "number"
|
|
@@ -12591,7 +12758,7 @@
|
|
|
12591
12758
|
},
|
|
12592
12759
|
{
|
|
12593
12760
|
"name": "icon",
|
|
12594
|
-
"description": "Icon which represents the
|
|
12761
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
12595
12762
|
"default": "\"measure-building-height-shadow\"",
|
|
12596
12763
|
"value": {
|
|
12597
12764
|
"type": "string"
|
|
@@ -12599,7 +12766,7 @@
|
|
|
12599
12766
|
},
|
|
12600
12767
|
{
|
|
12601
12768
|
"name": "label",
|
|
12602
|
-
"description": "The
|
|
12769
|
+
"description": "The component's default label.",
|
|
12603
12770
|
"value": {
|
|
12604
12771
|
"type": "string"
|
|
12605
12772
|
}
|
|
@@ -12623,13 +12790,14 @@
|
|
|
12623
12790
|
},
|
|
12624
12791
|
{
|
|
12625
12792
|
"name": "reference-element",
|
|
12793
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
12626
12794
|
"value": {
|
|
12627
12795
|
"type": "string"
|
|
12628
12796
|
}
|
|
12629
12797
|
},
|
|
12630
12798
|
{
|
|
12631
12799
|
"name": "start-time-of-day",
|
|
12632
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
12800
|
+
"description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)",
|
|
12633
12801
|
"default": "10 * 3600 * 1000",
|
|
12634
12802
|
"value": {
|
|
12635
12803
|
"type": "number"
|
|
@@ -12637,7 +12805,7 @@
|
|
|
12637
12805
|
},
|
|
12638
12806
|
{
|
|
12639
12807
|
"name": "state",
|
|
12640
|
-
"description": "The
|
|
12808
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
12641
12809
|
"default": "\"disabled\"",
|
|
12642
12810
|
"value": {
|
|
12643
12811
|
"type": [
|
|
@@ -12648,14 +12816,14 @@
|
|
|
12648
12816
|
},
|
|
12649
12817
|
{
|
|
12650
12818
|
"name": "utc-offset",
|
|
12651
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
12819
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
12652
12820
|
"value": {
|
|
12653
12821
|
"type": "number"
|
|
12654
12822
|
}
|
|
12655
12823
|
},
|
|
12656
12824
|
{
|
|
12657
12825
|
"name": "visualization-type",
|
|
12658
|
-
"description": "Type of visualization to use when showing the shadows
|
|
12826
|
+
"description": "Type of visualization to use when showing the shadows. There are 3 types of visualization:\n* `threshold` - only displays areas that receive shadows for a period longer than a given threshold value\n* `duration` - displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals\n* `discrete` - displays individual shadows cast at a given time interval",
|
|
12659
12827
|
"default": "\"threshold\"",
|
|
12660
12828
|
"value": {
|
|
12661
12829
|
"type": [
|
|
@@ -12687,21 +12855,22 @@
|
|
|
12687
12855
|
},
|
|
12688
12856
|
{
|
|
12689
12857
|
"name": "date",
|
|
12858
|
+
"description": "The calendar date used to calculate the shadow cast. This date excludes the time. If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.\nIf no date is set, then it defaults to the current date in local system time.\n\n_See also_\n\n* [Date](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)",
|
|
12690
12859
|
"type": "Date | number | string"
|
|
12691
12860
|
},
|
|
12692
12861
|
{
|
|
12693
12862
|
"name": "discreteOptions",
|
|
12694
|
-
"description": "The configuration used when the
|
|
12863
|
+
"description": "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)",
|
|
12695
12864
|
"type": "DiscreteOptions"
|
|
12696
12865
|
},
|
|
12697
12866
|
{
|
|
12698
12867
|
"name": "durationOptions",
|
|
12699
|
-
"description": "The configuration used when the
|
|
12868
|
+
"description": "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)",
|
|
12700
12869
|
"type": "DurationOptions"
|
|
12701
12870
|
},
|
|
12702
12871
|
{
|
|
12703
12872
|
"name": "endTimeOfDay",
|
|
12704
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
12873
|
+
"description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)",
|
|
12705
12874
|
"type": "number"
|
|
12706
12875
|
},
|
|
12707
12876
|
{
|
|
@@ -12751,12 +12920,12 @@
|
|
|
12751
12920
|
},
|
|
12752
12921
|
{
|
|
12753
12922
|
"name": "icon",
|
|
12754
|
-
"description": "Icon which represents the
|
|
12923
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
12755
12924
|
"type": "string"
|
|
12756
12925
|
},
|
|
12757
12926
|
{
|
|
12758
12927
|
"name": "label",
|
|
12759
|
-
"description": "The
|
|
12928
|
+
"description": "The component's default label.",
|
|
12760
12929
|
"type": "string"
|
|
12761
12930
|
},
|
|
12762
12931
|
{
|
|
@@ -12765,31 +12934,32 @@
|
|
|
12765
12934
|
},
|
|
12766
12935
|
{
|
|
12767
12936
|
"name": "referenceElement",
|
|
12937
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
12768
12938
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
12769
12939
|
},
|
|
12770
12940
|
{
|
|
12771
12941
|
"name": "startTimeOfDay",
|
|
12772
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
12942
|
+
"description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)",
|
|
12773
12943
|
"type": "number"
|
|
12774
12944
|
},
|
|
12775
12945
|
{
|
|
12776
12946
|
"name": "state",
|
|
12777
|
-
"description": "The
|
|
12947
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
12778
12948
|
"type": "\"disabled\" | \"ready\""
|
|
12779
12949
|
},
|
|
12780
12950
|
{
|
|
12781
12951
|
"name": "thresholdOptions",
|
|
12782
|
-
"description": "The configuration used when the
|
|
12952
|
+
"description": "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)",
|
|
12783
12953
|
"type": "ThresholdOptions"
|
|
12784
12954
|
},
|
|
12785
12955
|
{
|
|
12786
12956
|
"name": "utcOffset",
|
|
12787
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
12957
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
12788
12958
|
"type": "number"
|
|
12789
12959
|
},
|
|
12790
12960
|
{
|
|
12791
12961
|
"name": "visualizationType",
|
|
12792
|
-
"description": "Type of visualization to use when showing the shadows
|
|
12962
|
+
"description": "Type of visualization to use when showing the shadows. There are 3 types of visualization:\n* `threshold` - only displays areas that receive shadows for a period longer than a given threshold value\n* `duration` - displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals\n* `discrete` - displays individual shadows cast at a given time interval",
|
|
12793
12963
|
"type": "\"discrete\" | \"duration\" | \"threshold\""
|
|
12794
12964
|
}
|
|
12795
12965
|
],
|
|
@@ -13041,6 +13211,7 @@
|
|
|
13041
13211
|
},
|
|
13042
13212
|
{
|
|
13043
13213
|
"name": "reference-element",
|
|
13214
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
13044
13215
|
"value": {
|
|
13045
13216
|
"type": "string"
|
|
13046
13217
|
}
|
|
@@ -13283,6 +13454,7 @@
|
|
|
13283
13454
|
},
|
|
13284
13455
|
{
|
|
13285
13456
|
"name": "referenceElement",
|
|
13457
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
13286
13458
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
13287
13459
|
},
|
|
13288
13460
|
{
|
|
@@ -13356,7 +13528,7 @@
|
|
|
13356
13528
|
},
|
|
13357
13529
|
{
|
|
13358
13530
|
"name": "arcgis-slice",
|
|
13359
|
-
"description": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a
|
|
13531
|
+
"description": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). It applies\n[slice analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\nto any layer type, making it possible to see inside buildings or to explore geological surfaces.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nThe slicing [shape](#shape)\nis always a [plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).\nBy default, the plane is either horizontal or vertical. To allow a tilt angle for the plane, set\n[tiltEnabled](#tiltEnabled)\nto `true`. The slice hides any content in front of the surface. The handles on the sides of the plane can be used to adjust\nthe size, heading, tilt, and position of the slice plane.\nThe [SlicePlane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html)\ncan be set or retrieved using the [shape](#shape) property.\n\nOnce the slice plane is applied, layers can be excluded from the slicing. For example, by excluding the sublayers which include\ncolumns and floor slabs, the inner structure of a building can investigated.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nHolding the `Shift` key while 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/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the [shape](#shape) of the slice, effectively removing it from the view. Other properties like [excludedLayers](#excludedLayers)\nand [excludeGroundSurface](#excludeGroundSurface) are not modified.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start the interactive creation of a new slice, clearing the previous [shape](#shape).",
|
|
13360
13532
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/",
|
|
13361
13533
|
"attributes": [
|
|
13362
13534
|
{
|
|
@@ -13423,6 +13595,7 @@
|
|
|
13423
13595
|
},
|
|
13424
13596
|
{
|
|
13425
13597
|
"name": "reference-element",
|
|
13598
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
13426
13599
|
"value": {
|
|
13427
13600
|
"type": "string"
|
|
13428
13601
|
}
|
|
@@ -13465,7 +13638,7 @@
|
|
|
13465
13638
|
"properties": [
|
|
13466
13639
|
{
|
|
13467
13640
|
"name": "analysis",
|
|
13468
|
-
"description": "The [
|
|
13641
|
+
"description": "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```",
|
|
13469
13642
|
"type": "SliceAnalysis"
|
|
13470
13643
|
},
|
|
13471
13644
|
{
|
|
@@ -13499,7 +13672,7 @@
|
|
|
13499
13672
|
},
|
|
13500
13673
|
{
|
|
13501
13674
|
"name": "messageOverrides",
|
|
13502
|
-
"description": "Replace localized message strings with your own strings
|
|
13675
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
13503
13676
|
"type": "Record<string, unknown>"
|
|
13504
13677
|
},
|
|
13505
13678
|
{
|
|
@@ -13508,11 +13681,12 @@
|
|
|
13508
13681
|
},
|
|
13509
13682
|
{
|
|
13510
13683
|
"name": "referenceElement",
|
|
13684
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
13511
13685
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
13512
13686
|
},
|
|
13513
13687
|
{
|
|
13514
13688
|
"name": "shape",
|
|
13515
|
-
"description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a
|
|
13689
|
+
"description": "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).",
|
|
13516
13690
|
"type": "SlicePlane"
|
|
13517
13691
|
},
|
|
13518
13692
|
{
|
|
@@ -13660,6 +13834,7 @@
|
|
|
13660
13834
|
},
|
|
13661
13835
|
{
|
|
13662
13836
|
"name": "reference-element",
|
|
13837
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
13663
13838
|
"value": {
|
|
13664
13839
|
"type": "string"
|
|
13665
13840
|
}
|
|
@@ -13862,6 +14037,7 @@
|
|
|
13862
14037
|
},
|
|
13863
14038
|
{
|
|
13864
14039
|
"name": "referenceElement",
|
|
14040
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
13865
14041
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
13866
14042
|
},
|
|
13867
14043
|
{
|
|
@@ -13980,7 +14156,7 @@
|
|
|
13980
14156
|
},
|
|
13981
14157
|
{
|
|
13982
14158
|
"name": "arcgis-swipe",
|
|
13983
|
-
"description": "The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known
|
|
14159
|
+
"description": "The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `leadingLayers` and `trailingLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisSwipeChange** - Fires when the swipe position changes and the drag handle is released on the component.\n\n**Note:** To constantly listen to changes while dragging, use the `arcgisSwipeInput` event instead.\n- **arcgisSwipeInput** - Fires when the swipe position is updated.\nThis event is fired continuously while dragging the handle.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
13984
14160
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/",
|
|
13985
14161
|
"attributes": [
|
|
13986
14162
|
{
|
|
@@ -14061,6 +14237,7 @@
|
|
|
14061
14237
|
},
|
|
14062
14238
|
{
|
|
14063
14239
|
"name": "reference-element",
|
|
14240
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
14064
14241
|
"value": {
|
|
14065
14242
|
"type": "string"
|
|
14066
14243
|
}
|
|
@@ -14095,6 +14272,16 @@
|
|
|
14095
14272
|
"name": "arcgisReady",
|
|
14096
14273
|
"type": "void",
|
|
14097
14274
|
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
|
|
14275
|
+
},
|
|
14276
|
+
{
|
|
14277
|
+
"name": "arcgisSwipeChange",
|
|
14278
|
+
"type": "void",
|
|
14279
|
+
"description": "Fires when the swipe position changes and the drag handle is released on the component.\n\n**Note:** To constantly listen to changes while dragging, use the `arcgisSwipeInput` event instead."
|
|
14280
|
+
},
|
|
14281
|
+
{
|
|
14282
|
+
"name": "arcgisSwipeInput",
|
|
14283
|
+
"type": "void",
|
|
14284
|
+
"description": "Fires when the swipe position is updated.\nThis event is fired continuously while dragging the handle."
|
|
14098
14285
|
}
|
|
14099
14286
|
],
|
|
14100
14287
|
"js": {
|
|
@@ -14141,7 +14328,7 @@
|
|
|
14141
14328
|
},
|
|
14142
14329
|
{
|
|
14143
14330
|
"name": "messageOverrides",
|
|
14144
|
-
"description": "Replace localized message strings with your own strings
|
|
14331
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
14145
14332
|
"type": "Record<string, unknown>"
|
|
14146
14333
|
},
|
|
14147
14334
|
{
|
|
@@ -14150,6 +14337,7 @@
|
|
|
14150
14337
|
},
|
|
14151
14338
|
{
|
|
14152
14339
|
"name": "referenceElement",
|
|
14340
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
14153
14341
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
14154
14342
|
},
|
|
14155
14343
|
{
|
|
@@ -14178,6 +14366,16 @@
|
|
|
14178
14366
|
"name": "arcgisReady",
|
|
14179
14367
|
"type": "void",
|
|
14180
14368
|
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
|
|
14369
|
+
},
|
|
14370
|
+
{
|
|
14371
|
+
"name": "arcgisSwipeChange",
|
|
14372
|
+
"type": "void",
|
|
14373
|
+
"description": "Fires when the swipe position changes and the drag handle is released on the component.\n\n**Note:** To constantly listen to changes while dragging, use the `arcgisSwipeInput` event instead."
|
|
14374
|
+
},
|
|
14375
|
+
{
|
|
14376
|
+
"name": "arcgisSwipeInput",
|
|
14377
|
+
"type": "void",
|
|
14378
|
+
"description": "Fires when the swipe position is updated.\nThis event is fired continuously while dragging the handle."
|
|
14181
14379
|
}
|
|
14182
14380
|
]
|
|
14183
14381
|
}
|
|
@@ -14299,6 +14497,7 @@
|
|
|
14299
14497
|
},
|
|
14300
14498
|
{
|
|
14301
14499
|
"name": "reference-element",
|
|
14500
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
14302
14501
|
"value": {
|
|
14303
14502
|
"type": "string"
|
|
14304
14503
|
}
|
|
@@ -14469,6 +14668,7 @@
|
|
|
14469
14668
|
},
|
|
14470
14669
|
{
|
|
14471
14670
|
"name": "referenceElement",
|
|
14671
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
14472
14672
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
14473
14673
|
},
|
|
14474
14674
|
{
|
|
@@ -14636,6 +14836,7 @@
|
|
|
14636
14836
|
},
|
|
14637
14837
|
{
|
|
14638
14838
|
"name": "reference-element",
|
|
14839
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
14639
14840
|
"value": {
|
|
14640
14841
|
"type": "string"
|
|
14641
14842
|
}
|
|
@@ -14748,6 +14949,7 @@
|
|
|
14748
14949
|
},
|
|
14749
14950
|
{
|
|
14750
14951
|
"name": "referenceElement",
|
|
14952
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
14751
14953
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
14752
14954
|
},
|
|
14753
14955
|
{
|
|
@@ -14909,7 +15111,7 @@
|
|
|
14909
15111
|
},
|
|
14910
15112
|
{
|
|
14911
15113
|
"name": "messageOverrides",
|
|
14912
|
-
"description": "Replace localized message strings with your own strings
|
|
15114
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
14913
15115
|
"type": "Record<string, unknown>"
|
|
14914
15116
|
},
|
|
14915
15117
|
{
|
|
@@ -14942,7 +15144,7 @@
|
|
|
14942
15144
|
},
|
|
14943
15145
|
{
|
|
14944
15146
|
"name": "arcgis-track",
|
|
14945
|
-
"description": "The Track component is a button that animates the
|
|
15147
|
+
"description": "The Track component is a button that when activated continuously animates the Map or Scene\nto the user's location as the user moves.\nThe view rotates based on device heading, and the default heading symbol will display\nwhen speed is greater than zero and the browser provides heading information.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that support\n[Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility).\n\n**Known limitations**\n\n- The heading symbol is not currently supported within a [Scene component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start tracking the user's location. Only start the component on a user gesture such as a click event.\n- `stop(): Promise<void>` - Stop tracking the user's location.",
|
|
14946
15148
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-track/",
|
|
14947
15149
|
"attributes": [
|
|
14948
15150
|
{
|
|
@@ -15010,6 +15212,7 @@
|
|
|
15010
15212
|
},
|
|
15011
15213
|
{
|
|
15012
15214
|
"name": "reference-element",
|
|
15215
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
15013
15216
|
"value": {
|
|
15014
15217
|
"type": "string"
|
|
15015
15218
|
}
|
|
@@ -15032,7 +15235,7 @@
|
|
|
15032
15235
|
},
|
|
15033
15236
|
{
|
|
15034
15237
|
"name": "state",
|
|
15035
|
-
"description": "The current state of the
|
|
15238
|
+
"description": "The current state of the component.",
|
|
15036
15239
|
"default": "\"disabled\"",
|
|
15037
15240
|
"value": {
|
|
15038
15241
|
"type": [
|
|
@@ -15109,7 +15312,7 @@
|
|
|
15109
15312
|
},
|
|
15110
15313
|
{
|
|
15111
15314
|
"name": "messageOverrides",
|
|
15112
|
-
"description": "Replace localized message strings with your own strings
|
|
15315
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
15113
15316
|
"type": "Record<string, unknown>"
|
|
15114
15317
|
},
|
|
15115
15318
|
{
|
|
@@ -15123,6 +15326,7 @@
|
|
|
15123
15326
|
},
|
|
15124
15327
|
{
|
|
15125
15328
|
"name": "referenceElement",
|
|
15329
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
15126
15330
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
15127
15331
|
},
|
|
15128
15332
|
{
|
|
@@ -15137,7 +15341,7 @@
|
|
|
15137
15341
|
},
|
|
15138
15342
|
{
|
|
15139
15343
|
"name": "state",
|
|
15140
|
-
"description": "The current state of the
|
|
15344
|
+
"description": "The current state of the component.",
|
|
15141
15345
|
"type": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"ready\" | \"tracking\" | \"waiting\""
|
|
15142
15346
|
},
|
|
15143
15347
|
{
|
|
@@ -15170,7 +15374,7 @@
|
|
|
15170
15374
|
},
|
|
15171
15375
|
{
|
|
15172
15376
|
"name": "arcgis-utility-network-associations",
|
|
15173
|
-
"description": "The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials.\n
|
|
15377
|
+
"description": "The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
15174
15378
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-associations/",
|
|
15175
15379
|
"attributes": [
|
|
15176
15380
|
{
|
|
@@ -15310,6 +15514,7 @@
|
|
|
15310
15514
|
},
|
|
15311
15515
|
{
|
|
15312
15516
|
"name": "reference-element",
|
|
15517
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
15313
15518
|
"value": {
|
|
15314
15519
|
"type": "string"
|
|
15315
15520
|
}
|
|
@@ -15375,7 +15580,7 @@
|
|
|
15375
15580
|
},
|
|
15376
15581
|
{
|
|
15377
15582
|
"name": "visible-elements-connectivity-associations-settings-arrows-toggle",
|
|
15378
|
-
"description": "**Deprecated**: since 4.32
|
|
15583
|
+
"description": "**Deprecated**: since 4.32, showConnectivityAssociationsSettingsArrowsToggle instead. ",
|
|
15379
15584
|
"default": "false",
|
|
15380
15585
|
"value": {
|
|
15381
15586
|
"type": "boolean"
|
|
@@ -15383,7 +15588,7 @@
|
|
|
15383
15588
|
},
|
|
15384
15589
|
{
|
|
15385
15590
|
"name": "visible-elements-connectivity-associations-settings-cap-select",
|
|
15386
|
-
"description": "**Deprecated**: since 4.32
|
|
15591
|
+
"description": "**Deprecated**: since 4.32, use showConnectivityAssociationsSettingsCapSelect instead. ",
|
|
15387
15592
|
"default": "false",
|
|
15388
15593
|
"value": {
|
|
15389
15594
|
"type": "boolean"
|
|
@@ -15391,7 +15596,7 @@
|
|
|
15391
15596
|
},
|
|
15392
15597
|
{
|
|
15393
15598
|
"name": "visible-elements-connectivity-associations-settings-color-picker",
|
|
15394
|
-
"description": "**Deprecated**: since 4.32
|
|
15599
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsColorPicker instead. ",
|
|
15395
15600
|
"default": "true",
|
|
15396
15601
|
"value": {
|
|
15397
15602
|
"type": "boolean"
|
|
@@ -15399,7 +15604,7 @@
|
|
|
15399
15604
|
},
|
|
15400
15605
|
{
|
|
15401
15606
|
"name": "visible-elements-connectivity-associations-settings-style-picker",
|
|
15402
|
-
"description": "**Deprecated**: since 4.32
|
|
15607
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsStylePicker instead. ",
|
|
15403
15608
|
"default": "true",
|
|
15404
15609
|
"value": {
|
|
15405
15610
|
"type": "boolean"
|
|
@@ -15407,7 +15612,7 @@
|
|
|
15407
15612
|
},
|
|
15408
15613
|
{
|
|
15409
15614
|
"name": "visible-elements-connectivity-associations-settings-width-input",
|
|
15410
|
-
"description": "**Deprecated**: since 4.32
|
|
15615
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsWidthInput instead. ",
|
|
15411
15616
|
"default": "true",
|
|
15412
15617
|
"value": {
|
|
15413
15618
|
"type": "boolean"
|
|
@@ -15415,7 +15620,7 @@
|
|
|
15415
15620
|
},
|
|
15416
15621
|
{
|
|
15417
15622
|
"name": "visible-elements-max-allowable-associations-slider",
|
|
15418
|
-
"description": "**Deprecated**: since 4.32
|
|
15623
|
+
"description": "**Deprecated**: since 4.32, use showMaxAllowableAssociationsSlider instead. ",
|
|
15419
15624
|
"default": "false",
|
|
15420
15625
|
"value": {
|
|
15421
15626
|
"type": "boolean"
|
|
@@ -15423,7 +15628,7 @@
|
|
|
15423
15628
|
},
|
|
15424
15629
|
{
|
|
15425
15630
|
"name": "visible-elements-structural-attachment-associations-settings-arrows-toggle",
|
|
15426
|
-
"description": "**Deprecated**: since 4.32
|
|
15631
|
+
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsArrowsToggle instead. ",
|
|
15427
15632
|
"default": "false",
|
|
15428
15633
|
"value": {
|
|
15429
15634
|
"type": "boolean"
|
|
@@ -15431,7 +15636,7 @@
|
|
|
15431
15636
|
},
|
|
15432
15637
|
{
|
|
15433
15638
|
"name": "visible-elements-structural-attachment-associations-settings-cap-select",
|
|
15434
|
-
"description": "**Deprecated**: since 4.32
|
|
15639
|
+
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsCapSelect instead. ",
|
|
15435
15640
|
"default": "false",
|
|
15436
15641
|
"value": {
|
|
15437
15642
|
"type": "boolean"
|
|
@@ -15439,7 +15644,7 @@
|
|
|
15439
15644
|
},
|
|
15440
15645
|
{
|
|
15441
15646
|
"name": "visible-elements-structural-attachment-associations-settings-color-picker",
|
|
15442
|
-
"description": "**Deprecated**: since 4.32
|
|
15647
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsColorPicker instead. ",
|
|
15443
15648
|
"default": "true",
|
|
15444
15649
|
"value": {
|
|
15445
15650
|
"type": "boolean"
|
|
@@ -15447,7 +15652,7 @@
|
|
|
15447
15652
|
},
|
|
15448
15653
|
{
|
|
15449
15654
|
"name": "visible-elements-structural-attachment-associations-settings-style-picker",
|
|
15450
|
-
"description": "**Deprecated**: since 4.32
|
|
15655
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsStylePicker instead. ",
|
|
15451
15656
|
"default": "true",
|
|
15452
15657
|
"value": {
|
|
15453
15658
|
"type": "boolean"
|
|
@@ -15455,7 +15660,7 @@
|
|
|
15455
15660
|
},
|
|
15456
15661
|
{
|
|
15457
15662
|
"name": "visible-elements-structural-attachment-associations-settings-width-input",
|
|
15458
|
-
"description": "**Deprecated**: since 4.32
|
|
15663
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsWidthInput instead. ",
|
|
15459
15664
|
"default": "true",
|
|
15460
15665
|
"value": {
|
|
15461
15666
|
"type": "boolean"
|
|
@@ -15556,6 +15761,7 @@
|
|
|
15556
15761
|
},
|
|
15557
15762
|
{
|
|
15558
15763
|
"name": "referenceElement",
|
|
15764
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
15559
15765
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
15560
15766
|
},
|
|
15561
15767
|
{
|
|
@@ -15688,7 +15894,7 @@
|
|
|
15688
15894
|
},
|
|
15689
15895
|
{
|
|
15690
15896
|
"name": "gdb-version",
|
|
15691
|
-
"description": "**Deprecated**: since version 4.31
|
|
15897
|
+
"description": "**Deprecated**: `gdbVersion` is deprecated since version 4.31.. The Geodatabase version to pass into the trace.",
|
|
15692
15898
|
"default": "\"sde.DEFAULT\"",
|
|
15693
15899
|
"value": {
|
|
15694
15900
|
"type": "string"
|
|
@@ -15728,6 +15934,7 @@
|
|
|
15728
15934
|
},
|
|
15729
15935
|
{
|
|
15730
15936
|
"name": "reference-element",
|
|
15937
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
15731
15938
|
"value": {
|
|
15732
15939
|
"type": "string"
|
|
15733
15940
|
}
|
|
@@ -15853,6 +16060,7 @@
|
|
|
15853
16060
|
},
|
|
15854
16061
|
{
|
|
15855
16062
|
"name": "referenceElement",
|
|
16063
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
15856
16064
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
15857
16065
|
},
|
|
15858
16066
|
{
|
|
@@ -15978,6 +16186,7 @@
|
|
|
15978
16186
|
},
|
|
15979
16187
|
{
|
|
15980
16188
|
"name": "reference-element",
|
|
16189
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
15981
16190
|
"value": {
|
|
15982
16191
|
"type": "string"
|
|
15983
16192
|
}
|
|
@@ -16038,6 +16247,7 @@
|
|
|
16038
16247
|
},
|
|
16039
16248
|
{
|
|
16040
16249
|
"name": "referenceElement",
|
|
16250
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
16041
16251
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16042
16252
|
},
|
|
16043
16253
|
{
|
|
@@ -16192,6 +16402,7 @@
|
|
|
16192
16402
|
},
|
|
16193
16403
|
{
|
|
16194
16404
|
"name": "reference-element",
|
|
16405
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
16195
16406
|
"value": {
|
|
16196
16407
|
"type": "string"
|
|
16197
16408
|
}
|
|
@@ -16304,6 +16515,7 @@
|
|
|
16304
16515
|
},
|
|
16305
16516
|
{
|
|
16306
16517
|
"name": "referenceElement",
|
|
16518
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
16307
16519
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16308
16520
|
},
|
|
16309
16521
|
{
|
|
@@ -16393,7 +16605,7 @@
|
|
|
16393
16605
|
},
|
|
16394
16606
|
{
|
|
16395
16607
|
"name": "page-size",
|
|
16396
|
-
"description": "Specifies the number of versions displayed on each page of the Version Management
|
|
16608
|
+
"description": "Specifies the number of versions displayed on each page of the Version Management component.",
|
|
16397
16609
|
"default": "5",
|
|
16398
16610
|
"value": {
|
|
16399
16611
|
"type": "number"
|
|
@@ -16418,6 +16630,7 @@
|
|
|
16418
16630
|
},
|
|
16419
16631
|
{
|
|
16420
16632
|
"name": "reference-element",
|
|
16633
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
16421
16634
|
"value": {
|
|
16422
16635
|
"type": "string"
|
|
16423
16636
|
}
|
|
@@ -16469,7 +16682,7 @@
|
|
|
16469
16682
|
},
|
|
16470
16683
|
{
|
|
16471
16684
|
"name": "initialVersionInfos",
|
|
16472
|
-
"description": "The `initialVersionInfos` property enables users to initialize the Version Management
|
|
16685
|
+
"description": "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.",
|
|
16473
16686
|
"type": "Array<{\n url: string;\n name: string;\n}>"
|
|
16474
16687
|
},
|
|
16475
16688
|
{
|
|
@@ -16478,7 +16691,7 @@
|
|
|
16478
16691
|
},
|
|
16479
16692
|
{
|
|
16480
16693
|
"name": "messageOverrides",
|
|
16481
|
-
"description": "Replace localized message strings with your own strings
|
|
16694
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16482
16695
|
"type": "Record<string, unknown>"
|
|
16483
16696
|
},
|
|
16484
16697
|
{
|
|
@@ -16487,7 +16700,7 @@
|
|
|
16487
16700
|
},
|
|
16488
16701
|
{
|
|
16489
16702
|
"name": "pageSize",
|
|
16490
|
-
"description": "Specifies the number of versions displayed on each page of the Version Management
|
|
16703
|
+
"description": "Specifies the number of versions displayed on each page of the Version Management component.",
|
|
16491
16704
|
"type": "number"
|
|
16492
16705
|
},
|
|
16493
16706
|
{
|
|
@@ -16496,6 +16709,7 @@
|
|
|
16496
16709
|
},
|
|
16497
16710
|
{
|
|
16498
16711
|
"name": "referenceElement",
|
|
16712
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
16499
16713
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16500
16714
|
},
|
|
16501
16715
|
{
|
|
@@ -16505,7 +16719,7 @@
|
|
|
16505
16719
|
},
|
|
16506
16720
|
{
|
|
16507
16721
|
"name": "versioningStates",
|
|
16508
|
-
"description": "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
|
|
16722
|
+
"description": "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.",
|
|
16509
16723
|
"type": "Collection<VersioningState>"
|
|
16510
16724
|
}
|
|
16511
16725
|
],
|
|
@@ -16524,7 +16738,7 @@
|
|
|
16524
16738
|
},
|
|
16525
16739
|
{
|
|
16526
16740
|
"name": "arcgis-video",
|
|
16527
|
-
"description": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid
|
|
16741
|
+
"description": "The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid VideoLayer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n--\n\n### Events\n- **arcgisViewReadyChange**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.",
|
|
16528
16742
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/",
|
|
16529
16743
|
"attributes": [
|
|
16530
16744
|
{
|
|
@@ -16533,12 +16747,6 @@
|
|
|
16533
16747
|
"value": {
|
|
16534
16748
|
"type": "boolean"
|
|
16535
16749
|
}
|
|
16536
|
-
},
|
|
16537
|
-
{
|
|
16538
|
-
"name": "layer-url",
|
|
16539
|
-
"value": {
|
|
16540
|
-
"type": "string"
|
|
16541
|
-
}
|
|
16542
16750
|
}
|
|
16543
16751
|
],
|
|
16544
16752
|
"events": [
|
|
@@ -16559,8 +16767,9 @@
|
|
|
16559
16767
|
"type": "VideoLayer"
|
|
16560
16768
|
},
|
|
16561
16769
|
{
|
|
16562
|
-
"name": "
|
|
16563
|
-
"
|
|
16770
|
+
"name": "map",
|
|
16771
|
+
"description": "A reference to the associated [Map](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html) or [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html).",
|
|
16772
|
+
"type": "Map | WebMap"
|
|
16564
16773
|
},
|
|
16565
16774
|
{
|
|
16566
16775
|
"name": "ready",
|
|
@@ -16583,7 +16792,7 @@
|
|
|
16583
16792
|
},
|
|
16584
16793
|
{
|
|
16585
16794
|
"name": "arcgis-video-player",
|
|
16586
|
-
"description": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known
|
|
16795
|
+
"description": "The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[](https://mediaspace.esri.com/media/1_ctc3psfr)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n- **arcgisVideoReady**\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
16587
16796
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/",
|
|
16588
16797
|
"attributes": [
|
|
16589
16798
|
{
|
|
@@ -16594,6 +16803,19 @@
|
|
|
16594
16803
|
"type": "boolean"
|
|
16595
16804
|
}
|
|
16596
16805
|
},
|
|
16806
|
+
{
|
|
16807
|
+
"name": "following-mode",
|
|
16808
|
+
"description": "Determines which telemetry elements to follow when the video layer is playing.",
|
|
16809
|
+
"default": "\"follow-both\"",
|
|
16810
|
+
"value": {
|
|
16811
|
+
"type": [
|
|
16812
|
+
"\"follow-both\"",
|
|
16813
|
+
"\"follow-frame\"",
|
|
16814
|
+
"\"follow-sensor\"",
|
|
16815
|
+
"\"none\""
|
|
16816
|
+
]
|
|
16817
|
+
}
|
|
16818
|
+
},
|
|
16597
16819
|
{
|
|
16598
16820
|
"name": "hide-header",
|
|
16599
16821
|
"description": "Indicates whether to display the video player's header information.",
|
|
@@ -16636,6 +16858,7 @@
|
|
|
16636
16858
|
},
|
|
16637
16859
|
{
|
|
16638
16860
|
"name": "reference-element",
|
|
16861
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
16639
16862
|
"value": {
|
|
16640
16863
|
"type": "string"
|
|
16641
16864
|
}
|
|
@@ -16680,6 +16903,11 @@
|
|
|
16680
16903
|
"description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/#destroy) method when you are done to\nprevent memory leaks.",
|
|
16681
16904
|
"type": "boolean"
|
|
16682
16905
|
},
|
|
16906
|
+
{
|
|
16907
|
+
"name": "followingMode",
|
|
16908
|
+
"description": "Determines which telemetry elements to follow when the video layer is playing.",
|
|
16909
|
+
"type": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\""
|
|
16910
|
+
},
|
|
16683
16911
|
{
|
|
16684
16912
|
"name": "hideHeader",
|
|
16685
16913
|
"description": "Indicates whether to display the video player's header information.",
|
|
@@ -16702,7 +16930,7 @@
|
|
|
16702
16930
|
},
|
|
16703
16931
|
{
|
|
16704
16932
|
"name": "messageOverrides",
|
|
16705
|
-
"description": "Replace localized message strings with your own strings
|
|
16933
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16706
16934
|
"type": "Record<string, unknown>"
|
|
16707
16935
|
},
|
|
16708
16936
|
{
|
|
@@ -16711,6 +16939,7 @@
|
|
|
16711
16939
|
},
|
|
16712
16940
|
{
|
|
16713
16941
|
"name": "referenceElement",
|
|
16942
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
16714
16943
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16715
16944
|
},
|
|
16716
16945
|
{
|
|
@@ -16739,7 +16968,7 @@
|
|
|
16739
16968
|
},
|
|
16740
16969
|
{
|
|
16741
16970
|
"name": "arcgis-weather",
|
|
16742
|
-
"description": "The Weather component
|
|
16971
|
+
"description": "The Weather component allows easy selection and configuration of weather effects in a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThe available weather types are:\n[sunny](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html),\n[cloudy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html),\n[rainy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html),\n[snowy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html), and\n[foggy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html).\n\nTo set the weather programmatically, apply the desired weather type to the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) property of the Scene component.\n\n```js\n// Access the Scene component.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// Specify the weather settings.\nviewElement.environment.weather = {\n type: \"rainy\", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })\n cloudCover: 0.7,\n precipitation: 0.3\n};\n```\n\nTo determine if the weather visualization is available, check the boolean value of `viewElement.environment.weatherAvailable`. The weather is only available:\n * in `global` [viewing mode](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewingMode),\n * when `atmosphereEnabled` property on [environment](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) is `true`,\n * at lower altitudes, near the ground.\n\n**Known limitations**\n\nWeather is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html)\n- [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
16743
16972
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-weather/",
|
|
16744
16973
|
"attributes": [
|
|
16745
16974
|
{
|
|
@@ -16808,6 +17037,7 @@
|
|
|
16808
17037
|
},
|
|
16809
17038
|
{
|
|
16810
17039
|
"name": "reference-element",
|
|
17040
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
16811
17041
|
"value": {
|
|
16812
17042
|
"type": "string"
|
|
16813
17043
|
}
|
|
@@ -16865,7 +17095,7 @@
|
|
|
16865
17095
|
},
|
|
16866
17096
|
{
|
|
16867
17097
|
"name": "messageOverrides",
|
|
16868
|
-
"description": "Replace localized message strings with your own strings
|
|
17098
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16869
17099
|
"type": "Record<string, unknown>"
|
|
16870
17100
|
},
|
|
16871
17101
|
{
|
|
@@ -16874,6 +17104,7 @@
|
|
|
16874
17104
|
},
|
|
16875
17105
|
{
|
|
16876
17106
|
"name": "referenceElement",
|
|
17107
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
16877
17108
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16878
17109
|
},
|
|
16879
17110
|
{
|
|
@@ -16954,6 +17185,7 @@
|
|
|
16954
17185
|
},
|
|
16955
17186
|
{
|
|
16956
17187
|
"name": "reference-element",
|
|
17188
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
16957
17189
|
"value": {
|
|
16958
17190
|
"type": "string"
|
|
16959
17191
|
}
|
|
@@ -17006,7 +17238,7 @@
|
|
|
17006
17238
|
},
|
|
17007
17239
|
{
|
|
17008
17240
|
"name": "messageOverrides",
|
|
17009
|
-
"description": "Replace localized message strings with your own strings
|
|
17241
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
17010
17242
|
"type": "Record<string, unknown>"
|
|
17011
17243
|
},
|
|
17012
17244
|
{
|
|
@@ -17015,6 +17247,7 @@
|
|
|
17015
17247
|
},
|
|
17016
17248
|
{
|
|
17017
17249
|
"name": "referenceElement",
|
|
17250
|
+
"description": "By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.",
|
|
17018
17251
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
17019
17252
|
},
|
|
17020
17253
|
{
|