@arcgis/map-components 4.33.0-next.161 → 4.33.0-next.163
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/{OG6W7QCH.js → 2A4RYAIN.js} +2 -2
- package/dist/cdn/{KQYSSCFX.js → 2BPSFN2K.js} +2 -2
- package/dist/cdn/{C4ZTU2FS.js → 2C5JL6DO.js} +2 -2
- package/dist/cdn/{6HN3WPZU.js → 2PLEO7TO.js} +2 -2
- package/dist/cdn/{PVCLTYYJ.js → 2TM4J2HC.js} +2 -2
- package/dist/cdn/{4DZXO7CX.js → 2ZLZJUME.js} +2 -2
- package/dist/cdn/{R73JJZFN.js → 3ORNZSJG.js} +2 -2
- package/dist/cdn/{DTDS27QS.js → 3TEXQSG5.js} +2 -2
- package/dist/cdn/{7EC2DXND.js → 43ZTJD57.js} +2 -2
- package/dist/cdn/{ZXO6QHSZ.js → 44GOFRXG.js} +2 -2
- package/dist/cdn/{M4HIO6MK.js → 4H57JG34.js} +2 -2
- package/dist/cdn/{XWZQMDO5.js → 4HQ2RFD3.js} +2 -2
- package/dist/cdn/{VR2MVIE6.js → 4RNHVPLZ.js} +1 -1
- package/dist/cdn/{DXWJJUIM.js → 4UWZHYS2.js} +2 -2
- package/dist/cdn/{OWVH66PC.js → 4YGDO6GD.js} +2 -2
- package/dist/cdn/{WEOLD2D3.js → 4ZBS7BRR.js} +2 -2
- package/dist/cdn/{ISY3NJ6C.js → 4ZYIRQQU.js} +2 -2
- package/dist/cdn/{BNQB4UIX.js → 54YQ4ESE.js} +2 -2
- package/dist/cdn/{MNCLOG7A.js → 566EMTPB.js} +2 -2
- package/dist/cdn/{ODWCM6P6.js → 5GAKWQLJ.js} +2 -2
- package/dist/cdn/{5EUYSGKB.js → 75VV4YIS.js} +2 -2
- package/dist/cdn/{CDYMYLKD.js → 76TFSNAR.js} +2 -2
- package/dist/cdn/{ADKZ4NHF.js → 7R5ANPX3.js} +2 -2
- package/dist/cdn/{IK4UWPXO.js → 7WUX6M4U.js} +2 -2
- package/dist/cdn/{3WCXAGFW.js → AML3DNHD.js} +2 -2
- package/dist/cdn/{LZ5EN7FA.js → ASJVAATZ.js} +2 -2
- package/dist/cdn/{ZNLWAJB2.js → B4IFNJVQ.js} +2 -2
- package/dist/cdn/{ODLFEORZ.js → BROPAJES.js} +2 -2
- package/dist/cdn/{RTGYT7UD.js → BVVXESUQ.js} +2 -2
- package/dist/cdn/{3YOLDPNK.js → C3OP2OTB.js} +2 -2
- package/dist/cdn/{KFMIPW5E.js → CECYJ4XF.js} +2 -2
- package/dist/cdn/{Z37HGGZM.js → CK7I5P4C.js} +2 -2
- package/dist/cdn/{46LD6F7A.js → CKJNS7YB.js} +2 -2
- package/dist/cdn/{ICQGL7IW.js → CVIYSENP.js} +2 -2
- package/dist/cdn/{ZH5ADAAS.js → D2KDASCZ.js} +2 -2
- package/dist/cdn/{DDCJD534.js → D7ZVQG4A.js} +2 -2
- package/dist/cdn/{53LJYVB4.js → DDNQP7YC.js} +2 -2
- package/dist/cdn/{R4GO526O.js → DEKCGU76.js} +2 -2
- package/dist/cdn/{SYK66MOG.js → DJEQK3G5.js} +2 -2
- package/dist/cdn/{ALY3K3A7.js → DSKZY2NZ.js} +2 -2
- package/dist/cdn/{BJH7RRK5.js → DUGB7PK7.js} +2 -2
- package/dist/cdn/{T2YKVDNR.js → DURFPWUB.js} +2 -2
- package/dist/cdn/{XCUBEZIT.js → E2QKTSGJ.js} +2 -2
- package/dist/cdn/{TR2VTARW.js → E45YHEG2.js} +2 -2
- package/dist/cdn/{7COR2ZRA.js → ENT4AJB7.js} +2 -2
- package/dist/cdn/{AU2N4ZND.js → EXM5T74K.js} +2 -2
- package/dist/cdn/{HBLLEPUP.js → FCIBLXLX.js} +2 -2
- package/dist/cdn/{VAZQ7JV5.js → G72DSFRQ.js} +2 -2
- package/dist/cdn/{K3VCUDIY.js → GDDLERWA.js} +2 -2
- package/dist/cdn/{7DH6ZCGQ.js → GNTQCQ6K.js} +2 -2
- package/dist/cdn/{M4SN46VY.js → GZ55WLJI.js} +1 -1
- package/dist/cdn/{HLDUNQWI.js → HH66I244.js} +1 -1
- package/dist/cdn/{OPPJDIM4.js → HNXDPNMS.js} +2 -2
- package/dist/cdn/{TZLZDD6D.js → IA5S6ZIL.js} +2 -2
- package/dist/cdn/{MBPDVPRY.js → IIG64SHE.js} +2 -2
- package/dist/cdn/{JSHJP2OS.js → IJLIOVUG.js} +2 -2
- package/dist/cdn/{QQ5BLDX5.js → INF63V36.js} +2 -2
- package/dist/cdn/{7Q2NDXIV.js → IVZ5JFYF.js} +2 -2
- package/dist/cdn/{2Z2UGKIY.js → J3B7RYRA.js} +2 -2
- package/dist/cdn/{23JLKXWU.js → JA7MZAL4.js} +2 -2
- package/dist/cdn/{ICA22EMX.js → JCMVQZIH.js} +2 -2
- package/dist/cdn/{PH6XGDR2.js → JLMAQLRU.js} +2 -2
- package/dist/cdn/{CY7MECU5.js → KMZSQVAN.js} +2 -2
- package/dist/cdn/{TPJDMZEQ.js → KXK2TPWM.js} +1 -1
- package/dist/cdn/{UC3C23PX.js → LC5X6KRY.js} +2 -2
- package/dist/cdn/{RGZ7USCH.js → LFTMPZBR.js} +2 -2
- package/dist/cdn/{DDTYUZK2.js → LIUDKQEO.js} +2 -2
- package/dist/cdn/{2HVBIYZF.js → LJYZIIIZ.js} +2 -2
- package/dist/cdn/{Z6SXX4BK.js → LSVP4ALP.js} +2 -2
- package/dist/cdn/{JDEQO7YX.js → M2QPTJAY.js} +2 -2
- package/dist/cdn/{A6ABDZ33.js → M365EYNX.js} +2 -2
- package/dist/cdn/{EDPHB6V6.js → M7O2UKFZ.js} +2 -2
- package/dist/cdn/{BQVUWGRT.js → MTTYGBML.js} +2 -2
- package/dist/cdn/{COYH3BQJ.js → N7AZI3RG.js} +2 -2
- package/dist/cdn/{ILSC5Y5S.js → OVQ2FBI3.js} +2 -2
- package/dist/cdn/{3FWMW3J4.js → P7W4KR2N.js} +2 -2
- package/dist/cdn/{4Y3G5SNJ.js → P7XTL3VO.js} +2 -2
- package/dist/cdn/{FTX6Z63F.js → PNSZ7F45.js} +2 -2
- package/dist/cdn/{PQJ3D5V6.js → POZ5PCSD.js} +2 -2
- package/dist/cdn/{LJXCS7LQ.js → Q6CWOGIH.js} +2 -2
- package/dist/cdn/{BUCNNWYY.js → QAUQTL4Y.js} +2 -2
- package/dist/cdn/{PPPPYGPK.js → QOIZDUGS.js} +2 -2
- package/dist/cdn/{CVT5JNQG.js → QUU2SSOG.js} +2 -2
- package/dist/cdn/{5GF32TCC.js → R2N3C5JM.js} +2 -2
- package/dist/cdn/{LO6SS5JH.js → R5QSYBPN.js} +2 -2
- package/dist/cdn/{PWO2OVIO.js → RDBDWVBS.js} +2 -2
- package/dist/cdn/{MADGRIVR.js → RKNEIQKF.js} +2 -2
- package/dist/cdn/{N6NZTUCP.js → RO6O65ZA.js} +2 -2
- package/dist/cdn/{HYCT3YL2.js → RPM2DPRY.js} +2 -2
- package/dist/cdn/{5CNLMYQQ.js → RXLPCUXL.js} +2 -2
- package/dist/cdn/{GQBLKHTF.js → S3AKEUNL.js} +2 -2
- package/dist/cdn/{ERNACX23.js → S7FTNK4D.js} +2 -2
- package/dist/cdn/{3OS2BWTL.js → SCO36YQJ.js} +2 -2
- package/dist/cdn/{Z7L344Z7.js → STJWAIHS.js} +2 -2
- package/dist/cdn/{PD5ZWQ2P.js → SY2NVTB3.js} +2 -2
- package/dist/cdn/{KA7V6F7X.js → TNV4ESNY.js} +2 -2
- package/dist/cdn/{SG4INYAW.js → U5HBVCUH.js} +2 -2
- package/dist/cdn/{OGBNBQQX.js → UGDDRBLD.js} +2 -2
- package/dist/cdn/{2RUFFWN6.js → UIGLTPI2.js} +2 -2
- package/dist/cdn/{API2TUGS.js → UOOW2UAV.js} +2 -2
- package/dist/cdn/{JY6PDKSN.js → UT4FW7UU.js} +2 -2
- package/dist/cdn/{BK3SOS5S.js → UX7C7JO6.js} +2 -2
- package/dist/cdn/{HGEHL2MC.js → W43IMQPK.js} +2 -2
- package/dist/cdn/{VMO3KYDL.js → W7GVNXNB.js} +2 -2
- package/dist/cdn/{BRKDMDU4.js → WXC27O2B.js} +2 -2
- package/dist/cdn/{ICRFPO5Y.js → X6GQNGLK.js} +1 -1
- package/dist/cdn/{I2RBWNC4.js → XCDMDCOP.js} +2 -2
- package/dist/cdn/{Q66GTFXX.js → XLNB6VAT.js} +2 -2
- package/dist/cdn/{XNAEECAE.js → XYAXUXVM.js} +1 -1
- package/dist/cdn/{ZKGZBZ33.js → Y47VIODW.js} +2 -2
- package/dist/cdn/{GHWR7VAH.js → YCVMZZPV.js} +1 -1
- package/dist/cdn/{OV46R3D5.js → YMYVVTIE.js} +2 -2
- package/dist/cdn/{UCLEN5RI.js → YUY5GP2E.js} +2 -2
- package/dist/cdn/{FEEIM5TH.js → YX7ZXCDM.js} +2 -2
- package/dist/cdn/{LV6JYUMR.js → ZDUYWTU4.js} +2 -2
- package/dist/cdn/{SW3JBLR5.js → ZFQOEYRZ.js} +2 -2
- package/dist/cdn/{S5F5K4KE.js → ZISJYZSE.js} +2 -2
- package/dist/cdn/{ZJNQCL3I.js → ZKO2JNDF.js} +2 -2
- package/dist/cdn/{CPPD6SYN.js → ZSQOHH5X.js} +1 -1
- package/dist/cdn/index.js +2 -2
- package/dist/chunks/AnalysisViewModel.js +1 -1
- package/dist/chunks/async-utils.js +1 -1
- package/dist/chunks/basemap-gallery-resources.js +1 -1
- package/dist/chunks/component-utils.js +1 -1
- package/dist/chunks/createCloseEvent.js +1 -1
- package/dist/chunks/globalCss.js +1 -1
- package/dist/chunks/heading.js +1 -1
- package/dist/chunks/layer-list.js +1 -1
- package/dist/chunks/legacyIcon.js +1 -1
- package/dist/chunks/maybe.js +1 -1
- package/dist/chunks/measurementUtils.js +1 -1
- package/dist/chunks/runtime.js +1 -1
- package/dist/chunks/useHandles.js +1 -1
- package/dist/chunks/useT9n.js +1 -1
- package/dist/chunks/useView.js +1 -1
- package/dist/chunks/useViewModel.js +1 -1
- package/dist/chunks/useWidget.js +1 -1
- package/dist/chunks/utils.js +1 -1
- package/dist/components/arcgis-area-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-area-measurement-3d/customElement.d.ts +102 -6
- package/dist/components/arcgis-area-measurement-3d/customElement.js +1 -1
- package/dist/components/arcgis-attachments/customElement.js +1 -1
- package/dist/components/arcgis-basemap-gallery/customElement.js +1 -1
- package/dist/components/arcgis-basemap-gallery-item/customElement.js +1 -1
- package/dist/components/arcgis-basemap-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-basemap-toggle/customElement.js +1 -1
- package/dist/components/arcgis-bookmarks/customElement.js +1 -1
- package/dist/components/arcgis-building-explorer/customElement.d.ts +20 -15
- package/dist/components/arcgis-building-explorer/customElement.js +1 -1
- package/dist/components/arcgis-catalog-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-compass/customElement.js +1 -1
- package/dist/components/arcgis-coordinate-conversion/customElement.js +1 -1
- package/dist/components/arcgis-daylight/customElement.d.ts +12 -11
- package/dist/components/arcgis-daylight/customElement.js +1 -1
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.d.ts +104 -7
- package/dist/components/arcgis-direct-line-measurement-3d/customElement.js +1 -1
- package/dist/components/arcgis-directional-pad/customElement.js +1 -1
- package/dist/components/arcgis-directions/customElement.d.ts +1 -1
- package/dist/components/arcgis-directions/customElement.js +1 -1
- package/dist/components/arcgis-distance-measurement-2d/customElement.js +1 -1
- package/dist/components/arcgis-editor/customElement.js +1 -1
- package/dist/components/arcgis-elevation-profile/customElement.d.ts +14 -23
- package/dist/components/arcgis-elevation-profile/customElement.js +1 -1
- package/dist/components/arcgis-expand/customElement.js +1 -1
- package/dist/components/arcgis-feature/customElement.js +1 -1
- package/dist/components/arcgis-feature-form/customElement.js +1 -1
- package/dist/components/arcgis-feature-table/customElement.js +1 -1
- package/dist/components/arcgis-feature-templates/customElement.js +1 -1
- package/dist/components/arcgis-features/customElement.js +1 -1
- package/dist/components/arcgis-floor-filter/customElement.js +1 -1
- package/dist/components/arcgis-fullscreen/customElement.js +1 -1
- package/dist/components/arcgis-grid-controls/customElement.js +1 -1
- package/dist/components/arcgis-histogram-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-home/customElement.js +1 -1
- package/dist/components/arcgis-labeled-switch/customElement.js +1 -1
- package/dist/components/arcgis-layer-list/customElement.js +1 -1
- package/dist/components/arcgis-layer-list-item/customElement.js +1 -1
- package/dist/components/arcgis-legend/customElement.js +1 -1
- package/dist/components/arcgis-line-of-sight/customElement.d.ts +5 -4
- package/dist/components/arcgis-line-of-sight/customElement.js +1 -1
- package/dist/components/arcgis-link-chart/customElement.js +1 -1
- package/dist/components/arcgis-link-chart-layout-switcher/customElement.js +1 -1
- package/dist/components/arcgis-locate/customElement.js +1 -1
- package/dist/components/arcgis-map/customElement.js +1 -1
- package/dist/components/arcgis-measurement/customElement.js +1 -1
- package/dist/components/arcgis-measurement-content/customElement.js +1 -1
- package/dist/components/arcgis-navigation-toggle/customElement.d.ts +6 -7
- package/dist/components/arcgis-navigation-toggle/customElement.js +1 -1
- package/dist/components/arcgis-oriented-imagery-viewer/customElement.js +1 -1
- package/dist/components/arcgis-placement/customElement.js +1 -1
- package/dist/components/arcgis-print/customElement.js +1 -1
- package/dist/components/arcgis-print-custom-text-elements/customElement.js +1 -1
- package/dist/components/arcgis-print-dpi-input/customElement.js +1 -1
- package/dist/components/arcgis-print-export-button/customElement.js +1 -1
- package/dist/components/arcgis-print-exported-link/customElement.js +1 -1
- package/dist/components/arcgis-print-exports-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-format-select/customElement.js +1 -1
- package/dist/components/arcgis-print-layout-advanced-options/customElement.js +1 -1
- package/dist/components/arcgis-print-layout-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-main-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-map-only-advanced-options/customElement.js +1 -1
- package/dist/components/arcgis-print-map-only-panel/customElement.js +1 -1
- package/dist/components/arcgis-print-out-spatial-reference-input/customElement.js +1 -1
- package/dist/components/arcgis-print-preview-input/customElement.js +1 -1
- package/dist/components/arcgis-print-scale-section/customElement.js +1 -1
- package/dist/components/arcgis-print-template-select/customElement.js +1 -1
- package/dist/components/arcgis-print-template-selector/customElement.js +1 -1
- package/dist/components/arcgis-scale-bar/customElement.js +1 -1
- package/dist/components/arcgis-scale-range-slider/customElement.js +1 -1
- package/dist/components/arcgis-scene/customElement.d.ts +28 -43
- package/dist/components/arcgis-scene/customElement.js +1 -1
- package/dist/components/arcgis-search/customElement.d.ts +1 -1
- package/dist/components/arcgis-search/customElement.js +1 -1
- package/dist/components/arcgis-search-result-renderer/customElement.js +1 -1
- package/dist/components/arcgis-shadow-cast/customElement.d.ts +19 -25
- package/dist/components/arcgis-shadow-cast/customElement.js +1 -1
- package/dist/components/arcgis-sketch/customElement.js +1 -1
- package/dist/components/arcgis-slice/customElement.d.ts +59 -14
- package/dist/components/arcgis-slice/customElement.js +1 -1
- package/dist/components/arcgis-slider/customElement.js +1 -1
- package/dist/components/arcgis-swipe/customElement.js +1 -1
- package/dist/components/arcgis-table-list/customElement.js +1 -1
- package/dist/components/arcgis-time-slider/customElement.js +1 -1
- package/dist/components/arcgis-time-zone-label/customElement.js +1 -1
- package/dist/components/arcgis-track/customElement.js +1 -1
- package/dist/components/arcgis-unit-select/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-associations/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-trace/customElement.js +1 -1
- package/dist/components/arcgis-utility-network-validate-topology/customElement.js +1 -1
- package/dist/components/arcgis-value-picker/customElement.js +1 -1
- package/dist/components/arcgis-version-management/customElement.js +1 -1
- package/dist/components/arcgis-version-management-service-item/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-item/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-list/customElement.js +1 -1
- package/dist/components/arcgis-version-management-version-properties/customElement.js +1 -1
- package/dist/components/arcgis-video/customElement.js +1 -1
- package/dist/components/arcgis-video-player/customElement.js +1 -1
- package/dist/components/arcgis-video-player-action-bar/customElement.js +1 -1
- package/dist/components/arcgis-video-player-actions-group/customElement.js +1 -1
- package/dist/components/arcgis-video-player-controls-group/customElement.js +1 -1
- package/dist/components/arcgis-video-player-metadata/customElement.js +1 -1
- package/dist/components/arcgis-video-player-settings/customElement.js +1 -1
- package/dist/components/arcgis-video-player-slider/customElement.js +1 -1
- package/dist/components/arcgis-weather/customElement.d.ts +5 -1
- package/dist/components/arcgis-weather/customElement.js +1 -1
- package/dist/components/arcgis-zoom/customElement.js +1 -1
- package/dist/docs/api.json +114 -128
- package/dist/docs/docs.json +83 -103
- package/dist/docs/vscode.html-custom-data.json +42 -40
- package/dist/docs/web-types.json +101 -97
- package/dist/index.js +1 -1
- package/dist/loader.js +1 -1
- package/package.json +3 -3
|
@@ -144,7 +144,7 @@
|
|
|
144
144
|
},
|
|
145
145
|
{
|
|
146
146
|
"name": "arcgis-area-measurement-3d",
|
|
147
|
-
"description": "The Area Measurement 3D component calculates and displays the area and perimeter of a polygon.\
|
|
147
|
+
"description": "The Area Measurement 3D component calculates and displays the area and perimeter of a polygon.\nIt can be used in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent to measure the area and perimeter of a polygon.\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 more or less **coplanar** (aligning onto a horizontal or a sloped plane),\n the area and perimeter are projected to that plane. Also, the measurements are computed on that plane.\n2. If the vertices have varying z-values and they create a **non-planar** surface, the visualization and the\nmeasurements show the area and perimeter that are projected to a horizontal plane.\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\nThe 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\n**Things to consider**\n\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- [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.",
|
|
148
148
|
"attributes": [
|
|
149
149
|
{
|
|
150
150
|
"name": "auto-destroy-disabled",
|
|
@@ -200,7 +200,7 @@
|
|
|
200
200
|
},
|
|
201
201
|
{
|
|
202
202
|
"name": "state",
|
|
203
|
-
"description": "The
|
|
203
|
+
"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",
|
|
204
204
|
"values": [
|
|
205
205
|
{
|
|
206
206
|
"name": "disabled"
|
|
@@ -218,7 +218,7 @@
|
|
|
218
218
|
},
|
|
219
219
|
{
|
|
220
220
|
"name": "unit",
|
|
221
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the
|
|
221
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
222
222
|
"values": [
|
|
223
223
|
{
|
|
224
224
|
"name": "acres"
|
|
@@ -974,7 +974,7 @@
|
|
|
974
974
|
},
|
|
975
975
|
{
|
|
976
976
|
"name": "arcgis-building-explorer",
|
|
977
|
-
"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.",
|
|
977
|
+
"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.",
|
|
978
978
|
"attributes": [
|
|
979
979
|
{
|
|
980
980
|
"name": "auto-destroy-disabled",
|
|
@@ -983,7 +983,7 @@
|
|
|
983
983
|
},
|
|
984
984
|
{
|
|
985
985
|
"name": "heading-level",
|
|
986
|
-
"description": "Indicates the heading level to use for the
|
|
986
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
987
987
|
"values": []
|
|
988
988
|
},
|
|
989
989
|
{
|
|
@@ -1000,12 +1000,12 @@
|
|
|
1000
1000
|
},
|
|
1001
1001
|
{
|
|
1002
1002
|
"name": "icon",
|
|
1003
|
-
"description": "Icon which represents the
|
|
1003
|
+
"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/)",
|
|
1004
1004
|
"values": []
|
|
1005
1005
|
},
|
|
1006
1006
|
{
|
|
1007
1007
|
"name": "label",
|
|
1008
|
-
"description": "The
|
|
1008
|
+
"description": "The component's default label.",
|
|
1009
1009
|
"values": []
|
|
1010
1010
|
},
|
|
1011
1011
|
{
|
|
@@ -1047,7 +1047,7 @@
|
|
|
1047
1047
|
},
|
|
1048
1048
|
{
|
|
1049
1049
|
"name": "state",
|
|
1050
|
-
"description": "The
|
|
1050
|
+
"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",
|
|
1051
1051
|
"values": [
|
|
1052
1052
|
{
|
|
1053
1053
|
"name": "disabled"
|
|
@@ -1488,7 +1488,7 @@
|
|
|
1488
1488
|
},
|
|
1489
1489
|
{
|
|
1490
1490
|
"name": "arcgis-daylight",
|
|
1491
|
-
"description": "The Daylight component can be used to manipulate the lighting conditions of a [
|
|
1491
|
+
"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\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.",
|
|
1492
1492
|
"attributes": [
|
|
1493
1493
|
{
|
|
1494
1494
|
"name": "auto-destroy-disabled",
|
|
@@ -1515,7 +1515,7 @@
|
|
|
1515
1515
|
},
|
|
1516
1516
|
{
|
|
1517
1517
|
"name": "date-or-season",
|
|
1518
|
-
"description": "Controls whether the
|
|
1518
|
+
"description": "Controls whether the component displays a date or a season picker.",
|
|
1519
1519
|
"values": [
|
|
1520
1520
|
{
|
|
1521
1521
|
"name": "date"
|
|
@@ -1532,7 +1532,7 @@
|
|
|
1532
1532
|
},
|
|
1533
1533
|
{
|
|
1534
1534
|
"name": "heading-level",
|
|
1535
|
-
"description": "Indicates the heading level to use for the
|
|
1535
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1536
1536
|
"values": []
|
|
1537
1537
|
},
|
|
1538
1538
|
{
|
|
@@ -1561,12 +1561,12 @@
|
|
|
1561
1561
|
},
|
|
1562
1562
|
{
|
|
1563
1563
|
"name": "icon",
|
|
1564
|
-
"description": "Icon which represents the
|
|
1564
|
+
"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/)",
|
|
1565
1565
|
"values": []
|
|
1566
1566
|
},
|
|
1567
1567
|
{
|
|
1568
1568
|
"name": "label",
|
|
1569
|
-
"description": "The
|
|
1569
|
+
"description": "The component's default label.",
|
|
1570
1570
|
"values": []
|
|
1571
1571
|
},
|
|
1572
1572
|
{
|
|
@@ -1925,7 +1925,7 @@
|
|
|
1925
1925
|
},
|
|
1926
1926
|
{
|
|
1927
1927
|
"name": "arcgis-direct-line-measurement-3d",
|
|
1928
|
-
"description": "The Direct Line Measurement 3D component calculates and displays the 3D distance between two points
|
|
1928
|
+
"description": "The Direct Line Measurement 3D component calculates and displays the 3D distance between two points.\nIt can be used in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/)\ncomponent to measure the vertical, horizontal, and direct distance 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\nDirectLineMeasurement3D widget 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 widget 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\nThe 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\n**Things to consider**\n\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.",
|
|
1929
1929
|
"attributes": [
|
|
1930
1930
|
{
|
|
1931
1931
|
"name": "auto-destroy-disabled",
|
|
@@ -1981,6 +1981,7 @@
|
|
|
1981
1981
|
},
|
|
1982
1982
|
{
|
|
1983
1983
|
"name": "state",
|
|
1984
|
+
"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",
|
|
1984
1985
|
"values": [
|
|
1985
1986
|
{
|
|
1986
1987
|
"name": "disabled"
|
|
@@ -1998,7 +1999,7 @@
|
|
|
1998
1999
|
},
|
|
1999
2000
|
{
|
|
2000
2001
|
"name": "unit",
|
|
2001
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
2002
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
2002
2003
|
"values": [
|
|
2003
2004
|
{
|
|
2004
2005
|
"name": "centimeters"
|
|
@@ -2055,7 +2056,7 @@
|
|
|
2055
2056
|
},
|
|
2056
2057
|
{
|
|
2057
2058
|
"name": "arcgis-directline-measurement-3d",
|
|
2058
|
-
"description": "**Deprecated**. The
|
|
2059
|
+
"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.",
|
|
2059
2060
|
"attributes": [
|
|
2060
2061
|
{
|
|
2061
2062
|
"name": "auto-destroy-disabled",
|
|
@@ -2111,6 +2112,7 @@
|
|
|
2111
2112
|
},
|
|
2112
2113
|
{
|
|
2113
2114
|
"name": "state",
|
|
2115
|
+
"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",
|
|
2114
2116
|
"values": [
|
|
2115
2117
|
{
|
|
2116
2118
|
"name": "disabled"
|
|
@@ -2128,7 +2130,7 @@
|
|
|
2128
2130
|
},
|
|
2129
2131
|
{
|
|
2130
2132
|
"name": "unit",
|
|
2131
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
2133
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
2132
2134
|
"values": [
|
|
2133
2135
|
{
|
|
2134
2136
|
"name": "centimeters"
|
|
@@ -2529,12 +2531,12 @@
|
|
|
2529
2531
|
},
|
|
2530
2532
|
{
|
|
2531
2533
|
"name": "icon",
|
|
2532
|
-
"description": "Icon which represents the
|
|
2534
|
+
"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/)",
|
|
2533
2535
|
"values": []
|
|
2534
2536
|
},
|
|
2535
2537
|
{
|
|
2536
2538
|
"name": "label",
|
|
2537
|
-
"description": "The
|
|
2539
|
+
"description": "The component's default label.",
|
|
2538
2540
|
"values": []
|
|
2539
2541
|
},
|
|
2540
2542
|
{
|
|
@@ -2576,7 +2578,7 @@
|
|
|
2576
2578
|
},
|
|
2577
2579
|
{
|
|
2578
2580
|
"name": "state",
|
|
2579
|
-
"description": "The
|
|
2581
|
+
"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",
|
|
2580
2582
|
"values": [
|
|
2581
2583
|
{
|
|
2582
2584
|
"name": "created"
|
|
@@ -4686,7 +4688,7 @@
|
|
|
4686
4688
|
},
|
|
4687
4689
|
{
|
|
4688
4690
|
"name": "arcgis-line-of-sight",
|
|
4689
|
-
"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 3D view. Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including ground, integrated meshes, and 3D objects such as buildings or trees.\n\nThe results from the analysis are displayed as lines, where the visible part, indicating what the observer can see,\nis colored green. Visible targets are displayed with a green sphere and a fully green line of sight.\nThe spheres marking occluded targets are displayed red, as are the occluded parts of the lines of sight.\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 with the component, the first click in the scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html)\nand any further clicks place the [targets](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html).\nBoth, observer and target points, can be moved by dragging them. Additionally, the target points can be removed with a right click.\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()](
|
|
4691
|
+
"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 3D view. Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including ground, integrated meshes, and 3D objects such as buildings or trees.\n\nThe results from the analysis are displayed as lines, where the visible part, indicating what the observer can see,\nis colored green. Visible targets are displayed with a green sphere and a fully green line of sight.\nThe spheres marking occluded targets are displayed red, as are the occluded parts of the lines of sight.\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 with the component, the first click in the scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisObserver.html)\nand any further clicks place the [targets](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html).\nBoth, observer and target points, can be moved by dragging them. Additionally, the target points can be removed with a right click.\n\n**Known limitations**\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\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 line of sight analysis, keeping the results in the view.\nUsers can still interact with existing targets and the observer but they cannot place new target points.",
|
|
4690
4692
|
"attributes": [
|
|
4691
4693
|
{
|
|
4692
4694
|
"name": "auto-destroy-disabled",
|
|
@@ -5388,7 +5390,7 @@
|
|
|
5388
5390
|
},
|
|
5389
5391
|
{
|
|
5390
5392
|
"name": "arcgis-navigation-toggle",
|
|
5391
|
-
"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\
|
|
5393
|
+
"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>`",
|
|
5392
5394
|
"attributes": [
|
|
5393
5395
|
{
|
|
5394
5396
|
"name": "icon",
|
|
@@ -5414,7 +5416,7 @@
|
|
|
5414
5416
|
},
|
|
5415
5417
|
{
|
|
5416
5418
|
"name": "navigation-mode",
|
|
5417
|
-
"description": "The navigation mode of the view.
|
|
5419
|
+
"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.",
|
|
5418
5420
|
"values": [
|
|
5419
5421
|
{
|
|
5420
5422
|
"name": "pan"
|
|
@@ -6049,7 +6051,7 @@
|
|
|
6049
6051
|
},
|
|
6050
6052
|
{
|
|
6051
6053
|
"name": "arcgis-scene",
|
|
6052
|
-
"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- **arcgisAnalysisViewCreate** - 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- **arcgisAnalysisViewCreateError** - 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- **arcgisAnalysisViewDestroy** - 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:\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```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](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```js\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://next.sites.afd.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://next.sites.afd.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://next.sites.afd.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://next.sites.afd.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```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): 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)",
|
|
6054
|
+
"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\n**See also**\n\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- **arcgisAnalysisViewCreate** - 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- **arcgisAnalysisViewCreateError** - 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- **arcgisAnalysisViewDestroy** - 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```js\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://next.sites.afd.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://next.sites.afd.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://next.sites.afd.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://next.sites.afd.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): 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)",
|
|
6053
6055
|
"attributes": [
|
|
6054
6056
|
{
|
|
6055
6057
|
"name": "alpha-compositing-enabled",
|
|
@@ -6068,27 +6070,27 @@
|
|
|
6068
6070
|
},
|
|
6069
6071
|
{
|
|
6070
6072
|
"name": "camera-fov",
|
|
6071
|
-
"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()](
|
|
6073
|
+
"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)",
|
|
6072
6074
|
"values": []
|
|
6073
6075
|
},
|
|
6074
6076
|
{
|
|
6075
6077
|
"name": "camera-heading",
|
|
6076
|
-
"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()](
|
|
6078
|
+
"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)",
|
|
6077
6079
|
"values": []
|
|
6078
6080
|
},
|
|
6079
6081
|
{
|
|
6080
6082
|
"name": "camera-position",
|
|
6081
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
6083
|
+
"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)",
|
|
6082
6084
|
"values": []
|
|
6083
6085
|
},
|
|
6084
6086
|
{
|
|
6085
6087
|
"name": "camera-tilt",
|
|
6086
|
-
"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()](
|
|
6088
|
+
"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)",
|
|
6087
6089
|
"values": []
|
|
6088
6090
|
},
|
|
6089
6091
|
{
|
|
6090
6092
|
"name": "center",
|
|
6091
|
-
"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()](
|
|
6093
|
+
"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)",
|
|
6092
6094
|
"values": []
|
|
6093
6095
|
},
|
|
6094
6096
|
{
|
|
@@ -6113,7 +6115,7 @@
|
|
|
6113
6115
|
},
|
|
6114
6116
|
{
|
|
6115
6117
|
"name": "quality-profile",
|
|
6116
|
-
"description": "
|
|
6118
|
+
"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)",
|
|
6117
6119
|
"values": [
|
|
6118
6120
|
{
|
|
6119
6121
|
"name": "high"
|
|
@@ -6128,7 +6130,7 @@
|
|
|
6128
6130
|
},
|
|
6129
6131
|
{
|
|
6130
6132
|
"name": "scale",
|
|
6131
|
-
"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()](
|
|
6133
|
+
"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)",
|
|
6132
6134
|
"values": []
|
|
6133
6135
|
},
|
|
6134
6136
|
{
|
|
@@ -6150,7 +6152,7 @@
|
|
|
6150
6152
|
},
|
|
6151
6153
|
{
|
|
6152
6154
|
"name": "zoom",
|
|
6153
|
-
"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()](
|
|
6155
|
+
"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)",
|
|
6154
6156
|
"values": []
|
|
6155
6157
|
}
|
|
6156
6158
|
],
|
|
@@ -6303,7 +6305,7 @@
|
|
|
6303
6305
|
},
|
|
6304
6306
|
{
|
|
6305
6307
|
"name": "state",
|
|
6306
|
-
"description": "The current state
|
|
6308
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
6307
6309
|
"values": [
|
|
6308
6310
|
{
|
|
6309
6311
|
"name": "disabled"
|
|
@@ -6355,7 +6357,7 @@
|
|
|
6355
6357
|
},
|
|
6356
6358
|
{
|
|
6357
6359
|
"name": "arcgis-shadow-cast",
|
|
6358
|
-
"description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [
|
|
6360
|
+
"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/).\n\n**Known limitations**\n\nShadow Cast 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.\n- `getDuration(point: __esri.Point): Promise<number>`\n- `start(): Promise<void>`\n- `stop(): Promise<void>`",
|
|
6359
6361
|
"attributes": [
|
|
6360
6362
|
{
|
|
6361
6363
|
"name": "auto-destroy-disabled",
|
|
@@ -6418,12 +6420,12 @@
|
|
|
6418
6420
|
},
|
|
6419
6421
|
{
|
|
6420
6422
|
"name": "icon",
|
|
6421
|
-
"description": "Icon which represents the
|
|
6423
|
+
"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/)",
|
|
6422
6424
|
"values": []
|
|
6423
6425
|
},
|
|
6424
6426
|
{
|
|
6425
6427
|
"name": "label",
|
|
6426
|
-
"description": "The
|
|
6428
|
+
"description": "The component's default label.",
|
|
6427
6429
|
"values": []
|
|
6428
6430
|
},
|
|
6429
6431
|
{
|
|
@@ -6470,7 +6472,7 @@
|
|
|
6470
6472
|
},
|
|
6471
6473
|
{
|
|
6472
6474
|
"name": "state",
|
|
6473
|
-
"description": "The
|
|
6475
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
6474
6476
|
"values": [
|
|
6475
6477
|
{
|
|
6476
6478
|
"name": "disabled"
|
|
@@ -6482,7 +6484,7 @@
|
|
|
6482
6484
|
},
|
|
6483
6485
|
{
|
|
6484
6486
|
"name": "utc-offset",
|
|
6485
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
6487
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
6486
6488
|
"values": []
|
|
6487
6489
|
},
|
|
6488
6490
|
{
|
|
@@ -6787,7 +6789,7 @@
|
|
|
6787
6789
|
},
|
|
6788
6790
|
{
|
|
6789
6791
|
"name": "arcgis-slice",
|
|
6790
|
-
"description": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a
|
|
6792
|
+
"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\nWhen interactively creating a new slice, the Shift key can be held to force the slice to be applied vertically.\n\n**Known limitations**\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).",
|
|
6791
6793
|
"attributes": [
|
|
6792
6794
|
{
|
|
6793
6795
|
"name": "auto-destroy-disabled",
|
|
@@ -8491,7 +8493,7 @@
|
|
|
8491
8493
|
},
|
|
8492
8494
|
{
|
|
8493
8495
|
"name": "arcgis-weather",
|
|
8494
|
-
"description": "The Weather component provides an interface for easily selecting and configuring the weather effects in a [
|
|
8496
|
+
"description": "The Weather component provides an interface for easily selecting and configuring the weather effects in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\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\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.",
|
|
8495
8497
|
"attributes": [
|
|
8496
8498
|
{
|
|
8497
8499
|
"name": "auto-destroy-disabled",
|