@arcgis/map-components 4.34.0-next.5 → 4.34.0-next.51
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/23HAYJDR.js +4 -0
- package/dist/cdn/2CDG6HD7.js +4 -0
- package/dist/cdn/2EKUK755.js +4 -0
- package/dist/cdn/2LEPUYNL.js +4 -0
- package/dist/cdn/2X5HT3OR.js +4 -0
- package/dist/cdn/2X7UJLWL.js +4 -0
- package/dist/cdn/35HMSGLA.js +4 -0
- package/dist/cdn/3DPIAPJU.js +4 -0
- package/dist/cdn/3NF7FJBP.js +4 -0
- package/dist/cdn/3RJTB2MQ.js +4 -0
- package/dist/cdn/44ZQIRNR.js +4 -0
- package/dist/cdn/47QYSQQI.js +4 -0
- package/dist/cdn/47VHUNU6.js +4 -0
- package/dist/cdn/4F6FSL4T.js +4 -0
- package/dist/cdn/4LPNSJCM.js +4 -0
- package/dist/cdn/{4MRPFB2F.js → 4SDYEIKE.js} +2 -2
- package/dist/cdn/4TG2R2QU.js +4 -0
- package/dist/cdn/52EMW3O2.js +4 -0
- package/dist/cdn/57FQE7CG.js +4 -0
- package/dist/cdn/{V32WTVMP.js → 5FKORFL4.js} +1 -1
- package/dist/cdn/5P67NND5.js +4 -0
- package/dist/cdn/{RNMVFT5P.js → 5TUSCZO2.js} +1 -1
- package/dist/cdn/5YR5YPEH.js +4 -0
- package/dist/cdn/5YXRIS4X.js +3 -0
- package/dist/cdn/66PSAFAX.js +4 -0
- package/dist/cdn/6OBEVEH7.js +4 -0
- package/dist/cdn/6ODSFWYE.js +4 -0
- package/dist/cdn/6OS77J7L.js +4 -0
- package/dist/cdn/6OUY3XXG.js +4 -0
- package/dist/cdn/6UFE5NN6.js +4 -0
- package/dist/cdn/6VF4IEDN.js +4 -0
- package/dist/cdn/6XJKM67Q.js +4 -0
- package/dist/cdn/6ZUHPUCU.js +4 -0
- package/dist/cdn/7ABP4YLG.js +5 -0
- package/dist/cdn/7F5MGIQN.js +4 -0
- package/dist/cdn/7KIW5BCC.js +4 -0
- package/dist/cdn/7OHN63MP.js +4 -0
- package/dist/cdn/7PMQXZ6J.js +4 -0
- package/dist/cdn/7VBSLXI6.js +4 -0
- package/dist/cdn/ABY3EJGK.js +4 -0
- package/dist/cdn/AJOE7HMC.js +4 -0
- package/dist/cdn/{54VGZGQT.js → ANEAZJAQ.js} +2 -2
- package/dist/cdn/AOILTLWV.js +4 -0
- package/dist/cdn/APLX2G3G.js +4 -0
- package/dist/cdn/AYT64V4O.js +4 -0
- package/dist/cdn/BPKJF4BQ.js +4 -0
- package/dist/cdn/BQWGRO5F.js +4 -0
- package/dist/cdn/CATEMY5Q.js +4 -0
- package/dist/cdn/CBDJEZIQ.js +4 -0
- package/dist/cdn/CL2KUYAV.js +4 -0
- package/dist/cdn/{RZWKYMUH.js → CNVEHUDF.js} +2 -2
- package/dist/cdn/COBMNV4T.js +4 -0
- package/dist/cdn/D6C2QQQG.js +4 -0
- package/dist/cdn/DGOWPVSJ.js +4 -0
- package/dist/cdn/DNPTHNCU.js +4 -0
- package/dist/cdn/{BNUZVD5L.js → DOC7KVHO.js} +2 -2
- package/dist/cdn/{JE6AJOV2.js → DQFJCFJE.js} +2 -2
- package/dist/cdn/DRDEFATT.js +4 -0
- package/dist/cdn/E6DQN3MY.js +4 -0
- package/dist/cdn/EBPGB4PM.js +4 -0
- package/dist/cdn/EKDI5BRX.js +4 -0
- package/dist/cdn/ENB3QCSY.js +4 -0
- package/dist/cdn/F6A67IBM.js +4 -0
- package/dist/cdn/FGU7NQB3.js +4 -0
- package/dist/cdn/FNDCY6TH.js +4 -0
- package/dist/cdn/FNJ522JF.js +4 -0
- package/dist/cdn/FP6W6INT.js +4 -0
- package/dist/cdn/FQDWKAFC.js +4 -0
- package/dist/cdn/FUOB72QT.js +4 -0
- package/dist/cdn/FXYAWM4G.js +4 -0
- package/dist/cdn/FYTYNQJW.js +4 -0
- package/dist/cdn/G7MO5YNI.js +4 -0
- package/dist/cdn/GAO72ICS.js +4 -0
- package/dist/cdn/GAWSZGSE.js +4 -0
- package/dist/cdn/GCVFIMSI.js +4 -0
- package/dist/cdn/GH5ORWDD.js +4 -0
- package/dist/cdn/GLY2QNU5.js +4 -0
- package/dist/cdn/{UKUTVSTC.js → GOKTRDSW.js} +2 -2
- package/dist/cdn/GTEBKEBT.js +4 -0
- package/dist/cdn/H4XXPWYD.js +4 -0
- package/dist/cdn/HBRDA6ZG.js +4 -0
- package/dist/cdn/HHLBL37Q.js +4 -0
- package/dist/cdn/{AIJ5QKVL.js → HNH26E33.js} +1 -1
- package/dist/cdn/HOBDI6JD.js +4 -0
- package/dist/cdn/HOBYGWBS.js +4 -0
- package/dist/cdn/HQFAH7VM.js +4 -0
- package/dist/cdn/HTTSJGJH.js +4 -0
- package/dist/cdn/HW36UUHG.js +4 -0
- package/dist/cdn/IKLWWK2I.js +4 -0
- package/dist/cdn/IWDZFFZJ.js +4 -0
- package/dist/cdn/{CY2ZUEMG.js → IWRQ325C.js} +2 -2
- package/dist/cdn/IZ33XLJR.js +4 -0
- package/dist/cdn/J42NCWYZ.js +4 -0
- package/dist/cdn/J7AD3VVE.js +4 -0
- package/dist/cdn/JEAYFG3N.js +4 -0
- package/dist/cdn/JEVL26RG.js +4 -0
- package/dist/cdn/JNIAYBSA.js +4 -0
- package/dist/cdn/JO5V6L7X.js +4 -0
- package/dist/cdn/JT2Y2CFS.js +4 -0
- package/dist/cdn/K66BYPYZ.js +4 -0
- package/dist/cdn/K6AWFSFK.js +4 -0
- package/dist/cdn/KG2HQWWR.js +4 -0
- package/dist/cdn/KGR3TOXV.js +4 -0
- package/dist/cdn/KNPHEVWW.js +4 -0
- package/dist/cdn/KRTOFDMU.js +4 -0
- package/dist/cdn/KVN5WZ2F.js +4 -0
- package/dist/cdn/{EPS7HMFS.js → LSZOTLG2.js} +1 -1
- package/dist/cdn/M5EMWKKY.js +4 -0
- package/dist/cdn/M77KTA6U.js +4 -0
- package/dist/cdn/MOI6KAID.js +4 -0
- package/dist/cdn/MR5AO3NN.js +4 -0
- package/dist/cdn/MUMY6GEM.js +4 -0
- package/dist/cdn/N55D5MJJ.js +4 -0
- package/dist/cdn/NJTUC76F.js +4 -0
- package/dist/cdn/NPQISYAT.js +4 -0
- package/dist/cdn/NX654MZD.js +4 -0
- package/dist/cdn/NXKE4IBO.js +4 -0
- package/dist/cdn/NXP472VC.js +4 -0
- package/dist/cdn/NZMUQVNO.js +4 -0
- package/dist/cdn/O33QCB33.js +4 -0
- package/dist/cdn/O4UTHW2Y.js +4 -0
- package/dist/cdn/O7WE7QGS.js +4 -0
- package/dist/cdn/ODI4TZIM.js +4 -0
- package/dist/cdn/OOUQ765K.js +4 -0
- package/dist/cdn/OSBYI6F5.js +4 -0
- package/dist/cdn/OUTJJ7Z2.js +4 -0
- package/dist/cdn/OUURDOBJ.js +4 -0
- package/dist/cdn/PJSU42JM.js +6 -0
- package/dist/cdn/PLDRW24K.js +4 -0
- package/dist/cdn/PPGAVYMR.js +4 -0
- package/dist/cdn/PQMAOWDZ.js +4 -0
- package/dist/cdn/PWHAZRNJ.js +4 -0
- package/dist/cdn/{Z5OKVV3T.js → PZO5SSQT.js} +2 -2
- package/dist/cdn/Q34PXGKN.js +4 -0
- package/dist/cdn/QARQYR3S.js +4 -0
- package/dist/cdn/QHNAGBYU.js +4 -0
- package/dist/cdn/QLTAVM6R.js +4 -0
- package/dist/cdn/REC3WVMB.js +4 -0
- package/dist/cdn/RLRHEVME.js +4 -0
- package/dist/cdn/S3Y6WOSE.js +4 -0
- package/dist/cdn/S72W2EOS.js +4 -0
- package/dist/cdn/SCGFRFEA.js +4 -0
- package/dist/cdn/SDTNEE4Q.js +4 -0
- package/dist/cdn/SELAQDGF.js +4 -0
- package/dist/cdn/SG6XFUPU.js +4 -0
- package/dist/cdn/STPFZ6PG.js +4 -0
- package/dist/cdn/SULU3BCZ.js +4 -0
- package/dist/cdn/T347J3LH.js +4 -0
- package/dist/cdn/T4OF5KMY.js +4 -0
- package/dist/cdn/T4ZGI6ZX.js +4 -0
- package/dist/cdn/TIVO56VB.js +4 -0
- package/dist/cdn/TJLAHABW.js +4 -0
- package/dist/cdn/{5ZZR2J6N.js → TOOG2ECU.js} +2 -2
- package/dist/cdn/TVSLB42C.js +4 -0
- package/dist/cdn/{4GXYTGZZ.js → UHTGJYCW.js} +1 -1
- package/dist/cdn/UW2QFZLI.js +4 -0
- package/dist/cdn/VFCPDEJV.js +4 -0
- package/dist/cdn/VINXCROG.js +4 -0
- package/dist/cdn/VLJ5T5EM.js +4 -0
- package/dist/cdn/VMSV3XLY.js +4 -0
- package/dist/cdn/VT2S6EIP.js +4 -0
- package/dist/cdn/VWC4UHZI.js +4 -0
- package/dist/cdn/W2TJDRTX.js +4 -0
- package/dist/cdn/W6STCPFV.js +4 -0
- package/dist/cdn/{HRVDXQJH.js → W7KNNUEM.js} +1 -1
- package/dist/cdn/WC5PO2WX.js +4 -0
- package/dist/cdn/WJXSWJ6Y.js +4 -0
- package/dist/cdn/WLR2QMDR.js +4 -0
- package/dist/cdn/WMTBPX3C.js +4 -0
- package/dist/cdn/X3YMQ2R4.js +4 -0
- package/dist/cdn/{QIELYIFC.js → X4VRZLRF.js} +2 -2
- package/dist/cdn/X7YZSEGZ.js +4 -0
- package/dist/cdn/XCGQPPDC.js +4 -0
- package/dist/cdn/{ZFZIGRGE.js → XIW72IDH.js} +1 -1
- package/dist/cdn/XYEXAVRU.js +4 -0
- package/dist/cdn/Y6BRCKJZ.js +4 -0
- package/dist/cdn/YAPOF7X6.js +4 -0
- package/dist/cdn/YJD3MIER.js +4 -0
- package/dist/cdn/YRLL2RF2.js +4 -0
- package/dist/cdn/YYZRFHWC.js +4 -0
- package/dist/cdn/{LB4FJL6Z.js → Z2DUVJVT.js} +2 -2
- package/dist/cdn/ZQ3B7VXH.js +4 -0
- package/dist/cdn/{FCPVKFF7.js → ZT3D6RRA.js} +2 -2
- package/dist/cdn/ZYQGIGGR.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 +178 -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 +12 -1
- package/dist/components/arcgis-attachments/customElement.js +8 -8
- 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 +179 -87
- package/dist/components/arcgis-feature/customElement.js +192 -21
- package/dist/components/arcgis-feature/index.d.ts +7 -0
- package/dist/components/arcgis-feature/index.js +7 -0
- package/dist/components/arcgis-feature-attachments/customElement.d.ts +17 -0
- package/dist/components/arcgis-feature-attachments/customElement.js +37 -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 +21 -0
- package/dist/components/arcgis-feature-expression/customElement.js +248 -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 +36 -0
- package/dist/components/arcgis-feature-media/customElement.js +571 -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 +2220 -656
- package/dist/docs/docs.json +2021 -863
- package/dist/docs/vscode.html-custom-data.json +319 -135
- package/dist/docs/web-types.json +680 -322
- 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 +26 -20
- package/dist/support/heading.d.ts +2 -1
- package/dist/types/lumina.d.ts +23 -18
- package/dist/types/preact.d.ts +23 -18
- package/dist/types/react.d.ts +23 -18
- package/dist/types/stencil.d.ts +23 -18
- package/dist/utils/chart-utils.d.ts +6 -0
- package/dist/utils/feature-utils.d.ts +33 -0
- package/dist/utils/related-feature-utils.d.ts +6 -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.51",
|
|
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
|
}
|
|
@@ -461,7 +467,7 @@
|
|
|
461
467
|
"events": [
|
|
462
468
|
{
|
|
463
469
|
"name": "arcgisPropertyChange",
|
|
464
|
-
"type": "{ name: \"state\" | \"submitting\"; }",
|
|
470
|
+
"type": "{ name: \"state\" | \"submitting\" | \"attachmentInfos\"; }",
|
|
465
471
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
466
472
|
},
|
|
467
473
|
{
|
|
@@ -472,6 +478,11 @@
|
|
|
472
478
|
],
|
|
473
479
|
"js": {
|
|
474
480
|
"properties": [
|
|
481
|
+
{
|
|
482
|
+
"name": "attachmentInfos",
|
|
483
|
+
"description": "A collection of [AttachmentInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query-support-AttachmentInfo.html) defined on a feature.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#attachmentInfos)",
|
|
484
|
+
"type": "Collection<AttachmentInfo>"
|
|
485
|
+
},
|
|
475
486
|
{
|
|
476
487
|
"name": "autoDestroyDisabled",
|
|
477
488
|
"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-attachments/#destroy) method when you are done to\nprevent memory leaks.",
|
|
@@ -540,6 +551,7 @@
|
|
|
540
551
|
},
|
|
541
552
|
{
|
|
542
553
|
"name": "referenceElement",
|
|
554
|
+
"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
555
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
544
556
|
},
|
|
545
557
|
{
|
|
@@ -556,7 +568,7 @@
|
|
|
556
568
|
"events": [
|
|
557
569
|
{
|
|
558
570
|
"name": "arcgisPropertyChange",
|
|
559
|
-
"type": "{ name: \"state\" | \"submitting\"; }",
|
|
571
|
+
"type": "{ name: \"state\" | \"submitting\" | \"attachmentInfos\"; }",
|
|
560
572
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
561
573
|
},
|
|
562
574
|
{
|
|
@@ -645,6 +657,7 @@
|
|
|
645
657
|
},
|
|
646
658
|
{
|
|
647
659
|
"name": "reference-element",
|
|
660
|
+
"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
661
|
"value": {
|
|
649
662
|
"type": "string"
|
|
650
663
|
}
|
|
@@ -709,7 +722,7 @@
|
|
|
709
722
|
},
|
|
710
723
|
{
|
|
711
724
|
"name": "messageOverrides",
|
|
712
|
-
"description": "Replace localized message strings with your own strings
|
|
725
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
713
726
|
"type": "Record<string, unknown>"
|
|
714
727
|
},
|
|
715
728
|
{
|
|
@@ -718,6 +731,7 @@
|
|
|
718
731
|
},
|
|
719
732
|
{
|
|
720
733
|
"name": "referenceElement",
|
|
734
|
+
"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
735
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
722
736
|
},
|
|
723
737
|
{
|
|
@@ -898,6 +912,7 @@
|
|
|
898
912
|
},
|
|
899
913
|
{
|
|
900
914
|
"name": "reference-element",
|
|
915
|
+
"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
916
|
"value": {
|
|
902
917
|
"type": "string"
|
|
903
918
|
}
|
|
@@ -1124,6 +1139,7 @@
|
|
|
1124
1139
|
},
|
|
1125
1140
|
{
|
|
1126
1141
|
"name": "referenceElement",
|
|
1142
|
+
"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
1143
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
1128
1144
|
},
|
|
1129
1145
|
{
|
|
@@ -1269,6 +1285,7 @@
|
|
|
1269
1285
|
},
|
|
1270
1286
|
{
|
|
1271
1287
|
"name": "reference-element",
|
|
1288
|
+
"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
1289
|
"value": {
|
|
1273
1290
|
"type": "string"
|
|
1274
1291
|
}
|
|
@@ -1298,7 +1315,7 @@
|
|
|
1298
1315
|
"events": [
|
|
1299
1316
|
{
|
|
1300
1317
|
"name": "arcgisPropertyChange",
|
|
1301
|
-
"type": "{ name: \"state\" | \"nextBasemap\"; }",
|
|
1318
|
+
"type": "{ name: \"state\" | \"activeBasemap\" | \"nextBasemap\"; }",
|
|
1302
1319
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
1303
1320
|
},
|
|
1304
1321
|
{
|
|
@@ -1331,7 +1348,7 @@
|
|
|
1331
1348
|
},
|
|
1332
1349
|
{
|
|
1333
1350
|
"name": "messageOverrides",
|
|
1334
|
-
"description": "Replace localized message strings with your own strings
|
|
1351
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
1335
1352
|
"type": "Record<string, unknown>"
|
|
1336
1353
|
},
|
|
1337
1354
|
{
|
|
@@ -1345,6 +1362,7 @@
|
|
|
1345
1362
|
},
|
|
1346
1363
|
{
|
|
1347
1364
|
"name": "referenceElement",
|
|
1365
|
+
"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
1366
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
1349
1367
|
},
|
|
1350
1368
|
{
|
|
@@ -1361,7 +1379,7 @@
|
|
|
1361
1379
|
"events": [
|
|
1362
1380
|
{
|
|
1363
1381
|
"name": "arcgisPropertyChange",
|
|
1364
|
-
"type": "{ name: \"state\" | \"nextBasemap\"; }",
|
|
1382
|
+
"type": "{ name: \"state\" | \"activeBasemap\" | \"nextBasemap\"; }",
|
|
1365
1383
|
"description": "Emitted when the value of a property is changed. Use this to listen to changes to properties."
|
|
1366
1384
|
},
|
|
1367
1385
|
{
|
|
@@ -1374,7 +1392,7 @@
|
|
|
1374
1392
|
},
|
|
1375
1393
|
{
|
|
1376
1394
|
"name": "arcgis-bookmarks",
|
|
1377
|
-
"description": "The Bookmarks component
|
|
1395
|
+
"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
1396
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/",
|
|
1379
1397
|
"attributes": [
|
|
1380
1398
|
{
|
|
@@ -1395,7 +1413,7 @@
|
|
|
1395
1413
|
},
|
|
1396
1414
|
{
|
|
1397
1415
|
"name": "disabled",
|
|
1398
|
-
"description": "When true, the
|
|
1416
|
+
"description": "When true, the component is visually withdrawn and cannot be interacted with.",
|
|
1399
1417
|
"default": "false",
|
|
1400
1418
|
"value": {
|
|
1401
1419
|
"type": "boolean"
|
|
@@ -1411,20 +1429,38 @@
|
|
|
1411
1429
|
},
|
|
1412
1430
|
{
|
|
1413
1431
|
"name": "filter-placeholder",
|
|
1414
|
-
"description": "Defines the text used as a placeholder when
|
|
1432
|
+
"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`.",
|
|
1433
|
+
"default": "\"\"",
|
|
1415
1434
|
"value": {
|
|
1416
1435
|
"type": "string"
|
|
1417
1436
|
}
|
|
1418
1437
|
},
|
|
1419
1438
|
{
|
|
1420
1439
|
"name": "filter-text",
|
|
1421
|
-
"description": "Defines the text used to filter the bookmarks when
|
|
1440
|
+
"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`.",
|
|
1441
|
+
"default": "\"\"",
|
|
1422
1442
|
"value": {
|
|
1423
1443
|
"type": "string"
|
|
1424
1444
|
}
|
|
1425
1445
|
},
|
|
1446
|
+
{
|
|
1447
|
+
"name": "heading-level",
|
|
1448
|
+
"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.",
|
|
1449
|
+
"default": "2",
|
|
1450
|
+
"value": {
|
|
1451
|
+
"type": [
|
|
1452
|
+
"1",
|
|
1453
|
+
"2",
|
|
1454
|
+
"3",
|
|
1455
|
+
"4",
|
|
1456
|
+
"5",
|
|
1457
|
+
"6"
|
|
1458
|
+
]
|
|
1459
|
+
}
|
|
1460
|
+
},
|
|
1426
1461
|
{
|
|
1427
1462
|
"name": "hide-flow",
|
|
1463
|
+
"description": "Determines whether the component should be rendered within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/).",
|
|
1428
1464
|
"default": "false",
|
|
1429
1465
|
"value": {
|
|
1430
1466
|
"type": "boolean"
|
|
@@ -1432,6 +1468,7 @@
|
|
|
1432
1468
|
},
|
|
1433
1469
|
{
|
|
1434
1470
|
"name": "hide-thumbnail",
|
|
1471
|
+
"description": "Indicates whether the thumbnail associated with the bookmark is hidden.",
|
|
1435
1472
|
"default": "false",
|
|
1436
1473
|
"value": {
|
|
1437
1474
|
"type": "boolean"
|
|
@@ -1439,6 +1476,7 @@
|
|
|
1439
1476
|
},
|
|
1440
1477
|
{
|
|
1441
1478
|
"name": "hide-time",
|
|
1479
|
+
"description": "Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.",
|
|
1442
1480
|
"default": "false",
|
|
1443
1481
|
"value": {
|
|
1444
1482
|
"type": "boolean"
|
|
@@ -1446,22 +1484,22 @@
|
|
|
1446
1484
|
},
|
|
1447
1485
|
{
|
|
1448
1486
|
"name": "icon",
|
|
1449
|
-
"description": "Icon which represents the
|
|
1450
|
-
"default": "\"
|
|
1487
|
+
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
1488
|
+
"default": "\"icon\"",
|
|
1451
1489
|
"value": {
|
|
1452
1490
|
"type": "string"
|
|
1453
1491
|
}
|
|
1454
1492
|
},
|
|
1455
1493
|
{
|
|
1456
1494
|
"name": "label",
|
|
1457
|
-
"description": "The
|
|
1495
|
+
"description": "The component's default label.",
|
|
1458
1496
|
"value": {
|
|
1459
1497
|
"type": "string"
|
|
1460
1498
|
}
|
|
1461
1499
|
},
|
|
1462
1500
|
{
|
|
1463
1501
|
"name": "position",
|
|
1464
|
-
"default": "\"
|
|
1502
|
+
"default": "\"top-left\"",
|
|
1465
1503
|
"value": {
|
|
1466
1504
|
"type": [
|
|
1467
1505
|
"\"bottom-leading\"",
|
|
@@ -1478,12 +1516,14 @@
|
|
|
1478
1516
|
},
|
|
1479
1517
|
{
|
|
1480
1518
|
"name": "reference-element",
|
|
1519
|
+
"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
1520
|
"value": {
|
|
1482
1521
|
"type": "string"
|
|
1483
1522
|
}
|
|
1484
1523
|
},
|
|
1485
1524
|
{
|
|
1486
1525
|
"name": "show-add-bookmark-button",
|
|
1526
|
+
"description": "Indicates whether to display the button to add a new bookmark.",
|
|
1487
1527
|
"default": "false",
|
|
1488
1528
|
"value": {
|
|
1489
1529
|
"type": "boolean"
|
|
@@ -1491,6 +1531,7 @@
|
|
|
1491
1531
|
},
|
|
1492
1532
|
{
|
|
1493
1533
|
"name": "show-close-button",
|
|
1534
|
+
"description": "Indicates whether to display the close button.",
|
|
1494
1535
|
"default": "false",
|
|
1495
1536
|
"value": {
|
|
1496
1537
|
"type": "boolean"
|
|
@@ -1498,6 +1539,7 @@
|
|
|
1498
1539
|
},
|
|
1499
1540
|
{
|
|
1500
1541
|
"name": "show-collapse-button",
|
|
1542
|
+
"description": "Indicates whether to display the collapse button.",
|
|
1501
1543
|
"default": "false",
|
|
1502
1544
|
"value": {
|
|
1503
1545
|
"type": "boolean"
|
|
@@ -1505,6 +1547,7 @@
|
|
|
1505
1547
|
},
|
|
1506
1548
|
{
|
|
1507
1549
|
"name": "show-edit-bookmark-button",
|
|
1550
|
+
"description": "Indicates whether to display the button to edit a bookmark.",
|
|
1508
1551
|
"default": "false",
|
|
1509
1552
|
"value": {
|
|
1510
1553
|
"type": "boolean"
|
|
@@ -1512,6 +1555,7 @@
|
|
|
1512
1555
|
},
|
|
1513
1556
|
{
|
|
1514
1557
|
"name": "show-filter",
|
|
1558
|
+
"description": "Indicates whether to display the bookmark filter.",
|
|
1515
1559
|
"default": "false",
|
|
1516
1560
|
"value": {
|
|
1517
1561
|
"type": "boolean"
|
|
@@ -1519,6 +1563,7 @@
|
|
|
1519
1563
|
},
|
|
1520
1564
|
{
|
|
1521
1565
|
"name": "show-heading",
|
|
1566
|
+
"description": "Indicates whether to display the heading.",
|
|
1522
1567
|
"default": "false",
|
|
1523
1568
|
"value": {
|
|
1524
1569
|
"type": "boolean"
|
|
@@ -1534,17 +1579,26 @@
|
|
|
1534
1579
|
"\"ready\""
|
|
1535
1580
|
]
|
|
1536
1581
|
}
|
|
1582
|
+
},
|
|
1583
|
+
{
|
|
1584
|
+
"name": "time-disabled",
|
|
1585
|
+
"description": "Indicates whether to disable the time capability of the Bookmarks component.",
|
|
1586
|
+
"default": "false",
|
|
1587
|
+
"value": {
|
|
1588
|
+
"type": "boolean"
|
|
1589
|
+
}
|
|
1537
1590
|
}
|
|
1538
1591
|
],
|
|
1539
1592
|
"events": [
|
|
1540
1593
|
{
|
|
1541
|
-
"name": "
|
|
1542
|
-
"type": "
|
|
1543
|
-
"description": "
|
|
1594
|
+
"name": "arcgisBookmarkEdit",
|
|
1595
|
+
"type": "BookmarksBookmarkEditEvent",
|
|
1596
|
+
"description": "\nFires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited."
|
|
1544
1597
|
},
|
|
1545
1598
|
{
|
|
1546
|
-
"name": "
|
|
1547
|
-
"type": "
|
|
1599
|
+
"name": "arcgisBookmarkSelect",
|
|
1600
|
+
"type": "BookmarksBookmarkSelectEvent",
|
|
1601
|
+
"description": "Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected."
|
|
1548
1602
|
},
|
|
1549
1603
|
{
|
|
1550
1604
|
"name": "arcgisPropertyChange",
|
|
@@ -1555,10 +1609,6 @@
|
|
|
1555
1609
|
"name": "arcgisReady",
|
|
1556
1610
|
"type": "void",
|
|
1557
1611
|
"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
1612
|
}
|
|
1563
1613
|
],
|
|
1564
1614
|
"js": {
|
|
@@ -1570,7 +1620,7 @@
|
|
|
1570
1620
|
},
|
|
1571
1621
|
{
|
|
1572
1622
|
"name": "bookmarks",
|
|
1573
|
-
"description": "A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s
|
|
1623
|
+
"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
1624
|
"type": "Collection<Bookmark>"
|
|
1575
1625
|
},
|
|
1576
1626
|
{
|
|
@@ -1580,17 +1630,17 @@
|
|
|
1580
1630
|
},
|
|
1581
1631
|
{
|
|
1582
1632
|
"name": "defaultCreateOptions",
|
|
1583
|
-
"description": "Specifies how new bookmarks will be created if [
|
|
1633
|
+
"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
1634
|
"type": "BookmarkOptions"
|
|
1585
1635
|
},
|
|
1586
1636
|
{
|
|
1587
1637
|
"name": "defaultEditOptions",
|
|
1588
|
-
"description": "Specifies how bookmarks will be edited, if [
|
|
1638
|
+
"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
1639
|
"type": "BookmarkOptions"
|
|
1590
1640
|
},
|
|
1591
1641
|
{
|
|
1592
1642
|
"name": "disabled",
|
|
1593
|
-
"description": "When true, the
|
|
1643
|
+
"description": "When true, the component is visually withdrawn and cannot be interacted with.",
|
|
1594
1644
|
"type": "boolean"
|
|
1595
1645
|
},
|
|
1596
1646
|
{
|
|
@@ -1600,88 +1650,114 @@
|
|
|
1600
1650
|
},
|
|
1601
1651
|
{
|
|
1602
1652
|
"name": "filterPlaceholder",
|
|
1603
|
-
"description": "Defines the text used as a placeholder when
|
|
1653
|
+
"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
1654
|
"type": "string"
|
|
1605
1655
|
},
|
|
1606
1656
|
{
|
|
1607
1657
|
"name": "filterText",
|
|
1608
|
-
"description": "Defines the text used to filter the bookmarks when
|
|
1658
|
+
"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
1659
|
"type": "string"
|
|
1610
1660
|
},
|
|
1611
1661
|
{
|
|
1612
1662
|
"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)",
|
|
1663
|
+
"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
1664
|
"type": "(((view: MapView | SceneView, goToParameters: GoToParameters) => void))"
|
|
1615
1665
|
},
|
|
1666
|
+
{
|
|
1667
|
+
"name": "headingLevel",
|
|
1668
|
+
"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.",
|
|
1669
|
+
"type": "1 | 2 | 3 | 4 | 5 | 6"
|
|
1670
|
+
},
|
|
1616
1671
|
{
|
|
1617
1672
|
"name": "hideFlow",
|
|
1673
|
+
"description": "Determines whether the component should be rendered within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/).",
|
|
1618
1674
|
"type": "boolean"
|
|
1619
1675
|
},
|
|
1620
1676
|
{
|
|
1621
1677
|
"name": "hideThumbnail",
|
|
1678
|
+
"description": "Indicates whether the thumbnail associated with the bookmark is hidden.",
|
|
1622
1679
|
"type": "boolean"
|
|
1623
1680
|
},
|
|
1624
1681
|
{
|
|
1625
1682
|
"name": "hideTime",
|
|
1683
|
+
"description": "Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.",
|
|
1626
1684
|
"type": "boolean"
|
|
1627
1685
|
},
|
|
1628
1686
|
{
|
|
1629
1687
|
"name": "icon",
|
|
1630
|
-
"description": "Icon which represents the
|
|
1688
|
+
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
1631
1689
|
"type": "string"
|
|
1632
1690
|
},
|
|
1633
1691
|
{
|
|
1634
1692
|
"name": "label",
|
|
1635
|
-
"description": "The
|
|
1693
|
+
"description": "The component's default label.",
|
|
1636
1694
|
"type": "string"
|
|
1637
1695
|
},
|
|
1696
|
+
{
|
|
1697
|
+
"name": "messageOverrides",
|
|
1698
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
1699
|
+
"type": "Record<string, unknown>"
|
|
1700
|
+
},
|
|
1638
1701
|
{
|
|
1639
1702
|
"name": "position",
|
|
1640
1703
|
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
|
|
1641
1704
|
},
|
|
1642
1705
|
{
|
|
1643
1706
|
"name": "referenceElement",
|
|
1707
|
+
"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
1708
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
1645
1709
|
},
|
|
1646
1710
|
{
|
|
1647
1711
|
"name": "showAddBookmarkButton",
|
|
1712
|
+
"description": "Indicates whether to display the button to add a new bookmark.",
|
|
1648
1713
|
"type": "boolean"
|
|
1649
1714
|
},
|
|
1650
1715
|
{
|
|
1651
1716
|
"name": "showCloseButton",
|
|
1717
|
+
"description": "Indicates whether to display the close button.",
|
|
1652
1718
|
"type": "boolean"
|
|
1653
1719
|
},
|
|
1654
1720
|
{
|
|
1655
1721
|
"name": "showCollapseButton",
|
|
1722
|
+
"description": "Indicates whether to display the collapse button.",
|
|
1656
1723
|
"type": "boolean"
|
|
1657
1724
|
},
|
|
1658
1725
|
{
|
|
1659
1726
|
"name": "showEditBookmarkButton",
|
|
1727
|
+
"description": "Indicates whether to display the button to edit a bookmark.",
|
|
1660
1728
|
"type": "boolean"
|
|
1661
1729
|
},
|
|
1662
1730
|
{
|
|
1663
1731
|
"name": "showFilter",
|
|
1732
|
+
"description": "Indicates whether to display the bookmark filter.",
|
|
1664
1733
|
"type": "boolean"
|
|
1665
1734
|
},
|
|
1666
1735
|
{
|
|
1667
1736
|
"name": "showHeading",
|
|
1737
|
+
"description": "Indicates whether to display the heading.",
|
|
1668
1738
|
"type": "boolean"
|
|
1669
1739
|
},
|
|
1670
1740
|
{
|
|
1671
1741
|
"name": "state",
|
|
1672
1742
|
"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
1743
|
"type": "\"loading\" | \"ready\""
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
"name": "timeDisabled",
|
|
1747
|
+
"description": "Indicates whether to disable the time capability of the Bookmarks component.",
|
|
1748
|
+
"type": "boolean"
|
|
1674
1749
|
}
|
|
1675
1750
|
],
|
|
1676
1751
|
"events": [
|
|
1677
1752
|
{
|
|
1678
|
-
"name": "
|
|
1679
|
-
"type": "
|
|
1680
|
-
"description": "
|
|
1753
|
+
"name": "arcgisBookmarkEdit",
|
|
1754
|
+
"type": "BookmarksBookmarkEditEvent",
|
|
1755
|
+
"description": "\nFires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited."
|
|
1681
1756
|
},
|
|
1682
1757
|
{
|
|
1683
|
-
"name": "
|
|
1684
|
-
"type": "
|
|
1758
|
+
"name": "arcgisBookmarkSelect",
|
|
1759
|
+
"type": "BookmarksBookmarkSelectEvent",
|
|
1760
|
+
"description": "Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected."
|
|
1685
1761
|
},
|
|
1686
1762
|
{
|
|
1687
1763
|
"name": "arcgisPropertyChange",
|
|
@@ -1692,17 +1768,13 @@
|
|
|
1692
1768
|
"name": "arcgisReady",
|
|
1693
1769
|
"type": "void",
|
|
1694
1770
|
"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
1771
|
}
|
|
1700
1772
|
]
|
|
1701
1773
|
}
|
|
1702
1774
|
},
|
|
1703
1775
|
{
|
|
1704
1776
|
"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.",
|
|
1777
|
+
"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
1778
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/",
|
|
1707
1779
|
"attributes": [
|
|
1708
1780
|
{
|
|
@@ -1715,7 +1787,7 @@
|
|
|
1715
1787
|
},
|
|
1716
1788
|
{
|
|
1717
1789
|
"name": "heading-level",
|
|
1718
|
-
"description": "Indicates the heading level to use for the
|
|
1790
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1719
1791
|
"default": "3",
|
|
1720
1792
|
"value": {
|
|
1721
1793
|
"type": "number"
|
|
@@ -1744,7 +1816,7 @@
|
|
|
1744
1816
|
},
|
|
1745
1817
|
{
|
|
1746
1818
|
"name": "icon",
|
|
1747
|
-
"description": "Icon which represents the
|
|
1819
|
+
"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
1820
|
"default": "\"organization\"",
|
|
1749
1821
|
"value": {
|
|
1750
1822
|
"type": "string"
|
|
@@ -1752,7 +1824,7 @@
|
|
|
1752
1824
|
},
|
|
1753
1825
|
{
|
|
1754
1826
|
"name": "label",
|
|
1755
|
-
"description": "The
|
|
1827
|
+
"description": "The component's default label.",
|
|
1756
1828
|
"value": {
|
|
1757
1829
|
"type": "string"
|
|
1758
1830
|
}
|
|
@@ -1776,13 +1848,14 @@
|
|
|
1776
1848
|
},
|
|
1777
1849
|
{
|
|
1778
1850
|
"name": "reference-element",
|
|
1851
|
+
"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
1852
|
"value": {
|
|
1780
1853
|
"type": "string"
|
|
1781
1854
|
}
|
|
1782
1855
|
},
|
|
1783
1856
|
{
|
|
1784
1857
|
"name": "state",
|
|
1785
|
-
"description": "The
|
|
1858
|
+
"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
1859
|
"default": "\"disabled\"",
|
|
1787
1860
|
"value": {
|
|
1788
1861
|
"type": [
|
|
@@ -1815,7 +1888,7 @@
|
|
|
1815
1888
|
},
|
|
1816
1889
|
{
|
|
1817
1890
|
"name": "headingLevel",
|
|
1818
|
-
"description": "Indicates the heading level to use for the
|
|
1891
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1819
1892
|
"type": "number"
|
|
1820
1893
|
},
|
|
1821
1894
|
{
|
|
@@ -1832,17 +1905,17 @@
|
|
|
1832
1905
|
},
|
|
1833
1906
|
{
|
|
1834
1907
|
"name": "icon",
|
|
1835
|
-
"description": "Icon which represents the
|
|
1908
|
+
"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
1909
|
"type": "string"
|
|
1837
1910
|
},
|
|
1838
1911
|
{
|
|
1839
1912
|
"name": "label",
|
|
1840
|
-
"description": "The
|
|
1913
|
+
"description": "The component's default label.",
|
|
1841
1914
|
"type": "string"
|
|
1842
1915
|
},
|
|
1843
1916
|
{
|
|
1844
1917
|
"name": "layers",
|
|
1845
|
-
"description": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)
|
|
1918
|
+
"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
1919
|
"type": "Collection<BuildingSceneLayer>"
|
|
1847
1920
|
},
|
|
1848
1921
|
{
|
|
@@ -1861,11 +1934,12 @@
|
|
|
1861
1934
|
},
|
|
1862
1935
|
{
|
|
1863
1936
|
"name": "referenceElement",
|
|
1937
|
+
"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
1938
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
1865
1939
|
},
|
|
1866
1940
|
{
|
|
1867
1941
|
"name": "state",
|
|
1868
|
-
"description": "The
|
|
1942
|
+
"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
1943
|
"type": "\"disabled\" | \"failed\" | \"loading\" | \"ready\""
|
|
1870
1944
|
}
|
|
1871
1945
|
],
|
|
@@ -1992,6 +2066,7 @@
|
|
|
1992
2066
|
},
|
|
1993
2067
|
{
|
|
1994
2068
|
"name": "reference-element",
|
|
2069
|
+
"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
2070
|
"value": {
|
|
1996
2071
|
"type": "string"
|
|
1997
2072
|
}
|
|
@@ -2178,6 +2253,7 @@
|
|
|
2178
2253
|
},
|
|
2179
2254
|
{
|
|
2180
2255
|
"name": "referenceElement",
|
|
2256
|
+
"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
2257
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2182
2258
|
},
|
|
2183
2259
|
{
|
|
@@ -2295,6 +2371,7 @@
|
|
|
2295
2371
|
},
|
|
2296
2372
|
{
|
|
2297
2373
|
"name": "reference-element",
|
|
2374
|
+
"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
2375
|
"value": {
|
|
2299
2376
|
"type": "string"
|
|
2300
2377
|
}
|
|
@@ -2348,7 +2425,7 @@
|
|
|
2348
2425
|
},
|
|
2349
2426
|
{
|
|
2350
2427
|
"name": "messageOverrides",
|
|
2351
|
-
"description": "Replace localized message strings with your own strings
|
|
2428
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
2352
2429
|
"type": "Record<string, unknown>"
|
|
2353
2430
|
},
|
|
2354
2431
|
{
|
|
@@ -2362,6 +2439,7 @@
|
|
|
2362
2439
|
},
|
|
2363
2440
|
{
|
|
2364
2441
|
"name": "referenceElement",
|
|
2442
|
+
"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
2443
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2366
2444
|
},
|
|
2367
2445
|
{
|
|
@@ -2413,14 +2491,14 @@
|
|
|
2413
2491
|
}
|
|
2414
2492
|
},
|
|
2415
2493
|
{
|
|
2416
|
-
"name": "hide-
|
|
2494
|
+
"name": "hide-expand-button",
|
|
2417
2495
|
"default": "false",
|
|
2418
2496
|
"value": {
|
|
2419
2497
|
"type": "boolean"
|
|
2420
2498
|
}
|
|
2421
2499
|
},
|
|
2422
2500
|
{
|
|
2423
|
-
"name": "hide-
|
|
2501
|
+
"name": "hide-input-button",
|
|
2424
2502
|
"default": "false",
|
|
2425
2503
|
"value": {
|
|
2426
2504
|
"type": "boolean"
|
|
@@ -2498,6 +2576,7 @@
|
|
|
2498
2576
|
},
|
|
2499
2577
|
{
|
|
2500
2578
|
"name": "reference-element",
|
|
2579
|
+
"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
2580
|
"value": {
|
|
2502
2581
|
"type": "string"
|
|
2503
2582
|
}
|
|
@@ -2583,11 +2662,11 @@
|
|
|
2583
2662
|
"type": "boolean"
|
|
2584
2663
|
},
|
|
2585
2664
|
{
|
|
2586
|
-
"name": "
|
|
2665
|
+
"name": "hideExpandButton",
|
|
2587
2666
|
"type": "boolean"
|
|
2588
2667
|
},
|
|
2589
2668
|
{
|
|
2590
|
-
"name": "
|
|
2669
|
+
"name": "hideInputButton",
|
|
2591
2670
|
"type": "boolean"
|
|
2592
2671
|
},
|
|
2593
2672
|
{
|
|
@@ -2630,6 +2709,7 @@
|
|
|
2630
2709
|
},
|
|
2631
2710
|
{
|
|
2632
2711
|
"name": "referenceElement",
|
|
2712
|
+
"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
2713
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2634
2714
|
},
|
|
2635
2715
|
{
|
|
@@ -2664,7 +2744,7 @@
|
|
|
2664
2744
|
},
|
|
2665
2745
|
{
|
|
2666
2746
|
"name": "arcgis-daylight",
|
|
2667
|
-
"description": "The Daylight component can be used to manipulate the lighting conditions of a [
|
|
2747
|
+
"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
2748
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/",
|
|
2669
2749
|
"attributes": [
|
|
2670
2750
|
{
|
|
@@ -2689,7 +2769,7 @@
|
|
|
2689
2769
|
},
|
|
2690
2770
|
{
|
|
2691
2771
|
"name": "date-or-season",
|
|
2692
|
-
"description": "Controls whether the
|
|
2772
|
+
"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
2773
|
"default": "\"date\"",
|
|
2694
2774
|
"value": {
|
|
2695
2775
|
"type": [
|
|
@@ -2708,7 +2788,7 @@
|
|
|
2708
2788
|
},
|
|
2709
2789
|
{
|
|
2710
2790
|
"name": "heading-level",
|
|
2711
|
-
"description": "Indicates the heading level to use for the
|
|
2791
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
2712
2792
|
"default": "3",
|
|
2713
2793
|
"value": {
|
|
2714
2794
|
"type": "number"
|
|
@@ -2758,7 +2838,7 @@
|
|
|
2758
2838
|
},
|
|
2759
2839
|
{
|
|
2760
2840
|
"name": "icon",
|
|
2761
|
-
"description": "Icon which represents the
|
|
2841
|
+
"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
2842
|
"default": "\"brightness\"",
|
|
2763
2843
|
"value": {
|
|
2764
2844
|
"type": "string"
|
|
@@ -2766,7 +2846,7 @@
|
|
|
2766
2846
|
},
|
|
2767
2847
|
{
|
|
2768
2848
|
"name": "label",
|
|
2769
|
-
"description": "The
|
|
2849
|
+
"description": "The component's default label.",
|
|
2770
2850
|
"value": {
|
|
2771
2851
|
"type": "string"
|
|
2772
2852
|
}
|
|
@@ -2798,13 +2878,14 @@
|
|
|
2798
2878
|
},
|
|
2799
2879
|
{
|
|
2800
2880
|
"name": "reference-element",
|
|
2881
|
+
"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
2882
|
"value": {
|
|
2802
2883
|
"type": "string"
|
|
2803
2884
|
}
|
|
2804
2885
|
},
|
|
2805
2886
|
{
|
|
2806
2887
|
"name": "time-slider-steps",
|
|
2807
|
-
"description": "Sets steps, or intervals, on the time slider to restrict the times
|
|
2888
|
+
"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
2889
|
"default": "5",
|
|
2809
2890
|
"value": {
|
|
2810
2891
|
"type": "number"
|
|
@@ -2828,7 +2909,7 @@
|
|
|
2828
2909
|
{
|
|
2829
2910
|
"name": "arcgisUserDateTimeChange",
|
|
2830
2911
|
"type": "void",
|
|
2831
|
-
"description": "Fires when the user changes the date or time in the
|
|
2912
|
+
"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
2913
|
}
|
|
2833
2914
|
],
|
|
2834
2915
|
"js": {
|
|
@@ -2845,7 +2926,7 @@
|
|
|
2845
2926
|
},
|
|
2846
2927
|
{
|
|
2847
2928
|
"name": "dateOrSeason",
|
|
2848
|
-
"description": "Controls whether the
|
|
2929
|
+
"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
2930
|
"type": "\"date\" | \"season\""
|
|
2850
2931
|
},
|
|
2851
2932
|
{
|
|
@@ -2855,7 +2936,7 @@
|
|
|
2855
2936
|
},
|
|
2856
2937
|
{
|
|
2857
2938
|
"name": "headingLevel",
|
|
2858
|
-
"description": "Indicates the heading level to use for the
|
|
2939
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
2859
2940
|
"type": "number"
|
|
2860
2941
|
},
|
|
2861
2942
|
{
|
|
@@ -2884,12 +2965,12 @@
|
|
|
2884
2965
|
},
|
|
2885
2966
|
{
|
|
2886
2967
|
"name": "icon",
|
|
2887
|
-
"description": "Icon which represents the
|
|
2968
|
+
"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
2969
|
"type": "string"
|
|
2889
2970
|
},
|
|
2890
2971
|
{
|
|
2891
2972
|
"name": "label",
|
|
2892
|
-
"description": "The
|
|
2973
|
+
"description": "The component's default label.",
|
|
2893
2974
|
"type": "string"
|
|
2894
2975
|
},
|
|
2895
2976
|
{
|
|
@@ -2903,11 +2984,12 @@
|
|
|
2903
2984
|
},
|
|
2904
2985
|
{
|
|
2905
2986
|
"name": "referenceElement",
|
|
2987
|
+
"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
2988
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
2907
2989
|
},
|
|
2908
2990
|
{
|
|
2909
2991
|
"name": "timeSliderSteps",
|
|
2910
|
-
"description": "Sets steps, or intervals, on the time slider to restrict the times
|
|
2992
|
+
"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
2993
|
"type": "Array<number> | number"
|
|
2912
2994
|
},
|
|
2913
2995
|
{
|
|
@@ -2925,7 +3007,7 @@
|
|
|
2925
3007
|
{
|
|
2926
3008
|
"name": "arcgisUserDateTimeChange",
|
|
2927
3009
|
"type": "void",
|
|
2928
|
-
"description": "Fires when the user changes the date or time in the
|
|
3010
|
+
"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
3011
|
}
|
|
2930
3012
|
]
|
|
2931
3013
|
}
|
|
@@ -2993,6 +3075,7 @@
|
|
|
2993
3075
|
},
|
|
2994
3076
|
{
|
|
2995
3077
|
"name": "reference-element",
|
|
3078
|
+
"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
3079
|
"value": {
|
|
2997
3080
|
"type": "string"
|
|
2998
3081
|
}
|
|
@@ -3078,7 +3161,7 @@
|
|
|
3078
3161
|
},
|
|
3079
3162
|
{
|
|
3080
3163
|
"name": "messageOverrides",
|
|
3081
|
-
"description": "Replace localized message strings with your own strings
|
|
3164
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
3082
3165
|
"type": "Record<string, unknown>"
|
|
3083
3166
|
},
|
|
3084
3167
|
{
|
|
@@ -3087,6 +3170,7 @@
|
|
|
3087
3170
|
},
|
|
3088
3171
|
{
|
|
3089
3172
|
"name": "referenceElement",
|
|
3173
|
+
"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
3174
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3091
3175
|
},
|
|
3092
3176
|
{
|
|
@@ -3215,6 +3299,7 @@
|
|
|
3215
3299
|
},
|
|
3216
3300
|
{
|
|
3217
3301
|
"name": "reference-element",
|
|
3302
|
+
"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
3303
|
"value": {
|
|
3219
3304
|
"type": "string"
|
|
3220
3305
|
}
|
|
@@ -3346,6 +3431,7 @@
|
|
|
3346
3431
|
},
|
|
3347
3432
|
{
|
|
3348
3433
|
"name": "referenceElement",
|
|
3434
|
+
"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
3435
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3350
3436
|
},
|
|
3351
3437
|
{
|
|
@@ -3354,7 +3440,7 @@
|
|
|
3354
3440
|
},
|
|
3355
3441
|
{
|
|
3356
3442
|
"name": "searchProperties",
|
|
3357
|
-
"description": "Controls the default properties used when
|
|
3443
|
+
"description": "Controls the default properties used when searching.",
|
|
3358
3444
|
"type": "DirectionsSearchProperties"
|
|
3359
3445
|
},
|
|
3360
3446
|
{
|
|
@@ -3388,7 +3474,7 @@
|
|
|
3388
3474
|
},
|
|
3389
3475
|
{
|
|
3390
3476
|
"name": "arcgis-direct-line-measurement-3d",
|
|
3391
|
-
"description": "The Direct Line Measurement 3D component
|
|
3477
|
+
"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
3478
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/",
|
|
3393
3479
|
"attributes": [
|
|
3394
3480
|
{
|
|
@@ -3433,12 +3519,14 @@
|
|
|
3433
3519
|
},
|
|
3434
3520
|
{
|
|
3435
3521
|
"name": "reference-element",
|
|
3522
|
+
"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
3523
|
"value": {
|
|
3437
3524
|
"type": "string"
|
|
3438
3525
|
}
|
|
3439
3526
|
},
|
|
3440
3527
|
{
|
|
3441
3528
|
"name": "state",
|
|
3529
|
+
"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
3530
|
"value": {
|
|
3443
3531
|
"type": [
|
|
3444
3532
|
"\"disabled\"",
|
|
@@ -3450,7 +3538,7 @@
|
|
|
3450
3538
|
},
|
|
3451
3539
|
{
|
|
3452
3540
|
"name": "unit",
|
|
3453
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3541
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3454
3542
|
"value": {
|
|
3455
3543
|
"type": [
|
|
3456
3544
|
"\"centimeters\"",
|
|
@@ -3486,6 +3574,7 @@
|
|
|
3486
3574
|
"properties": [
|
|
3487
3575
|
{
|
|
3488
3576
|
"name": "analysis",
|
|
3577
|
+
"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
3578
|
"type": "DirectLineMeasurementAnalysis"
|
|
3490
3579
|
},
|
|
3491
3580
|
{
|
|
@@ -3509,20 +3598,22 @@
|
|
|
3509
3598
|
},
|
|
3510
3599
|
{
|
|
3511
3600
|
"name": "referenceElement",
|
|
3601
|
+
"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
3602
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3513
3603
|
},
|
|
3514
3604
|
{
|
|
3515
3605
|
"name": "state",
|
|
3606
|
+
"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
3607
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
3517
3608
|
},
|
|
3518
3609
|
{
|
|
3519
3610
|
"name": "unit",
|
|
3520
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3611
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3521
3612
|
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
3522
3613
|
},
|
|
3523
3614
|
{
|
|
3524
3615
|
"name": "unitOptions",
|
|
3525
|
-
"description": "List of unit systems (imperial, metric)
|
|
3616
|
+
"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
3617
|
"type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
|
|
3527
3618
|
}
|
|
3528
3619
|
],
|
|
@@ -3542,7 +3633,7 @@
|
|
|
3542
3633
|
},
|
|
3543
3634
|
{
|
|
3544
3635
|
"name": "arcgis-directline-measurement-3d",
|
|
3545
|
-
"description": "**Deprecated**. The
|
|
3636
|
+
"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
3637
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directline-measurement-3d/",
|
|
3547
3638
|
"attributes": [
|
|
3548
3639
|
{
|
|
@@ -3587,12 +3678,14 @@
|
|
|
3587
3678
|
},
|
|
3588
3679
|
{
|
|
3589
3680
|
"name": "reference-element",
|
|
3681
|
+
"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
3682
|
"value": {
|
|
3591
3683
|
"type": "string"
|
|
3592
3684
|
}
|
|
3593
3685
|
},
|
|
3594
3686
|
{
|
|
3595
3687
|
"name": "state",
|
|
3688
|
+
"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
3689
|
"value": {
|
|
3597
3690
|
"type": [
|
|
3598
3691
|
"\"disabled\"",
|
|
@@ -3604,7 +3697,7 @@
|
|
|
3604
3697
|
},
|
|
3605
3698
|
{
|
|
3606
3699
|
"name": "unit",
|
|
3607
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3700
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3608
3701
|
"value": {
|
|
3609
3702
|
"type": [
|
|
3610
3703
|
"\"centimeters\"",
|
|
@@ -3640,6 +3733,7 @@
|
|
|
3640
3733
|
"properties": [
|
|
3641
3734
|
{
|
|
3642
3735
|
"name": "analysis",
|
|
3736
|
+
"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
3737
|
"type": "DirectLineMeasurementAnalysis"
|
|
3644
3738
|
},
|
|
3645
3739
|
{
|
|
@@ -3663,20 +3757,22 @@
|
|
|
3663
3757
|
},
|
|
3664
3758
|
{
|
|
3665
3759
|
"name": "referenceElement",
|
|
3760
|
+
"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
3761
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3667
3762
|
},
|
|
3668
3763
|
{
|
|
3669
3764
|
"name": "state",
|
|
3765
|
+
"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
3766
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
3671
3767
|
},
|
|
3672
3768
|
{
|
|
3673
3769
|
"name": "unit",
|
|
3674
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3770
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3675
3771
|
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
3676
3772
|
},
|
|
3677
3773
|
{
|
|
3678
3774
|
"name": "unitOptions",
|
|
3679
|
-
"description": "List of unit systems (imperial, metric)
|
|
3775
|
+
"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
3776
|
"type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
|
|
3681
3777
|
}
|
|
3682
3778
|
],
|
|
@@ -3741,6 +3837,7 @@
|
|
|
3741
3837
|
},
|
|
3742
3838
|
{
|
|
3743
3839
|
"name": "reference-element",
|
|
3840
|
+
"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
3841
|
"value": {
|
|
3745
3842
|
"type": "string"
|
|
3746
3843
|
}
|
|
@@ -3815,6 +3912,7 @@
|
|
|
3815
3912
|
},
|
|
3816
3913
|
{
|
|
3817
3914
|
"name": "referenceElement",
|
|
3915
|
+
"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
3916
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
3819
3917
|
},
|
|
3820
3918
|
{
|
|
@@ -3963,6 +4061,7 @@
|
|
|
3963
4061
|
},
|
|
3964
4062
|
{
|
|
3965
4063
|
"name": "reference-element",
|
|
4064
|
+
"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
4065
|
"value": {
|
|
3967
4066
|
"type": "string"
|
|
3968
4067
|
}
|
|
@@ -3993,7 +4092,6 @@
|
|
|
3993
4092
|
"\"editing-attributes\"",
|
|
3994
4093
|
"\"editing-existing-feature\"",
|
|
3995
4094
|
"\"editing-features\"",
|
|
3996
|
-
"\"editing-new-feature\"",
|
|
3997
4095
|
"\"ready\"",
|
|
3998
4096
|
"\"viewing-selection-list\""
|
|
3999
4097
|
]
|
|
@@ -4087,6 +4185,7 @@
|
|
|
4087
4185
|
},
|
|
4088
4186
|
{
|
|
4089
4187
|
"name": "referenceElement",
|
|
4188
|
+
"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
4189
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4091
4190
|
},
|
|
4092
4191
|
{
|
|
@@ -4101,7 +4200,7 @@
|
|
|
4101
4200
|
{
|
|
4102
4201
|
"name": "state",
|
|
4103
4202
|
"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\" | \"
|
|
4203
|
+
"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
4204
|
},
|
|
4106
4205
|
{
|
|
4107
4206
|
"name": "supportingWidgetDefaults",
|
|
@@ -4130,7 +4229,7 @@
|
|
|
4130
4229
|
},
|
|
4131
4230
|
{
|
|
4132
4231
|
"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
|
|
4232
|
+
"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
4233
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/",
|
|
4135
4234
|
"attributes": [
|
|
4136
4235
|
{
|
|
@@ -4214,7 +4313,7 @@
|
|
|
4214
4313
|
},
|
|
4215
4314
|
{
|
|
4216
4315
|
"name": "icon",
|
|
4217
|
-
"description": "Icon which represents the
|
|
4316
|
+
"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
4317
|
"default": "\"altitude\"",
|
|
4219
4318
|
"value": {
|
|
4220
4319
|
"type": "string"
|
|
@@ -4222,7 +4321,7 @@
|
|
|
4222
4321
|
},
|
|
4223
4322
|
{
|
|
4224
4323
|
"name": "label",
|
|
4225
|
-
"description": "The
|
|
4324
|
+
"description": "The component's default label.",
|
|
4226
4325
|
"value": {
|
|
4227
4326
|
"type": "string"
|
|
4228
4327
|
}
|
|
@@ -4246,13 +4345,14 @@
|
|
|
4246
4345
|
},
|
|
4247
4346
|
{
|
|
4248
4347
|
"name": "reference-element",
|
|
4348
|
+
"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
4349
|
"value": {
|
|
4250
4350
|
"type": "string"
|
|
4251
4351
|
}
|
|
4252
4352
|
},
|
|
4253
4353
|
{
|
|
4254
4354
|
"name": "state",
|
|
4255
|
-
"description": "The
|
|
4355
|
+
"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
4356
|
"default": "\"disabled\"",
|
|
4257
4357
|
"value": {
|
|
4258
4358
|
"type": [
|
|
@@ -4316,7 +4416,7 @@
|
|
|
4316
4416
|
},
|
|
4317
4417
|
{
|
|
4318
4418
|
"name": "effectiveUnits",
|
|
4319
|
-
"description": "Units which have been selected according to the magnitude of the elevations and distances
|
|
4419
|
+
"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
4420
|
"type": "EffectiveUnits"
|
|
4321
4421
|
},
|
|
4322
4422
|
{
|
|
@@ -4363,17 +4463,17 @@
|
|
|
4363
4463
|
},
|
|
4364
4464
|
{
|
|
4365
4465
|
"name": "icon",
|
|
4366
|
-
"description": "Icon which represents the
|
|
4466
|
+
"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
4467
|
"type": "string"
|
|
4368
4468
|
},
|
|
4369
4469
|
{
|
|
4370
4470
|
"name": "input",
|
|
4371
|
-
"description": "The input
|
|
4471
|
+
"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
4472
|
"type": "Graphic"
|
|
4373
4473
|
},
|
|
4374
4474
|
{
|
|
4375
4475
|
"name": "label",
|
|
4376
|
-
"description": "The
|
|
4476
|
+
"description": "The component's default label.",
|
|
4377
4477
|
"type": "string"
|
|
4378
4478
|
},
|
|
4379
4479
|
{
|
|
@@ -4382,7 +4482,7 @@
|
|
|
4382
4482
|
},
|
|
4383
4483
|
{
|
|
4384
4484
|
"name": "profiles",
|
|
4385
|
-
"description": "Collection of elevation profile lines which are to be generated and displayed in the
|
|
4485
|
+
"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
4486
|
"type": "Collection<ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineView>"
|
|
4387
4487
|
},
|
|
4388
4488
|
{
|
|
@@ -4392,11 +4492,12 @@
|
|
|
4392
4492
|
},
|
|
4393
4493
|
{
|
|
4394
4494
|
"name": "referenceElement",
|
|
4495
|
+
"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
4496
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4396
4497
|
},
|
|
4397
4498
|
{
|
|
4398
4499
|
"name": "state",
|
|
4399
|
-
"description": "The
|
|
4500
|
+
"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
4501
|
"type": "\"created\" | \"creating\" | \"disabled\" | \"ready\" | \"selected\" | \"selecting\""
|
|
4401
4502
|
},
|
|
4402
4503
|
{
|
|
@@ -4431,7 +4532,7 @@
|
|
|
4431
4532
|
},
|
|
4432
4533
|
{
|
|
4433
4534
|
"name": "arcgis-expand",
|
|
4434
|
-
"description": "The Expand component acts as a clickable button for
|
|
4535
|
+
"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
4536
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/",
|
|
4436
4537
|
"attributes": [
|
|
4437
4538
|
{
|
|
@@ -4468,8 +4569,7 @@
|
|
|
4468
4569
|
},
|
|
4469
4570
|
{
|
|
4470
4571
|
"name": "collapse-tooltip",
|
|
4471
|
-
"description": "Tooltip to display to indicate Expand widget can be collapsed.",
|
|
4472
|
-
"default": "\"Collapse\" (English locale)",
|
|
4572
|
+
"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
4573
|
"value": {
|
|
4474
4574
|
"type": "string"
|
|
4475
4575
|
}
|
|
@@ -4484,8 +4584,7 @@
|
|
|
4484
4584
|
},
|
|
4485
4585
|
{
|
|
4486
4586
|
"name": "expand-tooltip",
|
|
4487
|
-
"description": "Tooltip to display to indicate Expand widget can be expanded.",
|
|
4488
|
-
"default": "\"Expand\" (English locale)",
|
|
4587
|
+
"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
4588
|
"value": {
|
|
4490
4589
|
"type": "string"
|
|
4491
4590
|
}
|
|
@@ -4508,7 +4607,7 @@
|
|
|
4508
4607
|
},
|
|
4509
4608
|
{
|
|
4510
4609
|
"name": "focus-trap-enabled",
|
|
4511
|
-
"description": "**Deprecated**: since 4.33
|
|
4610
|
+
"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
4611
|
"default": "false",
|
|
4513
4612
|
"value": {
|
|
4514
4613
|
"type": "boolean"
|
|
@@ -4596,6 +4695,7 @@
|
|
|
4596
4695
|
},
|
|
4597
4696
|
{
|
|
4598
4697
|
"name": "reference-element",
|
|
4698
|
+
"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
4699
|
"value": {
|
|
4600
4700
|
"type": "string"
|
|
4601
4701
|
}
|
|
@@ -4632,7 +4732,7 @@
|
|
|
4632
4732
|
},
|
|
4633
4733
|
{
|
|
4634
4734
|
"name": "collapseTooltip",
|
|
4635
|
-
"description": "Tooltip to display to indicate Expand widget can be collapsed.",
|
|
4735
|
+
"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
4736
|
"type": "string"
|
|
4637
4737
|
},
|
|
4638
4738
|
{
|
|
@@ -4647,7 +4747,7 @@
|
|
|
4647
4747
|
},
|
|
4648
4748
|
{
|
|
4649
4749
|
"name": "expandTooltip",
|
|
4650
|
-
"description": "Tooltip to display to indicate Expand widget can be expanded.",
|
|
4750
|
+
"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
4751
|
"type": "string"
|
|
4652
4752
|
},
|
|
4653
4753
|
{
|
|
@@ -4691,6 +4791,7 @@
|
|
|
4691
4791
|
},
|
|
4692
4792
|
{
|
|
4693
4793
|
"name": "referenceElement",
|
|
4794
|
+
"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
4795
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4695
4796
|
}
|
|
4696
4797
|
],
|
|
@@ -4705,7 +4806,7 @@
|
|
|
4705
4806
|
},
|
|
4706
4807
|
{
|
|
4707
4808
|
"name": "arcgis-feature",
|
|
4708
|
-
"description": "
|
|
4809
|
+
"description": "### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `nextMedia(contentElementIndex: number): Promise<void>` - Paginates to the next [media](esri-popup-content-MediaContent.html) info.\n- `previousMedia(contentElementIndex: number): Promise<void>` - Paginates to the previous [media](esri-popup-content-MediaContent.html) info in the specified\n[media](esri-popup-content-MediaContent.html) content element.\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>` - Paginates to a specified [media](esri-popup-content-MediaContent.html) info object. For example,\nyou may have [media](esri-popup-content-MediaContent.html) content which contains\nmultiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos`\nyou wish to display.\n\n::: esri-md class=\"warning\"\nPrior to version 4.17, this method was named `goToMedia`.\n:::",
|
|
4709
4810
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature/",
|
|
4710
4811
|
"attributes": [
|
|
4711
4812
|
{
|
|
@@ -4716,9 +4817,17 @@
|
|
|
4716
4817
|
"type": "boolean"
|
|
4717
4818
|
}
|
|
4718
4819
|
},
|
|
4820
|
+
{
|
|
4821
|
+
"name": "chart-animation-disabled",
|
|
4822
|
+
"description": "Disables chart animation",
|
|
4823
|
+
"default": "false",
|
|
4824
|
+
"value": {
|
|
4825
|
+
"type": "boolean"
|
|
4826
|
+
}
|
|
4827
|
+
},
|
|
4719
4828
|
{
|
|
4720
4829
|
"name": "default-popup-template-enabled",
|
|
4721
|
-
"description": "Enables automatic creation of a popup template for layers that have popups enabled but no\npopupTemplate defined.",
|
|
4830
|
+
"description": "Enables automatic creation of a popup template for layers that have popups enabled but no\npopupTemplate defined. Automatic popup templates are supported for layers that\nsupport the `createPopupTemplate` method. (Supported for\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html)\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html), and\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html)).\n\n::: esri-md class=\"warning\"\nStarting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#dateFormat)\nrather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.\n:::",
|
|
4722
4831
|
"default": "false",
|
|
4723
4832
|
"value": {
|
|
4724
4833
|
"type": "boolean"
|
|
@@ -4726,55 +4835,62 @@
|
|
|
4726
4835
|
},
|
|
4727
4836
|
{
|
|
4728
4837
|
"name": "heading-level",
|
|
4729
|
-
"description": "Indicates the heading level to use for the [title](
|
|
4838
|
+
"description": "Indicates the heading level to use for the [title](#title) of the feature widget.\nBy default, the title is rendered\nas a level 2 heading (e.g. `<h2>Title of content</h2>`). Depending on the widget's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
|
|
4730
4839
|
"default": "2",
|
|
4731
4840
|
"value": {
|
|
4732
|
-
"type":
|
|
4841
|
+
"type": [
|
|
4842
|
+
"1",
|
|
4843
|
+
"2",
|
|
4844
|
+
"3",
|
|
4845
|
+
"4",
|
|
4846
|
+
"5",
|
|
4847
|
+
"6"
|
|
4848
|
+
]
|
|
4733
4849
|
}
|
|
4734
4850
|
},
|
|
4735
4851
|
{
|
|
4736
|
-
"name": "hide-content
|
|
4737
|
-
"description": "
|
|
4852
|
+
"name": "hide-attachments-content",
|
|
4853
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4738
4854
|
"default": "false",
|
|
4739
4855
|
"value": {
|
|
4740
4856
|
"type": "boolean"
|
|
4741
4857
|
}
|
|
4742
4858
|
},
|
|
4743
4859
|
{
|
|
4744
|
-
"name": "hide-content
|
|
4745
|
-
"description": "
|
|
4860
|
+
"name": "hide-content",
|
|
4861
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4746
4862
|
"default": "false",
|
|
4747
4863
|
"value": {
|
|
4748
4864
|
"type": "boolean"
|
|
4749
4865
|
}
|
|
4750
4866
|
},
|
|
4751
4867
|
{
|
|
4752
|
-
"name": "hide-content
|
|
4753
|
-
"description": "
|
|
4868
|
+
"name": "hide-custom-content",
|
|
4869
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4754
4870
|
"default": "false",
|
|
4755
4871
|
"value": {
|
|
4756
4872
|
"type": "boolean"
|
|
4757
4873
|
}
|
|
4758
4874
|
},
|
|
4759
4875
|
{
|
|
4760
|
-
"name": "hide-content
|
|
4761
|
-
"description": "
|
|
4876
|
+
"name": "hide-expression-content",
|
|
4877
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4762
4878
|
"default": "false",
|
|
4763
4879
|
"value": {
|
|
4764
4880
|
"type": "boolean"
|
|
4765
4881
|
}
|
|
4766
4882
|
},
|
|
4767
4883
|
{
|
|
4768
|
-
"name": "hide-content
|
|
4769
|
-
"description": "
|
|
4884
|
+
"name": "hide-fields-content",
|
|
4885
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4770
4886
|
"default": "false",
|
|
4771
4887
|
"value": {
|
|
4772
4888
|
"type": "boolean"
|
|
4773
4889
|
}
|
|
4774
4890
|
},
|
|
4775
4891
|
{
|
|
4776
|
-
"name": "hide-
|
|
4777
|
-
"description": "
|
|
4892
|
+
"name": "hide-heading",
|
|
4893
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4778
4894
|
"default": "false",
|
|
4779
4895
|
"value": {
|
|
4780
4896
|
"type": "boolean"
|
|
@@ -4782,15 +4898,23 @@
|
|
|
4782
4898
|
},
|
|
4783
4899
|
{
|
|
4784
4900
|
"name": "hide-last-edited-info",
|
|
4785
|
-
"description": "
|
|
4901
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4786
4902
|
"default": "false",
|
|
4787
4903
|
"value": {
|
|
4788
4904
|
"type": "boolean"
|
|
4789
4905
|
}
|
|
4790
4906
|
},
|
|
4791
4907
|
{
|
|
4792
|
-
"name": "hide-
|
|
4793
|
-
"description": "
|
|
4908
|
+
"name": "hide-media-content",
|
|
4909
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4910
|
+
"default": "false",
|
|
4911
|
+
"value": {
|
|
4912
|
+
"type": "boolean"
|
|
4913
|
+
}
|
|
4914
|
+
},
|
|
4915
|
+
{
|
|
4916
|
+
"name": "hide-text-content",
|
|
4917
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4794
4918
|
"default": "false",
|
|
4795
4919
|
"value": {
|
|
4796
4920
|
"type": "boolean"
|
|
@@ -4798,22 +4922,22 @@
|
|
|
4798
4922
|
},
|
|
4799
4923
|
{
|
|
4800
4924
|
"name": "icon",
|
|
4801
|
-
"description": "Icon which represents the
|
|
4802
|
-
"default": "\"
|
|
4925
|
+
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
4926
|
+
"default": "\"icon\"",
|
|
4803
4927
|
"value": {
|
|
4804
4928
|
"type": "string"
|
|
4805
4929
|
}
|
|
4806
4930
|
},
|
|
4807
4931
|
{
|
|
4808
4932
|
"name": "label",
|
|
4809
|
-
"description": "The
|
|
4933
|
+
"description": "The component's default label.",
|
|
4810
4934
|
"value": {
|
|
4811
4935
|
"type": "string"
|
|
4812
4936
|
}
|
|
4813
4937
|
},
|
|
4814
4938
|
{
|
|
4815
4939
|
"name": "position",
|
|
4816
|
-
"default": "\"
|
|
4940
|
+
"default": "\"top-left\"",
|
|
4817
4941
|
"value": {
|
|
4818
4942
|
"type": [
|
|
4819
4943
|
"\"bottom-leading\"",
|
|
@@ -4834,6 +4958,22 @@
|
|
|
4834
4958
|
"type": "string"
|
|
4835
4959
|
}
|
|
4836
4960
|
},
|
|
4961
|
+
{
|
|
4962
|
+
"name": "show-relationship-content",
|
|
4963
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4964
|
+
"default": "false",
|
|
4965
|
+
"value": {
|
|
4966
|
+
"type": "boolean"
|
|
4967
|
+
}
|
|
4968
|
+
},
|
|
4969
|
+
{
|
|
4970
|
+
"name": "show-utility-network-content",
|
|
4971
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4972
|
+
"default": "false",
|
|
4973
|
+
"value": {
|
|
4974
|
+
"type": "boolean"
|
|
4975
|
+
}
|
|
4976
|
+
},
|
|
4837
4977
|
{
|
|
4838
4978
|
"name": "state",
|
|
4839
4979
|
"description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#state)",
|
|
@@ -4849,7 +4989,7 @@
|
|
|
4849
4989
|
},
|
|
4850
4990
|
{
|
|
4851
4991
|
"name": "time-zone",
|
|
4852
|
-
"description": "Dates and times displayed in the widget will be displayed in this time zone
|
|
4992
|
+
"description": "Dates and times displayed in the widget will be displayed in this time zone. By default this time zone is\ninherited from [MapView.timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone). When a MapView is not associated with the widget\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\nsystem | Dates and times will be displayed in the timezone of the device or browser.\nunknown | Dates and time are not adjusted for any timezone.\nSpecified IANA timezone | Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
|
|
4853
4993
|
"value": {
|
|
4854
4994
|
"type": "string"
|
|
4855
4995
|
}
|
|
@@ -4874,9 +5014,14 @@
|
|
|
4874
5014
|
"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-feature/#destroy) method when you are done to\nprevent memory leaks.",
|
|
4875
5015
|
"type": "boolean"
|
|
4876
5016
|
},
|
|
5017
|
+
{
|
|
5018
|
+
"name": "chartAnimationDisabled",
|
|
5019
|
+
"description": "Disables chart animation",
|
|
5020
|
+
"type": "boolean"
|
|
5021
|
+
},
|
|
4877
5022
|
{
|
|
4878
5023
|
"name": "defaultPopupTemplateEnabled",
|
|
4879
|
-
"description": "Enables automatic creation of a popup template for layers that have popups enabled but no\npopupTemplate defined.",
|
|
5024
|
+
"description": "Enables automatic creation of a popup template for layers that have popups enabled but no\npopupTemplate defined. Automatic popup templates are supported for layers that\nsupport the `createPopupTemplate` method. (Supported for\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html)\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html), and\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html)).\n\n::: esri-md class=\"warning\"\nStarting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#dateFormat)\nrather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.\n:::",
|
|
4880
5025
|
"type": "boolean"
|
|
4881
5026
|
},
|
|
4882
5027
|
{
|
|
@@ -4884,70 +5029,86 @@
|
|
|
4884
5029
|
"description": "The [Graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) used to represent the feature.",
|
|
4885
5030
|
"type": "Graphic"
|
|
4886
5031
|
},
|
|
5032
|
+
{
|
|
5033
|
+
"name": "heading",
|
|
5034
|
+
"description": "The title for the feature. You can disable this via the [visibleElements](#visibleElements) property.",
|
|
5035
|
+
"type": "string"
|
|
5036
|
+
},
|
|
4887
5037
|
{
|
|
4888
5038
|
"name": "headingLevel",
|
|
4889
|
-
"description": "Indicates the heading level to use for the [title](
|
|
4890
|
-
"type": "
|
|
5039
|
+
"description": "Indicates the heading level to use for the [title](#title) of the feature widget.\nBy default, the title is rendered\nas a level 2 heading (e.g. `<h2>Title of content</h2>`). Depending on the widget's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.",
|
|
5040
|
+
"type": "1 | 2 | 3 | 4 | 5 | 6"
|
|
4891
5041
|
},
|
|
4892
5042
|
{
|
|
4893
|
-
"name": "
|
|
4894
|
-
"description": "
|
|
5043
|
+
"name": "hideAttachmentsContent",
|
|
5044
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4895
5045
|
"type": "boolean"
|
|
4896
5046
|
},
|
|
4897
5047
|
{
|
|
4898
|
-
"name": "
|
|
4899
|
-
"description": "
|
|
5048
|
+
"name": "hideContent",
|
|
5049
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4900
5050
|
"type": "boolean"
|
|
4901
5051
|
},
|
|
4902
5052
|
{
|
|
4903
|
-
"name": "
|
|
4904
|
-
"description": "
|
|
5053
|
+
"name": "hideCustomContent",
|
|
5054
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4905
5055
|
"type": "boolean"
|
|
4906
5056
|
},
|
|
4907
5057
|
{
|
|
4908
|
-
"name": "
|
|
4909
|
-
"description": "
|
|
5058
|
+
"name": "hideExpressionContent",
|
|
5059
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4910
5060
|
"type": "boolean"
|
|
4911
5061
|
},
|
|
4912
5062
|
{
|
|
4913
|
-
"name": "
|
|
4914
|
-
"description": "
|
|
5063
|
+
"name": "hideFieldsContent",
|
|
5064
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
5065
|
+
"type": "boolean"
|
|
5066
|
+
},
|
|
5067
|
+
{
|
|
5068
|
+
"name": "hideHeading",
|
|
5069
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4915
5070
|
"type": "boolean"
|
|
4916
5071
|
},
|
|
4917
5072
|
{
|
|
4918
5073
|
"name": "hideLastEditedInfo",
|
|
4919
|
-
"description": "
|
|
5074
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4920
5075
|
"type": "boolean"
|
|
4921
5076
|
},
|
|
4922
5077
|
{
|
|
4923
|
-
"name": "
|
|
5078
|
+
"name": "hideMediaContent",
|
|
5079
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4924
5080
|
"type": "boolean"
|
|
4925
5081
|
},
|
|
4926
5082
|
{
|
|
4927
|
-
"name": "
|
|
4928
|
-
"description": "
|
|
5083
|
+
"name": "hideTextContent",
|
|
5084
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
4929
5085
|
"type": "boolean"
|
|
4930
5086
|
},
|
|
4931
5087
|
{
|
|
4932
5088
|
"name": "icon",
|
|
4933
|
-
"description": "Icon which represents the
|
|
5089
|
+
"description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).",
|
|
4934
5090
|
"type": "string"
|
|
4935
5091
|
},
|
|
4936
5092
|
{
|
|
4937
5093
|
"name": "label",
|
|
4938
|
-
"description": "The
|
|
5094
|
+
"description": "The component's default label.",
|
|
4939
5095
|
"type": "string"
|
|
4940
5096
|
},
|
|
4941
5097
|
{
|
|
4942
5098
|
"name": "location",
|
|
4943
|
-
"description": "The location of the
|
|
5099
|
+
"description": "The [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) representing the location of the\n[MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html) interaction used to trigger the opening of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature-FeatureViewModel.html#location)",
|
|
4944
5100
|
"type": "Point"
|
|
4945
5101
|
},
|
|
4946
5102
|
{
|
|
4947
5103
|
"name": "map",
|
|
4948
|
-
"description": "A map is required when the input [graphic](
|
|
5104
|
+
"description": "A map is required when the input [graphic](#graphic) has a popupTemplate that contains [Arcade](https://developers.arcgis.com/arcade) expressions in [ExpressionInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-ExpressionInfo.html) or [ExpressionContent](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-ExpressionContent.html) that may use the `$map` profile variable to access data from layers within a map. Without a map, expressions that use `$map` will throw an error.\n\nAlternatively, the [view](#view) property can be used to provide the map instance for this property.",
|
|
4949
5105
|
"type": "Map"
|
|
4950
5106
|
},
|
|
5107
|
+
{
|
|
5108
|
+
"name": "messageOverrides",
|
|
5109
|
+
"description": "Overwrite localized strings for this component",
|
|
5110
|
+
"type": "Record<string, unknown>"
|
|
5111
|
+
},
|
|
4951
5112
|
{
|
|
4952
5113
|
"name": "position",
|
|
4953
5114
|
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
|
|
@@ -4956,9 +5117,19 @@
|
|
|
4956
5117
|
"name": "referenceElement",
|
|
4957
5118
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
4958
5119
|
},
|
|
5120
|
+
{
|
|
5121
|
+
"name": "showRelationshipContent",
|
|
5122
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
5123
|
+
"type": "boolean"
|
|
5124
|
+
},
|
|
5125
|
+
{
|
|
5126
|
+
"name": "showUtilityNetworkContent",
|
|
5127
|
+
"description": "This property provides the ability to turn individual elements of the component's display on/off.",
|
|
5128
|
+
"type": "boolean"
|
|
5129
|
+
},
|
|
4959
5130
|
{
|
|
4960
5131
|
"name": "spatialReference",
|
|
4961
|
-
"description": "The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.",
|
|
5132
|
+
"description": "The spatial reference used for [Arcade](https://developers.arcgis.com/arcade) operations.\nThis property should be set if the Feature widget executes Arcade expressions that contain [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/).",
|
|
4962
5133
|
"type": "SpatialReference"
|
|
4963
5134
|
},
|
|
4964
5135
|
{
|
|
@@ -4968,7 +5139,7 @@
|
|
|
4968
5139
|
},
|
|
4969
5140
|
{
|
|
4970
5141
|
"name": "timeZone",
|
|
4971
|
-
"description": "Dates and times displayed in the widget will be displayed in this time zone
|
|
5142
|
+
"description": "Dates and times displayed in the widget will be displayed in this time zone. By default this time zone is\ninherited from [MapView.timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone). When a MapView is not associated with the widget\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\nsystem | Dates and times will be displayed in the timezone of the device or browser.\nunknown | Dates and time are not adjusted for any timezone.\nSpecified IANA timezone | Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
|
|
4972
5143
|
"type": "string"
|
|
4973
5144
|
}
|
|
4974
5145
|
],
|
|
@@ -5052,6 +5223,7 @@
|
|
|
5052
5223
|
},
|
|
5053
5224
|
{
|
|
5054
5225
|
"name": "reference-element",
|
|
5226
|
+
"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
5227
|
"value": {
|
|
5056
5228
|
"type": "string"
|
|
5057
5229
|
}
|
|
@@ -5136,7 +5308,7 @@
|
|
|
5136
5308
|
{
|
|
5137
5309
|
"name": "layer",
|
|
5138
5310
|
"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"
|
|
5311
|
+
"type": "FeatureLayer | GeoJSONLayer | KnowledgeGraphSublayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer"
|
|
5140
5312
|
},
|
|
5141
5313
|
{
|
|
5142
5314
|
"name": "position",
|
|
@@ -5144,6 +5316,7 @@
|
|
|
5144
5316
|
},
|
|
5145
5317
|
{
|
|
5146
5318
|
"name": "referenceElement",
|
|
5319
|
+
"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
5320
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
5148
5321
|
},
|
|
5149
5322
|
{
|
|
@@ -5537,6 +5710,7 @@
|
|
|
5537
5710
|
},
|
|
5538
5711
|
{
|
|
5539
5712
|
"name": "reference-element",
|
|
5713
|
+
"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
5714
|
"value": {
|
|
5541
5715
|
"type": "string"
|
|
5542
5716
|
}
|
|
@@ -5998,6 +6172,7 @@
|
|
|
5998
6172
|
},
|
|
5999
6173
|
{
|
|
6000
6174
|
"name": "referenceElement",
|
|
6175
|
+
"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
6176
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6002
6177
|
},
|
|
6003
6178
|
{
|
|
@@ -6072,7 +6247,7 @@
|
|
|
6072
6247
|
},
|
|
6073
6248
|
{
|
|
6074
6249
|
"name": "supportsResizeAttachments",
|
|
6075
|
-
"description": "
|
|
6250
|
+
"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
6251
|
"type": "boolean"
|
|
6077
6252
|
},
|
|
6078
6253
|
{
|
|
@@ -6244,6 +6419,7 @@
|
|
|
6244
6419
|
},
|
|
6245
6420
|
{
|
|
6246
6421
|
"name": "reference-element",
|
|
6422
|
+
"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
6423
|
"value": {
|
|
6248
6424
|
"type": "string"
|
|
6249
6425
|
}
|
|
@@ -6344,6 +6520,7 @@
|
|
|
6344
6520
|
},
|
|
6345
6521
|
{
|
|
6346
6522
|
"name": "referenceElement",
|
|
6523
|
+
"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
6524
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6348
6525
|
},
|
|
6349
6526
|
{
|
|
@@ -6558,6 +6735,7 @@
|
|
|
6558
6735
|
},
|
|
6559
6736
|
{
|
|
6560
6737
|
"name": "reference-element",
|
|
6738
|
+
"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
6739
|
"value": {
|
|
6562
6740
|
"type": "string"
|
|
6563
6741
|
}
|
|
@@ -6760,6 +6938,7 @@
|
|
|
6760
6938
|
},
|
|
6761
6939
|
{
|
|
6762
6940
|
"name": "referenceElement",
|
|
6941
|
+
"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
6942
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6764
6943
|
},
|
|
6765
6944
|
{
|
|
@@ -6893,6 +7072,7 @@
|
|
|
6893
7072
|
},
|
|
6894
7073
|
{
|
|
6895
7074
|
"name": "reference-element",
|
|
7075
|
+
"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
7076
|
"value": {
|
|
6897
7077
|
"type": "string"
|
|
6898
7078
|
}
|
|
@@ -6955,6 +7135,7 @@
|
|
|
6955
7135
|
},
|
|
6956
7136
|
{
|
|
6957
7137
|
"name": "referenceElement",
|
|
7138
|
+
"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
7139
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
6959
7140
|
},
|
|
6960
7141
|
{
|
|
@@ -6974,9 +7155,16 @@
|
|
|
6974
7155
|
},
|
|
6975
7156
|
{
|
|
6976
7157
|
"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.",
|
|
7158
|
+
"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
7159
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-fullscreen/",
|
|
6979
7160
|
"attributes": [
|
|
7161
|
+
{
|
|
7162
|
+
"name": "element",
|
|
7163
|
+
"description": "The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode.",
|
|
7164
|
+
"value": {
|
|
7165
|
+
"type": "string"
|
|
7166
|
+
}
|
|
7167
|
+
},
|
|
6980
7168
|
{
|
|
6981
7169
|
"name": "label",
|
|
6982
7170
|
"description": "The component's default label.",
|
|
@@ -7003,6 +7191,7 @@
|
|
|
7003
7191
|
},
|
|
7004
7192
|
{
|
|
7005
7193
|
"name": "reference-element",
|
|
7194
|
+
"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
7195
|
"value": {
|
|
7007
7196
|
"type": "string"
|
|
7008
7197
|
}
|
|
@@ -7036,7 +7225,7 @@
|
|
|
7036
7225
|
{
|
|
7037
7226
|
"name": "element",
|
|
7038
7227
|
"description": "The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode.",
|
|
7039
|
-
"type": "
|
|
7228
|
+
"type": "Element | string"
|
|
7040
7229
|
},
|
|
7041
7230
|
{
|
|
7042
7231
|
"name": "label",
|
|
@@ -7045,7 +7234,7 @@
|
|
|
7045
7234
|
},
|
|
7046
7235
|
{
|
|
7047
7236
|
"name": "messageOverrides",
|
|
7048
|
-
"description": "Replace localized message strings with your own strings
|
|
7237
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7049
7238
|
"type": "Record<string, unknown>"
|
|
7050
7239
|
},
|
|
7051
7240
|
{
|
|
@@ -7054,6 +7243,7 @@
|
|
|
7054
7243
|
},
|
|
7055
7244
|
{
|
|
7056
7245
|
"name": "referenceElement",
|
|
7246
|
+
"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
7247
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7058
7248
|
},
|
|
7059
7249
|
{
|
|
@@ -7255,6 +7445,7 @@
|
|
|
7255
7445
|
},
|
|
7256
7446
|
{
|
|
7257
7447
|
"name": "reference-element",
|
|
7448
|
+
"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
7449
|
"value": {
|
|
7259
7450
|
"type": "string"
|
|
7260
7451
|
}
|
|
@@ -7443,7 +7634,7 @@
|
|
|
7443
7634
|
},
|
|
7444
7635
|
{
|
|
7445
7636
|
"name": "messageOverrides",
|
|
7446
|
-
"description": "Replace localized message strings with your own strings
|
|
7637
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7447
7638
|
"type": "Record<string, unknown>"
|
|
7448
7639
|
},
|
|
7449
7640
|
{
|
|
@@ -7457,6 +7648,7 @@
|
|
|
7457
7648
|
},
|
|
7458
7649
|
{
|
|
7459
7650
|
"name": "referenceElement",
|
|
7651
|
+
"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
7652
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7461
7653
|
},
|
|
7462
7654
|
{
|
|
@@ -7617,6 +7809,7 @@
|
|
|
7617
7809
|
},
|
|
7618
7810
|
{
|
|
7619
7811
|
"name": "reference-element",
|
|
7812
|
+
"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
7813
|
"value": {
|
|
7621
7814
|
"type": "string"
|
|
7622
7815
|
}
|
|
@@ -7742,6 +7935,7 @@
|
|
|
7742
7935
|
},
|
|
7743
7936
|
{
|
|
7744
7937
|
"name": "referenceElement",
|
|
7938
|
+
"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
7939
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7746
7940
|
},
|
|
7747
7941
|
{
|
|
@@ -7781,7 +7975,7 @@
|
|
|
7781
7975
|
},
|
|
7782
7976
|
{
|
|
7783
7977
|
"name": "arcgis-home",
|
|
7784
|
-
"description": "The Home component is a button that
|
|
7978
|
+
"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
7979
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-home/",
|
|
7786
7980
|
"attributes": [
|
|
7787
7981
|
{
|
|
@@ -7826,6 +8020,7 @@
|
|
|
7826
8020
|
},
|
|
7827
8021
|
{
|
|
7828
8022
|
"name": "reference-element",
|
|
8023
|
+
"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
8024
|
"value": {
|
|
7830
8025
|
"type": "string"
|
|
7831
8026
|
}
|
|
@@ -7884,7 +8079,7 @@
|
|
|
7884
8079
|
},
|
|
7885
8080
|
{
|
|
7886
8081
|
"name": "messageOverrides",
|
|
7887
|
-
"description": "Replace localized message strings with your own strings
|
|
8082
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
7888
8083
|
"type": "Record<string, unknown>"
|
|
7889
8084
|
},
|
|
7890
8085
|
{
|
|
@@ -7893,6 +8088,7 @@
|
|
|
7893
8088
|
},
|
|
7894
8089
|
{
|
|
7895
8090
|
"name": "referenceElement",
|
|
8091
|
+
"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
8092
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
7897
8093
|
},
|
|
7898
8094
|
{
|
|
@@ -7902,7 +8098,7 @@
|
|
|
7902
8098
|
},
|
|
7903
8099
|
{
|
|
7904
8100
|
"name": "viewpoint",
|
|
7905
|
-
"description": "The esri
|
|
8101
|
+
"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
8102
|
"type": "Viewpoint"
|
|
7907
8103
|
}
|
|
7908
8104
|
],
|
|
@@ -8057,6 +8253,7 @@
|
|
|
8057
8253
|
},
|
|
8058
8254
|
{
|
|
8059
8255
|
"name": "reference-element",
|
|
8256
|
+
"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
8257
|
"value": {
|
|
8061
8258
|
"type": "string"
|
|
8062
8259
|
}
|
|
@@ -8272,6 +8469,7 @@
|
|
|
8272
8469
|
},
|
|
8273
8470
|
{
|
|
8274
8471
|
"name": "referenceElement",
|
|
8472
|
+
"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
8473
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
8276
8474
|
},
|
|
8277
8475
|
{
|
|
@@ -8427,6 +8625,7 @@
|
|
|
8427
8625
|
},
|
|
8428
8626
|
{
|
|
8429
8627
|
"name": "reference-element",
|
|
8628
|
+
"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
8629
|
"value": {
|
|
8431
8630
|
"type": "string"
|
|
8432
8631
|
}
|
|
@@ -8524,6 +8723,7 @@
|
|
|
8524
8723
|
},
|
|
8525
8724
|
{
|
|
8526
8725
|
"name": "referenceElement",
|
|
8726
|
+
"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
8727
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
8528
8728
|
},
|
|
8529
8729
|
{
|
|
@@ -8558,7 +8758,7 @@
|
|
|
8558
8758
|
},
|
|
8559
8759
|
{
|
|
8560
8760
|
"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
|
|
8761
|
+
"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
8762
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-line-of-sight/",
|
|
8563
8763
|
"attributes": [
|
|
8564
8764
|
{
|
|
@@ -8603,9 +8803,22 @@
|
|
|
8603
8803
|
},
|
|
8604
8804
|
{
|
|
8605
8805
|
"name": "reference-element",
|
|
8806
|
+
"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
8807
|
"value": {
|
|
8607
8808
|
"type": "string"
|
|
8608
8809
|
}
|
|
8810
|
+
},
|
|
8811
|
+
{
|
|
8812
|
+
"name": "state",
|
|
8813
|
+
"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",
|
|
8814
|
+
"value": {
|
|
8815
|
+
"type": [
|
|
8816
|
+
"\"created\"",
|
|
8817
|
+
"\"creating\"",
|
|
8818
|
+
"\"disabled\"",
|
|
8819
|
+
"\"ready\""
|
|
8820
|
+
]
|
|
8821
|
+
}
|
|
8609
8822
|
}
|
|
8610
8823
|
],
|
|
8611
8824
|
"events": [
|
|
@@ -8624,7 +8837,7 @@
|
|
|
8624
8837
|
"properties": [
|
|
8625
8838
|
{
|
|
8626
8839
|
"name": "analysis",
|
|
8627
|
-
"description": "The [
|
|
8840
|
+
"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
8841
|
"type": "LineOfSightAnalysis"
|
|
8629
8842
|
},
|
|
8630
8843
|
{
|
|
@@ -8644,7 +8857,7 @@
|
|
|
8644
8857
|
},
|
|
8645
8858
|
{
|
|
8646
8859
|
"name": "messageOverrides",
|
|
8647
|
-
"description": "Replace localized message strings with your own strings
|
|
8860
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
8648
8861
|
"type": "Record<string, unknown>"
|
|
8649
8862
|
},
|
|
8650
8863
|
{
|
|
@@ -8653,6 +8866,7 @@
|
|
|
8653
8866
|
},
|
|
8654
8867
|
{
|
|
8655
8868
|
"name": "referenceElement",
|
|
8869
|
+
"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
8870
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
8657
8871
|
},
|
|
8658
8872
|
{
|
|
@@ -8677,7 +8891,7 @@
|
|
|
8677
8891
|
},
|
|
8678
8892
|
{
|
|
8679
8893
|
"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
|
|
8894
|
+
"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
8895
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/",
|
|
8682
8896
|
"attributes": [
|
|
8683
8897
|
{
|
|
@@ -8933,7 +9147,7 @@
|
|
|
8933
9147
|
},
|
|
8934
9148
|
{
|
|
8935
9149
|
"name": "graphics",
|
|
8936
|
-
"description": "Allows for adding graphics directly to the default graphics in the View
|
|
9150
|
+
"description": "Allows for adding graphics directly to the default graphics in the View.",
|
|
8937
9151
|
"type": "Collection<Graphic>"
|
|
8938
9152
|
},
|
|
8939
9153
|
{
|
|
@@ -9240,6 +9454,7 @@
|
|
|
9240
9454
|
},
|
|
9241
9455
|
{
|
|
9242
9456
|
"name": "reference-element",
|
|
9457
|
+
"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
9458
|
"value": {
|
|
9244
9459
|
"type": "string"
|
|
9245
9460
|
}
|
|
@@ -9308,7 +9523,7 @@
|
|
|
9308
9523
|
},
|
|
9309
9524
|
{
|
|
9310
9525
|
"name": "messageOverrides",
|
|
9311
|
-
"description": "Replace localized message strings with your own strings
|
|
9526
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
9312
9527
|
"type": "Record<string, unknown>"
|
|
9313
9528
|
},
|
|
9314
9529
|
{
|
|
@@ -9322,6 +9537,7 @@
|
|
|
9322
9537
|
},
|
|
9323
9538
|
{
|
|
9324
9539
|
"name": "referenceElement",
|
|
9540
|
+
"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
9541
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
9326
9542
|
},
|
|
9327
9543
|
{
|
|
@@ -9351,7 +9567,7 @@
|
|
|
9351
9567
|
},
|
|
9352
9568
|
{
|
|
9353
9569
|
"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>`",
|
|
9570
|
+
"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
9571
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-locate/",
|
|
9356
9572
|
"attributes": [
|
|
9357
9573
|
{
|
|
@@ -9410,6 +9626,7 @@
|
|
|
9410
9626
|
},
|
|
9411
9627
|
{
|
|
9412
9628
|
"name": "reference-element",
|
|
9629
|
+
"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
9630
|
"value": {
|
|
9414
9631
|
"type": "string"
|
|
9415
9632
|
}
|
|
@@ -9492,7 +9709,7 @@
|
|
|
9492
9709
|
},
|
|
9493
9710
|
{
|
|
9494
9711
|
"name": "messageOverrides",
|
|
9495
|
-
"description": "Replace localized message strings with your own strings
|
|
9712
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
9496
9713
|
"type": "Record<string, unknown>"
|
|
9497
9714
|
},
|
|
9498
9715
|
{
|
|
@@ -9505,6 +9722,7 @@
|
|
|
9505
9722
|
},
|
|
9506
9723
|
{
|
|
9507
9724
|
"name": "referenceElement",
|
|
9725
|
+
"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
9726
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
9509
9727
|
},
|
|
9510
9728
|
{
|
|
@@ -9542,7 +9760,7 @@
|
|
|
9542
9760
|
},
|
|
9543
9761
|
{
|
|
9544
9762
|
"name": "arcgis-map",
|
|
9545
|
-
"description": "The ArcGIS Map
|
|
9763
|
+
"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
9764
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/",
|
|
9547
9765
|
"attributes": [
|
|
9548
9766
|
{
|
|
@@ -9815,7 +10033,7 @@
|
|
|
9815
10033
|
},
|
|
9816
10034
|
{
|
|
9817
10035
|
"name": "graphics",
|
|
9818
|
-
"description": "Allows for adding graphics directly to the default graphics in the View
|
|
10036
|
+
"description": "Allows for adding graphics directly to the default graphics in the View.",
|
|
9819
10037
|
"type": "Collection<Graphic>"
|
|
9820
10038
|
},
|
|
9821
10039
|
{
|
|
@@ -10172,6 +10390,7 @@
|
|
|
10172
10390
|
},
|
|
10173
10391
|
{
|
|
10174
10392
|
"name": "reference-element",
|
|
10393
|
+
"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
10394
|
"value": {
|
|
10176
10395
|
"type": "string"
|
|
10177
10396
|
}
|
|
@@ -10245,6 +10464,7 @@
|
|
|
10245
10464
|
},
|
|
10246
10465
|
{
|
|
10247
10466
|
"name": "referenceElement",
|
|
10467
|
+
"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
10468
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10249
10469
|
},
|
|
10250
10470
|
{
|
|
@@ -10269,7 +10489,7 @@
|
|
|
10269
10489
|
},
|
|
10270
10490
|
{
|
|
10271
10491
|
"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\
|
|
10492
|
+
"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
10493
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-navigation-toggle/",
|
|
10274
10494
|
"attributes": [
|
|
10275
10495
|
{
|
|
@@ -10299,7 +10519,7 @@
|
|
|
10299
10519
|
},
|
|
10300
10520
|
{
|
|
10301
10521
|
"name": "navigation-mode",
|
|
10302
|
-
"description": "The navigation mode of the view.
|
|
10522
|
+
"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
10523
|
"default": "\"pan\"",
|
|
10304
10524
|
"value": {
|
|
10305
10525
|
"type": [
|
|
@@ -10327,6 +10547,7 @@
|
|
|
10327
10547
|
},
|
|
10328
10548
|
{
|
|
10329
10549
|
"name": "reference-element",
|
|
10550
|
+
"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
10551
|
"value": {
|
|
10331
10552
|
"type": "string"
|
|
10332
10553
|
}
|
|
@@ -10334,7 +10555,6 @@
|
|
|
10334
10555
|
{
|
|
10335
10556
|
"name": "state",
|
|
10336
10557
|
"description": "The current state of the component.",
|
|
10337
|
-
"default": "\"disabled\"",
|
|
10338
10558
|
"value": {
|
|
10339
10559
|
"type": [
|
|
10340
10560
|
"\"disabled\"",
|
|
@@ -10374,12 +10594,12 @@
|
|
|
10374
10594
|
},
|
|
10375
10595
|
{
|
|
10376
10596
|
"name": "messageOverrides",
|
|
10377
|
-
"description": "Replace localized message strings with your own strings
|
|
10597
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
10378
10598
|
"type": "Record<string, unknown>"
|
|
10379
10599
|
},
|
|
10380
10600
|
{
|
|
10381
10601
|
"name": "navigationMode",
|
|
10382
|
-
"description": "The navigation mode of the view.
|
|
10602
|
+
"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
10603
|
"type": "\"pan\" | \"rotate\""
|
|
10384
10604
|
},
|
|
10385
10605
|
{
|
|
@@ -10388,6 +10608,7 @@
|
|
|
10388
10608
|
},
|
|
10389
10609
|
{
|
|
10390
10610
|
"name": "referenceElement",
|
|
10611
|
+
"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
10612
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10392
10613
|
},
|
|
10393
10614
|
{
|
|
@@ -10543,6 +10764,7 @@
|
|
|
10543
10764
|
},
|
|
10544
10765
|
{
|
|
10545
10766
|
"name": "reference-element",
|
|
10767
|
+
"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
10768
|
"value": {
|
|
10547
10769
|
"type": "string"
|
|
10548
10770
|
}
|
|
@@ -10647,6 +10869,7 @@
|
|
|
10647
10869
|
},
|
|
10648
10870
|
{
|
|
10649
10871
|
"name": "referenceElement",
|
|
10872
|
+
"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
10873
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10651
10874
|
},
|
|
10652
10875
|
{
|
|
@@ -10693,6 +10916,7 @@
|
|
|
10693
10916
|
},
|
|
10694
10917
|
{
|
|
10695
10918
|
"name": "reference-element",
|
|
10919
|
+
"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
10920
|
"value": {
|
|
10697
10921
|
"type": "string"
|
|
10698
10922
|
}
|
|
@@ -10713,6 +10937,7 @@
|
|
|
10713
10937
|
},
|
|
10714
10938
|
{
|
|
10715
10939
|
"name": "referenceElement",
|
|
10940
|
+
"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
10941
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10717
10942
|
}
|
|
10718
10943
|
],
|
|
@@ -10727,7 +10952,7 @@
|
|
|
10727
10952
|
},
|
|
10728
10953
|
{
|
|
10729
10954
|
"name": "arcgis-print",
|
|
10730
|
-
"description": "The Print
|
|
10955
|
+
"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
10956
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-print/",
|
|
10732
10957
|
"attributes": [
|
|
10733
10958
|
{
|
|
@@ -10740,6 +10965,7 @@
|
|
|
10740
10965
|
},
|
|
10741
10966
|
{
|
|
10742
10967
|
"name": "allowed-formats-for-saving",
|
|
10968
|
+
"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
10969
|
"value": {
|
|
10744
10970
|
"type": "\"all\""
|
|
10745
10971
|
}
|
|
@@ -10785,7 +11011,7 @@
|
|
|
10785
11011
|
},
|
|
10786
11012
|
{
|
|
10787
11013
|
"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
|
|
11014
|
+
"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
11015
|
"default": "3",
|
|
10790
11016
|
"value": {
|
|
10791
11017
|
"type": [
|
|
@@ -10800,6 +11026,7 @@
|
|
|
10800
11026
|
},
|
|
10801
11027
|
{
|
|
10802
11028
|
"name": "hide-header",
|
|
11029
|
+
"description": "Indicates whether the component's header is hidden.",
|
|
10803
11030
|
"default": "false",
|
|
10804
11031
|
"value": {
|
|
10805
11032
|
"type": "boolean"
|
|
@@ -10822,6 +11049,7 @@
|
|
|
10822
11049
|
},
|
|
10823
11050
|
{
|
|
10824
11051
|
"name": "position",
|
|
11052
|
+
"description": "The UI position of a component.",
|
|
10825
11053
|
"default": "\"top-left\"",
|
|
10826
11054
|
"value": {
|
|
10827
11055
|
"type": [
|
|
@@ -10839,20 +11067,21 @@
|
|
|
10839
11067
|
},
|
|
10840
11068
|
{
|
|
10841
11069
|
"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,
|
|
11070
|
+
"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
11071
|
"value": {
|
|
10844
11072
|
"type": "string"
|
|
10845
11073
|
}
|
|
10846
11074
|
},
|
|
10847
11075
|
{
|
|
10848
11076
|
"name": "reference-element",
|
|
11077
|
+
"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
11078
|
"value": {
|
|
10850
11079
|
"type": "string"
|
|
10851
11080
|
}
|
|
10852
11081
|
},
|
|
10853
11082
|
{
|
|
10854
11083
|
"name": "show-print-area-enabled",
|
|
10855
|
-
"description": "The initial state of the print area toggle in the Print
|
|
11084
|
+
"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
11085
|
"default": "false",
|
|
10857
11086
|
"value": {
|
|
10858
11087
|
"type": "boolean"
|
|
@@ -10860,7 +11089,7 @@
|
|
|
10860
11089
|
},
|
|
10861
11090
|
{
|
|
10862
11091
|
"name": "state",
|
|
10863
|
-
"description": "The
|
|
11092
|
+
"description": "The state of the Print component.",
|
|
10864
11093
|
"default": "\"disabled\"",
|
|
10865
11094
|
"value": {
|
|
10866
11095
|
"type": [
|
|
@@ -10875,7 +11104,8 @@
|
|
|
10875
11104
|
"events": [
|
|
10876
11105
|
{
|
|
10877
11106
|
"name": "arcgisComplete",
|
|
10878
|
-
"type": "
|
|
11107
|
+
"type": "PrintCompleteEvent",
|
|
11108
|
+
"description": "Emitted when the component is complete."
|
|
10879
11109
|
},
|
|
10880
11110
|
{
|
|
10881
11111
|
"name": "arcgisPropertyChange",
|
|
@@ -10889,7 +11119,8 @@
|
|
|
10889
11119
|
},
|
|
10890
11120
|
{
|
|
10891
11121
|
"name": "arcgisSubmit",
|
|
10892
|
-
"type": "
|
|
11122
|
+
"type": "PrintSubmitEvent",
|
|
11123
|
+
"description": "Emitted when the component is submitted."
|
|
10893
11124
|
}
|
|
10894
11125
|
],
|
|
10895
11126
|
"js": {
|
|
@@ -10901,6 +11132,7 @@
|
|
|
10901
11132
|
},
|
|
10902
11133
|
{
|
|
10903
11134
|
"name": "allowedFormatsForSaving",
|
|
11135
|
+
"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
11136
|
"type": "\"all\" | Array<string>"
|
|
10905
11137
|
},
|
|
10906
11138
|
{
|
|
@@ -10929,7 +11161,7 @@
|
|
|
10929
11161
|
},
|
|
10930
11162
|
{
|
|
10931
11163
|
"name": "exportedLinks",
|
|
10932
|
-
"description": "The collection of links exported from the Print
|
|
11164
|
+
"description": "The collection of links exported from the Print component.",
|
|
10933
11165
|
"type": "Collection<FileLink>"
|
|
10934
11166
|
},
|
|
10935
11167
|
{
|
|
@@ -10939,11 +11171,12 @@
|
|
|
10939
11171
|
},
|
|
10940
11172
|
{
|
|
10941
11173
|
"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
|
|
11174
|
+
"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
11175
|
"type": "1 | 2 | 3 | 4 | 5 | 6"
|
|
10944
11176
|
},
|
|
10945
11177
|
{
|
|
10946
11178
|
"name": "hideHeader",
|
|
11179
|
+
"description": "Indicates whether the component's header is hidden.",
|
|
10947
11180
|
"type": "boolean"
|
|
10948
11181
|
},
|
|
10949
11182
|
{
|
|
@@ -10958,30 +11191,32 @@
|
|
|
10958
11191
|
},
|
|
10959
11192
|
{
|
|
10960
11193
|
"name": "messageOverrides",
|
|
10961
|
-
"description": "Replace localized message strings with your own strings
|
|
11194
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
10962
11195
|
"type": "Record<string, unknown>"
|
|
10963
11196
|
},
|
|
10964
11197
|
{
|
|
10965
11198
|
"name": "outSpatialReference",
|
|
10966
|
-
"description": "The [spatial reference](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-SpatialReference.html) used to render
|
|
11199
|
+
"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
11200
|
"type": "SpatialReference"
|
|
10968
11201
|
},
|
|
10969
11202
|
{
|
|
10970
11203
|
"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.",
|
|
11204
|
+
"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
11205
|
"type": "Portal"
|
|
10973
11206
|
},
|
|
10974
11207
|
{
|
|
10975
11208
|
"name": "position",
|
|
11209
|
+
"description": "The UI position of a component.",
|
|
10976
11210
|
"type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\""
|
|
10977
11211
|
},
|
|
10978
11212
|
{
|
|
10979
11213
|
"name": "printServiceUrl",
|
|
10980
|
-
"description": "The URL of the REST endpoint of the Export Web Map Task.\nIf the [portal](#portal) property is set,
|
|
11214
|
+
"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
11215
|
"type": "string"
|
|
10982
11216
|
},
|
|
10983
11217
|
{
|
|
10984
11218
|
"name": "referenceElement",
|
|
11219
|
+
"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
11220
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
10986
11221
|
},
|
|
10987
11222
|
{
|
|
@@ -10990,29 +11225,30 @@
|
|
|
10990
11225
|
},
|
|
10991
11226
|
{
|
|
10992
11227
|
"name": "showPrintAreaEnabled",
|
|
10993
|
-
"description": "The initial state of the print area toggle in the Print
|
|
11228
|
+
"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
11229
|
"type": "boolean"
|
|
10995
11230
|
},
|
|
10996
11231
|
{
|
|
10997
11232
|
"name": "state",
|
|
10998
|
-
"description": "The
|
|
11233
|
+
"description": "The state of the Print component.",
|
|
10999
11234
|
"type": "\"disabled\" | \"error\" | \"initializing\" | \"ready\""
|
|
11000
11235
|
},
|
|
11001
11236
|
{
|
|
11002
11237
|
"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
|
|
11238
|
+
"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
11239
|
"type": "{\n [x: string]: Array<HashMap<string>> | undefined;\n}"
|
|
11005
11240
|
},
|
|
11006
11241
|
{
|
|
11007
11242
|
"name": "templateOptions",
|
|
11008
|
-
"description": "Defines the layout template options used by the
|
|
11243
|
+
"description": "Defines the layout template options used by the Print component to generate the print page.",
|
|
11009
11244
|
"type": "TemplateOptions"
|
|
11010
11245
|
}
|
|
11011
11246
|
],
|
|
11012
11247
|
"events": [
|
|
11013
11248
|
{
|
|
11014
11249
|
"name": "arcgisComplete",
|
|
11015
|
-
"type": "
|
|
11250
|
+
"type": "PrintCompleteEvent",
|
|
11251
|
+
"description": "Emitted when the component is complete."
|
|
11016
11252
|
},
|
|
11017
11253
|
{
|
|
11018
11254
|
"name": "arcgisPropertyChange",
|
|
@@ -11026,14 +11262,15 @@
|
|
|
11026
11262
|
},
|
|
11027
11263
|
{
|
|
11028
11264
|
"name": "arcgisSubmit",
|
|
11029
|
-
"type": "
|
|
11265
|
+
"type": "PrintSubmitEvent",
|
|
11266
|
+
"description": "Emitted when the component is submitted."
|
|
11030
11267
|
}
|
|
11031
11268
|
]
|
|
11032
11269
|
}
|
|
11033
11270
|
},
|
|
11034
11271
|
{
|
|
11035
11272
|
"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
|
|
11273
|
+
"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
11274
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-bar/",
|
|
11038
11275
|
"attributes": [
|
|
11039
11276
|
{
|
|
@@ -11089,6 +11326,7 @@
|
|
|
11089
11326
|
},
|
|
11090
11327
|
{
|
|
11091
11328
|
"name": "reference-element",
|
|
11329
|
+
"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
11330
|
"value": {
|
|
11093
11331
|
"type": "string"
|
|
11094
11332
|
}
|
|
@@ -11136,7 +11374,7 @@
|
|
|
11136
11374
|
},
|
|
11137
11375
|
{
|
|
11138
11376
|
"name": "messageOverrides",
|
|
11139
|
-
"description": "Replace localized message strings with your own strings
|
|
11377
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
11140
11378
|
"type": "Record<string, unknown>"
|
|
11141
11379
|
},
|
|
11142
11380
|
{
|
|
@@ -11145,6 +11383,7 @@
|
|
|
11145
11383
|
},
|
|
11146
11384
|
{
|
|
11147
11385
|
"name": "referenceElement",
|
|
11386
|
+
"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
11387
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
11149
11388
|
},
|
|
11150
11389
|
{
|
|
@@ -11278,6 +11517,7 @@
|
|
|
11278
11517
|
},
|
|
11279
11518
|
{
|
|
11280
11519
|
"name": "reference-element",
|
|
11520
|
+
"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
11521
|
"value": {
|
|
11282
11522
|
"type": "string"
|
|
11283
11523
|
}
|
|
@@ -11376,6 +11616,7 @@
|
|
|
11376
11616
|
},
|
|
11377
11617
|
{
|
|
11378
11618
|
"name": "referenceElement",
|
|
11619
|
+
"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
11620
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
11380
11621
|
},
|
|
11381
11622
|
{
|
|
@@ -11405,7 +11646,7 @@
|
|
|
11405
11646
|
},
|
|
11406
11647
|
{
|
|
11407
11648
|
"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)",
|
|
11649
|
+
"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
11650
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/",
|
|
11410
11651
|
"attributes": [
|
|
11411
11652
|
{
|
|
@@ -11433,35 +11674,35 @@
|
|
|
11433
11674
|
},
|
|
11434
11675
|
{
|
|
11435
11676
|
"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()](
|
|
11677
|
+
"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
11678
|
"value": {
|
|
11438
11679
|
"type": "number"
|
|
11439
11680
|
}
|
|
11440
11681
|
},
|
|
11441
11682
|
{
|
|
11442
11683
|
"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()](
|
|
11684
|
+
"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
11685
|
"value": {
|
|
11445
11686
|
"type": "number"
|
|
11446
11687
|
}
|
|
11447
11688
|
},
|
|
11448
11689
|
{
|
|
11449
11690
|
"name": "camera-position",
|
|
11450
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
11691
|
+
"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
11692
|
"value": {
|
|
11452
11693
|
"type": "string"
|
|
11453
11694
|
}
|
|
11454
11695
|
},
|
|
11455
11696
|
{
|
|
11456
11697
|
"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()](
|
|
11698
|
+
"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
11699
|
"value": {
|
|
11459
11700
|
"type": "number"
|
|
11460
11701
|
}
|
|
11461
11702
|
},
|
|
11462
11703
|
{
|
|
11463
11704
|
"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()](
|
|
11705
|
+
"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
11706
|
"value": {
|
|
11466
11707
|
"type": "string"
|
|
11467
11708
|
}
|
|
@@ -11476,7 +11717,7 @@
|
|
|
11476
11717
|
},
|
|
11477
11718
|
{
|
|
11478
11719
|
"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)",
|
|
11720
|
+
"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
11721
|
"value": {
|
|
11481
11722
|
"type": "string"
|
|
11482
11723
|
}
|
|
@@ -11498,7 +11739,7 @@
|
|
|
11498
11739
|
},
|
|
11499
11740
|
{
|
|
11500
11741
|
"name": "quality-profile",
|
|
11501
|
-
"description": "
|
|
11742
|
+
"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
11743
|
"value": {
|
|
11503
11744
|
"type": [
|
|
11504
11745
|
"\"high\"",
|
|
@@ -11509,7 +11750,7 @@
|
|
|
11509
11750
|
},
|
|
11510
11751
|
{
|
|
11511
11752
|
"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()](
|
|
11753
|
+
"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
11754
|
"value": {
|
|
11514
11755
|
"type": "number"
|
|
11515
11756
|
}
|
|
@@ -11535,22 +11776,37 @@
|
|
|
11535
11776
|
},
|
|
11536
11777
|
{
|
|
11537
11778
|
"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()](
|
|
11779
|
+
"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
11780
|
"value": {
|
|
11540
11781
|
"type": "number"
|
|
11541
11782
|
}
|
|
11542
11783
|
}
|
|
11543
11784
|
],
|
|
11544
11785
|
"events": [
|
|
11786
|
+
{
|
|
11787
|
+
"name": "arcgisViewAnalysisViewCreate",
|
|
11788
|
+
"type": "ViewAnalysisViewCreateEvent",
|
|
11789
|
+
"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)"
|
|
11790
|
+
},
|
|
11791
|
+
{
|
|
11792
|
+
"name": "arcgisViewAnalysisViewCreateError",
|
|
11793
|
+
"type": "ViewAnalysisViewCreateErrorEvent",
|
|
11794
|
+
"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)"
|
|
11795
|
+
},
|
|
11796
|
+
{
|
|
11797
|
+
"name": "arcgisViewAnalysisViewDestroy",
|
|
11798
|
+
"type": "ViewAnalysisViewDestroyEvent",
|
|
11799
|
+
"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)"
|
|
11800
|
+
},
|
|
11545
11801
|
{
|
|
11546
11802
|
"name": "arcgisViewChange",
|
|
11547
11803
|
"type": "void",
|
|
11548
|
-
"description": "This event is for view related property changes
|
|
11804
|
+
"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
11805
|
},
|
|
11550
11806
|
{
|
|
11551
11807
|
"name": "arcgisViewClick",
|
|
11552
11808
|
"type": "ViewClickEvent",
|
|
11553
|
-
"description": "Fires after a user clicks on the view.\n\n
|
|
11809
|
+
"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
11810
|
},
|
|
11555
11811
|
{
|
|
11556
11812
|
"name": "arcgisViewDoubleClick",
|
|
@@ -11635,7 +11891,7 @@
|
|
|
11635
11891
|
{
|
|
11636
11892
|
"name": "arcgisViewReadyChange",
|
|
11637
11893
|
"type": "void",
|
|
11638
|
-
"description": "This event is for the [ready](
|
|
11894
|
+
"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
11895
|
}
|
|
11640
11896
|
],
|
|
11641
11897
|
"js": {
|
|
@@ -11653,7 +11909,7 @@
|
|
|
11653
11909
|
{
|
|
11654
11910
|
"name": "analyses",
|
|
11655
11911
|
"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>"
|
|
11912
|
+
"type": "Collection<AreaMeasurementAnalysis | DimensionAnalysis | DirectLineMeasurementAnalysis | LineOfSightAnalysis | SliceAnalysis | ViewshedAnalysis | VolumeMeasurementAnalysis>"
|
|
11657
11913
|
},
|
|
11658
11914
|
{
|
|
11659
11915
|
"name": "autoDestroyDisabled",
|
|
@@ -11672,37 +11928,37 @@
|
|
|
11672
11928
|
},
|
|
11673
11929
|
{
|
|
11674
11930
|
"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
|
|
11931
|
+
"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
11932
|
"type": "Camera"
|
|
11677
11933
|
},
|
|
11678
11934
|
{
|
|
11679
11935
|
"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()](
|
|
11936
|
+
"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
11937
|
"type": "number"
|
|
11682
11938
|
},
|
|
11683
11939
|
{
|
|
11684
11940
|
"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()](
|
|
11941
|
+
"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
11942
|
"type": "number"
|
|
11687
11943
|
},
|
|
11688
11944
|
{
|
|
11689
11945
|
"name": "cameraPosition",
|
|
11690
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
11946
|
+
"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
11947
|
"type": "Array<number> | Point | string"
|
|
11692
11948
|
},
|
|
11693
11949
|
{
|
|
11694
11950
|
"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()](
|
|
11951
|
+
"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
11952
|
"type": "number"
|
|
11697
11953
|
},
|
|
11698
11954
|
{
|
|
11699
11955
|
"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()](
|
|
11956
|
+
"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
11957
|
"type": "Array<number> | Point | string"
|
|
11702
11958
|
},
|
|
11703
11959
|
{
|
|
11704
11960
|
"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
|
|
11961
|
+
"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
11962
|
"type": "Extent"
|
|
11707
11963
|
},
|
|
11708
11964
|
{
|
|
@@ -11717,12 +11973,12 @@
|
|
|
11717
11973
|
},
|
|
11718
11974
|
{
|
|
11719
11975
|
"name": "environment",
|
|
11720
|
-
"description": "Specifies various properties of the environment's visualization
|
|
11976
|
+
"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
11977
|
"type": "SceneViewEnvironment"
|
|
11722
11978
|
},
|
|
11723
11979
|
{
|
|
11724
11980
|
"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()](
|
|
11981
|
+
"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
11982
|
"type": "Extent"
|
|
11727
11983
|
},
|
|
11728
11984
|
{
|
|
@@ -11735,6 +11991,11 @@
|
|
|
11735
11991
|
"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
11992
|
"type": "Collection<string>"
|
|
11737
11993
|
},
|
|
11994
|
+
{
|
|
11995
|
+
"name": "focusAreas",
|
|
11996
|
+
"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)",
|
|
11997
|
+
"type": "FocusAreas"
|
|
11998
|
+
},
|
|
11738
11999
|
{
|
|
11739
12000
|
"name": "gamepad",
|
|
11740
12001
|
"description": "Gamepad input specific configuration settings.",
|
|
@@ -11742,12 +12003,12 @@
|
|
|
11742
12003
|
},
|
|
11743
12004
|
{
|
|
11744
12005
|
"name": "graphics",
|
|
11745
|
-
"description": "Allows for adding graphics directly to the default graphics in the view
|
|
12006
|
+
"description": "Allows for adding graphics directly to the default graphics in the view.",
|
|
11746
12007
|
"type": "Collection<Graphic>"
|
|
11747
12008
|
},
|
|
11748
12009
|
{
|
|
11749
12010
|
"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)",
|
|
12011
|
+
"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
12012
|
"type": "Ground | string"
|
|
11752
12013
|
},
|
|
11753
12014
|
{
|
|
@@ -11777,7 +12038,7 @@
|
|
|
11777
12038
|
},
|
|
11778
12039
|
{
|
|
11779
12040
|
"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.",
|
|
12041
|
+
"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
12042
|
"type": "Collection<LayerView>"
|
|
11782
12043
|
},
|
|
11783
12044
|
{
|
|
@@ -11812,7 +12073,7 @@
|
|
|
11812
12073
|
},
|
|
11813
12074
|
{
|
|
11814
12075
|
"name": "popup",
|
|
11815
|
-
"description": "A [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html)
|
|
12076
|
+
"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
12077
|
"type": "Popup"
|
|
11817
12078
|
},
|
|
11818
12079
|
{
|
|
@@ -11822,7 +12083,7 @@
|
|
|
11822
12083
|
},
|
|
11823
12084
|
{
|
|
11824
12085
|
"name": "qualityProfile",
|
|
11825
|
-
"description": "
|
|
12086
|
+
"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
12087
|
"type": "\"high\" | \"low\" | \"medium\""
|
|
11827
12088
|
},
|
|
11828
12089
|
{
|
|
@@ -11832,12 +12093,12 @@
|
|
|
11832
12093
|
},
|
|
11833
12094
|
{
|
|
11834
12095
|
"name": "resolution",
|
|
11835
|
-
"description": "Represents the current value of one pixel in the unit of the view's\n[spatialReference](
|
|
12096
|
+
"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
12097
|
"type": "number"
|
|
11837
12098
|
},
|
|
11838
12099
|
{
|
|
11839
12100
|
"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()](
|
|
12101
|
+
"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
12102
|
"type": "number"
|
|
11842
12103
|
},
|
|
11843
12104
|
{
|
|
@@ -11857,7 +12118,7 @@
|
|
|
11857
12118
|
},
|
|
11858
12119
|
{
|
|
11859
12120
|
"name": "theme",
|
|
11860
|
-
"description": "This property specifies the base colors used by some
|
|
12121
|
+
"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
12122
|
"type": "Theme"
|
|
11862
12123
|
},
|
|
11863
12124
|
{
|
|
@@ -11882,30 +12143,45 @@
|
|
|
11882
12143
|
},
|
|
11883
12144
|
{
|
|
11884
12145
|
"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()](
|
|
12146
|
+
"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
12147
|
"type": "Viewpoint"
|
|
11887
12148
|
},
|
|
11888
12149
|
{
|
|
11889
12150
|
"name": "visibleArea",
|
|
11890
|
-
"description": "The visibleArea represents the visible portion of a [map](
|
|
12151
|
+
"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
12152
|
"type": "Polygon"
|
|
11892
12153
|
},
|
|
11893
12154
|
{
|
|
11894
12155
|
"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()](
|
|
12156
|
+
"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
12157
|
"type": "number"
|
|
11897
12158
|
}
|
|
11898
12159
|
],
|
|
11899
12160
|
"events": [
|
|
12161
|
+
{
|
|
12162
|
+
"name": "arcgisViewAnalysisViewCreate",
|
|
12163
|
+
"type": "ViewAnalysisViewCreateEvent",
|
|
12164
|
+
"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)"
|
|
12165
|
+
},
|
|
12166
|
+
{
|
|
12167
|
+
"name": "arcgisViewAnalysisViewCreateError",
|
|
12168
|
+
"type": "ViewAnalysisViewCreateErrorEvent",
|
|
12169
|
+
"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)"
|
|
12170
|
+
},
|
|
12171
|
+
{
|
|
12172
|
+
"name": "arcgisViewAnalysisViewDestroy",
|
|
12173
|
+
"type": "ViewAnalysisViewDestroyEvent",
|
|
12174
|
+
"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)"
|
|
12175
|
+
},
|
|
11900
12176
|
{
|
|
11901
12177
|
"name": "arcgisViewChange",
|
|
11902
12178
|
"type": "void",
|
|
11903
|
-
"description": "This event is for view related property changes
|
|
12179
|
+
"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
12180
|
},
|
|
11905
12181
|
{
|
|
11906
12182
|
"name": "arcgisViewClick",
|
|
11907
12183
|
"type": "ViewClickEvent",
|
|
11908
|
-
"description": "Fires after a user clicks on the view.\n\n
|
|
12184
|
+
"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
12185
|
},
|
|
11910
12186
|
{
|
|
11911
12187
|
"name": "arcgisViewDoubleClick",
|
|
@@ -11990,14 +12266,14 @@
|
|
|
11990
12266
|
{
|
|
11991
12267
|
"name": "arcgisViewReadyChange",
|
|
11992
12268
|
"type": "void",
|
|
11993
|
-
"description": "This event is for the [ready](
|
|
12269
|
+
"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
12270
|
}
|
|
11995
12271
|
]
|
|
11996
12272
|
}
|
|
11997
12273
|
},
|
|
11998
12274
|
{
|
|
11999
12275
|
"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.",
|
|
12276
|
+
"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
12277
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/",
|
|
12002
12278
|
"attributes": [
|
|
12003
12279
|
{
|
|
@@ -12037,9 +12313,17 @@
|
|
|
12037
12313
|
}
|
|
12038
12314
|
},
|
|
12039
12315
|
{
|
|
12040
|
-
"name": "auto-
|
|
12316
|
+
"name": "auto-navigate-disabled",
|
|
12317
|
+
"description": "Indicates whether to automatically navigate to the selected result.",
|
|
12318
|
+
"default": "false",
|
|
12319
|
+
"value": {
|
|
12320
|
+
"type": "boolean"
|
|
12321
|
+
}
|
|
12322
|
+
},
|
|
12323
|
+
{
|
|
12324
|
+
"name": "auto-select-disabled",
|
|
12041
12325
|
"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": "
|
|
12326
|
+
"default": "false",
|
|
12043
12327
|
"value": {
|
|
12044
12328
|
"type": "boolean"
|
|
12045
12329
|
}
|
|
@@ -12061,9 +12345,9 @@
|
|
|
12061
12345
|
}
|
|
12062
12346
|
},
|
|
12063
12347
|
{
|
|
12064
|
-
"name": "include-default-sources",
|
|
12348
|
+
"name": "include-default-sources-disabled",
|
|
12065
12349
|
"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": "
|
|
12350
|
+
"default": "false",
|
|
12067
12351
|
"value": {
|
|
12068
12352
|
"type": "boolean"
|
|
12069
12353
|
}
|
|
@@ -12076,9 +12360,9 @@
|
|
|
12076
12360
|
}
|
|
12077
12361
|
},
|
|
12078
12362
|
{
|
|
12079
|
-
"name": "location-
|
|
12363
|
+
"name": "location-disabled",
|
|
12080
12364
|
"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": "
|
|
12365
|
+
"default": "false",
|
|
12082
12366
|
"value": {
|
|
12083
12367
|
"type": "boolean"
|
|
12084
12368
|
}
|
|
@@ -12108,9 +12392,9 @@
|
|
|
12108
12392
|
}
|
|
12109
12393
|
},
|
|
12110
12394
|
{
|
|
12111
|
-
"name": "popup-
|
|
12395
|
+
"name": "popup-disabled",
|
|
12112
12396
|
"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": "
|
|
12397
|
+
"default": "false",
|
|
12114
12398
|
"value": {
|
|
12115
12399
|
"type": "boolean"
|
|
12116
12400
|
}
|
|
@@ -12134,22 +12418,23 @@
|
|
|
12134
12418
|
},
|
|
12135
12419
|
{
|
|
12136
12420
|
"name": "reference-element",
|
|
12421
|
+
"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
12422
|
"value": {
|
|
12138
12423
|
"type": "string"
|
|
12139
12424
|
}
|
|
12140
12425
|
},
|
|
12141
12426
|
{
|
|
12142
|
-
"name": "result-graphic-
|
|
12427
|
+
"name": "result-graphic-disabled",
|
|
12143
12428
|
"description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
|
|
12144
|
-
"default": "
|
|
12429
|
+
"default": "false",
|
|
12145
12430
|
"value": {
|
|
12146
12431
|
"type": "boolean"
|
|
12147
12432
|
}
|
|
12148
12433
|
},
|
|
12149
12434
|
{
|
|
12150
|
-
"name": "search-all-
|
|
12435
|
+
"name": "search-all-disabled",
|
|
12151
12436
|
"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": "
|
|
12437
|
+
"default": "false",
|
|
12153
12438
|
"value": {
|
|
12154
12439
|
"type": "boolean"
|
|
12155
12440
|
}
|
|
@@ -12163,7 +12448,7 @@
|
|
|
12163
12448
|
},
|
|
12164
12449
|
{
|
|
12165
12450
|
"name": "state",
|
|
12166
|
-
"description": "The current state
|
|
12451
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
12167
12452
|
"default": "\"ready\"",
|
|
12168
12453
|
"value": {
|
|
12169
12454
|
"type": [
|
|
@@ -12175,9 +12460,9 @@
|
|
|
12175
12460
|
}
|
|
12176
12461
|
},
|
|
12177
12462
|
{
|
|
12178
|
-
"name": "suggestions-
|
|
12463
|
+
"name": "suggestions-disabled",
|
|
12179
12464
|
"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": "
|
|
12465
|
+
"default": "false",
|
|
12181
12466
|
"value": {
|
|
12182
12467
|
"type": "boolean"
|
|
12183
12468
|
}
|
|
@@ -12258,7 +12543,12 @@
|
|
|
12258
12543
|
"type": "boolean"
|
|
12259
12544
|
},
|
|
12260
12545
|
{
|
|
12261
|
-
"name": "
|
|
12546
|
+
"name": "autoNavigateDisabled",
|
|
12547
|
+
"description": "Indicates whether to automatically navigate to the selected result.",
|
|
12548
|
+
"type": "boolean"
|
|
12549
|
+
},
|
|
12550
|
+
{
|
|
12551
|
+
"name": "autoSelectDisabled",
|
|
12262
12552
|
"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
12553
|
"type": "boolean"
|
|
12264
12554
|
},
|
|
@@ -12283,7 +12573,7 @@
|
|
|
12283
12573
|
"type": "string"
|
|
12284
12574
|
},
|
|
12285
12575
|
{
|
|
12286
|
-
"name": "
|
|
12576
|
+
"name": "includeDefaultSourcesDisabled",
|
|
12287
12577
|
"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
12578
|
"type": "Function | boolean"
|
|
12289
12579
|
},
|
|
@@ -12293,7 +12583,7 @@
|
|
|
12293
12583
|
"type": "string"
|
|
12294
12584
|
},
|
|
12295
12585
|
{
|
|
12296
|
-
"name": "
|
|
12586
|
+
"name": "locationDisabled",
|
|
12297
12587
|
"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
12588
|
"type": "boolean"
|
|
12299
12589
|
},
|
|
@@ -12309,7 +12599,7 @@
|
|
|
12309
12599
|
},
|
|
12310
12600
|
{
|
|
12311
12601
|
"name": "messageOverrides",
|
|
12312
|
-
"description": "Replace localized message strings with your own strings
|
|
12602
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
12313
12603
|
"type": "Record<string, unknown>"
|
|
12314
12604
|
},
|
|
12315
12605
|
{
|
|
@@ -12318,7 +12608,7 @@
|
|
|
12318
12608
|
"type": "number"
|
|
12319
12609
|
},
|
|
12320
12610
|
{
|
|
12321
|
-
"name": "
|
|
12611
|
+
"name": "popupDisabled",
|
|
12322
12612
|
"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
12613
|
"type": "boolean"
|
|
12324
12614
|
},
|
|
@@ -12338,6 +12628,7 @@
|
|
|
12338
12628
|
},
|
|
12339
12629
|
{
|
|
12340
12630
|
"name": "referenceElement",
|
|
12631
|
+
"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
12632
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
12342
12633
|
},
|
|
12343
12634
|
{
|
|
@@ -12346,7 +12637,7 @@
|
|
|
12346
12637
|
"type": "Graphic"
|
|
12347
12638
|
},
|
|
12348
12639
|
{
|
|
12349
|
-
"name": "
|
|
12640
|
+
"name": "resultGraphicDisabled",
|
|
12350
12641
|
"description": "Indicates if the [resultGraphic](#resultGraphic) will display at the\nlocation of the selected feature.",
|
|
12351
12642
|
"type": "boolean"
|
|
12352
12643
|
},
|
|
@@ -12356,7 +12647,7 @@
|
|
|
12356
12647
|
"type": "Array<SearchResults>"
|
|
12357
12648
|
},
|
|
12358
12649
|
{
|
|
12359
|
-
"name": "
|
|
12650
|
+
"name": "searchAllDisabled",
|
|
12360
12651
|
"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
12652
|
"type": "boolean"
|
|
12362
12653
|
},
|
|
@@ -12377,7 +12668,7 @@
|
|
|
12377
12668
|
},
|
|
12378
12669
|
{
|
|
12379
12670
|
"name": "state",
|
|
12380
|
-
"description": "The current state
|
|
12671
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
12381
12672
|
"type": "\"disabled\" | \"loading\" | \"ready\" | \"searching\""
|
|
12382
12673
|
},
|
|
12383
12674
|
{
|
|
@@ -12386,7 +12677,7 @@
|
|
|
12386
12677
|
"type": "Array<SuggestResults>"
|
|
12387
12678
|
},
|
|
12388
12679
|
{
|
|
12389
|
-
"name": "
|
|
12680
|
+
"name": "suggestionsDisabled",
|
|
12390
12681
|
"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
12682
|
"type": "boolean"
|
|
12392
12683
|
}
|
|
@@ -12465,7 +12756,7 @@
|
|
|
12465
12756
|
},
|
|
12466
12757
|
{
|
|
12467
12758
|
"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\" | \"
|
|
12759
|
+
"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
12760
|
},
|
|
12470
12761
|
{
|
|
12471
12762
|
"name": "viewModel",
|
|
@@ -12483,7 +12774,7 @@
|
|
|
12483
12774
|
},
|
|
12484
12775
|
{
|
|
12485
12776
|
"name": "arcgis-shadow-cast",
|
|
12486
|
-
"description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [
|
|
12777
|
+
"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
12778
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/",
|
|
12488
12779
|
"attributes": [
|
|
12489
12780
|
{
|
|
@@ -12496,6 +12787,7 @@
|
|
|
12496
12787
|
},
|
|
12497
12788
|
{
|
|
12498
12789
|
"name": "date",
|
|
12790
|
+
"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
12791
|
"value": {
|
|
12500
12792
|
"type": [
|
|
12501
12793
|
"number",
|
|
@@ -12505,7 +12797,7 @@
|
|
|
12505
12797
|
},
|
|
12506
12798
|
{
|
|
12507
12799
|
"name": "end-time-of-day",
|
|
12508
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
12800
|
+
"description": "Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#endTimeOfDay)",
|
|
12509
12801
|
"default": "16 * 3600 * 1000",
|
|
12510
12802
|
"value": {
|
|
12511
12803
|
"type": "number"
|
|
@@ -12591,7 +12883,7 @@
|
|
|
12591
12883
|
},
|
|
12592
12884
|
{
|
|
12593
12885
|
"name": "icon",
|
|
12594
|
-
"description": "Icon which represents the
|
|
12886
|
+
"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
12887
|
"default": "\"measure-building-height-shadow\"",
|
|
12596
12888
|
"value": {
|
|
12597
12889
|
"type": "string"
|
|
@@ -12599,7 +12891,7 @@
|
|
|
12599
12891
|
},
|
|
12600
12892
|
{
|
|
12601
12893
|
"name": "label",
|
|
12602
|
-
"description": "The
|
|
12894
|
+
"description": "The component's default label.",
|
|
12603
12895
|
"value": {
|
|
12604
12896
|
"type": "string"
|
|
12605
12897
|
}
|
|
@@ -12623,13 +12915,14 @@
|
|
|
12623
12915
|
},
|
|
12624
12916
|
{
|
|
12625
12917
|
"name": "reference-element",
|
|
12918
|
+
"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
12919
|
"value": {
|
|
12627
12920
|
"type": "string"
|
|
12628
12921
|
}
|
|
12629
12922
|
},
|
|
12630
12923
|
{
|
|
12631
12924
|
"name": "start-time-of-day",
|
|
12632
|
-
"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 start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ShadowCast-ShadowCastViewModel.html#startTimeOfDay)",
|
|
12633
12926
|
"default": "10 * 3600 * 1000",
|
|
12634
12927
|
"value": {
|
|
12635
12928
|
"type": "number"
|
|
@@ -12637,7 +12930,7 @@
|
|
|
12637
12930
|
},
|
|
12638
12931
|
{
|
|
12639
12932
|
"name": "state",
|
|
12640
|
-
"description": "The
|
|
12933
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
12641
12934
|
"default": "\"disabled\"",
|
|
12642
12935
|
"value": {
|
|
12643
12936
|
"type": [
|
|
@@ -12648,14 +12941,14 @@
|
|
|
12648
12941
|
},
|
|
12649
12942
|
{
|
|
12650
12943
|
"name": "utc-offset",
|
|
12651
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
12944
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
12652
12945
|
"value": {
|
|
12653
12946
|
"type": "number"
|
|
12654
12947
|
}
|
|
12655
12948
|
},
|
|
12656
12949
|
{
|
|
12657
12950
|
"name": "visualization-type",
|
|
12658
|
-
"description": "Type of visualization to use when showing the shadows
|
|
12951
|
+
"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
12952
|
"default": "\"threshold\"",
|
|
12660
12953
|
"value": {
|
|
12661
12954
|
"type": [
|
|
@@ -12687,21 +12980,22 @@
|
|
|
12687
12980
|
},
|
|
12688
12981
|
{
|
|
12689
12982
|
"name": "date",
|
|
12983
|
+
"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
12984
|
"type": "Date | number | string"
|
|
12691
12985
|
},
|
|
12692
12986
|
{
|
|
12693
12987
|
"name": "discreteOptions",
|
|
12694
|
-
"description": "The configuration used when the
|
|
12988
|
+
"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
12989
|
"type": "DiscreteOptions"
|
|
12696
12990
|
},
|
|
12697
12991
|
{
|
|
12698
12992
|
"name": "durationOptions",
|
|
12699
|
-
"description": "The configuration used when the
|
|
12993
|
+
"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
12994
|
"type": "DurationOptions"
|
|
12701
12995
|
},
|
|
12702
12996
|
{
|
|
12703
12997
|
"name": "endTimeOfDay",
|
|
12704
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
12998
|
+
"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
12999
|
"type": "number"
|
|
12706
13000
|
},
|
|
12707
13001
|
{
|
|
@@ -12751,12 +13045,12 @@
|
|
|
12751
13045
|
},
|
|
12752
13046
|
{
|
|
12753
13047
|
"name": "icon",
|
|
12754
|
-
"description": "Icon which represents the
|
|
13048
|
+
"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
13049
|
"type": "string"
|
|
12756
13050
|
},
|
|
12757
13051
|
{
|
|
12758
13052
|
"name": "label",
|
|
12759
|
-
"description": "The
|
|
13053
|
+
"description": "The component's default label.",
|
|
12760
13054
|
"type": "string"
|
|
12761
13055
|
},
|
|
12762
13056
|
{
|
|
@@ -12765,31 +13059,32 @@
|
|
|
12765
13059
|
},
|
|
12766
13060
|
{
|
|
12767
13061
|
"name": "referenceElement",
|
|
13062
|
+
"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
13063
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
12769
13064
|
},
|
|
12770
13065
|
{
|
|
12771
13066
|
"name": "startTimeOfDay",
|
|
12772
|
-
"description": "Time (in milliseconds from midnight of the [date](
|
|
13067
|
+
"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
13068
|
"type": "number"
|
|
12774
13069
|
},
|
|
12775
13070
|
{
|
|
12776
13071
|
"name": "state",
|
|
12777
|
-
"description": "The
|
|
13072
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
12778
13073
|
"type": "\"disabled\" | \"ready\""
|
|
12779
13074
|
},
|
|
12780
13075
|
{
|
|
12781
13076
|
"name": "thresholdOptions",
|
|
12782
|
-
"description": "The configuration used when the
|
|
13077
|
+
"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
13078
|
"type": "ThresholdOptions"
|
|
12784
13079
|
},
|
|
12785
13080
|
{
|
|
12786
13081
|
"name": "utcOffset",
|
|
12787
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
13082
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
12788
13083
|
"type": "number"
|
|
12789
13084
|
},
|
|
12790
13085
|
{
|
|
12791
13086
|
"name": "visualizationType",
|
|
12792
|
-
"description": "Type of visualization to use when showing the shadows
|
|
13087
|
+
"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
13088
|
"type": "\"discrete\" | \"duration\" | \"threshold\""
|
|
12794
13089
|
}
|
|
12795
13090
|
],
|
|
@@ -13041,6 +13336,7 @@
|
|
|
13041
13336
|
},
|
|
13042
13337
|
{
|
|
13043
13338
|
"name": "reference-element",
|
|
13339
|
+
"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
13340
|
"value": {
|
|
13045
13341
|
"type": "string"
|
|
13046
13342
|
}
|
|
@@ -13283,6 +13579,7 @@
|
|
|
13283
13579
|
},
|
|
13284
13580
|
{
|
|
13285
13581
|
"name": "referenceElement",
|
|
13582
|
+
"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
13583
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
13287
13584
|
},
|
|
13288
13585
|
{
|
|
@@ -13356,7 +13653,7 @@
|
|
|
13356
13653
|
},
|
|
13357
13654
|
{
|
|
13358
13655
|
"name": "arcgis-slice",
|
|
13359
|
-
"description": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a
|
|
13656
|
+
"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
13657
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/",
|
|
13361
13658
|
"attributes": [
|
|
13362
13659
|
{
|
|
@@ -13423,6 +13720,7 @@
|
|
|
13423
13720
|
},
|
|
13424
13721
|
{
|
|
13425
13722
|
"name": "reference-element",
|
|
13723
|
+
"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
13724
|
"value": {
|
|
13427
13725
|
"type": "string"
|
|
13428
13726
|
}
|
|
@@ -13465,7 +13763,7 @@
|
|
|
13465
13763
|
"properties": [
|
|
13466
13764
|
{
|
|
13467
13765
|
"name": "analysis",
|
|
13468
|
-
"description": "The [
|
|
13766
|
+
"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
13767
|
"type": "SliceAnalysis"
|
|
13470
13768
|
},
|
|
13471
13769
|
{
|
|
@@ -13499,7 +13797,7 @@
|
|
|
13499
13797
|
},
|
|
13500
13798
|
{
|
|
13501
13799
|
"name": "messageOverrides",
|
|
13502
|
-
"description": "Replace localized message strings with your own strings
|
|
13800
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
13503
13801
|
"type": "Record<string, unknown>"
|
|
13504
13802
|
},
|
|
13505
13803
|
{
|
|
@@ -13508,11 +13806,12 @@
|
|
|
13508
13806
|
},
|
|
13509
13807
|
{
|
|
13510
13808
|
"name": "referenceElement",
|
|
13809
|
+
"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
13810
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
13512
13811
|
},
|
|
13513
13812
|
{
|
|
13514
13813
|
"name": "shape",
|
|
13515
|
-
"description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a
|
|
13814
|
+
"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
13815
|
"type": "SlicePlane"
|
|
13517
13816
|
},
|
|
13518
13817
|
{
|
|
@@ -13660,6 +13959,7 @@
|
|
|
13660
13959
|
},
|
|
13661
13960
|
{
|
|
13662
13961
|
"name": "reference-element",
|
|
13962
|
+
"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
13963
|
"value": {
|
|
13664
13964
|
"type": "string"
|
|
13665
13965
|
}
|
|
@@ -13862,6 +14162,7 @@
|
|
|
13862
14162
|
},
|
|
13863
14163
|
{
|
|
13864
14164
|
"name": "referenceElement",
|
|
14165
|
+
"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
14166
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
13866
14167
|
},
|
|
13867
14168
|
{
|
|
@@ -13980,7 +14281,7 @@
|
|
|
13980
14281
|
},
|
|
13981
14282
|
{
|
|
13982
14283
|
"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
|
|
14284
|
+
"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
14285
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/",
|
|
13985
14286
|
"attributes": [
|
|
13986
14287
|
{
|
|
@@ -14061,6 +14362,7 @@
|
|
|
14061
14362
|
},
|
|
14062
14363
|
{
|
|
14063
14364
|
"name": "reference-element",
|
|
14365
|
+
"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
14366
|
"value": {
|
|
14065
14367
|
"type": "string"
|
|
14066
14368
|
}
|
|
@@ -14095,6 +14397,16 @@
|
|
|
14095
14397
|
"name": "arcgisReady",
|
|
14096
14398
|
"type": "void",
|
|
14097
14399
|
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
|
|
14400
|
+
},
|
|
14401
|
+
{
|
|
14402
|
+
"name": "arcgisSwipeChange",
|
|
14403
|
+
"type": "void",
|
|
14404
|
+
"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."
|
|
14405
|
+
},
|
|
14406
|
+
{
|
|
14407
|
+
"name": "arcgisSwipeInput",
|
|
14408
|
+
"type": "void",
|
|
14409
|
+
"description": "Fires when the swipe position is updated.\nThis event is fired continuously while dragging the handle."
|
|
14098
14410
|
}
|
|
14099
14411
|
],
|
|
14100
14412
|
"js": {
|
|
@@ -14141,7 +14453,7 @@
|
|
|
14141
14453
|
},
|
|
14142
14454
|
{
|
|
14143
14455
|
"name": "messageOverrides",
|
|
14144
|
-
"description": "Replace localized message strings with your own strings
|
|
14456
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
14145
14457
|
"type": "Record<string, unknown>"
|
|
14146
14458
|
},
|
|
14147
14459
|
{
|
|
@@ -14150,6 +14462,7 @@
|
|
|
14150
14462
|
},
|
|
14151
14463
|
{
|
|
14152
14464
|
"name": "referenceElement",
|
|
14465
|
+
"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
14466
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
14154
14467
|
},
|
|
14155
14468
|
{
|
|
@@ -14178,6 +14491,16 @@
|
|
|
14178
14491
|
"name": "arcgisReady",
|
|
14179
14492
|
"type": "void",
|
|
14180
14493
|
"description": "Emitted when the component associated with a map or scene view is is ready to be interacted with."
|
|
14494
|
+
},
|
|
14495
|
+
{
|
|
14496
|
+
"name": "arcgisSwipeChange",
|
|
14497
|
+
"type": "void",
|
|
14498
|
+
"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."
|
|
14499
|
+
},
|
|
14500
|
+
{
|
|
14501
|
+
"name": "arcgisSwipeInput",
|
|
14502
|
+
"type": "void",
|
|
14503
|
+
"description": "Fires when the swipe position is updated.\nThis event is fired continuously while dragging the handle."
|
|
14181
14504
|
}
|
|
14182
14505
|
]
|
|
14183
14506
|
}
|
|
@@ -14299,6 +14622,7 @@
|
|
|
14299
14622
|
},
|
|
14300
14623
|
{
|
|
14301
14624
|
"name": "reference-element",
|
|
14625
|
+
"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
14626
|
"value": {
|
|
14303
14627
|
"type": "string"
|
|
14304
14628
|
}
|
|
@@ -14469,6 +14793,7 @@
|
|
|
14469
14793
|
},
|
|
14470
14794
|
{
|
|
14471
14795
|
"name": "referenceElement",
|
|
14796
|
+
"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
14797
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
14473
14798
|
},
|
|
14474
14799
|
{
|
|
@@ -14636,6 +14961,7 @@
|
|
|
14636
14961
|
},
|
|
14637
14962
|
{
|
|
14638
14963
|
"name": "reference-element",
|
|
14964
|
+
"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
14965
|
"value": {
|
|
14640
14966
|
"type": "string"
|
|
14641
14967
|
}
|
|
@@ -14748,6 +15074,7 @@
|
|
|
14748
15074
|
},
|
|
14749
15075
|
{
|
|
14750
15076
|
"name": "referenceElement",
|
|
15077
|
+
"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
15078
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
14752
15079
|
},
|
|
14753
15080
|
{
|
|
@@ -14909,7 +15236,7 @@
|
|
|
14909
15236
|
},
|
|
14910
15237
|
{
|
|
14911
15238
|
"name": "messageOverrides",
|
|
14912
|
-
"description": "Replace localized message strings with your own strings
|
|
15239
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
14913
15240
|
"type": "Record<string, unknown>"
|
|
14914
15241
|
},
|
|
14915
15242
|
{
|
|
@@ -14942,7 +15269,7 @@
|
|
|
14942
15269
|
},
|
|
14943
15270
|
{
|
|
14944
15271
|
"name": "arcgis-track",
|
|
14945
|
-
"description": "The Track component is a button that animates the
|
|
15272
|
+
"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
15273
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-track/",
|
|
14947
15274
|
"attributes": [
|
|
14948
15275
|
{
|
|
@@ -15010,6 +15337,7 @@
|
|
|
15010
15337
|
},
|
|
15011
15338
|
{
|
|
15012
15339
|
"name": "reference-element",
|
|
15340
|
+
"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
15341
|
"value": {
|
|
15014
15342
|
"type": "string"
|
|
15015
15343
|
}
|
|
@@ -15032,7 +15360,7 @@
|
|
|
15032
15360
|
},
|
|
15033
15361
|
{
|
|
15034
15362
|
"name": "state",
|
|
15035
|
-
"description": "The current state of the
|
|
15363
|
+
"description": "The current state of the component.",
|
|
15036
15364
|
"default": "\"disabled\"",
|
|
15037
15365
|
"value": {
|
|
15038
15366
|
"type": [
|
|
@@ -15109,7 +15437,7 @@
|
|
|
15109
15437
|
},
|
|
15110
15438
|
{
|
|
15111
15439
|
"name": "messageOverrides",
|
|
15112
|
-
"description": "Replace localized message strings with your own strings
|
|
15440
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
15113
15441
|
"type": "Record<string, unknown>"
|
|
15114
15442
|
},
|
|
15115
15443
|
{
|
|
@@ -15123,6 +15451,7 @@
|
|
|
15123
15451
|
},
|
|
15124
15452
|
{
|
|
15125
15453
|
"name": "referenceElement",
|
|
15454
|
+
"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
15455
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
15127
15456
|
},
|
|
15128
15457
|
{
|
|
@@ -15137,7 +15466,7 @@
|
|
|
15137
15466
|
},
|
|
15138
15467
|
{
|
|
15139
15468
|
"name": "state",
|
|
15140
|
-
"description": "The current state of the
|
|
15469
|
+
"description": "The current state of the component.",
|
|
15141
15470
|
"type": "\"disabled\" | \"error\" | \"feature-unsupported\" | \"ready\" | \"tracking\" | \"waiting\""
|
|
15142
15471
|
},
|
|
15143
15472
|
{
|
|
@@ -15170,7 +15499,7 @@
|
|
|
15170
15499
|
},
|
|
15171
15500
|
{
|
|
15172
15501
|
"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
|
|
15502
|
+
"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
15503
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-associations/",
|
|
15175
15504
|
"attributes": [
|
|
15176
15505
|
{
|
|
@@ -15310,6 +15639,7 @@
|
|
|
15310
15639
|
},
|
|
15311
15640
|
{
|
|
15312
15641
|
"name": "reference-element",
|
|
15642
|
+
"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
15643
|
"value": {
|
|
15314
15644
|
"type": "string"
|
|
15315
15645
|
}
|
|
@@ -15375,7 +15705,7 @@
|
|
|
15375
15705
|
},
|
|
15376
15706
|
{
|
|
15377
15707
|
"name": "visible-elements-connectivity-associations-settings-arrows-toggle",
|
|
15378
|
-
"description": "**Deprecated**: since 4.32
|
|
15708
|
+
"description": "**Deprecated**: since 4.32, showConnectivityAssociationsSettingsArrowsToggle instead. ",
|
|
15379
15709
|
"default": "false",
|
|
15380
15710
|
"value": {
|
|
15381
15711
|
"type": "boolean"
|
|
@@ -15383,7 +15713,7 @@
|
|
|
15383
15713
|
},
|
|
15384
15714
|
{
|
|
15385
15715
|
"name": "visible-elements-connectivity-associations-settings-cap-select",
|
|
15386
|
-
"description": "**Deprecated**: since 4.32
|
|
15716
|
+
"description": "**Deprecated**: since 4.32, use showConnectivityAssociationsSettingsCapSelect instead. ",
|
|
15387
15717
|
"default": "false",
|
|
15388
15718
|
"value": {
|
|
15389
15719
|
"type": "boolean"
|
|
@@ -15391,7 +15721,7 @@
|
|
|
15391
15721
|
},
|
|
15392
15722
|
{
|
|
15393
15723
|
"name": "visible-elements-connectivity-associations-settings-color-picker",
|
|
15394
|
-
"description": "**Deprecated**: since 4.32
|
|
15724
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsColorPicker instead. ",
|
|
15395
15725
|
"default": "true",
|
|
15396
15726
|
"value": {
|
|
15397
15727
|
"type": "boolean"
|
|
@@ -15399,7 +15729,7 @@
|
|
|
15399
15729
|
},
|
|
15400
15730
|
{
|
|
15401
15731
|
"name": "visible-elements-connectivity-associations-settings-style-picker",
|
|
15402
|
-
"description": "**Deprecated**: since 4.32
|
|
15732
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsStylePicker instead. ",
|
|
15403
15733
|
"default": "true",
|
|
15404
15734
|
"value": {
|
|
15405
15735
|
"type": "boolean"
|
|
@@ -15407,7 +15737,7 @@
|
|
|
15407
15737
|
},
|
|
15408
15738
|
{
|
|
15409
15739
|
"name": "visible-elements-connectivity-associations-settings-width-input",
|
|
15410
|
-
"description": "**Deprecated**: since 4.32
|
|
15740
|
+
"description": "**Deprecated**: since 4.32, use hideConnectivityAssociationsSettingsWidthInput instead. ",
|
|
15411
15741
|
"default": "true",
|
|
15412
15742
|
"value": {
|
|
15413
15743
|
"type": "boolean"
|
|
@@ -15415,7 +15745,7 @@
|
|
|
15415
15745
|
},
|
|
15416
15746
|
{
|
|
15417
15747
|
"name": "visible-elements-max-allowable-associations-slider",
|
|
15418
|
-
"description": "**Deprecated**: since 4.32
|
|
15748
|
+
"description": "**Deprecated**: since 4.32, use showMaxAllowableAssociationsSlider instead. ",
|
|
15419
15749
|
"default": "false",
|
|
15420
15750
|
"value": {
|
|
15421
15751
|
"type": "boolean"
|
|
@@ -15423,7 +15753,7 @@
|
|
|
15423
15753
|
},
|
|
15424
15754
|
{
|
|
15425
15755
|
"name": "visible-elements-structural-attachment-associations-settings-arrows-toggle",
|
|
15426
|
-
"description": "**Deprecated**: since 4.32
|
|
15756
|
+
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsArrowsToggle instead. ",
|
|
15427
15757
|
"default": "false",
|
|
15428
15758
|
"value": {
|
|
15429
15759
|
"type": "boolean"
|
|
@@ -15431,7 +15761,7 @@
|
|
|
15431
15761
|
},
|
|
15432
15762
|
{
|
|
15433
15763
|
"name": "visible-elements-structural-attachment-associations-settings-cap-select",
|
|
15434
|
-
"description": "**Deprecated**: since 4.32
|
|
15764
|
+
"description": "**Deprecated**: since 4.32, use showStructuralAttachmentAssociationsSettingsCapSelect instead. ",
|
|
15435
15765
|
"default": "false",
|
|
15436
15766
|
"value": {
|
|
15437
15767
|
"type": "boolean"
|
|
@@ -15439,7 +15769,7 @@
|
|
|
15439
15769
|
},
|
|
15440
15770
|
{
|
|
15441
15771
|
"name": "visible-elements-structural-attachment-associations-settings-color-picker",
|
|
15442
|
-
"description": "**Deprecated**: since 4.32
|
|
15772
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsColorPicker instead. ",
|
|
15443
15773
|
"default": "true",
|
|
15444
15774
|
"value": {
|
|
15445
15775
|
"type": "boolean"
|
|
@@ -15447,7 +15777,7 @@
|
|
|
15447
15777
|
},
|
|
15448
15778
|
{
|
|
15449
15779
|
"name": "visible-elements-structural-attachment-associations-settings-style-picker",
|
|
15450
|
-
"description": "**Deprecated**: since 4.32
|
|
15780
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsStylePicker instead. ",
|
|
15451
15781
|
"default": "true",
|
|
15452
15782
|
"value": {
|
|
15453
15783
|
"type": "boolean"
|
|
@@ -15455,7 +15785,7 @@
|
|
|
15455
15785
|
},
|
|
15456
15786
|
{
|
|
15457
15787
|
"name": "visible-elements-structural-attachment-associations-settings-width-input",
|
|
15458
|
-
"description": "**Deprecated**: since 4.32
|
|
15788
|
+
"description": "**Deprecated**: since 4.32, use hideStructuralAttachmentAssociationsSettingsWidthInput instead. ",
|
|
15459
15789
|
"default": "true",
|
|
15460
15790
|
"value": {
|
|
15461
15791
|
"type": "boolean"
|
|
@@ -15556,6 +15886,7 @@
|
|
|
15556
15886
|
},
|
|
15557
15887
|
{
|
|
15558
15888
|
"name": "referenceElement",
|
|
15889
|
+
"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
15890
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
15560
15891
|
},
|
|
15561
15892
|
{
|
|
@@ -15688,7 +16019,7 @@
|
|
|
15688
16019
|
},
|
|
15689
16020
|
{
|
|
15690
16021
|
"name": "gdb-version",
|
|
15691
|
-
"description": "**Deprecated**: since version 4.31
|
|
16022
|
+
"description": "**Deprecated**: `gdbVersion` is deprecated since version 4.31.. The Geodatabase version to pass into the trace.",
|
|
15692
16023
|
"default": "\"sde.DEFAULT\"",
|
|
15693
16024
|
"value": {
|
|
15694
16025
|
"type": "string"
|
|
@@ -15728,6 +16059,7 @@
|
|
|
15728
16059
|
},
|
|
15729
16060
|
{
|
|
15730
16061
|
"name": "reference-element",
|
|
16062
|
+
"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
16063
|
"value": {
|
|
15732
16064
|
"type": "string"
|
|
15733
16065
|
}
|
|
@@ -15853,6 +16185,7 @@
|
|
|
15853
16185
|
},
|
|
15854
16186
|
{
|
|
15855
16187
|
"name": "referenceElement",
|
|
16188
|
+
"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
16189
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
15857
16190
|
},
|
|
15858
16191
|
{
|
|
@@ -15978,6 +16311,7 @@
|
|
|
15978
16311
|
},
|
|
15979
16312
|
{
|
|
15980
16313
|
"name": "reference-element",
|
|
16314
|
+
"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
16315
|
"value": {
|
|
15982
16316
|
"type": "string"
|
|
15983
16317
|
}
|
|
@@ -16038,6 +16372,7 @@
|
|
|
16038
16372
|
},
|
|
16039
16373
|
{
|
|
16040
16374
|
"name": "referenceElement",
|
|
16375
|
+
"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
16376
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16042
16377
|
},
|
|
16043
16378
|
{
|
|
@@ -16192,6 +16527,7 @@
|
|
|
16192
16527
|
},
|
|
16193
16528
|
{
|
|
16194
16529
|
"name": "reference-element",
|
|
16530
|
+
"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
16531
|
"value": {
|
|
16196
16532
|
"type": "string"
|
|
16197
16533
|
}
|
|
@@ -16304,6 +16640,7 @@
|
|
|
16304
16640
|
},
|
|
16305
16641
|
{
|
|
16306
16642
|
"name": "referenceElement",
|
|
16643
|
+
"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
16644
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16308
16645
|
},
|
|
16309
16646
|
{
|
|
@@ -16393,7 +16730,7 @@
|
|
|
16393
16730
|
},
|
|
16394
16731
|
{
|
|
16395
16732
|
"name": "page-size",
|
|
16396
|
-
"description": "Specifies the number of versions displayed on each page of the Version Management
|
|
16733
|
+
"description": "Specifies the number of versions displayed on each page of the Version Management component.",
|
|
16397
16734
|
"default": "5",
|
|
16398
16735
|
"value": {
|
|
16399
16736
|
"type": "number"
|
|
@@ -16418,6 +16755,7 @@
|
|
|
16418
16755
|
},
|
|
16419
16756
|
{
|
|
16420
16757
|
"name": "reference-element",
|
|
16758
|
+
"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
16759
|
"value": {
|
|
16422
16760
|
"type": "string"
|
|
16423
16761
|
}
|
|
@@ -16469,7 +16807,7 @@
|
|
|
16469
16807
|
},
|
|
16470
16808
|
{
|
|
16471
16809
|
"name": "initialVersionInfos",
|
|
16472
|
-
"description": "The `initialVersionInfos` property enables users to initialize the Version Management
|
|
16810
|
+
"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
16811
|
"type": "Array<{\n url: string;\n name: string;\n}>"
|
|
16474
16812
|
},
|
|
16475
16813
|
{
|
|
@@ -16478,7 +16816,7 @@
|
|
|
16478
16816
|
},
|
|
16479
16817
|
{
|
|
16480
16818
|
"name": "messageOverrides",
|
|
16481
|
-
"description": "Replace localized message strings with your own strings
|
|
16819
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16482
16820
|
"type": "Record<string, unknown>"
|
|
16483
16821
|
},
|
|
16484
16822
|
{
|
|
@@ -16487,7 +16825,7 @@
|
|
|
16487
16825
|
},
|
|
16488
16826
|
{
|
|
16489
16827
|
"name": "pageSize",
|
|
16490
|
-
"description": "Specifies the number of versions displayed on each page of the Version Management
|
|
16828
|
+
"description": "Specifies the number of versions displayed on each page of the Version Management component.",
|
|
16491
16829
|
"type": "number"
|
|
16492
16830
|
},
|
|
16493
16831
|
{
|
|
@@ -16496,6 +16834,7 @@
|
|
|
16496
16834
|
},
|
|
16497
16835
|
{
|
|
16498
16836
|
"name": "referenceElement",
|
|
16837
|
+
"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
16838
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16500
16839
|
},
|
|
16501
16840
|
{
|
|
@@ -16505,7 +16844,7 @@
|
|
|
16505
16844
|
},
|
|
16506
16845
|
{
|
|
16507
16846
|
"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
|
|
16847
|
+
"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
16848
|
"type": "Collection<VersioningState>"
|
|
16510
16849
|
}
|
|
16511
16850
|
],
|
|
@@ -16524,7 +16863,7 @@
|
|
|
16524
16863
|
},
|
|
16525
16864
|
{
|
|
16526
16865
|
"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
|
|
16866
|
+
"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
16867
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/",
|
|
16529
16868
|
"attributes": [
|
|
16530
16869
|
{
|
|
@@ -16533,12 +16872,6 @@
|
|
|
16533
16872
|
"value": {
|
|
16534
16873
|
"type": "boolean"
|
|
16535
16874
|
}
|
|
16536
|
-
},
|
|
16537
|
-
{
|
|
16538
|
-
"name": "layer-url",
|
|
16539
|
-
"value": {
|
|
16540
|
-
"type": "string"
|
|
16541
|
-
}
|
|
16542
16875
|
}
|
|
16543
16876
|
],
|
|
16544
16877
|
"events": [
|
|
@@ -16559,8 +16892,9 @@
|
|
|
16559
16892
|
"type": "VideoLayer"
|
|
16560
16893
|
},
|
|
16561
16894
|
{
|
|
16562
|
-
"name": "
|
|
16563
|
-
"
|
|
16895
|
+
"name": "map",
|
|
16896
|
+
"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).",
|
|
16897
|
+
"type": "Map | WebMap"
|
|
16564
16898
|
},
|
|
16565
16899
|
{
|
|
16566
16900
|
"name": "ready",
|
|
@@ -16583,7 +16917,7 @@
|
|
|
16583
16917
|
},
|
|
16584
16918
|
{
|
|
16585
16919
|
"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
|
|
16920
|
+
"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
16921
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/",
|
|
16588
16922
|
"attributes": [
|
|
16589
16923
|
{
|
|
@@ -16594,6 +16928,19 @@
|
|
|
16594
16928
|
"type": "boolean"
|
|
16595
16929
|
}
|
|
16596
16930
|
},
|
|
16931
|
+
{
|
|
16932
|
+
"name": "following-mode",
|
|
16933
|
+
"description": "Determines which telemetry elements to follow when the video layer is playing.",
|
|
16934
|
+
"default": "\"follow-both\"",
|
|
16935
|
+
"value": {
|
|
16936
|
+
"type": [
|
|
16937
|
+
"\"follow-both\"",
|
|
16938
|
+
"\"follow-frame\"",
|
|
16939
|
+
"\"follow-sensor\"",
|
|
16940
|
+
"\"none\""
|
|
16941
|
+
]
|
|
16942
|
+
}
|
|
16943
|
+
},
|
|
16597
16944
|
{
|
|
16598
16945
|
"name": "hide-header",
|
|
16599
16946
|
"description": "Indicates whether to display the video player's header information.",
|
|
@@ -16636,6 +16983,7 @@
|
|
|
16636
16983
|
},
|
|
16637
16984
|
{
|
|
16638
16985
|
"name": "reference-element",
|
|
16986
|
+
"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
16987
|
"value": {
|
|
16640
16988
|
"type": "string"
|
|
16641
16989
|
}
|
|
@@ -16680,6 +17028,11 @@
|
|
|
16680
17028
|
"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
17029
|
"type": "boolean"
|
|
16682
17030
|
},
|
|
17031
|
+
{
|
|
17032
|
+
"name": "followingMode",
|
|
17033
|
+
"description": "Determines which telemetry elements to follow when the video layer is playing.",
|
|
17034
|
+
"type": "\"follow-both\" | \"follow-frame\" | \"follow-sensor\" | \"none\""
|
|
17035
|
+
},
|
|
16683
17036
|
{
|
|
16684
17037
|
"name": "hideHeader",
|
|
16685
17038
|
"description": "Indicates whether to display the video player's header information.",
|
|
@@ -16702,7 +17055,7 @@
|
|
|
16702
17055
|
},
|
|
16703
17056
|
{
|
|
16704
17057
|
"name": "messageOverrides",
|
|
16705
|
-
"description": "Replace localized message strings with your own strings
|
|
17058
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16706
17059
|
"type": "Record<string, unknown>"
|
|
16707
17060
|
},
|
|
16708
17061
|
{
|
|
@@ -16711,6 +17064,7 @@
|
|
|
16711
17064
|
},
|
|
16712
17065
|
{
|
|
16713
17066
|
"name": "referenceElement",
|
|
17067
|
+
"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
17068
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16715
17069
|
},
|
|
16716
17070
|
{
|
|
@@ -16739,7 +17093,7 @@
|
|
|
16739
17093
|
},
|
|
16740
17094
|
{
|
|
16741
17095
|
"name": "arcgis-weather",
|
|
16742
|
-
"description": "The Weather component
|
|
17096
|
+
"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
17097
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-weather/",
|
|
16744
17098
|
"attributes": [
|
|
16745
17099
|
{
|
|
@@ -16808,6 +17162,7 @@
|
|
|
16808
17162
|
},
|
|
16809
17163
|
{
|
|
16810
17164
|
"name": "reference-element",
|
|
17165
|
+
"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
17166
|
"value": {
|
|
16812
17167
|
"type": "string"
|
|
16813
17168
|
}
|
|
@@ -16865,7 +17220,7 @@
|
|
|
16865
17220
|
},
|
|
16866
17221
|
{
|
|
16867
17222
|
"name": "messageOverrides",
|
|
16868
|
-
"description": "Replace localized message strings with your own strings
|
|
17223
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
16869
17224
|
"type": "Record<string, unknown>"
|
|
16870
17225
|
},
|
|
16871
17226
|
{
|
|
@@ -16874,6 +17229,7 @@
|
|
|
16874
17229
|
},
|
|
16875
17230
|
{
|
|
16876
17231
|
"name": "referenceElement",
|
|
17232
|
+
"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
17233
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
16878
17234
|
},
|
|
16879
17235
|
{
|
|
@@ -16954,6 +17310,7 @@
|
|
|
16954
17310
|
},
|
|
16955
17311
|
{
|
|
16956
17312
|
"name": "reference-element",
|
|
17313
|
+
"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
17314
|
"value": {
|
|
16958
17315
|
"type": "string"
|
|
16959
17316
|
}
|
|
@@ -17006,7 +17363,7 @@
|
|
|
17006
17363
|
},
|
|
17007
17364
|
{
|
|
17008
17365
|
"name": "messageOverrides",
|
|
17009
|
-
"description": "Replace localized message strings with your own strings
|
|
17366
|
+
"description": "Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._",
|
|
17010
17367
|
"type": "Record<string, unknown>"
|
|
17011
17368
|
},
|
|
17012
17369
|
{
|
|
@@ -17015,6 +17372,7 @@
|
|
|
17015
17372
|
},
|
|
17016
17373
|
{
|
|
17017
17374
|
"name": "referenceElement",
|
|
17375
|
+
"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
17376
|
"type": "HTMLArcgisLinkChartElement | HTMLArcgisMapElement | HTMLArcgisSceneElement | string"
|
|
17019
17377
|
},
|
|
17020
17378
|
{
|