@arcgis/map-components 4.34.0-next.5 → 4.34.0-next.50
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/26R2YV3B.js +4 -0
- package/dist/cdn/2CQONIL2.js +4 -0
- package/dist/cdn/2GI6YQEI.js +4 -0
- package/dist/cdn/2H5QL6X7.js +4 -0
- package/dist/cdn/{JE6AJOV2.js → 2OQ6OXJG.js} +2 -2
- package/dist/cdn/2V6QW57Y.js +4 -0
- package/dist/cdn/{RNMVFT5P.js → 2WB3VDBK.js} +1 -1
- package/dist/cdn/34V6FFLC.js +4 -0
- package/dist/cdn/3IUDGD65.js +4 -0
- package/dist/cdn/3KFRZNJE.js +4 -0
- package/dist/cdn/3Q5GWAOH.js +4 -0
- package/dist/cdn/{UKUTVSTC.js → 3TNNWTAT.js} +2 -2
- package/dist/cdn/3TQU7RFR.js +4 -0
- package/dist/cdn/4CYKZL33.js +4 -0
- package/dist/cdn/{BNUZVD5L.js → 4DUQHI6P.js} +2 -2
- package/dist/cdn/4ISQY7KF.js +4 -0
- package/dist/cdn/4JDOUOBV.js +4 -0
- package/dist/cdn/4TO2R3SL.js +4 -0
- package/dist/cdn/4YWQ66WB.js +4 -0
- package/dist/cdn/{54VGZGQT.js → 5GSDGHZ3.js} +2 -2
- package/dist/cdn/5KHZOBUA.js +4 -0
- package/dist/cdn/5KNUYIJ6.js +4 -0
- package/dist/cdn/5QDRURVW.js +4 -0
- package/dist/cdn/{FCPVKFF7.js → 5TSGKVAP.js} +2 -2
- package/dist/cdn/5V4YSXEX.js +4 -0
- package/dist/cdn/5VMYC2HB.js +4 -0
- package/dist/cdn/5YKVZEXB.js +4 -0
- package/dist/cdn/62KIHSAJ.js +4 -0
- package/dist/cdn/67DILXT3.js +4 -0
- package/dist/cdn/6DGB7FVP.js +4 -0
- package/dist/cdn/6DNNBLTS.js +4 -0
- package/dist/cdn/{Z5OKVV3T.js → 6FRZKVET.js} +2 -2
- package/dist/cdn/6FTO5TUV.js +4 -0
- package/dist/cdn/6ILWU6S2.js +4 -0
- package/dist/cdn/6LSEPDH5.js +4 -0
- package/dist/cdn/6UE2J3H3.js +4 -0
- package/dist/cdn/6UXIXOUF.js +4 -0
- package/dist/cdn/{CY2ZUEMG.js → 75KMGR2T.js} +2 -2
- package/dist/cdn/7ADE73RA.js +4 -0
- package/dist/cdn/7GIELD22.js +4 -0
- package/dist/cdn/7XPT54JR.js +4 -0
- package/dist/cdn/7ZR5PR2L.js +4 -0
- package/dist/cdn/A5VWDFHE.js +4 -0
- package/dist/cdn/AHBYJOVM.js +4 -0
- package/dist/cdn/AI7PXAN4.js +4 -0
- package/dist/cdn/ALII4L6W.js +4 -0
- package/dist/cdn/APJD3H2R.js +4 -0
- package/dist/cdn/AUZ7N5WS.js +4 -0
- package/dist/cdn/AYGTXJXG.js +4 -0
- package/dist/cdn/B5N4VUXB.js +4 -0
- package/dist/cdn/BBPAZJHG.js +4 -0
- package/dist/cdn/BJ7DXLBG.js +4 -0
- package/dist/cdn/BQVV32YK.js +4 -0
- package/dist/cdn/BRFMXB22.js +4 -0
- package/dist/cdn/BU57WANH.js +4 -0
- package/dist/cdn/{RZWKYMUH.js → BUJKCBLN.js} +2 -2
- package/dist/cdn/BYIG4A56.js +4 -0
- package/dist/cdn/C2YRACL5.js +4 -0
- package/dist/cdn/C4PORT7A.js +4 -0
- package/dist/cdn/C5NTPG2J.js +4 -0
- package/dist/cdn/CCIJI4Q3.js +4 -0
- package/dist/cdn/CFCNUTV7.js +4 -0
- package/dist/cdn/CIAKNPGH.js +4 -0
- package/dist/cdn/CQM22ZVV.js +4 -0
- package/dist/cdn/D6EDBL24.js +4 -0
- package/dist/cdn/DA2JDIA5.js +4 -0
- package/dist/cdn/{HRVDXQJH.js → DDZSCFPP.js} +1 -1
- package/dist/cdn/{ZFZIGRGE.js → DL5QNAJH.js} +1 -1
- package/dist/cdn/DRS5TFL3.js +4 -0
- package/dist/cdn/ED2ELRSD.js +4 -0
- package/dist/cdn/EGHBXJIQ.js +4 -0
- package/dist/cdn/EMURL3M6.js +6 -0
- package/dist/cdn/ENYA3CUT.js +4 -0
- package/dist/cdn/EYYHLTDA.js +4 -0
- package/dist/cdn/EZRL6KFN.js +4 -0
- package/dist/cdn/FBDQXCVG.js +5 -0
- package/dist/cdn/FMJZJRW7.js +4 -0
- package/dist/cdn/FPW62K7V.js +4 -0
- package/dist/cdn/FVIXRTM5.js +4 -0
- package/dist/cdn/G2W42WVA.js +4 -0
- package/dist/cdn/G77RWWJ5.js +4 -0
- package/dist/cdn/GAAU3OGF.js +4 -0
- package/dist/cdn/GPA5ZUND.js +4 -0
- package/dist/cdn/GZ333KTW.js +4 -0
- package/dist/cdn/GZCPDM7J.js +4 -0
- package/dist/cdn/HQL7E2T6.js +4 -0
- package/dist/cdn/HT3JKPOI.js +4 -0
- package/dist/cdn/IAB4RRTE.js +4 -0
- package/dist/cdn/IUSN6HPI.js +4 -0
- package/dist/cdn/IZPSAWGI.js +4 -0
- package/dist/cdn/JFFZT22V.js +4 -0
- package/dist/cdn/JGO5DXAG.js +4 -0
- package/dist/cdn/JPGZ6LTV.js +4 -0
- package/dist/cdn/JYJEO4XX.js +4 -0
- package/dist/cdn/KNDCZL4P.js +4 -0
- package/dist/cdn/KWFOKKJP.js +4 -0
- package/dist/cdn/KWQEP3GX.js +4 -0
- package/dist/cdn/LB4VE6GE.js +4 -0
- package/dist/cdn/LFAAOP6W.js +4 -0
- package/dist/cdn/LGEEWJVV.js +4 -0
- package/dist/cdn/LKCFUBW7.js +4 -0
- package/dist/cdn/LKDVJARU.js +4 -0
- package/dist/cdn/LPIAWKJF.js +4 -0
- package/dist/cdn/LRWBSDZG.js +4 -0
- package/dist/cdn/MJAUREYK.js +4 -0
- package/dist/cdn/{4MRPFB2F.js → N7K24QHL.js} +2 -2
- package/dist/cdn/NBPRSKK7.js +4 -0
- package/dist/cdn/NM4L7QLO.js +4 -0
- package/dist/cdn/NN5DZJEE.js +4 -0
- package/dist/cdn/NNYT4CEU.js +4 -0
- package/dist/cdn/NPZSYTOT.js +4 -0
- package/dist/cdn/NWB2XYJW.js +4 -0
- package/dist/cdn/OFQCNUYO.js +4 -0
- package/dist/cdn/OGM4QM2V.js +4 -0
- package/dist/cdn/OPFMFHCU.js +4 -0
- package/dist/cdn/OSGGZ36A.js +4 -0
- package/dist/cdn/{AIJ5QKVL.js → OTWW4QVQ.js} +1 -1
- package/dist/cdn/P4ZV2W74.js +4 -0
- package/dist/cdn/PCQ7W5WT.js +4 -0
- package/dist/cdn/PCSSJZVF.js +4 -0
- package/dist/cdn/PVB3L6DK.js +4 -0
- package/dist/cdn/QAK5OEEC.js +4 -0
- package/dist/cdn/QBVLPPIJ.js +4 -0
- package/dist/cdn/QC56X3K3.js +4 -0
- package/dist/cdn/QCEJDAKG.js +4 -0
- package/dist/cdn/{LB4FJL6Z.js → QOIC3IV2.js} +2 -2
- package/dist/cdn/QVFHJC6H.js +4 -0
- package/dist/cdn/R3O37JLG.js +4 -0
- package/dist/cdn/R45G45E4.js +4 -0
- package/dist/cdn/R6K42OY3.js +4 -0
- package/dist/cdn/RCVY3GBR.js +4 -0
- package/dist/cdn/RNLSGN6H.js +4 -0
- package/dist/cdn/RR65BWBB.js +4 -0
- package/dist/cdn/RXSZD3FE.js +4 -0
- package/dist/cdn/RYW3GXMR.js +4 -0
- package/dist/cdn/S5MYJBHN.js +4 -0
- package/dist/cdn/SASHNNW5.js +4 -0
- package/dist/cdn/{QIELYIFC.js → SLRHUPQ2.js} +2 -2
- package/dist/cdn/SPJRFIG2.js +4 -0
- package/dist/cdn/SPRMAJ56.js +4 -0
- package/dist/cdn/SWTYYNLD.js +4 -0
- package/dist/cdn/SZMMDMHA.js +4 -0
- package/dist/cdn/T4CACD5U.js +4 -0
- package/dist/cdn/TQPCCDKQ.js +3 -0
- package/dist/cdn/TT5VTF6S.js +4 -0
- package/dist/cdn/TYMITYZ4.js +4 -0
- package/dist/cdn/TYUKFL7V.js +4 -0
- package/dist/cdn/UA2BRGBJ.js +4 -0
- package/dist/cdn/UFENVRBO.js +4 -0
- package/dist/cdn/UK5RXJ2E.js +4 -0
- package/dist/cdn/{5ZZR2J6N.js → UPRLADCM.js} +2 -2
- package/dist/cdn/UUZ5KPUV.js +4 -0
- package/dist/cdn/V2XEX63R.js +4 -0
- package/dist/cdn/V7EIWO6W.js +4 -0
- package/dist/cdn/{4GXYTGZZ.js → VCPKX6Y6.js} +1 -1
- package/dist/cdn/VGB2AEHQ.js +4 -0
- package/dist/cdn/VIEIBC7W.js +4 -0
- package/dist/cdn/VOKZINB7.js +4 -0
- package/dist/cdn/VOXJGYJJ.js +4 -0
- package/dist/cdn/VSO767QL.js +4 -0
- package/dist/cdn/VUFI4AOT.js +4 -0
- package/dist/cdn/W23WNNVI.js +4 -0
- package/dist/cdn/WCRDNJT5.js +4 -0
- package/dist/cdn/WDVXB57P.js +4 -0
- package/dist/cdn/WOCZMUK7.js +4 -0
- package/dist/cdn/WQSJK5WS.js +4 -0
- package/dist/cdn/X34P6RQS.js +4 -0
- package/dist/cdn/{EPS7HMFS.js → X4QWBI4I.js} +1 -1
- package/dist/cdn/XDG7JWMS.js +4 -0
- package/dist/cdn/XKAZZEMM.js +4 -0
- package/dist/cdn/XNFLRNSD.js +4 -0
- package/dist/cdn/XRWJG5LI.js +4 -0
- package/dist/cdn/XTK5JLGR.js +4 -0
- package/dist/cdn/YAMEYVQA.js +4 -0
- package/dist/cdn/YBP6R7CX.js +4 -0
- package/dist/cdn/YFCCMEVT.js +4 -0
- package/dist/cdn/YIAYHUYJ.js +4 -0
- package/dist/cdn/YNHG6MC2.js +4 -0
- package/dist/cdn/{V32WTVMP.js → YYBZPUPB.js} +1 -1
- package/dist/cdn/YYTCKFUT.js +4 -0
- package/dist/cdn/Z27CF6WG.js +4 -0
- package/dist/cdn/Z2AC2NOA.js +4 -0
- package/dist/cdn/Z5ZIY43G.js +4 -0
- package/dist/cdn/ZCRRAN4X.js +4 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ar.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.bg.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.bs.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ca.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.cs.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.da.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.de.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.el.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.en.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.es.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.et.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.fi.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.fr.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.he.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.hr.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.hu.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.id.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.it.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ja.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ko.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.lt.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.lv.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.nl.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.no.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.pl.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.pt-BR.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.pt-PT.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ro.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.ru.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.sk.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.sl.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.sr.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.sv.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.th.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.tr.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.uk.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.vi.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.zh-CN.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.zh-HK.json +1 -0
- package/dist/cdn/assets/bookmarks/t9n/messages.zh-TW.json +1 -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 +2 -2
- 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 +2 -2
- package/dist/components/arcgis-area-measurement-3d/customElement.d.ts +111 -9
- package/dist/components/arcgis-area-measurement-3d/customElement.js +19 -23
- package/dist/components/arcgis-attachments/customElement.d.ts +6 -1
- package/dist/components/arcgis-attachments/customElement.js +2 -2
- package/dist/components/arcgis-basemap-gallery/customElement.d.ts +10 -1
- package/dist/components/arcgis-basemap-gallery/customElement.js +18 -19
- 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 +2 -2
- package/dist/components/arcgis-basemap-toggle/customElement.d.ts +11 -2
- package/dist/components/arcgis-basemap-toggle/customElement.js +16 -17
- package/dist/components/arcgis-bookmarks/css.d.ts +22 -0
- package/dist/components/arcgis-bookmarks/customElement.d.ts +239 -82
- package/dist/components/arcgis-bookmarks/customElement.js +456 -17
- package/dist/components/arcgis-bookmarks/index.d.ts +21 -0
- package/dist/components/arcgis-bookmarks/index.js +21 -0
- package/dist/components/arcgis-bookmarks/interfaces.d.ts +12 -0
- package/dist/components/arcgis-bookmarks/user-state.d.ts +26 -0
- package/dist/components/arcgis-building-explorer/customElement.d.ts +26 -14
- package/dist/components/arcgis-building-explorer/customElement.js +2 -2
- package/dist/components/arcgis-catalog-layer-list/customElement.d.ts +5 -0
- package/dist/components/arcgis-catalog-layer-list/customElement.js +2 -2
- package/dist/components/arcgis-compass/customElement.d.ts +10 -1
- package/dist/components/arcgis-compass/customElement.js +15 -16
- package/dist/components/arcgis-coordinate-conversion/customElement.d.ts +6 -1
- package/dist/components/arcgis-coordinate-conversion/customElement.js +4 -4
- package/dist/components/arcgis-daylight/customElement.d.ts +27 -13
- package/dist/components/arcgis-daylight/customElement.js +2 -2
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.d.ts +112 -9
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.js +13 -17
- package/dist/components/arcgis-directional-pad/customElement.d.ts +10 -1
- package/dist/components/arcgis-directional-pad/customElement.js +20 -21
- package/dist/components/arcgis-directions/customElement.d.ts +7 -2
- package/dist/components/arcgis-directions/customElement.js +2 -2
- package/dist/components/arcgis-distance-measurement-2d/customElement.d.ts +5 -0
- package/dist/components/arcgis-distance-measurement-2d/customElement.js +2 -2
- package/dist/components/arcgis-editor/customElement.d.ts +6 -1
- package/dist/components/arcgis-editor/customElement.js +2 -2
- package/dist/components/arcgis-elevation-profile/customElement.d.ts +28 -20
- package/dist/components/arcgis-elevation-profile/customElement.js +2 -2
- package/dist/components/arcgis-expand/customElement.d.ts +10 -4
- package/dist/components/arcgis-expand/customElement.js +2 -2
- package/dist/components/arcgis-feature/customElement.d.ts +6 -1
- package/dist/components/arcgis-feature/customElement.js +11 -10
- package/dist/components/arcgis-feature-attachments/customElement.d.ts +16 -0
- package/dist/components/arcgis-feature-attachments/customElement.js +30 -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 +65 -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 +42 -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 +241 -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 +142 -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 +2 -2
- 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 +576 -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 +2 -2
- package/dist/components/arcgis-feature-templates/customElement.d.ts +5 -0
- package/dist/components/arcgis-feature-templates/customElement.js +2 -2
- package/dist/components/arcgis-features/customElement.d.ts +5 -0
- package/dist/components/arcgis-features/customElement.js +2 -2
- package/dist/components/arcgis-floor-filter/customElement.d.ts +5 -0
- package/dist/components/arcgis-floor-filter/customElement.js +2 -2
- package/dist/components/arcgis-fullscreen/customElement.d.ts +21 -2
- package/dist/components/arcgis-fullscreen/customElement.js +32 -19
- package/dist/components/arcgis-grid-controls/customElement.d.ts +10 -1
- package/dist/components/arcgis-grid-controls/customElement.js +15 -16
- package/dist/components/arcgis-histogram-range-slider/customElement.d.ts +5 -0
- package/dist/components/arcgis-histogram-range-slider/customElement.js +2 -2
- package/dist/components/arcgis-home/customElement.d.ts +39 -16
- package/dist/components/arcgis-home/customElement.js +14 -15
- package/dist/components/arcgis-labeled-switch/customElement.js +10 -11
- 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 +2 -2
- package/dist/components/arcgis-legend/customElement.d.ts +5 -0
- package/dist/components/arcgis-legend/customElement.js +2 -2
- package/dist/components/arcgis-line-of-sight/customElement.d.ts +75 -19
- package/dist/components/arcgis-line-of-sight/customElement.js +19 -23
- package/dist/components/arcgis-link-chart/customElement.d.ts +20 -10
- package/dist/components/arcgis-link-chart/customElement.js +20 -9
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.d.ts +13 -2
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.js +25 -27
- 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 +55 -56
- package/dist/components/arcgis-map/customElement.d.ts +27 -14
- package/dist/components/arcgis-map/customElement.js +26 -15
- package/dist/components/arcgis-measurement/customElement.d.ts +5 -0
- package/dist/components/arcgis-measurement/customElement.js +2 -2
- package/dist/components/arcgis-measurement-content/customElement.js +12 -13
- package/dist/components/arcgis-navigation-toggle/customElement.d.ts +17 -13
- package/dist/components/arcgis-navigation-toggle/customElement.js +17 -15
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.d.ts +5 -0
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.js +2 -2
- package/dist/components/arcgis-placement/customElement.d.ts +5 -0
- package/dist/components/arcgis-placement/customElement.js +2 -2
- package/dist/components/arcgis-print/customElement.d.ts +55 -41
- package/dist/components/arcgis-print/customElement.js +38 -33
- package/dist/components/arcgis-print/types.d.ts +40 -0
- package/dist/components/arcgis-print/utils.d.ts +1 -1
- package/dist/components/arcgis-print-custom-text-elements/customElement.js +2 -2
- 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 +4 -5
- package/dist/components/arcgis-print-exported-link/customElement.d.ts +1 -1
- package/dist/components/arcgis-print-exported-link/customElement.js +24 -25
- package/dist/components/arcgis-print-exports-panel/customElement.d.ts +1 -1
- package/dist/components/arcgis-print-exports-panel/customElement.js +10 -11
- package/dist/components/arcgis-print-format-select/customElement.d.ts +1 -1
- package/dist/components/arcgis-print-format-select/customElement.js +3 -3
- package/dist/components/arcgis-print-layout-advanced-options/customElement.js +9 -10
- package/dist/components/arcgis-print-layout-panel/customElement.d.ts +1 -7
- package/dist/components/arcgis-print-layout-panel/customElement.js +14 -15
- package/dist/components/arcgis-print-main-panel/customElement.d.ts +2 -8
- package/dist/components/arcgis-print-main-panel/customElement.js +12 -13
- package/dist/components/arcgis-print-map-only-advanced-options/customElement.js +6 -7
- package/dist/components/arcgis-print-map-only-panel/customElement.d.ts +1 -7
- package/dist/components/arcgis-print-map-only-panel/customElement.js +28 -23
- package/dist/components/arcgis-print-out-spatial-reference-input/customElement.js +26 -22
- package/dist/components/arcgis-print-preview-input/customElement.js +2 -2
- package/dist/components/arcgis-print-scale-section/customElement.js +26 -20
- package/dist/components/arcgis-print-template-select/customElement.js +11 -12
- package/dist/components/arcgis-print-template-selector/customElement.js +9 -10
- package/dist/components/arcgis-scale-bar/customElement.d.ts +11 -2
- package/dist/components/arcgis-scale-bar/customElement.js +3 -3
- package/dist/components/arcgis-scale-range-slider/customElement.d.ts +5 -0
- package/dist/components/arcgis-scale-range-slider/customElement.js +2 -2
- package/dist/components/arcgis-scene/customElement.d.ts +144 -81
- package/dist/components/arcgis-scene/customElement.js +28 -17
- package/dist/components/arcgis-search/customElement.d.ts +52 -16
- package/dist/components/arcgis-search/customElement.js +41 -38
- package/dist/components/arcgis-search-result-renderer/customElement.js +14 -15
- package/dist/components/arcgis-shadow-cast/customElement.d.ts +92 -30
- package/dist/components/arcgis-shadow-cast/customElement.js +2 -2
- 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 +32 -41
- package/dist/components/arcgis-slider/customElement.d.ts +5 -0
- package/dist/components/arcgis-slider/customElement.js +2 -2
- package/dist/components/arcgis-swipe/customElement.d.ts +28 -2
- package/dist/components/arcgis-swipe/customElement.js +43 -44
- package/dist/components/arcgis-table-list/customElement.d.ts +5 -0
- package/dist/components/arcgis-table-list/customElement.js +2 -2
- package/dist/components/arcgis-time-slider/customElement.d.ts +5 -0
- package/dist/components/arcgis-time-slider/customElement.js +2 -2
- package/dist/components/arcgis-time-zone-label/customElement.d.ts +3 -1
- package/dist/components/arcgis-time-zone-label/customElement.js +10 -11
- package/dist/components/arcgis-track/customElement.d.ts +26 -9
- package/dist/components/arcgis-track/customElement.js +14 -15
- package/dist/components/arcgis-unit-select/customElement.d.ts +6 -2
- package/dist/components/arcgis-unit-select/customElement.js +22 -16
- 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 +2 -2
- package/dist/components/arcgis-version-management/customElement.d.ts +14 -5
- package/dist/components/arcgis-version-management/customElement.js +49 -51
- 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 +12 -12
- package/dist/components/arcgis-version-management-version-list/customElement.d.ts +0 -1
- package/dist/components/arcgis-version-management-version-list/customElement.js +18 -22
- package/dist/components/arcgis-version-management-version-properties/customElement.d.ts +0 -1
- package/dist/components/arcgis-version-management-version-properties/customElement.js +43 -44
- 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 +38 -32
- package/dist/components/arcgis-video-player-action-bar/customElement.js +11 -12
- package/dist/components/arcgis-video-player-actions-group/customElement.js +2 -2
- package/dist/components/arcgis-video-player-controls-group/customElement.js +13 -13
- package/dist/components/arcgis-video-player-metadata/customElement.js +10 -11
- package/dist/components/arcgis-video-player-settings/customElement.js +8 -9
- package/dist/components/arcgis-video-player-slider/customElement.js +6 -7
- 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 +16 -17
- package/dist/components/arcgis-zoom/customElement.d.ts +10 -1
- package/dist/components/arcgis-zoom/customElement.js +11 -12
- package/dist/controllers/Handles.d.ts +2 -2
- package/dist/controllers/useHandles.d.ts +4 -4
- package/dist/docs/api.json +1881 -586
- package/dist/docs/docs.json +1746 -818
- package/dist/docs/vscode.html-custom-data.json +252 -114
- package/dist/docs/web-types.json +559 -274
- package/dist/geolocation/GeolocationPositioning.d.ts +5 -6
- package/dist/index.d.ts +7 -3
- package/dist/index.js +1 -1
- package/dist/loader.js +24 -18
- package/dist/support/heading.d.ts +2 -1
- package/dist/types/lumina.d.ts +22 -17
- package/dist/types/preact.d.ts +22 -17
- package/dist/types/react.d.ts +22 -17
- package/dist/types/stencil.d.ts +22 -17
- 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 +6 -4
- package/dist/cdn/24BGG5B5.js +0 -4
- package/dist/cdn/2ABLOYUQ.js +0 -4
- package/dist/cdn/2MCSN6B6.js +0 -4
- package/dist/cdn/2O4Y7OHR.js +0 -4
- package/dist/cdn/2TWTTB4C.js +0 -4
- package/dist/cdn/2UUPIIJ2.js +0 -4
- package/dist/cdn/3JRMNN7J.js +0 -4
- package/dist/cdn/3PIZQW3M.js +0 -4
- package/dist/cdn/3TK75HC6.js +0 -4
- package/dist/cdn/4O62D3XH.js +0 -4
- package/dist/cdn/4WF35OVZ.js +0 -4
- package/dist/cdn/544SB4EK.js +0 -4
- package/dist/cdn/5AZ345NY.js +0 -4
- package/dist/cdn/5DVI4EBY.js +0 -4
- package/dist/cdn/64ECRPXA.js +0 -4
- package/dist/cdn/6CDNOZQF.js +0 -4
- package/dist/cdn/6SCGGHDS.js +0 -4
- package/dist/cdn/7LOOJUA4.js +0 -4
- package/dist/cdn/7Q2LH4TM.js +0 -4
- package/dist/cdn/7X5UWWAM.js +0 -4
- package/dist/cdn/A2GEUHD7.js +0 -4
- package/dist/cdn/BMYPLHTO.js +0 -4
- package/dist/cdn/BOBGF74Z.js +0 -4
- package/dist/cdn/CEY2DMIN.js +0 -4
- package/dist/cdn/CQG33CHS.js +0 -4
- package/dist/cdn/DB2RVFYE.js +0 -4
- package/dist/cdn/DCAIQVAC.js +0 -4
- package/dist/cdn/EDF5YBMS.js +0 -4
- package/dist/cdn/EE2WJOUL.js +0 -4
- package/dist/cdn/EFPP35S3.js +0 -4
- package/dist/cdn/ETTC3DDE.js +0 -4
- package/dist/cdn/EZXIFOKP.js +0 -4
- package/dist/cdn/FDO7BW3M.js +0 -4
- package/dist/cdn/FIIIUSQA.js +0 -4
- package/dist/cdn/FIQDTOHK.js +0 -4
- package/dist/cdn/FIRY4NWS.js +0 -4
- package/dist/cdn/FKYCCKL6.js +0 -4
- package/dist/cdn/G7FI7ZEJ.js +0 -4
- package/dist/cdn/GTFZYBLH.js +0 -4
- package/dist/cdn/H7WRFI2D.js +0 -4
- package/dist/cdn/HGHOHO2E.js +0 -4
- package/dist/cdn/HHKEZDYI.js +0 -4
- package/dist/cdn/HI5YGVEU.js +0 -4
- package/dist/cdn/HVHKTHJR.js +0 -4
- package/dist/cdn/I4UJICTJ.js +0 -4
- package/dist/cdn/IDRJHSB4.js +0 -4
- package/dist/cdn/INXLPBES.js +0 -4
- package/dist/cdn/IPSPJR6H.js +0 -4
- package/dist/cdn/J3TNLK3O.js +0 -4
- package/dist/cdn/JEGU6LY5.js +0 -4
- package/dist/cdn/JPHNAFYX.js +0 -4
- package/dist/cdn/JWHVUXI7.js +0 -4
- package/dist/cdn/JXEJ2FDT.js +0 -4
- package/dist/cdn/K667RV3F.js +0 -4
- package/dist/cdn/KHHWOKDH.js +0 -4
- package/dist/cdn/KWXFVL5O.js +0 -4
- package/dist/cdn/LNC2FBRF.js +0 -4
- package/dist/cdn/LX2VKBL5.js +0 -4
- package/dist/cdn/LZ4SDJU4.js +0 -4
- package/dist/cdn/M42LA7QJ.js +0 -4
- package/dist/cdn/MHF4R4QG.js +0 -4
- package/dist/cdn/MHXI4R7Q.js +0 -6
- package/dist/cdn/MT6FGRRO.js +0 -4
- package/dist/cdn/MTJFO22N.js +0 -4
- package/dist/cdn/MWH2P5CL.js +0 -4
- package/dist/cdn/MWRQZLPR.js +0 -4
- package/dist/cdn/MZJOI5UH.js +0 -4
- package/dist/cdn/O2E4MNME.js +0 -4
- package/dist/cdn/O7NRUX5I.js +0 -4
- package/dist/cdn/OLDX3JZA.js +0 -4
- package/dist/cdn/OMQCMWFC.js +0 -4
- package/dist/cdn/OQ4Q4IIJ.js +0 -4
- package/dist/cdn/OSKGVTTW.js +0 -4
- package/dist/cdn/OVXJMGHR.js +0 -4
- package/dist/cdn/P2BRHVAB.js +0 -4
- package/dist/cdn/PQ3OUY5L.js +0 -4
- package/dist/cdn/PVTCJ67N.js +0 -4
- package/dist/cdn/RC2PKLFD.js +0 -4
- package/dist/cdn/RLYPTZW6.js +0 -4
- package/dist/cdn/RRJG3CW4.js +0 -4
- package/dist/cdn/SRXUA5WQ.js +0 -4
- package/dist/cdn/T5RGPAAI.js +0 -4
- package/dist/cdn/TEBWJ3I7.js +0 -4
- package/dist/cdn/TISZTZQL.js +0 -4
- package/dist/cdn/UF2KELUQ.js +0 -4
- package/dist/cdn/UF5A7HCA.js +0 -4
- package/dist/cdn/UKX6JNY3.js +0 -4
- package/dist/cdn/UPUPF3OI.js +0 -4
- package/dist/cdn/V5FW6B4I.js +0 -4
- package/dist/cdn/VF2Y76QB.js +0 -4
- package/dist/cdn/W425S3CR.js +0 -4
- package/dist/cdn/WE4HRX3B.js +0 -4
- package/dist/cdn/X7HXAK7T.js +0 -4
- package/dist/cdn/XBWRLYN4.js +0 -4
- package/dist/cdn/XIHWMEJG.js +0 -4
- package/dist/cdn/YGTIT746.js +0 -4
- package/dist/cdn/YJLPPO4D.js +0 -4
- package/dist/cdn/YTVNHZ2T.js +0 -4
- package/dist/cdn/YZO4MONH.js +0 -4
- package/dist/cdn/ZPQ7DJV3.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.50",
|
|
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
|
{
|
|
@@ -1374,7 +1387,7 @@
|
|
|
1374
1387
|
},
|
|
1375
1388
|
{
|
|
1376
1389
|
"name": "arcgis-bookmarks",
|
|
1377
|
-
"description": "The Bookmarks component
|
|
1390
|
+
"description": "The Bookmarks component allows end users to quickly navigate to a particular area of interest.\nIt displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html),\nwhich are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks).\n\nEach bookmark may contain the following properties: `name`, `thumbnail`, `viewpoint` (defines rotation, scale, and target geometry), and `timeExtent`.\nWhen a bookmark with a timeExtent is selected, the [arcgis-map.timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeExtent) of the Map will be set to the timeExtent of the selected bookmark.\nTo disable time capability in the Bookmarks component, set [timeDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#timeDisabled) to `true`.\n\nThe Bookmarks component can be used to create, edit, reorder, and delete bookmarks.\nTo enable these features, set the following properties to `true`:\n[showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showAddBookmarkButton), [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton), and [dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#dragEnabled).\n\n**Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) only if they come from a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks) or are [provided manually](#bookmarks). [Presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html) provides a similar experience for [WebScenes](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html).\n--\n\n### Events\n- **arcgisBookmarkEdit** - \nFires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited.\n- **arcgisBookmarkSelect** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected.\n- **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- `goTo(bookmark: __esri.Bookmark): Promise<void>` - Zoom to a specific bookmark.",
|
|
1378
1391
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/",
|
|
1379
1392
|
"attributes": [
|
|
1380
1393
|
{
|
|
@@ -1395,7 +1408,7 @@
|
|
|
1395
1408
|
},
|
|
1396
1409
|
{
|
|
1397
1410
|
"name": "disabled",
|
|
1398
|
-
"description": "When true, the
|
|
1411
|
+
"description": "When true, the component is visually withdrawn and cannot be interacted with.",
|
|
1399
1412
|
"default": "false",
|
|
1400
1413
|
"value": {
|
|
1401
1414
|
"type": "boolean"
|
|
@@ -1411,20 +1424,38 @@
|
|
|
1411
1424
|
},
|
|
1412
1425
|
{
|
|
1413
1426
|
"name": "filter-placeholder",
|
|
1414
|
-
"description": "Defines the text used as a placeholder when
|
|
1427
|
+
"description": "Defines the text used as a placeholder when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.",
|
|
1428
|
+
"default": "\"\"",
|
|
1415
1429
|
"value": {
|
|
1416
1430
|
"type": "string"
|
|
1417
1431
|
}
|
|
1418
1432
|
},
|
|
1419
1433
|
{
|
|
1420
1434
|
"name": "filter-text",
|
|
1421
|
-
"description": "Defines the text used to filter the bookmarks when
|
|
1435
|
+
"description": "Defines the text used to filter the bookmarks when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.",
|
|
1436
|
+
"default": "\"\"",
|
|
1422
1437
|
"value": {
|
|
1423
1438
|
"type": "string"
|
|
1424
1439
|
}
|
|
1425
1440
|
},
|
|
1441
|
+
{
|
|
1442
|
+
"name": "heading-level",
|
|
1443
|
+
"description": "Indicates the heading level to use for the message \"No bookmarks\" when no bookmarks\nare available. By default, this message is rendered\nas a level 2 heading (e.g. `<h2>No bookmarks</h2>`). 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.",
|
|
1444
|
+
"default": "2",
|
|
1445
|
+
"value": {
|
|
1446
|
+
"type": [
|
|
1447
|
+
"1",
|
|
1448
|
+
"2",
|
|
1449
|
+
"3",
|
|
1450
|
+
"4",
|
|
1451
|
+
"5",
|
|
1452
|
+
"6"
|
|
1453
|
+
]
|
|
1454
|
+
}
|
|
1455
|
+
},
|
|
1426
1456
|
{
|
|
1427
1457
|
"name": "hide-flow",
|
|
1458
|
+
"description": "Determines whether the component should be rendered within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/).",
|
|
1428
1459
|
"default": "false",
|
|
1429
1460
|
"value": {
|
|
1430
1461
|
"type": "boolean"
|
|
@@ -1432,6 +1463,7 @@
|
|
|
1432
1463
|
},
|
|
1433
1464
|
{
|
|
1434
1465
|
"name": "hide-thumbnail",
|
|
1466
|
+
"description": "Indicates whether the thumbnail associated with the bookmark is hidden.",
|
|
1435
1467
|
"default": "false",
|
|
1436
1468
|
"value": {
|
|
1437
1469
|
"type": "boolean"
|
|
@@ -1439,6 +1471,7 @@
|
|
|
1439
1471
|
},
|
|
1440
1472
|
{
|
|
1441
1473
|
"name": "hide-time",
|
|
1474
|
+
"description": "Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.",
|
|
1442
1475
|
"default": "false",
|
|
1443
1476
|
"value": {
|
|
1444
1477
|
"type": "boolean"
|
|
@@ -1446,22 +1479,22 @@
|
|
|
1446
1479
|
},
|
|
1447
1480
|
{
|
|
1448
1481
|
"name": "icon",
|
|
1449
|
-
"description": "Icon which represents the
|
|
1450
|
-
"default": "\"
|
|
1482
|
+
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
1483
|
+
"default": "\"icon\"",
|
|
1451
1484
|
"value": {
|
|
1452
1485
|
"type": "string"
|
|
1453
1486
|
}
|
|
1454
1487
|
},
|
|
1455
1488
|
{
|
|
1456
1489
|
"name": "label",
|
|
1457
|
-
"description": "The
|
|
1490
|
+
"description": "The component's default label.",
|
|
1458
1491
|
"value": {
|
|
1459
1492
|
"type": "string"
|
|
1460
1493
|
}
|
|
1461
1494
|
},
|
|
1462
1495
|
{
|
|
1463
1496
|
"name": "position",
|
|
1464
|
-
"default": "\"
|
|
1497
|
+
"default": "\"top-left\"",
|
|
1465
1498
|
"value": {
|
|
1466
1499
|
"type": [
|
|
1467
1500
|
"\"bottom-leading\"",
|
|
@@ -1478,12 +1511,14 @@
|
|
|
1478
1511
|
},
|
|
1479
1512
|
{
|
|
1480
1513
|
"name": "reference-element",
|
|
1514
|
+
"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
1515
|
"value": {
|
|
1482
1516
|
"type": "string"
|
|
1483
1517
|
}
|
|
1484
1518
|
},
|
|
1485
1519
|
{
|
|
1486
1520
|
"name": "show-add-bookmark-button",
|
|
1521
|
+
"description": "Indicates whether to display the button to add a new bookmark.",
|
|
1487
1522
|
"default": "false",
|
|
1488
1523
|
"value": {
|
|
1489
1524
|
"type": "boolean"
|
|
@@ -1491,6 +1526,7 @@
|
|
|
1491
1526
|
},
|
|
1492
1527
|
{
|
|
1493
1528
|
"name": "show-close-button",
|
|
1529
|
+
"description": "Indicates whether to display the close button.",
|
|
1494
1530
|
"default": "false",
|
|
1495
1531
|
"value": {
|
|
1496
1532
|
"type": "boolean"
|
|
@@ -1498,6 +1534,7 @@
|
|
|
1498
1534
|
},
|
|
1499
1535
|
{
|
|
1500
1536
|
"name": "show-collapse-button",
|
|
1537
|
+
"description": "Indicates whether to display the collapse button.",
|
|
1501
1538
|
"default": "false",
|
|
1502
1539
|
"value": {
|
|
1503
1540
|
"type": "boolean"
|
|
@@ -1505,6 +1542,7 @@
|
|
|
1505
1542
|
},
|
|
1506
1543
|
{
|
|
1507
1544
|
"name": "show-edit-bookmark-button",
|
|
1545
|
+
"description": "Indicates whether to display the button to edit a bookmark.",
|
|
1508
1546
|
"default": "false",
|
|
1509
1547
|
"value": {
|
|
1510
1548
|
"type": "boolean"
|
|
@@ -1512,6 +1550,7 @@
|
|
|
1512
1550
|
},
|
|
1513
1551
|
{
|
|
1514
1552
|
"name": "show-filter",
|
|
1553
|
+
"description": "Indicates whether to display the bookmark filter.",
|
|
1515
1554
|
"default": "false",
|
|
1516
1555
|
"value": {
|
|
1517
1556
|
"type": "boolean"
|
|
@@ -1519,6 +1558,7 @@
|
|
|
1519
1558
|
},
|
|
1520
1559
|
{
|
|
1521
1560
|
"name": "show-heading",
|
|
1561
|
+
"description": "Indicates whether to display the heading.",
|
|
1522
1562
|
"default": "false",
|
|
1523
1563
|
"value": {
|
|
1524
1564
|
"type": "boolean"
|
|
@@ -1534,17 +1574,26 @@
|
|
|
1534
1574
|
"\"ready\""
|
|
1535
1575
|
]
|
|
1536
1576
|
}
|
|
1577
|
+
},
|
|
1578
|
+
{
|
|
1579
|
+
"name": "time-disabled",
|
|
1580
|
+
"description": "Indicates whether to disable the time capability of the Bookmarks component.",
|
|
1581
|
+
"default": "false",
|
|
1582
|
+
"value": {
|
|
1583
|
+
"type": "boolean"
|
|
1584
|
+
}
|
|
1537
1585
|
}
|
|
1538
1586
|
],
|
|
1539
1587
|
"events": [
|
|
1540
1588
|
{
|
|
1541
|
-
"name": "
|
|
1542
|
-
"type": "
|
|
1543
|
-
"description": "
|
|
1589
|
+
"name": "arcgisBookmarkEdit",
|
|
1590
|
+
"type": "BookmarksBookmarkEditEvent",
|
|
1591
|
+
"description": "\nFires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited."
|
|
1544
1592
|
},
|
|
1545
1593
|
{
|
|
1546
|
-
"name": "
|
|
1547
|
-
"type": "
|
|
1594
|
+
"name": "arcgisBookmarkSelect",
|
|
1595
|
+
"type": "BookmarksBookmarkSelectEvent",
|
|
1596
|
+
"description": "Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected."
|
|
1548
1597
|
},
|
|
1549
1598
|
{
|
|
1550
1599
|
"name": "arcgisPropertyChange",
|
|
@@ -1555,10 +1604,6 @@
|
|
|
1555
1604
|
"name": "arcgisReady",
|
|
1556
1605
|
"type": "void",
|
|
1557
1606
|
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
|
|
1558
|
-
},
|
|
1559
|
-
{
|
|
1560
|
-
"name": "arcgisSelect",
|
|
1561
|
-
"type": "BookmarksBookmarkSelectEvent"
|
|
1562
1607
|
}
|
|
1563
1608
|
],
|
|
1564
1609
|
"js": {
|
|
@@ -1570,7 +1615,7 @@
|
|
|
1570
1615
|
},
|
|
1571
1616
|
{
|
|
1572
1617
|
"name": "bookmarks",
|
|
1573
|
-
"description": "A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s
|
|
1618
|
+
"description": "A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s. These are typically defined inside of a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks), but can also be defined manually, as shown in the code snippet below.",
|
|
1574
1619
|
"type": "Collection<Bookmark>"
|
|
1575
1620
|
},
|
|
1576
1621
|
{
|
|
@@ -1580,17 +1625,17 @@
|
|
|
1580
1625
|
},
|
|
1581
1626
|
{
|
|
1582
1627
|
"name": "defaultCreateOptions",
|
|
1583
|
-
"description": "Specifies how new bookmarks will be created if [
|
|
1628
|
+
"description": "Specifies how new bookmarks will be created if [showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showAddBookmarkButton) is set to `true`.\nCan be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current\nview when a bookmark is created. See [BookmarkOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel-BookmarkOptions.html)\nfor the full list of options.",
|
|
1584
1629
|
"type": "BookmarkOptions"
|
|
1585
1630
|
},
|
|
1586
1631
|
{
|
|
1587
1632
|
"name": "defaultEditOptions",
|
|
1588
|
-
"description": "Specifies how bookmarks will be edited, if [
|
|
1633
|
+
"description": "Specifies how bookmarks will be edited, if [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton) is set to `true`.\nCan be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current\nview when a bookmark is edited. See [BookmarkOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel-BookmarkOptions.html)\nfor the full list of options.",
|
|
1589
1634
|
"type": "BookmarkOptions"
|
|
1590
1635
|
},
|
|
1591
1636
|
{
|
|
1592
1637
|
"name": "disabled",
|
|
1593
|
-
"description": "When true, the
|
|
1638
|
+
"description": "When true, the component is visually withdrawn and cannot be interacted with.",
|
|
1594
1639
|
"type": "boolean"
|
|
1595
1640
|
},
|
|
1596
1641
|
{
|
|
@@ -1600,88 +1645,114 @@
|
|
|
1600
1645
|
},
|
|
1601
1646
|
{
|
|
1602
1647
|
"name": "filterPlaceholder",
|
|
1603
|
-
"description": "Defines the text used as a placeholder when
|
|
1648
|
+
"description": "Defines the text used as a placeholder when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.",
|
|
1604
1649
|
"type": "string"
|
|
1605
1650
|
},
|
|
1606
1651
|
{
|
|
1607
1652
|
"name": "filterText",
|
|
1608
|
-
"description": "Defines the text used to filter the bookmarks when
|
|
1653
|
+
"description": "Defines the text used to filter the bookmarks when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.",
|
|
1609
1654
|
"type": "string"
|
|
1610
1655
|
},
|
|
1611
1656
|
{
|
|
1612
1657
|
"name": "goToOverride",
|
|
1613
|
-
"description": "This function provides the ability to override either the\n[MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or\n[SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#goToOverride)",
|
|
1658
|
+
"description": "This function provides the ability to override either the\n[MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or\n[SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#goToOverride)",
|
|
1614
1659
|
"type": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))"
|
|
1615
1660
|
},
|
|
1661
|
+
{
|
|
1662
|
+
"name": "headingLevel",
|
|
1663
|
+
"description": "Indicates the heading level to use for the message \"No bookmarks\" when no bookmarks\nare available. By default, this message is rendered\nas a level 2 heading (e.g. `<h2>No bookmarks</h2>`). 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.",
|
|
1664
|
+
"type": "1 | 2 | 3 | 4 | 5 | 6"
|
|
1665
|
+
},
|
|
1616
1666
|
{
|
|
1617
1667
|
"name": "hideFlow",
|
|
1668
|
+
"description": "Determines whether the component should be rendered within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/).",
|
|
1618
1669
|
"type": "boolean"
|
|
1619
1670
|
},
|
|
1620
1671
|
{
|
|
1621
1672
|
"name": "hideThumbnail",
|
|
1673
|
+
"description": "Indicates whether the thumbnail associated with the bookmark is hidden.",
|
|
1622
1674
|
"type": "boolean"
|
|
1623
1675
|
},
|
|
1624
1676
|
{
|
|
1625
1677
|
"name": "hideTime",
|
|
1678
|
+
"description": "Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.",
|
|
1626
1679
|
"type": "boolean"
|
|
1627
1680
|
},
|
|
1628
1681
|
{
|
|
1629
1682
|
"name": "icon",
|
|
1630
|
-
"description": "Icon which represents the
|
|
1683
|
+
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
1631
1684
|
"type": "string"
|
|
1632
1685
|
},
|
|
1633
1686
|
{
|
|
1634
1687
|
"name": "label",
|
|
1635
|
-
"description": "The
|
|
1688
|
+
"description": "The component's default label.",
|
|
1636
1689
|
"type": "string"
|
|
1637
1690
|
},
|
|
1691
|
+
{
|
|
1692
|
+
"name": "messageOverrides",
|
|
1693
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
1694
|
+
"type": "Record<string, unknown>"
|
|
1695
|
+
},
|
|
1638
1696
|
{
|
|
1639
1697
|
"name": "position",
|
|
1640
1698
|
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
|
|
1641
1699
|
},
|
|
1642
1700
|
{
|
|
1643
1701
|
"name": "referenceElement",
|
|
1702
|
+
"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
1703
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
1645
1704
|
},
|
|
1646
1705
|
{
|
|
1647
1706
|
"name": "showAddBookmarkButton",
|
|
1707
|
+
"description": "Indicates whether to display the button to add a new bookmark.",
|
|
1648
1708
|
"type": "boolean"
|
|
1649
1709
|
},
|
|
1650
1710
|
{
|
|
1651
1711
|
"name": "showCloseButton",
|
|
1712
|
+
"description": "Indicates whether to display the close button.",
|
|
1652
1713
|
"type": "boolean"
|
|
1653
1714
|
},
|
|
1654
1715
|
{
|
|
1655
1716
|
"name": "showCollapseButton",
|
|
1717
|
+
"description": "Indicates whether to display the collapse button.",
|
|
1656
1718
|
"type": "boolean"
|
|
1657
1719
|
},
|
|
1658
1720
|
{
|
|
1659
1721
|
"name": "showEditBookmarkButton",
|
|
1722
|
+
"description": "Indicates whether to display the button to edit a bookmark.",
|
|
1660
1723
|
"type": "boolean"
|
|
1661
1724
|
},
|
|
1662
1725
|
{
|
|
1663
1726
|
"name": "showFilter",
|
|
1727
|
+
"description": "Indicates whether to display the bookmark filter.",
|
|
1664
1728
|
"type": "boolean"
|
|
1665
1729
|
},
|
|
1666
1730
|
{
|
|
1667
1731
|
"name": "showHeading",
|
|
1732
|
+
"description": "Indicates whether to display the heading.",
|
|
1668
1733
|
"type": "boolean"
|
|
1669
1734
|
},
|
|
1670
1735
|
{
|
|
1671
1736
|
"name": "state",
|
|
1672
1737
|
"description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#state)",
|
|
1673
1738
|
"type": "\"loading\" | \"ready\""
|
|
1739
|
+
},
|
|
1740
|
+
{
|
|
1741
|
+
"name": "timeDisabled",
|
|
1742
|
+
"description": "Indicates whether to disable the time capability of the Bookmarks component.",
|
|
1743
|
+
"type": "boolean"
|
|
1674
1744
|
}
|
|
1675
1745
|
],
|
|
1676
1746
|
"events": [
|
|
1677
1747
|
{
|
|
1678
|
-
"name": "
|
|
1679
|
-
"type": "
|
|
1680
|
-
"description": "
|
|
1748
|
+
"name": "arcgisBookmarkEdit",
|
|
1749
|
+
"type": "BookmarksBookmarkEditEvent",
|
|
1750
|
+
"description": "\nFires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited."
|
|
1681
1751
|
},
|
|
1682
1752
|
{
|
|
1683
|
-
"name": "
|
|
1684
|
-
"type": "
|
|
1753
|
+
"name": "arcgisBookmarkSelect",
|
|
1754
|
+
"type": "BookmarksBookmarkSelectEvent",
|
|
1755
|
+
"description": "Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected."
|
|
1685
1756
|
},
|
|
1686
1757
|
{
|
|
1687
1758
|
"name": "arcgisPropertyChange",
|
|
@@ -1692,17 +1763,13 @@
|
|
|
1692
1763
|
"name": "arcgisReady",
|
|
1693
1764
|
"type": "void",
|
|
1694
1765
|
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
|
|
1695
|
-
},
|
|
1696
|
-
{
|
|
1697
|
-
"name": "arcgisSelect",
|
|
1698
|
-
"type": "BookmarksBookmarkSelectEvent"
|
|
1699
1766
|
}
|
|
1700
1767
|
]
|
|
1701
1768
|
}
|
|
1702
1769
|
},
|
|
1703
1770
|
{
|
|
1704
1771
|
"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.",
|
|
1772
|
+
"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
1773
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/",
|
|
1707
1774
|
"attributes": [
|
|
1708
1775
|
{
|
|
@@ -1715,7 +1782,7 @@
|
|
|
1715
1782
|
},
|
|
1716
1783
|
{
|
|
1717
1784
|
"name": "heading-level",
|
|
1718
|
-
"description": "Indicates the heading level to use for the
|
|
1785
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1719
1786
|
"default": "3",
|
|
1720
1787
|
"value": {
|
|
1721
1788
|
"type": "number"
|
|
@@ -1744,7 +1811,7 @@
|
|
|
1744
1811
|
},
|
|
1745
1812
|
{
|
|
1746
1813
|
"name": "icon",
|
|
1747
|
-
"description": "Icon which represents the
|
|
1814
|
+
"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
1815
|
"default": "\"organization\"",
|
|
1749
1816
|
"value": {
|
|
1750
1817
|
"type": "string"
|
|
@@ -1752,7 +1819,7 @@
|
|
|
1752
1819
|
},
|
|
1753
1820
|
{
|
|
1754
1821
|
"name": "label",
|
|
1755
|
-
"description": "The
|
|
1822
|
+
"description": "The component's default label.",
|
|
1756
1823
|
"value": {
|
|
1757
1824
|
"type": "string"
|
|
1758
1825
|
}
|
|
@@ -1776,13 +1843,14 @@
|
|
|
1776
1843
|
},
|
|
1777
1844
|
{
|
|
1778
1845
|
"name": "reference-element",
|
|
1846
|
+
"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
1847
|
"value": {
|
|
1780
1848
|
"type": "string"
|
|
1781
1849
|
}
|
|
1782
1850
|
},
|
|
1783
1851
|
{
|
|
1784
1852
|
"name": "state",
|
|
1785
|
-
"description": "The
|
|
1853
|
+
"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
1854
|
"default": "\"disabled\"",
|
|
1787
1855
|
"value": {
|
|
1788
1856
|
"type": [
|
|
@@ -1815,7 +1883,7 @@
|
|
|
1815
1883
|
},
|
|
1816
1884
|
{
|
|
1817
1885
|
"name": "headingLevel",
|
|
1818
|
-
"description": "Indicates the heading level to use for the
|
|
1886
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1819
1887
|
"type": "number"
|
|
1820
1888
|
},
|
|
1821
1889
|
{
|
|
@@ -1832,17 +1900,17 @@
|
|
|
1832
1900
|
},
|
|
1833
1901
|
{
|
|
1834
1902
|
"name": "icon",
|
|
1835
|
-
"description": "Icon which represents the
|
|
1903
|
+
"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
1904
|
"type": "string"
|
|
1837
1905
|
},
|
|
1838
1906
|
{
|
|
1839
1907
|
"name": "label",
|
|
1840
|
-
"description": "The
|
|
1908
|
+
"description": "The component's default label.",
|
|
1841
1909
|
"type": "string"
|
|
1842
1910
|
},
|
|
1843
1911
|
{
|
|
1844
1912
|
"name": "layers",
|
|
1845
|
-
"description": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)
|
|
1913
|
+
"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
1914
|
"type": "Collection<BuildingSceneLayer>"
|
|
1847
1915
|
},
|
|
1848
1916
|
{
|
|
@@ -1861,11 +1929,12 @@
|
|
|
1861
1929
|
},
|
|
1862
1930
|
{
|
|
1863
1931
|
"name": "referenceElement",
|
|
1932
|
+
"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
1933
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
1865
1934
|
},
|
|
1866
1935
|
{
|
|
1867
1936
|
"name": "state",
|
|
1868
|
-
"description": "The
|
|
1937
|
+
"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
1938
|
"type": "\"disabled\" | \"failed\" | \"loading\" | \"ready\""
|
|
1870
1939
|
}
|
|
1871
1940
|
],
|
|
@@ -1992,6 +2061,7 @@
|
|
|
1992
2061
|
},
|
|
1993
2062
|
{
|
|
1994
2063
|
"name": "reference-element",
|
|
2064
|
+
"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
2065
|
"value": {
|
|
1996
2066
|
"type": "string"
|
|
1997
2067
|
}
|
|
@@ -2178,6 +2248,7 @@
|
|
|
2178
2248
|
},
|
|
2179
2249
|
{
|
|
2180
2250
|
"name": "referenceElement",
|
|
2251
|
+
"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
2252
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2182
2253
|
},
|
|
2183
2254
|
{
|
|
@@ -2295,6 +2366,7 @@
|
|
|
2295
2366
|
},
|
|
2296
2367
|
{
|
|
2297
2368
|
"name": "reference-element",
|
|
2369
|
+
"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
2370
|
"value": {
|
|
2299
2371
|
"type": "string"
|
|
2300
2372
|
}
|
|
@@ -2348,7 +2420,7 @@
|
|
|
2348
2420
|
},
|
|
2349
2421
|
{
|
|
2350
2422
|
"name": "messageOverrides",
|
|
2351
|
-
"description": "Replace localized message strings with your own strings
|
|
2423
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
2352
2424
|
"type": "Record<string, unknown>"
|
|
2353
2425
|
},
|
|
2354
2426
|
{
|
|
@@ -2362,6 +2434,7 @@
|
|
|
2362
2434
|
},
|
|
2363
2435
|
{
|
|
2364
2436
|
"name": "referenceElement",
|
|
2437
|
+
"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
2438
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2366
2439
|
},
|
|
2367
2440
|
{
|
|
@@ -2413,14 +2486,14 @@
|
|
|
2413
2486
|
}
|
|
2414
2487
|
},
|
|
2415
2488
|
{
|
|
2416
|
-
"name": "hide-
|
|
2489
|
+
"name": "hide-expand-button",
|
|
2417
2490
|
"default": "false",
|
|
2418
2491
|
"value": {
|
|
2419
2492
|
"type": "boolean"
|
|
2420
2493
|
}
|
|
2421
2494
|
},
|
|
2422
2495
|
{
|
|
2423
|
-
"name": "hide-
|
|
2496
|
+
"name": "hide-input-button",
|
|
2424
2497
|
"default": "false",
|
|
2425
2498
|
"value": {
|
|
2426
2499
|
"type": "boolean"
|
|
@@ -2498,6 +2571,7 @@
|
|
|
2498
2571
|
},
|
|
2499
2572
|
{
|
|
2500
2573
|
"name": "reference-element",
|
|
2574
|
+
"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
2575
|
"value": {
|
|
2502
2576
|
"type": "string"
|
|
2503
2577
|
}
|
|
@@ -2583,11 +2657,11 @@
|
|
|
2583
2657
|
"type": "boolean"
|
|
2584
2658
|
},
|
|
2585
2659
|
{
|
|
2586
|
-
"name": "
|
|
2660
|
+
"name": "hideExpandButton",
|
|
2587
2661
|
"type": "boolean"
|
|
2588
2662
|
},
|
|
2589
2663
|
{
|
|
2590
|
-
"name": "
|
|
2664
|
+
"name": "hideInputButton",
|
|
2591
2665
|
"type": "boolean"
|
|
2592
2666
|
},
|
|
2593
2667
|
{
|
|
@@ -2630,6 +2704,7 @@
|
|
|
2630
2704
|
},
|
|
2631
2705
|
{
|
|
2632
2706
|
"name": "referenceElement",
|
|
2707
|
+
"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
2708
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2634
2709
|
},
|
|
2635
2710
|
{
|
|
@@ -2664,7 +2739,7 @@
|
|
|
2664
2739
|
},
|
|
2665
2740
|
{
|
|
2666
2741
|
"name": "arcgis-daylight",
|
|
2667
|
-
"description": "The Daylight component can be used to manipulate the lighting conditions of a [
|
|
2742
|
+
"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
2743
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/",
|
|
2669
2744
|
"attributes": [
|
|
2670
2745
|
{
|
|
@@ -2689,7 +2764,7 @@
|
|
|
2689
2764
|
},
|
|
2690
2765
|
{
|
|
2691
2766
|
"name": "date-or-season",
|
|
2692
|
-
"description": "Controls whether the
|
|
2767
|
+
"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
2768
|
"default": "\"date\"",
|
|
2694
2769
|
"value": {
|
|
2695
2770
|
"type": [
|
|
@@ -2708,7 +2783,7 @@
|
|
|
2708
2783
|
},
|
|
2709
2784
|
{
|
|
2710
2785
|
"name": "heading-level",
|
|
2711
|
-
"description": "Indicates the heading level to use for the
|
|
2786
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
2712
2787
|
"default": "3",
|
|
2713
2788
|
"value": {
|
|
2714
2789
|
"type": "number"
|
|
@@ -2758,7 +2833,7 @@
|
|
|
2758
2833
|
},
|
|
2759
2834
|
{
|
|
2760
2835
|
"name": "icon",
|
|
2761
|
-
"description": "Icon which represents the
|
|
2836
|
+
"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
2837
|
"default": "\"brightness\"",
|
|
2763
2838
|
"value": {
|
|
2764
2839
|
"type": "string"
|
|
@@ -2766,7 +2841,7 @@
|
|
|
2766
2841
|
},
|
|
2767
2842
|
{
|
|
2768
2843
|
"name": "label",
|
|
2769
|
-
"description": "The
|
|
2844
|
+
"description": "The component's default label.",
|
|
2770
2845
|
"value": {
|
|
2771
2846
|
"type": "string"
|
|
2772
2847
|
}
|
|
@@ -2798,13 +2873,14 @@
|
|
|
2798
2873
|
},
|
|
2799
2874
|
{
|
|
2800
2875
|
"name": "reference-element",
|
|
2876
|
+
"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
2877
|
"value": {
|
|
2802
2878
|
"type": "string"
|
|
2803
2879
|
}
|
|
2804
2880
|
},
|
|
2805
2881
|
{
|
|
2806
2882
|
"name": "time-slider-steps",
|
|
2807
|
-
"description": "Sets steps, or intervals, on the time slider to restrict the times
|
|
2883
|
+
"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
2884
|
"default": "5",
|
|
2809
2885
|
"value": {
|
|
2810
2886
|
"type": "number"
|
|
@@ -2828,7 +2904,7 @@
|
|
|
2828
2904
|
{
|
|
2829
2905
|
"name": "arcgisUserDateTimeChange",
|
|
2830
2906
|
"type": "void",
|
|
2831
|
-
"description": "Fires when the user changes the date or time in the
|
|
2907
|
+
"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
2908
|
}
|
|
2833
2909
|
],
|
|
2834
2910
|
"js": {
|
|
@@ -2845,7 +2921,7 @@
|
|
|
2845
2921
|
},
|
|
2846
2922
|
{
|
|
2847
2923
|
"name": "dateOrSeason",
|
|
2848
|
-
"description": "Controls whether the
|
|
2924
|
+
"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
2925
|
"type": "\"date\" | \"season\""
|
|
2850
2926
|
},
|
|
2851
2927
|
{
|
|
@@ -2855,7 +2931,7 @@
|
|
|
2855
2931
|
},
|
|
2856
2932
|
{
|
|
2857
2933
|
"name": "headingLevel",
|
|
2858
|
-
"description": "Indicates the heading level to use for the
|
|
2934
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
2859
2935
|
"type": "number"
|
|
2860
2936
|
},
|
|
2861
2937
|
{
|
|
@@ -2884,12 +2960,12 @@
|
|
|
2884
2960
|
},
|
|
2885
2961
|
{
|
|
2886
2962
|
"name": "icon",
|
|
2887
|
-
"description": "Icon which represents the
|
|
2963
|
+
"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
2964
|
"type": "string"
|
|
2889
2965
|
},
|
|
2890
2966
|
{
|
|
2891
2967
|
"name": "label",
|
|
2892
|
-
"description": "The
|
|
2968
|
+
"description": "The component's default label.",
|
|
2893
2969
|
"type": "string"
|
|
2894
2970
|
},
|
|
2895
2971
|
{
|
|
@@ -2903,11 +2979,12 @@
|
|
|
2903
2979
|
},
|
|
2904
2980
|
{
|
|
2905
2981
|
"name": "referenceElement",
|
|
2982
|
+
"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
2983
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2907
2984
|
},
|
|
2908
2985
|
{
|
|
2909
2986
|
"name": "timeSliderSteps",
|
|
2910
|
-
"description": "Sets steps, or intervals, on the time slider to restrict the times
|
|
2987
|
+
"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
2988
|
"type": "Array<number> | number"
|
|
2912
2989
|
},
|
|
2913
2990
|
{
|
|
@@ -2925,7 +3002,7 @@
|
|
|
2925
3002
|
{
|
|
2926
3003
|
"name": "arcgisUserDateTimeChange",
|
|
2927
3004
|
"type": "void",
|
|
2928
|
-
"description": "Fires when the user changes the date or time in the
|
|
3005
|
+
"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
3006
|
}
|
|
2930
3007
|
]
|
|
2931
3008
|
}
|
|
@@ -2993,6 +3070,7 @@
|
|
|
2993
3070
|
},
|
|
2994
3071
|
{
|
|
2995
3072
|
"name": "reference-element",
|
|
3073
|
+
"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
3074
|
"value": {
|
|
2997
3075
|
"type": "string"
|
|
2998
3076
|
}
|
|
@@ -3078,7 +3156,7 @@
|
|
|
3078
3156
|
},
|
|
3079
3157
|
{
|
|
3080
3158
|
"name": "messageOverrides",
|
|
3081
|
-
"description": "Replace localized message strings with your own strings
|
|
3159
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
3082
3160
|
"type": "Record<string, unknown>"
|
|
3083
3161
|
},
|
|
3084
3162
|
{
|
|
@@ -3087,6 +3165,7 @@
|
|
|
3087
3165
|
},
|
|
3088
3166
|
{
|
|
3089
3167
|
"name": "referenceElement",
|
|
3168
|
+
"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
3169
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3091
3170
|
},
|
|
3092
3171
|
{
|
|
@@ -3215,6 +3294,7 @@
|
|
|
3215
3294
|
},
|
|
3216
3295
|
{
|
|
3217
3296
|
"name": "reference-element",
|
|
3297
|
+
"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
3298
|
"value": {
|
|
3219
3299
|
"type": "string"
|
|
3220
3300
|
}
|
|
@@ -3346,6 +3426,7 @@
|
|
|
3346
3426
|
},
|
|
3347
3427
|
{
|
|
3348
3428
|
"name": "referenceElement",
|
|
3429
|
+
"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
3430
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3350
3431
|
},
|
|
3351
3432
|
{
|
|
@@ -3354,7 +3435,7 @@
|
|
|
3354
3435
|
},
|
|
3355
3436
|
{
|
|
3356
3437
|
"name": "searchProperties",
|
|
3357
|
-
"description": "Controls the default properties used when
|
|
3438
|
+
"description": "Controls the default properties used when searching.",
|
|
3358
3439
|
"type": "DirectionsSearchProperties"
|
|
3359
3440
|
},
|
|
3360
3441
|
{
|
|
@@ -3388,7 +3469,7 @@
|
|
|
3388
3469
|
},
|
|
3389
3470
|
{
|
|
3390
3471
|
"name": "arcgis-direct-line-measurement-3d",
|
|
3391
|
-
"description": "The Direct Line Measurement 3D component
|
|
3472
|
+
"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
3473
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/",
|
|
3393
3474
|
"attributes": [
|
|
3394
3475
|
{
|
|
@@ -3433,12 +3514,14 @@
|
|
|
3433
3514
|
},
|
|
3434
3515
|
{
|
|
3435
3516
|
"name": "reference-element",
|
|
3517
|
+
"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
3518
|
"value": {
|
|
3437
3519
|
"type": "string"
|
|
3438
3520
|
}
|
|
3439
3521
|
},
|
|
3440
3522
|
{
|
|
3441
3523
|
"name": "state",
|
|
3524
|
+
"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
3525
|
"value": {
|
|
3443
3526
|
"type": [
|
|
3444
3527
|
"\"disabled\"",
|
|
@@ -3450,7 +3533,7 @@
|
|
|
3450
3533
|
},
|
|
3451
3534
|
{
|
|
3452
3535
|
"name": "unit",
|
|
3453
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3536
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3454
3537
|
"value": {
|
|
3455
3538
|
"type": [
|
|
3456
3539
|
"\"centimeters\"",
|
|
@@ -3486,6 +3569,7 @@
|
|
|
3486
3569
|
"properties": [
|
|
3487
3570
|
{
|
|
3488
3571
|
"name": "analysis",
|
|
3572
|
+
"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
3573
|
"type": "DirectLineMeasurementAnalysis"
|
|
3490
3574
|
},
|
|
3491
3575
|
{
|
|
@@ -3509,20 +3593,22 @@
|
|
|
3509
3593
|
},
|
|
3510
3594
|
{
|
|
3511
3595
|
"name": "referenceElement",
|
|
3596
|
+
"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
3597
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3513
3598
|
},
|
|
3514
3599
|
{
|
|
3515
3600
|
"name": "state",
|
|
3601
|
+
"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
3602
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
3517
3603
|
},
|
|
3518
3604
|
{
|
|
3519
3605
|
"name": "unit",
|
|
3520
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3606
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3521
3607
|
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
3522
3608
|
},
|
|
3523
3609
|
{
|
|
3524
3610
|
"name": "unitOptions",
|
|
3525
|
-
"description": "List of unit systems (imperial, metric)
|
|
3611
|
+
"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
3612
|
"type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
|
|
3527
3613
|
}
|
|
3528
3614
|
],
|
|
@@ -3542,7 +3628,7 @@
|
|
|
3542
3628
|
},
|
|
3543
3629
|
{
|
|
3544
3630
|
"name": "arcgis-directline-measurement-3d",
|
|
3545
|
-
"description": "**Deprecated**. The
|
|
3631
|
+
"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
3632
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directline-measurement-3d/",
|
|
3547
3633
|
"attributes": [
|
|
3548
3634
|
{
|
|
@@ -3587,12 +3673,14 @@
|
|
|
3587
3673
|
},
|
|
3588
3674
|
{
|
|
3589
3675
|
"name": "reference-element",
|
|
3676
|
+
"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
3677
|
"value": {
|
|
3591
3678
|
"type": "string"
|
|
3592
3679
|
}
|
|
3593
3680
|
},
|
|
3594
3681
|
{
|
|
3595
3682
|
"name": "state",
|
|
3683
|
+
"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
3684
|
"value": {
|
|
3597
3685
|
"type": [
|
|
3598
3686
|
"\"disabled\"",
|
|
@@ -3604,7 +3692,7 @@
|
|
|
3604
3692
|
},
|
|
3605
3693
|
{
|
|
3606
3694
|
"name": "unit",
|
|
3607
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3695
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3608
3696
|
"value": {
|
|
3609
3697
|
"type": [
|
|
3610
3698
|
"\"centimeters\"",
|
|
@@ -3640,6 +3728,7 @@
|
|
|
3640
3728
|
"properties": [
|
|
3641
3729
|
{
|
|
3642
3730
|
"name": "analysis",
|
|
3731
|
+
"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
3732
|
"type": "DirectLineMeasurementAnalysis"
|
|
3644
3733
|
},
|
|
3645
3734
|
{
|
|
@@ -3663,20 +3752,22 @@
|
|
|
3663
3752
|
},
|
|
3664
3753
|
{
|
|
3665
3754
|
"name": "referenceElement",
|
|
3755
|
+
"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
3756
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3667
3757
|
},
|
|
3668
3758
|
{
|
|
3669
3759
|
"name": "state",
|
|
3760
|
+
"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
3761
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
3671
3762
|
},
|
|
3672
3763
|
{
|
|
3673
3764
|
"name": "unit",
|
|
3674
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3765
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3675
3766
|
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
3676
3767
|
},
|
|
3677
3768
|
{
|
|
3678
3769
|
"name": "unitOptions",
|
|
3679
|
-
"description": "List of unit systems (imperial, metric)
|
|
3770
|
+
"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
3771
|
"type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
|
|
3681
3772
|
}
|
|
3682
3773
|
],
|
|
@@ -3741,6 +3832,7 @@
|
|
|
3741
3832
|
},
|
|
3742
3833
|
{
|
|
3743
3834
|
"name": "reference-element",
|
|
3835
|
+
"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
3836
|
"value": {
|
|
3745
3837
|
"type": "string"
|
|
3746
3838
|
}
|
|
@@ -3815,6 +3907,7 @@
|
|
|
3815
3907
|
},
|
|
3816
3908
|
{
|
|
3817
3909
|
"name": "referenceElement",
|
|
3910
|
+
"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
3911
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3819
3912
|
},
|
|
3820
3913
|
{
|
|
@@ -3963,6 +4056,7 @@
|
|
|
3963
4056
|
},
|
|
3964
4057
|
{
|
|
3965
4058
|
"name": "reference-element",
|
|
4059
|
+
"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
4060
|
"value": {
|
|
3967
4061
|
"type": "string"
|
|
3968
4062
|
}
|
|
@@ -3993,7 +4087,6 @@
|
|
|
3993
4087
|
"\"editing-attributes\"",
|
|
3994
4088
|
"\"editing-existing-feature\"",
|
|
3995
4089
|
"\"editing-features\"",
|
|
3996
|
-
"\"editing-new-feature\"",
|
|
3997
4090
|
"\"ready\"",
|
|
3998
4091
|
"\"viewing-selection-list\""
|
|
3999
4092
|
]
|
|
@@ -4087,6 +4180,7 @@
|
|
|
4087
4180
|
},
|
|
4088
4181
|
{
|
|
4089
4182
|
"name": "referenceElement",
|
|
4183
|
+
"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
4184
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4091
4185
|
},
|
|
4092
4186
|
{
|
|
@@ -4101,7 +4195,7 @@
|
|
|
4101
4195
|
{
|
|
4102
4196
|
"name": "state",
|
|
4103
4197
|
"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\" | \"
|
|
4198
|
+
"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
4199
|
},
|
|
4106
4200
|
{
|
|
4107
4201
|
"name": "supportingWidgetDefaults",
|
|
@@ -4130,7 +4224,7 @@
|
|
|
4130
4224
|
},
|
|
4131
4225
|
{
|
|
4132
4226
|
"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
|
|
4227
|
+
"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
4228
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/",
|
|
4135
4229
|
"attributes": [
|
|
4136
4230
|
{
|
|
@@ -4214,7 +4308,7 @@
|
|
|
4214
4308
|
},
|
|
4215
4309
|
{
|
|
4216
4310
|
"name": "icon",
|
|
4217
|
-
"description": "Icon which represents the
|
|
4311
|
+
"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
4312
|
"default": "\"altitude\"",
|
|
4219
4313
|
"value": {
|
|
4220
4314
|
"type": "string"
|
|
@@ -4222,7 +4316,7 @@
|
|
|
4222
4316
|
},
|
|
4223
4317
|
{
|
|
4224
4318
|
"name": "label",
|
|
4225
|
-
"description": "The
|
|
4319
|
+
"description": "The component's default label.",
|
|
4226
4320
|
"value": {
|
|
4227
4321
|
"type": "string"
|
|
4228
4322
|
}
|
|
@@ -4246,13 +4340,14 @@
|
|
|
4246
4340
|
},
|
|
4247
4341
|
{
|
|
4248
4342
|
"name": "reference-element",
|
|
4343
|
+
"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
4344
|
"value": {
|
|
4250
4345
|
"type": "string"
|
|
4251
4346
|
}
|
|
4252
4347
|
},
|
|
4253
4348
|
{
|
|
4254
4349
|
"name": "state",
|
|
4255
|
-
"description": "The
|
|
4350
|
+
"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
4351
|
"default": "\"disabled\"",
|
|
4257
4352
|
"value": {
|
|
4258
4353
|
"type": [
|
|
@@ -4316,7 +4411,7 @@
|
|
|
4316
4411
|
},
|
|
4317
4412
|
{
|
|
4318
4413
|
"name": "effectiveUnits",
|
|
4319
|
-
"description": "Units which have been selected according to the magnitude of the elevations and distances
|
|
4414
|
+
"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
4415
|
"type": "EffectiveUnits"
|
|
4321
4416
|
},
|
|
4322
4417
|
{
|
|
@@ -4363,17 +4458,17 @@
|
|
|
4363
4458
|
},
|
|
4364
4459
|
{
|
|
4365
4460
|
"name": "icon",
|
|
4366
|
-
"description": "Icon which represents the
|
|
4461
|
+
"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
4462
|
"type": "string"
|
|
4368
4463
|
},
|
|
4369
4464
|
{
|
|
4370
4465
|
"name": "input",
|
|
4371
|
-
"description": "The input
|
|
4466
|
+
"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
4467
|
"type": "Graphic"
|
|
4373
4468
|
},
|
|
4374
4469
|
{
|
|
4375
4470
|
"name": "label",
|
|
4376
|
-
"description": "The
|
|
4471
|
+
"description": "The component's default label.",
|
|
4377
4472
|
"type": "string"
|
|
4378
4473
|
},
|
|
4379
4474
|
{
|
|
@@ -4382,7 +4477,7 @@
|
|
|
4382
4477
|
},
|
|
4383
4478
|
{
|
|
4384
4479
|
"name": "profiles",
|
|
4385
|
-
"description": "Collection of elevation profile lines which are to be generated and displayed in the
|
|
4480
|
+
"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
4481
|
"type": "Collection<ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineView>"
|
|
4387
4482
|
},
|
|
4388
4483
|
{
|
|
@@ -4392,11 +4487,12 @@
|
|
|
4392
4487
|
},
|
|
4393
4488
|
{
|
|
4394
4489
|
"name": "referenceElement",
|
|
4490
|
+
"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
4491
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4396
4492
|
},
|
|
4397
4493
|
{
|
|
4398
4494
|
"name": "state",
|
|
4399
|
-
"description": "The
|
|
4495
|
+
"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
4496
|
"type": "\"created\" | \"creating\" | \"disabled\" | \"ready\" | \"selected\" | \"selecting\""
|
|
4401
4497
|
},
|
|
4402
4498
|
{
|
|
@@ -4431,7 +4527,7 @@
|
|
|
4431
4527
|
},
|
|
4432
4528
|
{
|
|
4433
4529
|
"name": "arcgis-expand",
|
|
4434
|
-
"description": "The Expand component acts as a clickable button for
|
|
4530
|
+
"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
4531
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/",
|
|
4436
4532
|
"attributes": [
|
|
4437
4533
|
{
|
|
@@ -4468,8 +4564,7 @@
|
|
|
4468
4564
|
},
|
|
4469
4565
|
{
|
|
4470
4566
|
"name": "collapse-tooltip",
|
|
4471
|
-
"description": "Tooltip to display to indicate Expand widget can be collapsed.",
|
|
4472
|
-
"default": "\"Collapse\" (English locale)",
|
|
4567
|
+
"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
4568
|
"value": {
|
|
4474
4569
|
"type": "string"
|
|
4475
4570
|
}
|
|
@@ -4484,8 +4579,7 @@
|
|
|
4484
4579
|
},
|
|
4485
4580
|
{
|
|
4486
4581
|
"name": "expand-tooltip",
|
|
4487
|
-
"description": "Tooltip to display to indicate Expand widget can be expanded.",
|
|
4488
|
-
"default": "\"Expand\" (English locale)",
|
|
4582
|
+
"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
4583
|
"value": {
|
|
4490
4584
|
"type": "string"
|
|
4491
4585
|
}
|
|
@@ -4508,7 +4602,7 @@
|
|
|
4508
4602
|
},
|
|
4509
4603
|
{
|
|
4510
4604
|
"name": "focus-trap-enabled",
|
|
4511
|
-
"description": "**Deprecated**: since 4.33
|
|
4605
|
+
"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
4606
|
"default": "false",
|
|
4513
4607
|
"value": {
|
|
4514
4608
|
"type": "boolean"
|
|
@@ -4596,6 +4690,7 @@
|
|
|
4596
4690
|
},
|
|
4597
4691
|
{
|
|
4598
4692
|
"name": "reference-element",
|
|
4693
|
+
"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
4694
|
"value": {
|
|
4600
4695
|
"type": "string"
|
|
4601
4696
|
}
|
|
@@ -4632,7 +4727,7 @@
|
|
|
4632
4727
|
},
|
|
4633
4728
|
{
|
|
4634
4729
|
"name": "collapseTooltip",
|
|
4635
|
-
"description": "Tooltip to display to indicate Expand widget can be collapsed.",
|
|
4730
|
+
"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
4731
|
"type": "string"
|
|
4637
4732
|
},
|
|
4638
4733
|
{
|
|
@@ -4647,7 +4742,7 @@
|
|
|
4647
4742
|
},
|
|
4648
4743
|
{
|
|
4649
4744
|
"name": "expandTooltip",
|
|
4650
|
-
"description": "Tooltip to display to indicate Expand widget can be expanded.",
|
|
4745
|
+
"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
4746
|
"type": "string"
|
|
4652
4747
|
},
|
|
4653
4748
|
{
|
|
@@ -4691,6 +4786,7 @@
|
|
|
4691
4786
|
},
|
|
4692
4787
|
{
|
|
4693
4788
|
"name": "referenceElement",
|
|
4789
|
+
"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
4790
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4695
4791
|
}
|
|
4696
4792
|
],
|
|
@@ -4774,7 +4870,7 @@
|
|
|
4774
4870
|
},
|
|
4775
4871
|
{
|
|
4776
4872
|
"name": "hide-last-edit-info",
|
|
4777
|
-
"description": "**Deprecated**: since 4.33
|
|
4873
|
+
"description": "**Deprecated**: since 4.33, use [hideLastEditedInfo](#hideLastEditedInfo) instead.. ",
|
|
4778
4874
|
"default": "false",
|
|
4779
4875
|
"value": {
|
|
4780
4876
|
"type": "boolean"
|
|
@@ -4830,6 +4926,7 @@
|
|
|
4830
4926
|
},
|
|
4831
4927
|
{
|
|
4832
4928
|
"name": "reference-element",
|
|
4929
|
+
"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
4930
|
"value": {
|
|
4834
4931
|
"type": "string"
|
|
4835
4932
|
}
|
|
@@ -4954,6 +5051,7 @@
|
|
|
4954
5051
|
},
|
|
4955
5052
|
{
|
|
4956
5053
|
"name": "referenceElement",
|
|
5054
|
+
"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
5055
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4958
5056
|
},
|
|
4959
5057
|
{
|
|
@@ -5052,6 +5150,7 @@
|
|
|
5052
5150
|
},
|
|
5053
5151
|
{
|
|
5054
5152
|
"name": "reference-element",
|
|
5153
|
+
"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
5154
|
"value": {
|
|
5056
5155
|
"type": "string"
|
|
5057
5156
|
}
|
|
@@ -5136,7 +5235,7 @@
|
|
|
5136
5235
|
{
|
|
5137
5236
|
"name": "layer",
|
|
5138
5237
|
"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"
|
|
5238
|
+
"type": "FeatureLayer | GeoJSONLayer | KnowledgeGraphSublayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer"
|
|
5140
5239
|
},
|
|
5141
5240
|
{
|
|
5142
5241
|
"name": "position",
|
|
@@ -5144,6 +5243,7 @@
|
|
|
5144
5243
|
},
|
|
5145
5244
|
{
|
|
5146
5245
|
"name": "referenceElement",
|
|
5246
|
+
"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
5247
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
5148
5248
|
},
|
|
5149
5249
|
{
|
|
@@ -5537,6 +5637,7 @@
|
|
|
5537
5637
|
},
|
|
5538
5638
|
{
|
|
5539
5639
|
"name": "reference-element",
|
|
5640
|
+
"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
5641
|
"value": {
|
|
5541
5642
|
"type": "string"
|
|
5542
5643
|
}
|
|
@@ -5998,6 +6099,7 @@
|
|
|
5998
6099
|
},
|
|
5999
6100
|
{
|
|
6000
6101
|
"name": "referenceElement",
|
|
6102
|
+
"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
6103
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6002
6104
|
},
|
|
6003
6105
|
{
|
|
@@ -6072,7 +6174,7 @@
|
|
|
6072
6174
|
},
|
|
6073
6175
|
{
|
|
6074
6176
|
"name": "supportsResizeAttachments",
|
|
6075
|
-
"description": "
|
|
6177
|
+
"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
6178
|
"type": "boolean"
|
|
6077
6179
|
},
|
|
6078
6180
|
{
|
|
@@ -6244,6 +6346,7 @@
|
|
|
6244
6346
|
},
|
|
6245
6347
|
{
|
|
6246
6348
|
"name": "reference-element",
|
|
6349
|
+
"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
6350
|
"value": {
|
|
6248
6351
|
"type": "string"
|
|
6249
6352
|
}
|
|
@@ -6344,6 +6447,7 @@
|
|
|
6344
6447
|
},
|
|
6345
6448
|
{
|
|
6346
6449
|
"name": "referenceElement",
|
|
6450
|
+
"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
6451
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6348
6452
|
},
|
|
6349
6453
|
{
|
|
@@ -6558,6 +6662,7 @@
|
|
|
6558
6662
|
},
|
|
6559
6663
|
{
|
|
6560
6664
|
"name": "reference-element",
|
|
6665
|
+
"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
6666
|
"value": {
|
|
6562
6667
|
"type": "string"
|
|
6563
6668
|
}
|
|
@@ -6760,6 +6865,7 @@
|
|
|
6760
6865
|
},
|
|
6761
6866
|
{
|
|
6762
6867
|
"name": "referenceElement",
|
|
6868
|
+
"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
6869
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6764
6870
|
},
|
|
6765
6871
|
{
|
|
@@ -6893,6 +6999,7 @@
|
|
|
6893
6999
|
},
|
|
6894
7000
|
{
|
|
6895
7001
|
"name": "reference-element",
|
|
7002
|
+
"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
7003
|
"value": {
|
|
6897
7004
|
"type": "string"
|
|
6898
7005
|
}
|
|
@@ -6955,6 +7062,7 @@
|
|
|
6955
7062
|
},
|
|
6956
7063
|
{
|
|
6957
7064
|
"name": "referenceElement",
|
|
7065
|
+
"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
7066
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6959
7067
|
},
|
|
6960
7068
|
{
|
|
@@ -6974,9 +7082,16 @@
|
|
|
6974
7082
|
},
|
|
6975
7083
|
{
|
|
6976
7084
|
"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.",
|
|
7085
|
+
"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
7086
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-fullscreen/",
|
|
6979
7087
|
"attributes": [
|
|
7088
|
+
{
|
|
7089
|
+
"name": "element",
|
|
7090
|
+
"description": "The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode.",
|
|
7091
|
+
"value": {
|
|
7092
|
+
"type": "string"
|
|
7093
|
+
}
|
|
7094
|
+
},
|
|
6980
7095
|
{
|
|
6981
7096
|
"name": "label",
|
|
6982
7097
|
"description": "The component's default label.",
|
|
@@ -7003,6 +7118,7 @@
|
|
|
7003
7118
|
},
|
|
7004
7119
|
{
|
|
7005
7120
|
"name": "reference-element",
|
|
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.",
|
|
7006
7122
|
"value": {
|
|
7007
7123
|
"type": "string"
|
|
7008
7124
|
}
|
|
@@ -7036,7 +7152,7 @@
|
|
|
7036
7152
|
{
|
|
7037
7153
|
"name": "element",
|
|
7038
7154
|
"description": "The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode.",
|
|
7039
|
-
"type": "
|
|
7155
|
+
"type": "Element | string"
|
|
7040
7156
|
},
|
|
7041
7157
|
{
|
|
7042
7158
|
"name": "label",
|
|
@@ -7045,7 +7161,7 @@
|
|
|
7045
7161
|
},
|
|
7046
7162
|
{
|
|
7047
7163
|
"name": "messageOverrides",
|
|
7048
|
-
"description": "Replace localized message strings with your own strings
|
|
7164
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7049
7165
|
"type": "Record<string, unknown>"
|
|
7050
7166
|
},
|
|
7051
7167
|
{
|
|
@@ -7054,6 +7170,7 @@
|
|
|
7054
7170
|
},
|
|
7055
7171
|
{
|
|
7056
7172
|
"name": "referenceElement",
|
|
7173
|
+
"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
7174
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7058
7175
|
},
|
|
7059
7176
|
{
|
|
@@ -7255,6 +7372,7 @@
|
|
|
7255
7372
|
},
|
|
7256
7373
|
{
|
|
7257
7374
|
"name": "reference-element",
|
|
7375
|
+
"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
7376
|
"value": {
|
|
7259
7377
|
"type": "string"
|
|
7260
7378
|
}
|
|
@@ -7443,7 +7561,7 @@
|
|
|
7443
7561
|
},
|
|
7444
7562
|
{
|
|
7445
7563
|
"name": "messageOverrides",
|
|
7446
|
-
"description": "Replace localized message strings with your own strings
|
|
7564
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7447
7565
|
"type": "Record<string, unknown>"
|
|
7448
7566
|
},
|
|
7449
7567
|
{
|
|
@@ -7457,6 +7575,7 @@
|
|
|
7457
7575
|
},
|
|
7458
7576
|
{
|
|
7459
7577
|
"name": "referenceElement",
|
|
7578
|
+
"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
7579
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7461
7580
|
},
|
|
7462
7581
|
{
|
|
@@ -7617,6 +7736,7 @@
|
|
|
7617
7736
|
},
|
|
7618
7737
|
{
|
|
7619
7738
|
"name": "reference-element",
|
|
7739
|
+
"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
7740
|
"value": {
|
|
7621
7741
|
"type": "string"
|
|
7622
7742
|
}
|
|
@@ -7742,6 +7862,7 @@
|
|
|
7742
7862
|
},
|
|
7743
7863
|
{
|
|
7744
7864
|
"name": "referenceElement",
|
|
7865
|
+
"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
7866
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7746
7867
|
},
|
|
7747
7868
|
{
|
|
@@ -7781,7 +7902,7 @@
|
|
|
7781
7902
|
},
|
|
7782
7903
|
{
|
|
7783
7904
|
"name": "arcgis-home",
|
|
7784
|
-
"description": "The Home component is a button that
|
|
7905
|
+
"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
7906
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-home/",
|
|
7786
7907
|
"attributes": [
|
|
7787
7908
|
{
|
|
@@ -7826,6 +7947,7 @@
|
|
|
7826
7947
|
},
|
|
7827
7948
|
{
|
|
7828
7949
|
"name": "reference-element",
|
|
7950
|
+
"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
7951
|
"value": {
|
|
7830
7952
|
"type": "string"
|
|
7831
7953
|
}
|
|
@@ -7884,7 +8006,7 @@
|
|
|
7884
8006
|
},
|
|
7885
8007
|
{
|
|
7886
8008
|
"name": "messageOverrides",
|
|
7887
|
-
"description": "Replace localized message strings with your own strings
|
|
8009
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7888
8010
|
"type": "Record<string, unknown>"
|
|
7889
8011
|
},
|
|
7890
8012
|
{
|
|
@@ -7893,6 +8015,7 @@
|
|
|
7893
8015
|
},
|
|
7894
8016
|
{
|
|
7895
8017
|
"name": "referenceElement",
|
|
8018
|
+
"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
8019
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7897
8020
|
},
|
|
7898
8021
|
{
|
|
@@ -7902,7 +8025,7 @@
|
|
|
7902
8025
|
},
|
|
7903
8026
|
{
|
|
7904
8027
|
"name": "viewpoint",
|
|
7905
|
-
"description": "The esri
|
|
8028
|
+
"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
8029
|
"type": "Viewpoint"
|
|
7907
8030
|
}
|
|
7908
8031
|
],
|
|
@@ -8057,6 +8180,7 @@
|
|
|
8057
8180
|
},
|
|
8058
8181
|
{
|
|
8059
8182
|
"name": "reference-element",
|
|
8183
|
+
"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
8184
|
"value": {
|
|
8061
8185
|
"type": "string"
|
|
8062
8186
|
}
|
|
@@ -8272,6 +8396,7 @@
|
|
|
8272
8396
|
},
|
|
8273
8397
|
{
|
|
8274
8398
|
"name": "referenceElement",
|
|
8399
|
+
"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
8400
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
8276
8401
|
},
|
|
8277
8402
|
{
|
|
@@ -8427,6 +8552,7 @@
|
|
|
8427
8552
|
},
|
|
8428
8553
|
{
|
|
8429
8554
|
"name": "reference-element",
|
|
8555
|
+
"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
8556
|
"value": {
|
|
8431
8557
|
"type": "string"
|
|
8432
8558
|
}
|
|
@@ -8524,6 +8650,7 @@
|
|
|
8524
8650
|
},
|
|
8525
8651
|
{
|
|
8526
8652
|
"name": "referenceElement",
|
|
8653
|
+
"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
8654
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
8528
8655
|
},
|
|
8529
8656
|
{
|
|
@@ -8558,7 +8685,7 @@
|
|
|
8558
8685
|
},
|
|
8559
8686
|
{
|
|
8560
8687
|
"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
|
|
8688
|
+
"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
8689
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-line-of-sight/",
|
|
8563
8690
|
"attributes": [
|
|
8564
8691
|
{
|
|
@@ -8603,9 +8730,22 @@
|
|
|
8603
8730
|
},
|
|
8604
8731
|
{
|
|
8605
8732
|
"name": "reference-element",
|
|
8733
|
+
"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
8734
|
"value": {
|
|
8607
8735
|
"type": "string"
|
|
8608
8736
|
}
|
|
8737
|
+
},
|
|
8738
|
+
{
|
|
8739
|
+
"name": "state",
|
|
8740
|
+
"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",
|
|
8741
|
+
"value": {
|
|
8742
|
+
"type": [
|
|
8743
|
+
"\"created\"",
|
|
8744
|
+
"\"creating\"",
|
|
8745
|
+
"\"disabled\"",
|
|
8746
|
+
"\"ready\""
|
|
8747
|
+
]
|
|
8748
|
+
}
|
|
8609
8749
|
}
|
|
8610
8750
|
],
|
|
8611
8751
|
"events": [
|
|
@@ -8624,7 +8764,7 @@
|
|
|
8624
8764
|
"properties": [
|
|
8625
8765
|
{
|
|
8626
8766
|
"name": "analysis",
|
|
8627
|
-
"description": "The [
|
|
8767
|
+
"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
8768
|
"type": "LineOfSightAnalysis"
|
|
8629
8769
|
},
|
|
8630
8770
|
{
|
|
@@ -8644,7 +8784,7 @@
|
|
|
8644
8784
|
},
|
|
8645
8785
|
{
|
|
8646
8786
|
"name": "messageOverrides",
|
|
8647
|
-
"description": "Replace localized message strings with your own strings
|
|
8787
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
8648
8788
|
"type": "Record<string, unknown>"
|
|
8649
8789
|
},
|
|
8650
8790
|
{
|
|
@@ -8653,6 +8793,7 @@
|
|
|
8653
8793
|
},
|
|
8654
8794
|
{
|
|
8655
8795
|
"name": "referenceElement",
|
|
8796
|
+
"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
8797
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
8657
8798
|
},
|
|
8658
8799
|
{
|
|
@@ -8677,7 +8818,7 @@
|
|
|
8677
8818
|
},
|
|
8678
8819
|
{
|
|
8679
8820
|
"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
|
|
8821
|
+
"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
8822
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/",
|
|
8682
8823
|
"attributes": [
|
|
8683
8824
|
{
|
|
@@ -8933,7 +9074,7 @@
|
|
|
8933
9074
|
},
|
|
8934
9075
|
{
|
|
8935
9076
|
"name": "graphics",
|
|
8936
|
-
"description": "Allows for adding graphics directly to the default graphics in the View
|
|
9077
|
+
"description": "Allows for adding graphics directly to the default graphics in the View.",
|
|
8937
9078
|
"type": "Collection<Graphic>"
|
|
8938
9079
|
},
|
|
8939
9080
|
{
|
|
@@ -9240,6 +9381,7 @@
|
|
|
9240
9381
|
},
|
|
9241
9382
|
{
|
|
9242
9383
|
"name": "reference-element",
|
|
9384
|
+
"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
9385
|
"value": {
|
|
9244
9386
|
"type": "string"
|
|
9245
9387
|
}
|
|
@@ -9308,7 +9450,7 @@
|
|
|
9308
9450
|
},
|
|
9309
9451
|
{
|
|
9310
9452
|
"name": "messageOverrides",
|
|
9311
|
-
"description": "Replace localized message strings with your own strings
|
|
9453
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
9312
9454
|
"type": "Record<string, unknown>"
|
|
9313
9455
|
},
|
|
9314
9456
|
{
|
|
@@ -9322,6 +9464,7 @@
|
|
|
9322
9464
|
},
|
|
9323
9465
|
{
|
|
9324
9466
|
"name": "referenceElement",
|
|
9467
|
+
"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
9468
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
9326
9469
|
},
|
|
9327
9470
|
{
|
|
@@ -9351,7 +9494,7 @@
|
|
|
9351
9494
|
},
|
|
9352
9495
|
{
|
|
9353
9496
|
"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>`",
|
|
9497
|
+
"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
9498
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-locate/",
|
|
9356
9499
|
"attributes": [
|
|
9357
9500
|
{
|
|
@@ -9410,6 +9553,7 @@
|
|
|
9410
9553
|
},
|
|
9411
9554
|
{
|
|
9412
9555
|
"name": "reference-element",
|
|
9556
|
+
"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
9557
|
"value": {
|
|
9414
9558
|
"type": "string"
|
|
9415
9559
|
}
|
|
@@ -9492,7 +9636,7 @@
|
|
|
9492
9636
|
},
|
|
9493
9637
|
{
|
|
9494
9638
|
"name": "messageOverrides",
|
|
9495
|
-
"description": "Replace localized message strings with your own strings
|
|
9639
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
9496
9640
|
"type": "Record<string, unknown>"
|
|
9497
9641
|
},
|
|
9498
9642
|
{
|
|
@@ -9505,6 +9649,7 @@
|
|
|
9505
9649
|
},
|
|
9506
9650
|
{
|
|
9507
9651
|
"name": "referenceElement",
|
|
9652
|
+
"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
9653
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
9509
9654
|
},
|
|
9510
9655
|
{
|
|
@@ -9542,7 +9687,7 @@
|
|
|
9542
9687
|
},
|
|
9543
9688
|
{
|
|
9544
9689
|
"name": "arcgis-map",
|
|
9545
|
-
"description": "The ArcGIS Map
|
|
9690
|
+
"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
9691
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/",
|
|
9547
9692
|
"attributes": [
|
|
9548
9693
|
{
|
|
@@ -9815,7 +9960,7 @@
|
|
|
9815
9960
|
},
|
|
9816
9961
|
{
|
|
9817
9962
|
"name": "graphics",
|
|
9818
|
-
"description": "Allows for adding graphics directly to the default graphics in the View
|
|
9963
|
+
"description": "Allows for adding graphics directly to the default graphics in the View.",
|
|
9819
9964
|
"type": "Collection<Graphic>"
|
|
9820
9965
|
},
|
|
9821
9966
|
{
|
|
@@ -10172,6 +10317,7 @@
|
|
|
10172
10317
|
},
|
|
10173
10318
|
{
|
|
10174
10319
|
"name": "reference-element",
|
|
10320
|
+
"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
10321
|
"value": {
|
|
10176
10322
|
"type": "string"
|
|
10177
10323
|
}
|
|
@@ -10245,6 +10391,7 @@
|
|
|
10245
10391
|
},
|
|
10246
10392
|
{
|
|
10247
10393
|
"name": "referenceElement",
|
|
10394
|
+
"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
10395
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10249
10396
|
},
|
|
10250
10397
|
{
|
|
@@ -10269,7 +10416,7 @@
|
|
|
10269
10416
|
},
|
|
10270
10417
|
{
|
|
10271
10418
|
"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\
|
|
10419
|
+
"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
10420
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-navigation-toggle/",
|
|
10274
10421
|
"attributes": [
|
|
10275
10422
|
{
|
|
@@ -10299,7 +10446,7 @@
|
|
|
10299
10446
|
},
|
|
10300
10447
|
{
|
|
10301
10448
|
"name": "navigation-mode",
|
|
10302
|
-
"description": "The navigation mode of the view.
|
|
10449
|
+
"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
10450
|
"default": "\"pan\"",
|
|
10304
10451
|
"value": {
|
|
10305
10452
|
"type": [
|
|
@@ -10327,6 +10474,7 @@
|
|
|
10327
10474
|
},
|
|
10328
10475
|
{
|
|
10329
10476
|
"name": "reference-element",
|
|
10477
|
+
"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
10478
|
"value": {
|
|
10331
10479
|
"type": "string"
|
|
10332
10480
|
}
|
|
@@ -10334,7 +10482,6 @@
|
|
|
10334
10482
|
{
|
|
10335
10483
|
"name": "state",
|
|
10336
10484
|
"description": "The current state of the component.",
|
|
10337
|
-
"default": "\"disabled\"",
|
|
10338
10485
|
"value": {
|
|
10339
10486
|
"type": [
|
|
10340
10487
|
"\"disabled\"",
|
|
@@ -10374,12 +10521,12 @@
|
|
|
10374
10521
|
},
|
|
10375
10522
|
{
|
|
10376
10523
|
"name": "messageOverrides",
|
|
10377
|
-
"description": "Replace localized message strings with your own strings
|
|
10524
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
10378
10525
|
"type": "Record<string, unknown>"
|
|
10379
10526
|
},
|
|
10380
10527
|
{
|
|
10381
10528
|
"name": "navigationMode",
|
|
10382
|
-
"description": "The navigation mode of the view.
|
|
10529
|
+
"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
10530
|
"type": "\"pan\" | \"rotate\""
|
|
10384
10531
|
},
|
|
10385
10532
|
{
|
|
@@ -10388,6 +10535,7 @@
|
|
|
10388
10535
|
},
|
|
10389
10536
|
{
|
|
10390
10537
|
"name": "referenceElement",
|
|
10538
|
+
"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
10539
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10392
10540
|
},
|
|
10393
10541
|
{
|
|
@@ -10543,6 +10691,7 @@
|
|
|
10543
10691
|
},
|
|
10544
10692
|
{
|
|
10545
10693
|
"name": "reference-element",
|
|
10694
|
+
"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
10695
|
"value": {
|
|
10547
10696
|
"type": "string"
|
|
10548
10697
|
}
|
|
@@ -10647,6 +10796,7 @@
|
|
|
10647
10796
|
},
|
|
10648
10797
|
{
|
|
10649
10798
|
"name": "referenceElement",
|
|
10799
|
+
"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
10800
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10651
10801
|
},
|
|
10652
10802
|
{
|
|
@@ -10693,6 +10843,7 @@
|
|
|
10693
10843
|
},
|
|
10694
10844
|
{
|
|
10695
10845
|
"name": "reference-element",
|
|
10846
|
+
"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
10847
|
"value": {
|
|
10697
10848
|
"type": "string"
|
|
10698
10849
|
}
|
|
@@ -10713,6 +10864,7 @@
|
|
|
10713
10864
|
},
|
|
10714
10865
|
{
|
|
10715
10866
|
"name": "referenceElement",
|
|
10867
|
+
"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
10868
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10717
10869
|
}
|
|
10718
10870
|
],
|
|
@@ -10727,7 +10879,7 @@
|
|
|
10727
10879
|
},
|
|
10728
10880
|
{
|
|
10729
10881
|
"name": "arcgis-print",
|
|
10730
|
-
"description": "The Print
|
|
10882
|
+
"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
10883
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-print/",
|
|
10732
10884
|
"attributes": [
|
|
10733
10885
|
{
|
|
@@ -10740,6 +10892,7 @@
|
|
|
10740
10892
|
},
|
|
10741
10893
|
{
|
|
10742
10894
|
"name": "allowed-formats-for-saving",
|
|
10895
|
+
"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
10896
|
"value": {
|
|
10744
10897
|
"type": "\"all\""
|
|
10745
10898
|
}
|
|
@@ -10785,7 +10938,7 @@
|
|
|
10785
10938
|
},
|
|
10786
10939
|
{
|
|
10787
10940
|
"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
|
|
10941
|
+
"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
10942
|
"default": "3",
|
|
10790
10943
|
"value": {
|
|
10791
10944
|
"type": [
|
|
@@ -10800,6 +10953,7 @@
|
|
|
10800
10953
|
},
|
|
10801
10954
|
{
|
|
10802
10955
|
"name": "hide-header",
|
|
10956
|
+
"description": "Indicates whether the component's header is hidden.",
|
|
10803
10957
|
"default": "false",
|
|
10804
10958
|
"value": {
|
|
10805
10959
|
"type": "boolean"
|
|
@@ -10822,6 +10976,7 @@
|
|
|
10822
10976
|
},
|
|
10823
10977
|
{
|
|
10824
10978
|
"name": "position",
|
|
10979
|
+
"description": "The UI position of a component.",
|
|
10825
10980
|
"default": "\"top-left\"",
|
|
10826
10981
|
"value": {
|
|
10827
10982
|
"type": [
|
|
@@ -10839,20 +10994,21 @@
|
|
|
10839
10994
|
},
|
|
10840
10995
|
{
|
|
10841
10996
|
"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,
|
|
10997
|
+
"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
10998
|
"value": {
|
|
10844
10999
|
"type": "string"
|
|
10845
11000
|
}
|
|
10846
11001
|
},
|
|
10847
11002
|
{
|
|
10848
11003
|
"name": "reference-element",
|
|
11004
|
+
"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
11005
|
"value": {
|
|
10850
11006
|
"type": "string"
|
|
10851
11007
|
}
|
|
10852
11008
|
},
|
|
10853
11009
|
{
|
|
10854
11010
|
"name": "show-print-area-enabled",
|
|
10855
|
-
"description": "The initial state of the print area toggle in the Print
|
|
11011
|
+
"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
11012
|
"default": "false",
|
|
10857
11013
|
"value": {
|
|
10858
11014
|
"type": "boolean"
|
|
@@ -10860,7 +11016,7 @@
|
|
|
10860
11016
|
},
|
|
10861
11017
|
{
|
|
10862
11018
|
"name": "state",
|
|
10863
|
-
"description": "The
|
|
11019
|
+
"description": "The state of the Print component.",
|
|
10864
11020
|
"default": "\"disabled\"",
|
|
10865
11021
|
"value": {
|
|
10866
11022
|
"type": [
|
|
@@ -10875,7 +11031,8 @@
|
|
|
10875
11031
|
"events": [
|
|
10876
11032
|
{
|
|
10877
11033
|
"name": "arcgisComplete",
|
|
10878
|
-
"type": "
|
|
11034
|
+
"type": "PrintCompleteEvent",
|
|
11035
|
+
"description": "Emitted when the component is complete."
|
|
10879
11036
|
},
|
|
10880
11037
|
{
|
|
10881
11038
|
"name": "arcgisPropertyChange",
|
|
@@ -10889,7 +11046,8 @@
|
|
|
10889
11046
|
},
|
|
10890
11047
|
{
|
|
10891
11048
|
"name": "arcgisSubmit",
|
|
10892
|
-
"type": "
|
|
11049
|
+
"type": "PrintSubmitEvent",
|
|
11050
|
+
"description": "Emitted when the component is submitted."
|
|
10893
11051
|
}
|
|
10894
11052
|
],
|
|
10895
11053
|
"js": {
|
|
@@ -10901,6 +11059,7 @@
|
|
|
10901
11059
|
},
|
|
10902
11060
|
{
|
|
10903
11061
|
"name": "allowedFormatsForSaving",
|
|
11062
|
+
"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
11063
|
"type": "\"all\" | Array<string>"
|
|
10905
11064
|
},
|
|
10906
11065
|
{
|
|
@@ -10929,7 +11088,7 @@
|
|
|
10929
11088
|
},
|
|
10930
11089
|
{
|
|
10931
11090
|
"name": "exportedLinks",
|
|
10932
|
-
"description": "The collection of links exported from the Print
|
|
11091
|
+
"description": "The collection of links exported from the Print component.",
|
|
10933
11092
|
"type": "Collection<FileLink>"
|
|
10934
11093
|
},
|
|
10935
11094
|
{
|
|
@@ -10939,11 +11098,12 @@
|
|
|
10939
11098
|
},
|
|
10940
11099
|
{
|
|
10941
11100
|
"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
|
|
11101
|
+
"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
11102
|
"type": "1 | 2 | 3 | 4 | 5 | 6"
|
|
10944
11103
|
},
|
|
10945
11104
|
{
|
|
10946
11105
|
"name": "hideHeader",
|
|
11106
|
+
"description": "Indicates whether the component's header is hidden.",
|
|
10947
11107
|
"type": "boolean"
|
|
10948
11108
|
},
|
|
10949
11109
|
{
|
|
@@ -10958,30 +11118,32 @@
|
|
|
10958
11118
|
},
|
|
10959
11119
|
{
|
|
10960
11120
|
"name": "messageOverrides",
|
|
10961
|
-
"description": "Replace localized message strings with your own strings
|
|
11121
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
10962
11122
|
"type": "Record<string, unknown>"
|
|
10963
11123
|
},
|
|
10964
11124
|
{
|
|
10965
11125
|
"name": "outSpatialReference",
|
|
10966
|
-
"description": "The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) used to render
|
|
11126
|
+
"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
11127
|
"type": "SpatialReference"
|
|
10968
11128
|
},
|
|
10969
11129
|
{
|
|
10970
11130
|
"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.",
|
|
11131
|
+
"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
11132
|
"type": "Portal"
|
|
10973
11133
|
},
|
|
10974
11134
|
{
|
|
10975
11135
|
"name": "position",
|
|
11136
|
+
"description": "The UI position of a component.",
|
|
10976
11137
|
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
|
|
10977
11138
|
},
|
|
10978
11139
|
{
|
|
10979
11140
|
"name": "printServiceUrl",
|
|
10980
|
-
"description": "The URL of the REST endpoint of the Export Web Map Task.\nIf the [portal](#portal) property is set,
|
|
11141
|
+
"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
11142
|
"type": "string"
|
|
10982
11143
|
},
|
|
10983
11144
|
{
|
|
10984
11145
|
"name": "referenceElement",
|
|
11146
|
+
"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
11147
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10986
11148
|
},
|
|
10987
11149
|
{
|
|
@@ -10990,29 +11152,30 @@
|
|
|
10990
11152
|
},
|
|
10991
11153
|
{
|
|
10992
11154
|
"name": "showPrintAreaEnabled",
|
|
10993
|
-
"description": "The initial state of the print area toggle in the Print
|
|
11155
|
+
"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
11156
|
"type": "boolean"
|
|
10995
11157
|
},
|
|
10996
11158
|
{
|
|
10997
11159
|
"name": "state",
|
|
10998
|
-
"description": "The
|
|
11160
|
+
"description": "The state of the Print component.",
|
|
10999
11161
|
"type": "\"disabled\" | \"error\" | \"initializing\" | \"ready\""
|
|
11000
11162
|
},
|
|
11001
11163
|
{
|
|
11002
11164
|
"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
|
|
11165
|
+
"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
11166
|
"type": "{\n [x: string]: Array<HashMap<string>> | undefined;\n}"
|
|
11005
11167
|
},
|
|
11006
11168
|
{
|
|
11007
11169
|
"name": "templateOptions",
|
|
11008
|
-
"description": "Defines the layout template options used by the
|
|
11170
|
+
"description": "Defines the layout template options used by the Print component to generate the print page.",
|
|
11009
11171
|
"type": "TemplateOptions"
|
|
11010
11172
|
}
|
|
11011
11173
|
],
|
|
11012
11174
|
"events": [
|
|
11013
11175
|
{
|
|
11014
11176
|
"name": "arcgisComplete",
|
|
11015
|
-
"type": "
|
|
11177
|
+
"type": "PrintCompleteEvent",
|
|
11178
|
+
"description": "Emitted when the component is complete."
|
|
11016
11179
|
},
|
|
11017
11180
|
{
|
|
11018
11181
|
"name": "arcgisPropertyChange",
|
|
@@ -11026,14 +11189,15 @@
|
|
|
11026
11189
|
},
|
|
11027
11190
|
{
|
|
11028
11191
|
"name": "arcgisSubmit",
|
|
11029
|
-
"type": "
|
|
11192
|
+
"type": "PrintSubmitEvent",
|
|
11193
|
+
"description": "Emitted when the component is submitted."
|
|
11030
11194
|
}
|
|
11031
11195
|
]
|
|
11032
11196
|
}
|
|
11033
11197
|
},
|
|
11034
11198
|
{
|
|
11035
11199
|
"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
|
|
11200
|
+
"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
11201
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-bar/",
|
|
11038
11202
|
"attributes": [
|
|
11039
11203
|
{
|
|
@@ -11089,6 +11253,7 @@
|
|
|
11089
11253
|
},
|
|
11090
11254
|
{
|
|
11091
11255
|
"name": "reference-element",
|
|
11256
|
+
"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
11257
|
"value": {
|
|
11093
11258
|
"type": "string"
|
|
11094
11259
|
}
|
|
@@ -11136,7 +11301,7 @@
|
|
|
11136
11301
|
},
|
|
11137
11302
|
{
|
|
11138
11303
|
"name": "messageOverrides",
|
|
11139
|
-
"description": "Replace localized message strings with your own strings
|
|
11304
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
11140
11305
|
"type": "Record<string, unknown>"
|
|
11141
11306
|
},
|
|
11142
11307
|
{
|
|
@@ -11145,6 +11310,7 @@
|
|
|
11145
11310
|
},
|
|
11146
11311
|
{
|
|
11147
11312
|
"name": "referenceElement",
|
|
11313
|
+
"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
11314
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
11149
11315
|
},
|
|
11150
11316
|
{
|
|
@@ -11278,6 +11444,7 @@
|
|
|
11278
11444
|
},
|
|
11279
11445
|
{
|
|
11280
11446
|
"name": "reference-element",
|
|
11447
|
+
"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
11448
|
"value": {
|
|
11282
11449
|
"type": "string"
|
|
11283
11450
|
}
|
|
@@ -11376,6 +11543,7 @@
|
|
|
11376
11543
|
},
|
|
11377
11544
|
{
|
|
11378
11545
|
"name": "referenceElement",
|
|
11546
|
+
"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
11547
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
11380
11548
|
},
|
|
11381
11549
|
{
|
|
@@ -11405,7 +11573,7 @@
|
|
|
11405
11573
|
},
|
|
11406
11574
|
{
|
|
11407
11575
|
"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)",
|
|
11576
|
+
"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
11577
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/",
|
|
11410
11578
|
"attributes": [
|
|
11411
11579
|
{
|
|
@@ -11433,35 +11601,35 @@
|
|
|
11433
11601
|
},
|
|
11434
11602
|
{
|
|
11435
11603
|
"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()](
|
|
11604
|
+
"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
11605
|
"value": {
|
|
11438
11606
|
"type": "number"
|
|
11439
11607
|
}
|
|
11440
11608
|
},
|
|
11441
11609
|
{
|
|
11442
11610
|
"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()](
|
|
11611
|
+
"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
11612
|
"value": {
|
|
11445
11613
|
"type": "number"
|
|
11446
11614
|
}
|
|
11447
11615
|
},
|
|
11448
11616
|
{
|
|
11449
11617
|
"name": "camera-position",
|
|
11450
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
11618
|
+
"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
11619
|
"value": {
|
|
11452
11620
|
"type": "string"
|
|
11453
11621
|
}
|
|
11454
11622
|
},
|
|
11455
11623
|
{
|
|
11456
11624
|
"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()](
|
|
11625
|
+
"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
11626
|
"value": {
|
|
11459
11627
|
"type": "number"
|
|
11460
11628
|
}
|
|
11461
11629
|
},
|
|
11462
11630
|
{
|
|
11463
11631
|
"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()](
|
|
11632
|
+
"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
11633
|
"value": {
|
|
11466
11634
|
"type": "string"
|
|
11467
11635
|
}
|
|
@@ -11476,7 +11644,7 @@
|
|
|
11476
11644
|
},
|
|
11477
11645
|
{
|
|
11478
11646
|
"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)",
|
|
11647
|
+
"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
11648
|
"value": {
|
|
11481
11649
|
"type": "string"
|
|
11482
11650
|
}
|
|
@@ -11498,7 +11666,7 @@
|
|
|
11498
11666
|
},
|
|
11499
11667
|
{
|
|
11500
11668
|
"name": "quality-profile",
|
|
11501
|
-
"description": "
|
|
11669
|
+
"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
11670
|
"value": {
|
|
11503
11671
|
"type": [
|
|
11504
11672
|
"\"high\"",
|
|
@@ -11509,7 +11677,7 @@
|
|
|
11509
11677
|
},
|
|
11510
11678
|
{
|
|
11511
11679
|
"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()](
|
|
11680
|
+
"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
11681
|
"value": {
|
|
11514
11682
|
"type": "number"
|
|
11515
11683
|
}
|
|
@@ -11535,22 +11703,37 @@
|
|
|
11535
11703
|
},
|
|
11536
11704
|
{
|
|
11537
11705
|
"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()](
|
|
11706
|
+
"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
11707
|
"value": {
|
|
11540
11708
|
"type": "number"
|
|
11541
11709
|
}
|
|
11542
11710
|
}
|
|
11543
11711
|
],
|
|
11544
11712
|
"events": [
|
|
11713
|
+
{
|
|
11714
|
+
"name": "arcgisViewAnalysisViewCreate",
|
|
11715
|
+
"type": "ViewAnalysisViewCreateEvent",
|
|
11716
|
+
"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)"
|
|
11717
|
+
},
|
|
11718
|
+
{
|
|
11719
|
+
"name": "arcgisViewAnalysisViewCreateError",
|
|
11720
|
+
"type": "ViewAnalysisViewCreateErrorEvent",
|
|
11721
|
+
"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)"
|
|
11722
|
+
},
|
|
11723
|
+
{
|
|
11724
|
+
"name": "arcgisViewAnalysisViewDestroy",
|
|
11725
|
+
"type": "ViewAnalysisViewDestroyEvent",
|
|
11726
|
+
"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)"
|
|
11727
|
+
},
|
|
11545
11728
|
{
|
|
11546
11729
|
"name": "arcgisViewChange",
|
|
11547
11730
|
"type": "void",
|
|
11548
|
-
"description": "This event is for view related property changes
|
|
11731
|
+
"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
11732
|
},
|
|
11550
11733
|
{
|
|
11551
11734
|
"name": "arcgisViewClick",
|
|
11552
11735
|
"type": "ViewClickEvent",
|
|
11553
|
-
"description": "Fires after a user clicks on the view.\n\n
|
|
11736
|
+
"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
11737
|
},
|
|
11555
11738
|
{
|
|
11556
11739
|
"name": "arcgisViewDoubleClick",
|
|
@@ -11635,7 +11818,7 @@
|
|
|
11635
11818
|
{
|
|
11636
11819
|
"name": "arcgisViewReadyChange",
|
|
11637
11820
|
"type": "void",
|
|
11638
|
-
"description": "This event is for the [ready](
|
|
11821
|
+
"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
11822
|
}
|
|
11640
11823
|
],
|
|
11641
11824
|
"js": {
|
|
@@ -11653,7 +11836,7 @@
|
|
|
11653
11836
|
{
|
|
11654
11837
|
"name": "analyses",
|
|
11655
11838
|
"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>"
|
|
11839
|
+
"type": "Collection<AreaMeasurementAnalysis | DimensionAnalysis | DirectLineMeasurementAnalysis | LineOfSightAnalysis | SliceAnalysis | ViewshedAnalysis | VolumeMeasurementAnalysis>"
|
|
11657
11840
|
},
|
|
11658
11841
|
{
|
|
11659
11842
|
"name": "autoDestroyDisabled",
|
|
@@ -11672,37 +11855,37 @@
|
|
|
11672
11855
|
},
|
|
11673
11856
|
{
|
|
11674
11857
|
"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
|
|
11858
|
+
"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
11859
|
"type": "Camera"
|
|
11677
11860
|
},
|
|
11678
11861
|
{
|
|
11679
11862
|
"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()](
|
|
11863
|
+
"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
11864
|
"type": "number"
|
|
11682
11865
|
},
|
|
11683
11866
|
{
|
|
11684
11867
|
"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()](
|
|
11868
|
+
"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
11869
|
"type": "number"
|
|
11687
11870
|
},
|
|
11688
11871
|
{
|
|
11689
11872
|
"name": "cameraPosition",
|
|
11690
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
11873
|
+
"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
11874
|
"type": "Array<number> | Point | string"
|
|
11692
11875
|
},
|
|
11693
11876
|
{
|
|
11694
11877
|
"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()](
|
|
11878
|
+
"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
11879
|
"type": "number"
|
|
11697
11880
|
},
|
|
11698
11881
|
{
|
|
11699
11882
|
"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()](
|
|
11883
|
+
"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
11884
|
"type": "Array<number> | Point | string"
|
|
11702
11885
|
},
|
|
11703
11886
|
{
|
|
11704
11887
|
"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
|
|
11888
|
+
"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
11889
|
"type": "Extent"
|
|
11707
11890
|
},
|
|
11708
11891
|
{
|
|
@@ -11717,12 +11900,12 @@
|
|
|
11717
11900
|
},
|
|
11718
11901
|
{
|
|
11719
11902
|
"name": "environment",
|
|
11720
|
-
"description": "Specifies various properties of the environment's visualization
|
|
11903
|
+
"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
11904
|
"type": "SceneViewEnvironment"
|
|
11722
11905
|
},
|
|
11723
11906
|
{
|
|
11724
11907
|
"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()](
|
|
11908
|
+
"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
11909
|
"type": "Extent"
|
|
11727
11910
|
},
|
|
11728
11911
|
{
|
|
@@ -11735,6 +11918,11 @@
|
|
|
11735
11918
|
"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
11919
|
"type": "Collection<string>"
|
|
11737
11920
|
},
|
|
11921
|
+
{
|
|
11922
|
+
"name": "focusAreas",
|
|
11923
|
+
"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)",
|
|
11924
|
+
"type": "FocusAreas"
|
|
11925
|
+
},
|
|
11738
11926
|
{
|
|
11739
11927
|
"name": "gamepad",
|
|
11740
11928
|
"description": "Gamepad input specific configuration settings.",
|
|
@@ -11742,12 +11930,12 @@
|
|
|
11742
11930
|
},
|
|
11743
11931
|
{
|
|
11744
11932
|
"name": "graphics",
|
|
11745
|
-
"description": "Allows for adding graphics directly to the default graphics in the view
|
|
11933
|
+
"description": "Allows for adding graphics directly to the default graphics in the view.",
|
|
11746
11934
|
"type": "Collection<Graphic>"
|
|
11747
11935
|
},
|
|
11748
11936
|
{
|
|
11749
11937
|
"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)",
|
|
11938
|
+
"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
11939
|
"type": "Ground | string"
|
|
11752
11940
|
},
|
|
11753
11941
|
{
|
|
@@ -11777,7 +11965,7 @@
|
|
|
11777
11965
|
},
|
|
11778
11966
|
{
|
|
11779
11967
|
"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.",
|
|
11968
|
+
"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
11969
|
"type": "Collection<LayerView>"
|
|
11782
11970
|
},
|
|
11783
11971
|
{
|
|
@@ -11812,7 +12000,7 @@
|
|
|
11812
12000
|
},
|
|
11813
12001
|
{
|
|
11814
12002
|
"name": "popup",
|
|
11815
|
-
"description": "A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html)
|
|
12003
|
+
"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
12004
|
"type": "Popup"
|
|
11817
12005
|
},
|
|
11818
12006
|
{
|
|
@@ -11822,7 +12010,7 @@
|
|
|
11822
12010
|
},
|
|
11823
12011
|
{
|
|
11824
12012
|
"name": "qualityProfile",
|
|
11825
|
-
"description": "
|
|
12013
|
+
"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
12014
|
"type": "\"high\" | \"low\" | \"medium\""
|
|
11827
12015
|
},
|
|
11828
12016
|
{
|
|
@@ -11832,12 +12020,12 @@
|
|
|
11832
12020
|
},
|
|
11833
12021
|
{
|
|
11834
12022
|
"name": "resolution",
|
|
11835
|
-
"description": "Represents the current value of one pixel in the unit of the view's\n[spatialReference](
|
|
12023
|
+
"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
12024
|
"type": "number"
|
|
11837
12025
|
},
|
|
11838
12026
|
{
|
|
11839
12027
|
"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()](
|
|
12028
|
+
"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
12029
|
"type": "number"
|
|
11842
12030
|
},
|
|
11843
12031
|
{
|
|
@@ -11857,7 +12045,7 @@
|
|
|
11857
12045
|
},
|
|
11858
12046
|
{
|
|
11859
12047
|
"name": "theme",
|
|
11860
|
-
"description": "This property specifies the base colors used by some
|
|
12048
|
+
"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
12049
|
"type": "Theme"
|
|
11862
12050
|
},
|
|
11863
12051
|
{
|
|
@@ -11882,30 +12070,45 @@
|
|
|
11882
12070
|
},
|
|
11883
12071
|
{
|
|
11884
12072
|
"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()](
|
|
12073
|
+
"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
12074
|
"type": "Viewpoint"
|
|
11887
12075
|
},
|
|
11888
12076
|
{
|
|
11889
12077
|
"name": "visibleArea",
|
|
11890
|
-
"description": "The visibleArea represents the visible portion of a [map](
|
|
12078
|
+
"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
12079
|
"type": "Polygon"
|
|
11892
12080
|
},
|
|
11893
12081
|
{
|
|
11894
12082
|
"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()](
|
|
12083
|
+
"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
12084
|
"type": "number"
|
|
11897
12085
|
}
|
|
11898
12086
|
],
|
|
11899
12087
|
"events": [
|
|
12088
|
+
{
|
|
12089
|
+
"name": "arcgisViewAnalysisViewCreate",
|
|
12090
|
+
"type": "ViewAnalysisViewCreateEvent",
|
|
12091
|
+
"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)"
|
|
12092
|
+
},
|
|
12093
|
+
{
|
|
12094
|
+
"name": "arcgisViewAnalysisViewCreateError",
|
|
12095
|
+
"type": "ViewAnalysisViewCreateErrorEvent",
|
|
12096
|
+
"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)"
|
|
12097
|
+
},
|
|
12098
|
+
{
|
|
12099
|
+
"name": "arcgisViewAnalysisViewDestroy",
|
|
12100
|
+
"type": "ViewAnalysisViewDestroyEvent",
|
|
12101
|
+
"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)"
|
|
12102
|
+
},
|
|
11900
12103
|
{
|
|
11901
12104
|
"name": "arcgisViewChange",
|
|
11902
12105
|
"type": "void",
|
|
11903
|
-
"description": "This event is for view related property changes
|
|
12106
|
+
"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
12107
|
},
|
|
11905
12108
|
{
|
|
11906
12109
|
"name": "arcgisViewClick",
|
|
11907
12110
|
"type": "ViewClickEvent",
|
|
11908
|
-
"description": "Fires after a user clicks on the view.\n\n
|
|
12111
|
+
"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
12112
|
},
|
|
11910
12113
|
{
|
|
11911
12114
|
"name": "arcgisViewDoubleClick",
|
|
@@ -11990,14 +12193,14 @@
|
|
|
11990
12193
|
{
|
|
11991
12194
|
"name": "arcgisViewReadyChange",
|
|
11992
12195
|
"type": "void",
|
|
11993
|
-
"description": "This event is for the [ready](
|
|
12196
|
+
"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
12197
|
}
|
|
11995
12198
|
]
|
|
11996
12199
|
}
|
|
11997
12200
|
},
|
|
11998
12201
|
{
|
|
11999
12202
|
"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.",
|
|
12203
|
+
"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
12204
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/",
|
|
12002
12205
|
"attributes": [
|
|
12003
12206
|
{
|
|
@@ -12037,9 +12240,17 @@
|
|
|
12037
12240
|
}
|
|
12038
12241
|
},
|
|
12039
12242
|
{
|
|
12040
|
-
"name": "auto-
|
|
12243
|
+
"name": "auto-navigate-disabled",
|
|
12244
|
+
"description": "Indicates whether to automatically navigate to the selected result.",
|
|
12245
|
+
"default": "false",
|
|
12246
|
+
"value": {
|
|
12247
|
+
"type": "boolean"
|
|
12248
|
+
}
|
|
12249
|
+
},
|
|
12250
|
+
{
|
|
12251
|
+
"name": "auto-select-disabled",
|
|
12041
12252
|
"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": "
|
|
12253
|
+
"default": "false",
|
|
12043
12254
|
"value": {
|
|
12044
12255
|
"type": "boolean"
|
|
12045
12256
|
}
|
|
@@ -12061,9 +12272,9 @@
|
|
|
12061
12272
|
}
|
|
12062
12273
|
},
|
|
12063
12274
|
{
|
|
12064
|
-
"name": "include-default-sources",
|
|
12275
|
+
"name": "include-default-sources-disabled",
|
|
12065
12276
|
"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": "
|
|
12277
|
+
"default": "false",
|
|
12067
12278
|
"value": {
|
|
12068
12279
|
"type": "boolean"
|
|
12069
12280
|
}
|
|
@@ -12076,9 +12287,9 @@
|
|
|
12076
12287
|
}
|
|
12077
12288
|
},
|
|
12078
12289
|
{
|
|
12079
|
-
"name": "location-
|
|
12290
|
+
"name": "location-disabled",
|
|
12080
12291
|
"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": "
|
|
12292
|
+
"default": "false",
|
|
12082
12293
|
"value": {
|
|
12083
12294
|
"type": "boolean"
|
|
12084
12295
|
}
|
|
@@ -12108,9 +12319,9 @@
|
|
|
12108
12319
|
}
|
|
12109
12320
|
},
|
|
12110
12321
|
{
|
|
12111
|
-
"name": "popup-
|
|
12322
|
+
"name": "popup-disabled",
|
|
12112
12323
|
"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": "
|
|
12324
|
+
"default": "false",
|
|
12114
12325
|
"value": {
|
|
12115
12326
|
"type": "boolean"
|
|
12116
12327
|
}
|
|
@@ -12134,22 +12345,23 @@
|
|
|
12134
12345
|
},
|
|
12135
12346
|
{
|
|
12136
12347
|
"name": "reference-element",
|
|
12348
|
+
"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
12349
|
"value": {
|
|
12138
12350
|
"type": "string"
|
|
12139
12351
|
}
|
|
12140
12352
|
},
|
|
12141
12353
|
{
|
|
12142
|
-
"name": "result-graphic-
|
|
12354
|
+
"name": "result-graphic-disabled",
|
|
12143
12355
|
"description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
|
|
12144
|
-
"default": "
|
|
12356
|
+
"default": "false",
|
|
12145
12357
|
"value": {
|
|
12146
12358
|
"type": "boolean"
|
|
12147
12359
|
}
|
|
12148
12360
|
},
|
|
12149
12361
|
{
|
|
12150
|
-
"name": "search-all-
|
|
12362
|
+
"name": "search-all-disabled",
|
|
12151
12363
|
"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": "
|
|
12364
|
+
"default": "false",
|
|
12153
12365
|
"value": {
|
|
12154
12366
|
"type": "boolean"
|
|
12155
12367
|
}
|
|
@@ -12163,7 +12375,7 @@
|
|
|
12163
12375
|
},
|
|
12164
12376
|
{
|
|
12165
12377
|
"name": "state",
|
|
12166
|
-
"description": "The current state
|
|
12378
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
12167
12379
|
"default": "\"ready\"",
|
|
12168
12380
|
"value": {
|
|
12169
12381
|
"type": [
|
|
@@ -12175,9 +12387,9 @@
|
|
|
12175
12387
|
}
|
|
12176
12388
|
},
|
|
12177
12389
|
{
|
|
12178
|
-
"name": "suggestions-
|
|
12390
|
+
"name": "suggestions-disabled",
|
|
12179
12391
|
"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": "
|
|
12392
|
+
"default": "false",
|
|
12181
12393
|
"value": {
|
|
12182
12394
|
"type": "boolean"
|
|
12183
12395
|
}
|
|
@@ -12258,7 +12470,12 @@
|
|
|
12258
12470
|
"type": "boolean"
|
|
12259
12471
|
},
|
|
12260
12472
|
{
|
|
12261
|
-
"name": "
|
|
12473
|
+
"name": "autoNavigateDisabled",
|
|
12474
|
+
"description": "Indicates whether to automatically navigate to the selected result.",
|
|
12475
|
+
"type": "boolean"
|
|
12476
|
+
},
|
|
12477
|
+
{
|
|
12478
|
+
"name": "autoSelectDisabled",
|
|
12262
12479
|
"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
12480
|
"type": "boolean"
|
|
12264
12481
|
},
|
|
@@ -12283,7 +12500,7 @@
|
|
|
12283
12500
|
"type": "string"
|
|
12284
12501
|
},
|
|
12285
12502
|
{
|
|
12286
|
-
"name": "
|
|
12503
|
+
"name": "includeDefaultSourcesDisabled",
|
|
12287
12504
|
"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
12505
|
"type": "Function | boolean"
|
|
12289
12506
|
},
|
|
@@ -12293,7 +12510,7 @@
|
|
|
12293
12510
|
"type": "string"
|
|
12294
12511
|
},
|
|
12295
12512
|
{
|
|
12296
|
-
"name": "
|
|
12513
|
+
"name": "locationDisabled",
|
|
12297
12514
|
"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
12515
|
"type": "boolean"
|
|
12299
12516
|
},
|
|
@@ -12309,7 +12526,7 @@
|
|
|
12309
12526
|
},
|
|
12310
12527
|
{
|
|
12311
12528
|
"name": "messageOverrides",
|
|
12312
|
-
"description": "Replace localized message strings with your own strings
|
|
12529
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
12313
12530
|
"type": "Record<string, unknown>"
|
|
12314
12531
|
},
|
|
12315
12532
|
{
|
|
@@ -12318,7 +12535,7 @@
|
|
|
12318
12535
|
"type": "number"
|
|
12319
12536
|
},
|
|
12320
12537
|
{
|
|
12321
|
-
"name": "
|
|
12538
|
+
"name": "popupDisabled",
|
|
12322
12539
|
"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
12540
|
"type": "boolean"
|
|
12324
12541
|
},
|
|
@@ -12338,6 +12555,7 @@
|
|
|
12338
12555
|
},
|
|
12339
12556
|
{
|
|
12340
12557
|
"name": "referenceElement",
|
|
12558
|
+
"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
12559
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
12342
12560
|
},
|
|
12343
12561
|
{
|
|
@@ -12346,7 +12564,7 @@
|
|
|
12346
12564
|
"type": "Graphic"
|
|
12347
12565
|
},
|
|
12348
12566
|
{
|
|
12349
|
-
"name": "
|
|
12567
|
+
"name": "resultGraphicDisabled",
|
|
12350
12568
|
"description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
|
|
12351
12569
|
"type": "boolean"
|
|
12352
12570
|
},
|
|
@@ -12356,7 +12574,7 @@
|
|
|
12356
12574
|
"type": "Array<SearchResults>"
|
|
12357
12575
|
},
|
|
12358
12576
|
{
|
|
12359
|
-
"name": "
|
|
12577
|
+
"name": "searchAllDisabled",
|
|
12360
12578
|
"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
12579
|
"type": "boolean"
|
|
12362
12580
|
},
|
|
@@ -12377,7 +12595,7 @@
|
|
|
12377
12595
|
},
|
|
12378
12596
|
{
|
|
12379
12597
|
"name": "state",
|
|
12380
|
-
"description": "The current state
|
|
12598
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
12381
12599
|
"type": "\"disabled\" | \"loading\" | \"ready\" | \"searching\""
|
|
12382
12600
|
},
|
|
12383
12601
|
{
|
|
@@ -12386,7 +12604,7 @@
|
|
|
12386
12604
|
"type": "Array<SuggestResults>"
|
|
12387
12605
|
},
|
|
12388
12606
|
{
|
|
12389
|
-
"name": "
|
|
12607
|
+
"name": "suggestionsDisabled",
|
|
12390
12608
|
"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
12609
|
"type": "boolean"
|
|
12392
12610
|
}
|
|
@@ -12465,7 +12683,7 @@
|
|
|
12465
12683
|
},
|
|
12466
12684
|
{
|
|
12467
12685
|
"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\" | \"
|
|
12686
|
+
"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
12687
|
},
|
|
12470
12688
|
{
|
|
12471
12689
|
"name": "viewModel",
|
|
@@ -12483,7 +12701,7 @@
|
|
|
12483
12701
|
},
|
|
12484
12702
|
{
|
|
12485
12703
|
"name": "arcgis-shadow-cast",
|
|
12486
|
-
"description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [
|
|
12704
|
+
"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
12705
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/",
|
|
12488
12706
|
"attributes": [
|
|
12489
12707
|
{
|
|
@@ -12496,6 +12714,7 @@
|
|
|
12496
12714
|
},
|
|
12497
12715
|
{
|
|
12498
12716
|
"name": "date",
|
|
12717
|
+
"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
12718
|
"value": {
|
|
12500
12719
|
"type": [
|
|
12501
12720
|
"number",
|
|
@@ -12505,7 +12724,7 @@
|
|
|
12505
12724
|
},
|
|
12506
12725
|
{
|
|
12507
12726
|
"name": "end-time-of-day",
|
|
12508
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
12727
|
+
"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
12728
|
"default": "16 * 3600 * 1000",
|
|
12510
12729
|
"value": {
|
|
12511
12730
|
"type": "number"
|
|
@@ -12591,7 +12810,7 @@
|
|
|
12591
12810
|
},
|
|
12592
12811
|
{
|
|
12593
12812
|
"name": "icon",
|
|
12594
|
-
"description": "Icon which represents the
|
|
12813
|
+
"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
12814
|
"default": "\"measure-building-height-shadow\"",
|
|
12596
12815
|
"value": {
|
|
12597
12816
|
"type": "string"
|
|
@@ -12599,7 +12818,7 @@
|
|
|
12599
12818
|
},
|
|
12600
12819
|
{
|
|
12601
12820
|
"name": "label",
|
|
12602
|
-
"description": "The
|
|
12821
|
+
"description": "The component's default label.",
|
|
12603
12822
|
"value": {
|
|
12604
12823
|
"type": "string"
|
|
12605
12824
|
}
|
|
@@ -12623,13 +12842,14 @@
|
|
|
12623
12842
|
},
|
|
12624
12843
|
{
|
|
12625
12844
|
"name": "reference-element",
|
|
12845
|
+
"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
12846
|
"value": {
|
|
12627
12847
|
"type": "string"
|
|
12628
12848
|
}
|
|
12629
12849
|
},
|
|
12630
12850
|
{
|
|
12631
12851
|
"name": "start-time-of-day",
|
|
12632
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
12852
|
+
"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
12853
|
"default": "10 * 3600 * 1000",
|
|
12634
12854
|
"value": {
|
|
12635
12855
|
"type": "number"
|
|
@@ -12637,7 +12857,7 @@
|
|
|
12637
12857
|
},
|
|
12638
12858
|
{
|
|
12639
12859
|
"name": "state",
|
|
12640
|
-
"description": "The
|
|
12860
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
12641
12861
|
"default": "\"disabled\"",
|
|
12642
12862
|
"value": {
|
|
12643
12863
|
"type": [
|
|
@@ -12648,14 +12868,14 @@
|
|
|
12648
12868
|
},
|
|
12649
12869
|
{
|
|
12650
12870
|
"name": "utc-offset",
|
|
12651
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
12871
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
12652
12872
|
"value": {
|
|
12653
12873
|
"type": "number"
|
|
12654
12874
|
}
|
|
12655
12875
|
},
|
|
12656
12876
|
{
|
|
12657
12877
|
"name": "visualization-type",
|
|
12658
|
-
"description": "Type of visualization to use when showing the shadows
|
|
12878
|
+
"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
12879
|
"default": "\"threshold\"",
|
|
12660
12880
|
"value": {
|
|
12661
12881
|
"type": [
|
|
@@ -12687,21 +12907,22 @@
|
|
|
12687
12907
|
},
|
|
12688
12908
|
{
|
|
12689
12909
|
"name": "date",
|
|
12910
|
+
"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
12911
|
"type": "Date | number | string"
|
|
12691
12912
|
},
|
|
12692
12913
|
{
|
|
12693
12914
|
"name": "discreteOptions",
|
|
12694
|
-
"description": "The configuration used when the
|
|
12915
|
+
"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
12916
|
"type": "DiscreteOptions"
|
|
12696
12917
|
},
|
|
12697
12918
|
{
|
|
12698
12919
|
"name": "durationOptions",
|
|
12699
|
-
"description": "The configuration used when the
|
|
12920
|
+
"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
12921
|
"type": "DurationOptions"
|
|
12701
12922
|
},
|
|
12702
12923
|
{
|
|
12703
12924
|
"name": "endTimeOfDay",
|
|
12704
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
12925
|
+
"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
12926
|
"type": "number"
|
|
12706
12927
|
},
|
|
12707
12928
|
{
|
|
@@ -12751,12 +12972,12 @@
|
|
|
12751
12972
|
},
|
|
12752
12973
|
{
|
|
12753
12974
|
"name": "icon",
|
|
12754
|
-
"description": "Icon which represents the
|
|
12975
|
+
"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
12976
|
"type": "string"
|
|
12756
12977
|
},
|
|
12757
12978
|
{
|
|
12758
12979
|
"name": "label",
|
|
12759
|
-
"description": "The
|
|
12980
|
+
"description": "The component's default label.",
|
|
12760
12981
|
"type": "string"
|
|
12761
12982
|
},
|
|
12762
12983
|
{
|
|
@@ -12765,31 +12986,32 @@
|
|
|
12765
12986
|
},
|
|
12766
12987
|
{
|
|
12767
12988
|
"name": "referenceElement",
|
|
12989
|
+
"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
12990
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
12769
12991
|
},
|
|
12770
12992
|
{
|
|
12771
12993
|
"name": "startTimeOfDay",
|
|
12772
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
12994
|
+
"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
12995
|
"type": "number"
|
|
12774
12996
|
},
|
|
12775
12997
|
{
|
|
12776
12998
|
"name": "state",
|
|
12777
|
-
"description": "The
|
|
12999
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
12778
13000
|
"type": "\"disabled\" | \"ready\""
|
|
12779
13001
|
},
|
|
12780
13002
|
{
|
|
12781
13003
|
"name": "thresholdOptions",
|
|
12782
|
-
"description": "The configuration used when the
|
|
13004
|
+
"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
13005
|
"type": "ThresholdOptions"
|
|
12784
13006
|
},
|
|
12785
13007
|
{
|
|
12786
13008
|
"name": "utcOffset",
|
|
12787
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
13009
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
12788
13010
|
"type": "number"
|
|
12789
13011
|
},
|
|
12790
13012
|
{
|
|
12791
13013
|
"name": "visualizationType",
|
|
12792
|
-
"description": "Type of visualization to use when showing the shadows
|
|
13014
|
+
"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
13015
|
"type": "\"discrete\" | \"duration\" | \"threshold\""
|
|
12794
13016
|
}
|
|
12795
13017
|
],
|
|
@@ -13041,6 +13263,7 @@
|
|
|
13041
13263
|
},
|
|
13042
13264
|
{
|
|
13043
13265
|
"name": "reference-element",
|
|
13266
|
+
"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
13267
|
"value": {
|
|
13045
13268
|
"type": "string"
|
|
13046
13269
|
}
|
|
@@ -13283,6 +13506,7 @@
|
|
|
13283
13506
|
},
|
|
13284
13507
|
{
|
|
13285
13508
|
"name": "referenceElement",
|
|
13509
|
+
"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
13510
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
13287
13511
|
},
|
|
13288
13512
|
{
|
|
@@ -13356,7 +13580,7 @@
|
|
|
13356
13580
|
},
|
|
13357
13581
|
{
|
|
13358
13582
|
"name": "arcgis-slice",
|
|
13359
|
-
"description": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a
|
|
13583
|
+
"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
13584
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/",
|
|
13361
13585
|
"attributes": [
|
|
13362
13586
|
{
|
|
@@ -13423,6 +13647,7 @@
|
|
|
13423
13647
|
},
|
|
13424
13648
|
{
|
|
13425
13649
|
"name": "reference-element",
|
|
13650
|
+
"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
13651
|
"value": {
|
|
13427
13652
|
"type": "string"
|
|
13428
13653
|
}
|
|
@@ -13465,7 +13690,7 @@
|
|
|
13465
13690
|
"properties": [
|
|
13466
13691
|
{
|
|
13467
13692
|
"name": "analysis",
|
|
13468
|
-
"description": "The [
|
|
13693
|
+
"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
13694
|
"type": "SliceAnalysis"
|
|
13470
13695
|
},
|
|
13471
13696
|
{
|
|
@@ -13499,7 +13724,7 @@
|
|
|
13499
13724
|
},
|
|
13500
13725
|
{
|
|
13501
13726
|
"name": "messageOverrides",
|
|
13502
|
-
"description": "Replace localized message strings with your own strings
|
|
13727
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
13503
13728
|
"type": "Record<string, unknown>"
|
|
13504
13729
|
},
|
|
13505
13730
|
{
|
|
@@ -13508,11 +13733,12 @@
|
|
|
13508
13733
|
},
|
|
13509
13734
|
{
|
|
13510
13735
|
"name": "referenceElement",
|
|
13736
|
+
"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
13737
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
13512
13738
|
},
|
|
13513
13739
|
{
|
|
13514
13740
|
"name": "shape",
|
|
13515
|
-
"description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a
|
|
13741
|
+
"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
13742
|
"type": "SlicePlane"
|
|
13517
13743
|
},
|
|
13518
13744
|
{
|
|
@@ -13660,6 +13886,7 @@
|
|
|
13660
13886
|
},
|
|
13661
13887
|
{
|
|
13662
13888
|
"name": "reference-element",
|
|
13889
|
+
"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
13890
|
"value": {
|
|
13664
13891
|
"type": "string"
|
|
13665
13892
|
}
|
|
@@ -13862,6 +14089,7 @@
|
|
|
13862
14089
|
},
|
|
13863
14090
|
{
|
|
13864
14091
|
"name": "referenceElement",
|
|
14092
|
+
"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
14093
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
13866
14094
|
},
|
|
13867
14095
|
{
|
|
@@ -13980,7 +14208,7 @@
|
|
|
13980
14208
|
},
|
|
13981
14209
|
{
|
|
13982
14210
|
"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
|
|
14211
|
+
"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
14212
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/",
|
|
13985
14213
|
"attributes": [
|
|
13986
14214
|
{
|
|
@@ -14061,6 +14289,7 @@
|
|
|
14061
14289
|
},
|
|
14062
14290
|
{
|
|
14063
14291
|
"name": "reference-element",
|
|
14292
|
+
"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
14293
|
"value": {
|
|
14065
14294
|
"type": "string"
|
|
14066
14295
|
}
|
|
@@ -14095,6 +14324,16 @@
|
|
|
14095
14324
|
"name": "arcgisReady",
|
|
14096
14325
|
"type": "void",
|
|
14097
14326
|
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
|
|
14327
|
+
},
|
|
14328
|
+
{
|
|
14329
|
+
"name": "arcgisSwipeChange",
|
|
14330
|
+
"type": "void",
|
|
14331
|
+
"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."
|
|
14332
|
+
},
|
|
14333
|
+
{
|
|
14334
|
+
"name": "arcgisSwipeInput",
|
|
14335
|
+
"type": "void",
|
|
14336
|
+
"description": "Fires when the swipe position is updated.\nThis event is fired continuously while dragging the handle."
|
|
14098
14337
|
}
|
|
14099
14338
|
],
|
|
14100
14339
|
"js": {
|
|
@@ -14141,7 +14380,7 @@
|
|
|
14141
14380
|
},
|
|
14142
14381
|
{
|
|
14143
14382
|
"name": "messageOverrides",
|
|
14144
|
-
"description": "Replace localized message strings with your own strings
|
|
14383
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
14145
14384
|
"type": "Record<string, unknown>"
|
|
14146
14385
|
},
|
|
14147
14386
|
{
|
|
@@ -14150,6 +14389,7 @@
|
|
|
14150
14389
|
},
|
|
14151
14390
|
{
|
|
14152
14391
|
"name": "referenceElement",
|
|
14392
|
+
"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
14393
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
14154
14394
|
},
|
|
14155
14395
|
{
|
|
@@ -14178,6 +14418,16 @@
|
|
|
14178
14418
|
"name": "arcgisReady",
|
|
14179
14419
|
"type": "void",
|
|
14180
14420
|
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
|
|
14421
|
+
},
|
|
14422
|
+
{
|
|
14423
|
+
"name": "arcgisSwipeChange",
|
|
14424
|
+
"type": "void",
|
|
14425
|
+
"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."
|
|
14426
|
+
},
|
|
14427
|
+
{
|
|
14428
|
+
"name": "arcgisSwipeInput",
|
|
14429
|
+
"type": "void",
|
|
14430
|
+
"description": "Fires when the swipe position is updated.\nThis event is fired continuously while dragging the handle."
|
|
14181
14431
|
}
|
|
14182
14432
|
]
|
|
14183
14433
|
}
|
|
@@ -14299,6 +14549,7 @@
|
|
|
14299
14549
|
},
|
|
14300
14550
|
{
|
|
14301
14551
|
"name": "reference-element",
|
|
14552
|
+
"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
14553
|
"value": {
|
|
14303
14554
|
"type": "string"
|
|
14304
14555
|
}
|
|
@@ -14469,6 +14720,7 @@
|
|
|
14469
14720
|
},
|
|
14470
14721
|
{
|
|
14471
14722
|
"name": "referenceElement",
|
|
14723
|
+
"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
14724
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
14473
14725
|
},
|
|
14474
14726
|
{
|
|
@@ -14636,6 +14888,7 @@
|
|
|
14636
14888
|
},
|
|
14637
14889
|
{
|
|
14638
14890
|
"name": "reference-element",
|
|
14891
|
+
"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
14892
|
"value": {
|
|
14640
14893
|
"type": "string"
|
|
14641
14894
|
}
|
|
@@ -14748,6 +15001,7 @@
|
|
|
14748
15001
|
},
|
|
14749
15002
|
{
|
|
14750
15003
|
"name": "referenceElement",
|
|
15004
|
+
"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
15005
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
14752
15006
|
},
|
|
14753
15007
|
{
|
|
@@ -14909,7 +15163,7 @@
|
|
|
14909
15163
|
},
|
|
14910
15164
|
{
|
|
14911
15165
|
"name": "messageOverrides",
|
|
14912
|
-
"description": "Replace localized message strings with your own strings
|
|
15166
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
14913
15167
|
"type": "Record<string, unknown>"
|
|
14914
15168
|
},
|
|
14915
15169
|
{
|
|
@@ -14942,7 +15196,7 @@
|
|
|
14942
15196
|
},
|
|
14943
15197
|
{
|
|
14944
15198
|
"name": "arcgis-track",
|
|
14945
|
-
"description": "The Track component is a button that animates the
|
|
15199
|
+
"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
15200
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-track/",
|
|
14947
15201
|
"attributes": [
|
|
14948
15202
|
{
|
|
@@ -15010,6 +15264,7 @@
|
|
|
15010
15264
|
},
|
|
15011
15265
|
{
|
|
15012
15266
|
"name": "reference-element",
|
|
15267
|
+
"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
15268
|
"value": {
|
|
15014
15269
|
"type": "string"
|
|
15015
15270
|
}
|
|
@@ -15032,7 +15287,7 @@
|
|
|
15032
15287
|
},
|
|
15033
15288
|
{
|
|
15034
15289
|
"name": "state",
|
|
15035
|
-
"description": "The current state of the
|
|
15290
|
+
"description": "The current state of the component.",
|
|
15036
15291
|
"default": "\"disabled\"",
|
|
15037
15292
|
"value": {
|
|
15038
15293
|
"type": [
|
|
@@ -15109,7 +15364,7 @@
|
|
|
15109
15364
|
},
|
|
15110
15365
|
{
|
|
15111
15366
|
"name": "messageOverrides",
|
|
15112
|
-
"description": "Replace localized message strings with your own strings
|
|
15367
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
15113
15368
|
"type": "Record<string, unknown>"
|
|
15114
15369
|
},
|
|
15115
15370
|
{
|
|
@@ -15123,6 +15378,7 @@
|
|
|
15123
15378
|
},
|
|
15124
15379
|
{
|
|
15125
15380
|
"name": "referenceElement",
|
|
15381
|
+
"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
15382
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
15127
15383
|
},
|
|
15128
15384
|
{
|
|
@@ -15137,7 +15393,7 @@
|
|
|
15137
15393
|
},
|
|
15138
15394
|
{
|
|
15139
15395
|
"name": "state",
|
|
15140
|
-
"description": "The current state of the
|
|
15396
|
+
"description": "The current state of the component.",
|
|
15141
15397
|
"type": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"ready\" | \"tracking\" | \"waiting\""
|
|
15142
15398
|
},
|
|
15143
15399
|
{
|
|
@@ -15170,7 +15426,7 @@
|
|
|
15170
15426
|
},
|
|
15171
15427
|
{
|
|
15172
15428
|
"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
|
|
15429
|
+
"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
15430
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-associations/",
|
|
15175
15431
|
"attributes": [
|
|
15176
15432
|
{
|
|
@@ -15310,6 +15566,7 @@
|
|
|
15310
15566
|
},
|
|
15311
15567
|
{
|
|
15312
15568
|
"name": "reference-element",
|
|
15569
|
+
"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
15570
|
"value": {
|
|
15314
15571
|
"type": "string"
|
|
15315
15572
|
}
|
|
@@ -15375,7 +15632,7 @@
|
|
|
15375
15632
|
},
|
|
15376
15633
|
{
|
|
15377
15634
|
"name": "visible-elements-connectivity-associations-settings-arrows-toggle",
|
|
15378
|
-
"description": "**Deprecated**: since 4.32
|
|
15635
|
+
"description": "**Deprecated**: since 4.32, showConnectivityAssociationsSettingsArrowsToggle instead. ",
|
|
15379
15636
|
"default": "false",
|
|
15380
15637
|
"value": {
|
|
15381
15638
|
"type": "boolean"
|
|
@@ -15383,7 +15640,7 @@
|
|
|
15383
15640
|
},
|
|
15384
15641
|
{
|
|
15385
15642
|
"name": "visible-elements-connectivity-associations-settings-cap-select",
|
|
15386
|
-
"description": "**Deprecated**: since 4.32
|
|
15643
|
+
"description": "**Deprecated**: since 4.32, use showConnectivityAssociationsSettingsCapSelect instead. ",
|
|
15387
15644
|
"default": "false",
|
|
15388
15645
|
"value": {
|
|
15389
15646
|
"type": "boolean"
|
|
@@ -15391,7 +15648,7 @@
|
|
|
15391
15648
|
},
|
|
15392
15649
|
{
|
|
15393
15650
|
"name": "visible-elements-connectivity-associations-settings-color-picker",
|
|
15394
|
-
"description": "**Deprecated**: since 4.32
|
|
15651
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsColorPicker instead. ",
|
|
15395
15652
|
"default": "true",
|
|
15396
15653
|
"value": {
|
|
15397
15654
|
"type": "boolean"
|
|
@@ -15399,7 +15656,7 @@
|
|
|
15399
15656
|
},
|
|
15400
15657
|
{
|
|
15401
15658
|
"name": "visible-elements-connectivity-associations-settings-style-picker",
|
|
15402
|
-
"description": "**Deprecated**: since 4.32
|
|
15659
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsStylePicker instead. ",
|
|
15403
15660
|
"default": "true",
|
|
15404
15661
|
"value": {
|
|
15405
15662
|
"type": "boolean"
|
|
@@ -15407,7 +15664,7 @@
|
|
|
15407
15664
|
},
|
|
15408
15665
|
{
|
|
15409
15666
|
"name": "visible-elements-connectivity-associations-settings-width-input",
|
|
15410
|
-
"description": "**Deprecated**: since 4.32
|
|
15667
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsWidthInput instead. ",
|
|
15411
15668
|
"default": "true",
|
|
15412
15669
|
"value": {
|
|
15413
15670
|
"type": "boolean"
|
|
@@ -15415,7 +15672,7 @@
|
|
|
15415
15672
|
},
|
|
15416
15673
|
{
|
|
15417
15674
|
"name": "visible-elements-max-allowable-associations-slider",
|
|
15418
|
-
"description": "**Deprecated**: since 4.32
|
|
15675
|
+
"description": "**Deprecated**: since 4.32, use showMaxAllowableAssociationsSlider instead. ",
|
|
15419
15676
|
"default": "false",
|
|
15420
15677
|
"value": {
|
|
15421
15678
|
"type": "boolean"
|
|
@@ -15423,7 +15680,7 @@
|
|
|
15423
15680
|
},
|
|
15424
15681
|
{
|
|
15425
15682
|
"name": "visible-elements-structural-attachment-associations-settings-arrows-toggle",
|
|
15426
|
-
"description": "**Deprecated**: since 4.32
|
|
15683
|
+
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsArrowsToggle instead. ",
|
|
15427
15684
|
"default": "false",
|
|
15428
15685
|
"value": {
|
|
15429
15686
|
"type": "boolean"
|
|
@@ -15431,7 +15688,7 @@
|
|
|
15431
15688
|
},
|
|
15432
15689
|
{
|
|
15433
15690
|
"name": "visible-elements-structural-attachment-associations-settings-cap-select",
|
|
15434
|
-
"description": "**Deprecated**: since 4.32
|
|
15691
|
+
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsCapSelect instead. ",
|
|
15435
15692
|
"default": "false",
|
|
15436
15693
|
"value": {
|
|
15437
15694
|
"type": "boolean"
|
|
@@ -15439,7 +15696,7 @@
|
|
|
15439
15696
|
},
|
|
15440
15697
|
{
|
|
15441
15698
|
"name": "visible-elements-structural-attachment-associations-settings-color-picker",
|
|
15442
|
-
"description": "**Deprecated**: since 4.32
|
|
15699
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsColorPicker instead. ",
|
|
15443
15700
|
"default": "true",
|
|
15444
15701
|
"value": {
|
|
15445
15702
|
"type": "boolean"
|
|
@@ -15447,7 +15704,7 @@
|
|
|
15447
15704
|
},
|
|
15448
15705
|
{
|
|
15449
15706
|
"name": "visible-elements-structural-attachment-associations-settings-style-picker",
|
|
15450
|
-
"description": "**Deprecated**: since 4.32
|
|
15707
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsStylePicker instead. ",
|
|
15451
15708
|
"default": "true",
|
|
15452
15709
|
"value": {
|
|
15453
15710
|
"type": "boolean"
|
|
@@ -15455,7 +15712,7 @@
|
|
|
15455
15712
|
},
|
|
15456
15713
|
{
|
|
15457
15714
|
"name": "visible-elements-structural-attachment-associations-settings-width-input",
|
|
15458
|
-
"description": "**Deprecated**: since 4.32
|
|
15715
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsWidthInput instead. ",
|
|
15459
15716
|
"default": "true",
|
|
15460
15717
|
"value": {
|
|
15461
15718
|
"type": "boolean"
|
|
@@ -15556,6 +15813,7 @@
|
|
|
15556
15813
|
},
|
|
15557
15814
|
{
|
|
15558
15815
|
"name": "referenceElement",
|
|
15816
|
+
"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
15817
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
15560
15818
|
},
|
|
15561
15819
|
{
|
|
@@ -15688,7 +15946,7 @@
|
|
|
15688
15946
|
},
|
|
15689
15947
|
{
|
|
15690
15948
|
"name": "gdb-version",
|
|
15691
|
-
"description": "**Deprecated**: since version 4.31
|
|
15949
|
+
"description": "**Deprecated**: `gdbVersion` is deprecated since version 4.31.. The Geodatabase version to pass into the trace.",
|
|
15692
15950
|
"default": "\"sde.DEFAULT\"",
|
|
15693
15951
|
"value": {
|
|
15694
15952
|
"type": "string"
|
|
@@ -15728,6 +15986,7 @@
|
|
|
15728
15986
|
},
|
|
15729
15987
|
{
|
|
15730
15988
|
"name": "reference-element",
|
|
15989
|
+
"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
15990
|
"value": {
|
|
15732
15991
|
"type": "string"
|
|
15733
15992
|
}
|
|
@@ -15853,6 +16112,7 @@
|
|
|
15853
16112
|
},
|
|
15854
16113
|
{
|
|
15855
16114
|
"name": "referenceElement",
|
|
16115
|
+
"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
16116
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
15857
16117
|
},
|
|
15858
16118
|
{
|
|
@@ -15978,6 +16238,7 @@
|
|
|
15978
16238
|
},
|
|
15979
16239
|
{
|
|
15980
16240
|
"name": "reference-element",
|
|
16241
|
+
"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
16242
|
"value": {
|
|
15982
16243
|
"type": "string"
|
|
15983
16244
|
}
|
|
@@ -16038,6 +16299,7 @@
|
|
|
16038
16299
|
},
|
|
16039
16300
|
{
|
|
16040
16301
|
"name": "referenceElement",
|
|
16302
|
+
"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
16303
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16042
16304
|
},
|
|
16043
16305
|
{
|
|
@@ -16192,6 +16454,7 @@
|
|
|
16192
16454
|
},
|
|
16193
16455
|
{
|
|
16194
16456
|
"name": "reference-element",
|
|
16457
|
+
"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
16458
|
"value": {
|
|
16196
16459
|
"type": "string"
|
|
16197
16460
|
}
|
|
@@ -16304,6 +16567,7 @@
|
|
|
16304
16567
|
},
|
|
16305
16568
|
{
|
|
16306
16569
|
"name": "referenceElement",
|
|
16570
|
+
"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
16571
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16308
16572
|
},
|
|
16309
16573
|
{
|
|
@@ -16393,7 +16657,7 @@
|
|
|
16393
16657
|
},
|
|
16394
16658
|
{
|
|
16395
16659
|
"name": "page-size",
|
|
16396
|
-
"description": "Specifies the number of versions displayed on each page of the Version Management
|
|
16660
|
+
"description": "Specifies the number of versions displayed on each page of the Version Management component.",
|
|
16397
16661
|
"default": "5",
|
|
16398
16662
|
"value": {
|
|
16399
16663
|
"type": "number"
|
|
@@ -16418,6 +16682,7 @@
|
|
|
16418
16682
|
},
|
|
16419
16683
|
{
|
|
16420
16684
|
"name": "reference-element",
|
|
16685
|
+
"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
16686
|
"value": {
|
|
16422
16687
|
"type": "string"
|
|
16423
16688
|
}
|
|
@@ -16469,7 +16734,7 @@
|
|
|
16469
16734
|
},
|
|
16470
16735
|
{
|
|
16471
16736
|
"name": "initialVersionInfos",
|
|
16472
|
-
"description": "The `initialVersionInfos` property enables users to initialize the Version Management
|
|
16737
|
+
"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
16738
|
"type": "Array<{\n url: string;\n name: string;\n}>"
|
|
16474
16739
|
},
|
|
16475
16740
|
{
|
|
@@ -16478,7 +16743,7 @@
|
|
|
16478
16743
|
},
|
|
16479
16744
|
{
|
|
16480
16745
|
"name": "messageOverrides",
|
|
16481
|
-
"description": "Replace localized message strings with your own strings
|
|
16746
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16482
16747
|
"type": "Record<string, unknown>"
|
|
16483
16748
|
},
|
|
16484
16749
|
{
|
|
@@ -16487,7 +16752,7 @@
|
|
|
16487
16752
|
},
|
|
16488
16753
|
{
|
|
16489
16754
|
"name": "pageSize",
|
|
16490
|
-
"description": "Specifies the number of versions displayed on each page of the Version Management
|
|
16755
|
+
"description": "Specifies the number of versions displayed on each page of the Version Management component.",
|
|
16491
16756
|
"type": "number"
|
|
16492
16757
|
},
|
|
16493
16758
|
{
|
|
@@ -16496,6 +16761,7 @@
|
|
|
16496
16761
|
},
|
|
16497
16762
|
{
|
|
16498
16763
|
"name": "referenceElement",
|
|
16764
|
+
"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
16765
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16500
16766
|
},
|
|
16501
16767
|
{
|
|
@@ -16505,7 +16771,7 @@
|
|
|
16505
16771
|
},
|
|
16506
16772
|
{
|
|
16507
16773
|
"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
|
|
16774
|
+
"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
16775
|
"type": "Collection<VersioningState>"
|
|
16510
16776
|
}
|
|
16511
16777
|
],
|
|
@@ -16524,7 +16790,7 @@
|
|
|
16524
16790
|
},
|
|
16525
16791
|
{
|
|
16526
16792
|
"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
|
|
16793
|
+
"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
16794
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/",
|
|
16529
16795
|
"attributes": [
|
|
16530
16796
|
{
|
|
@@ -16533,12 +16799,6 @@
|
|
|
16533
16799
|
"value": {
|
|
16534
16800
|
"type": "boolean"
|
|
16535
16801
|
}
|
|
16536
|
-
},
|
|
16537
|
-
{
|
|
16538
|
-
"name": "layer-url",
|
|
16539
|
-
"value": {
|
|
16540
|
-
"type": "string"
|
|
16541
|
-
}
|
|
16542
16802
|
}
|
|
16543
16803
|
],
|
|
16544
16804
|
"events": [
|
|
@@ -16559,8 +16819,9 @@
|
|
|
16559
16819
|
"type": "VideoLayer"
|
|
16560
16820
|
},
|
|
16561
16821
|
{
|
|
16562
|
-
"name": "
|
|
16563
|
-
"
|
|
16822
|
+
"name": "map",
|
|
16823
|
+
"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).",
|
|
16824
|
+
"type": "Map | WebMap"
|
|
16564
16825
|
},
|
|
16565
16826
|
{
|
|
16566
16827
|
"name": "ready",
|
|
@@ -16583,7 +16844,7 @@
|
|
|
16583
16844
|
},
|
|
16584
16845
|
{
|
|
16585
16846
|
"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
|
|
16847
|
+
"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
16848
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/",
|
|
16588
16849
|
"attributes": [
|
|
16589
16850
|
{
|
|
@@ -16594,6 +16855,19 @@
|
|
|
16594
16855
|
"type": "boolean"
|
|
16595
16856
|
}
|
|
16596
16857
|
},
|
|
16858
|
+
{
|
|
16859
|
+
"name": "following-mode",
|
|
16860
|
+
"description": "Determines which telemetry elements to follow when the video layer is playing.",
|
|
16861
|
+
"default": "\"follow-both\"",
|
|
16862
|
+
"value": {
|
|
16863
|
+
"type": [
|
|
16864
|
+
"\"follow-both\"",
|
|
16865
|
+
"\"follow-frame\"",
|
|
16866
|
+
"\"follow-sensor\"",
|
|
16867
|
+
"\"none\""
|
|
16868
|
+
]
|
|
16869
|
+
}
|
|
16870
|
+
},
|
|
16597
16871
|
{
|
|
16598
16872
|
"name": "hide-header",
|
|
16599
16873
|
"description": "Indicates whether to display the video player's header information.",
|
|
@@ -16636,6 +16910,7 @@
|
|
|
16636
16910
|
},
|
|
16637
16911
|
{
|
|
16638
16912
|
"name": "reference-element",
|
|
16913
|
+
"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
16914
|
"value": {
|
|
16640
16915
|
"type": "string"
|
|
16641
16916
|
}
|
|
@@ -16680,6 +16955,11 @@
|
|
|
16680
16955
|
"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
16956
|
"type": "boolean"
|
|
16682
16957
|
},
|
|
16958
|
+
{
|
|
16959
|
+
"name": "followingMode",
|
|
16960
|
+
"description": "Determines which telemetry elements to follow when the video layer is playing.",
|
|
16961
|
+
"type": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\""
|
|
16962
|
+
},
|
|
16683
16963
|
{
|
|
16684
16964
|
"name": "hideHeader",
|
|
16685
16965
|
"description": "Indicates whether to display the video player's header information.",
|
|
@@ -16702,7 +16982,7 @@
|
|
|
16702
16982
|
},
|
|
16703
16983
|
{
|
|
16704
16984
|
"name": "messageOverrides",
|
|
16705
|
-
"description": "Replace localized message strings with your own strings
|
|
16985
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16706
16986
|
"type": "Record<string, unknown>"
|
|
16707
16987
|
},
|
|
16708
16988
|
{
|
|
@@ -16711,6 +16991,7 @@
|
|
|
16711
16991
|
},
|
|
16712
16992
|
{
|
|
16713
16993
|
"name": "referenceElement",
|
|
16994
|
+
"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
16995
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16715
16996
|
},
|
|
16716
16997
|
{
|
|
@@ -16739,7 +17020,7 @@
|
|
|
16739
17020
|
},
|
|
16740
17021
|
{
|
|
16741
17022
|
"name": "arcgis-weather",
|
|
16742
|
-
"description": "The Weather component
|
|
17023
|
+
"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
17024
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-weather/",
|
|
16744
17025
|
"attributes": [
|
|
16745
17026
|
{
|
|
@@ -16808,6 +17089,7 @@
|
|
|
16808
17089
|
},
|
|
16809
17090
|
{
|
|
16810
17091
|
"name": "reference-element",
|
|
17092
|
+
"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
17093
|
"value": {
|
|
16812
17094
|
"type": "string"
|
|
16813
17095
|
}
|
|
@@ -16865,7 +17147,7 @@
|
|
|
16865
17147
|
},
|
|
16866
17148
|
{
|
|
16867
17149
|
"name": "messageOverrides",
|
|
16868
|
-
"description": "Replace localized message strings with your own strings
|
|
17150
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16869
17151
|
"type": "Record<string, unknown>"
|
|
16870
17152
|
},
|
|
16871
17153
|
{
|
|
@@ -16874,6 +17156,7 @@
|
|
|
16874
17156
|
},
|
|
16875
17157
|
{
|
|
16876
17158
|
"name": "referenceElement",
|
|
17159
|
+
"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
17160
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16878
17161
|
},
|
|
16879
17162
|
{
|
|
@@ -16954,6 +17237,7 @@
|
|
|
16954
17237
|
},
|
|
16955
17238
|
{
|
|
16956
17239
|
"name": "reference-element",
|
|
17240
|
+
"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
17241
|
"value": {
|
|
16958
17242
|
"type": "string"
|
|
16959
17243
|
}
|
|
@@ -17006,7 +17290,7 @@
|
|
|
17006
17290
|
},
|
|
17007
17291
|
{
|
|
17008
17292
|
"name": "messageOverrides",
|
|
17009
|
-
"description": "Replace localized message strings with your own strings
|
|
17293
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
17010
17294
|
"type": "Record<string, unknown>"
|
|
17011
17295
|
},
|
|
17012
17296
|
{
|
|
@@ -17015,6 +17299,7 @@
|
|
|
17015
17299
|
},
|
|
17016
17300
|
{
|
|
17017
17301
|
"name": "referenceElement",
|
|
17302
|
+
"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
17303
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
17019
17304
|
},
|
|
17020
17305
|
{
|