@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
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.33.0-next.
|
|
4
|
+
"version": "4.33.0-next.163",
|
|
5
5
|
"description-markup": "markdown",
|
|
6
6
|
"contributions": {
|
|
7
7
|
"html": {
|
|
@@ -171,7 +171,7 @@
|
|
|
171
171
|
},
|
|
172
172
|
{
|
|
173
173
|
"name": "arcgis-area-measurement-3d",
|
|
174
|
-
"description": "The Area Measurement 3D component calculates and displays the area and perimeter of a polygon.\
|
|
174
|
+
"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.",
|
|
175
175
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/",
|
|
176
176
|
"attributes": [
|
|
177
177
|
{
|
|
@@ -223,7 +223,7 @@
|
|
|
223
223
|
},
|
|
224
224
|
{
|
|
225
225
|
"name": "state",
|
|
226
|
-
"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",
|
|
227
227
|
"value": {
|
|
228
228
|
"type": [
|
|
229
229
|
"\"disabled\"",
|
|
@@ -235,7 +235,7 @@
|
|
|
235
235
|
},
|
|
236
236
|
{
|
|
237
237
|
"name": "unit",
|
|
238
|
-
"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).",
|
|
239
239
|
"value": {
|
|
240
240
|
"type": [
|
|
241
241
|
"\"acres\"",
|
|
@@ -274,7 +274,7 @@
|
|
|
274
274
|
"properties": [
|
|
275
275
|
{
|
|
276
276
|
"name": "analysis",
|
|
277
|
-
"description": "
|
|
277
|
+
"description": "The [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\ncreated or modified by the component.\n\nIf no programmatically created analysis is provided, the component automatically creates an empty analysis on its own and adds it to the view.\nIn this case, the analysis will also be automatically removed from the view when the component is destroyed.\n\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 view component.\nviewElement.analyses.add(areaMeasurementAnalysis);\n// Connect the analysis to the measurement component:\nareaMeasurement3d.analysis = areaMeasurementAnalysis;\n```",
|
|
278
278
|
"type": "AreaMeasurementAnalysis"
|
|
279
279
|
},
|
|
280
280
|
{
|
|
@@ -303,17 +303,17 @@
|
|
|
303
303
|
},
|
|
304
304
|
{
|
|
305
305
|
"name": "state",
|
|
306
|
-
"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",
|
|
307
307
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
308
308
|
},
|
|
309
309
|
{
|
|
310
310
|
"name": "unit",
|
|
311
|
-
"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).",
|
|
312
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\""
|
|
313
313
|
},
|
|
314
314
|
{
|
|
315
315
|
"name": "unitOptions",
|
|
316
|
-
"description": "List of unit systems (imperial, metric)
|
|
316
|
+
"description": "List of available units and unit systems (imperial, metric) for displaying the area values.\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.\nWith this, it is possible to limit which options are shown in the component's dropdown.",
|
|
317
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\">"
|
|
318
318
|
}
|
|
319
319
|
],
|
|
@@ -1717,7 +1717,7 @@
|
|
|
1717
1717
|
},
|
|
1718
1718
|
{
|
|
1719
1719
|
"name": "arcgis-building-explorer",
|
|
1720
|
-
"description": "The Building Explorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
1720
|
+
"description": "The Building Explorer component is used to filter and explore the various components of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.\n\n**Known limitations**\n\nBuilding Explorer is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.",
|
|
1721
1721
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/",
|
|
1722
1722
|
"attributes": [
|
|
1723
1723
|
{
|
|
@@ -1730,7 +1730,7 @@
|
|
|
1730
1730
|
},
|
|
1731
1731
|
{
|
|
1732
1732
|
"name": "heading-level",
|
|
1733
|
-
"description": "Indicates the heading level to use for the
|
|
1733
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1734
1734
|
"default": "3",
|
|
1735
1735
|
"value": {
|
|
1736
1736
|
"type": "number"
|
|
@@ -1759,7 +1759,7 @@
|
|
|
1759
1759
|
},
|
|
1760
1760
|
{
|
|
1761
1761
|
"name": "icon",
|
|
1762
|
-
"description": "Icon which represents the
|
|
1762
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
1763
1763
|
"default": "\"organization\"",
|
|
1764
1764
|
"value": {
|
|
1765
1765
|
"type": "string"
|
|
@@ -1767,7 +1767,7 @@
|
|
|
1767
1767
|
},
|
|
1768
1768
|
{
|
|
1769
1769
|
"name": "label",
|
|
1770
|
-
"description": "The
|
|
1770
|
+
"description": "The component's default label.",
|
|
1771
1771
|
"value": {
|
|
1772
1772
|
"type": "string"
|
|
1773
1773
|
}
|
|
@@ -1798,7 +1798,7 @@
|
|
|
1798
1798
|
},
|
|
1799
1799
|
{
|
|
1800
1800
|
"name": "state",
|
|
1801
|
-
"description": "The
|
|
1801
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - \tcomponent is being created\n* `loading` - layers and statistics are loading\n* `ready` - component is ready\n* `failed` - component failed to load data",
|
|
1802
1802
|
"default": "\"disabled\"",
|
|
1803
1803
|
"value": {
|
|
1804
1804
|
"type": [
|
|
@@ -1831,7 +1831,7 @@
|
|
|
1831
1831
|
},
|
|
1832
1832
|
{
|
|
1833
1833
|
"name": "headingLevel",
|
|
1834
|
-
"description": "Indicates the heading level to use for the
|
|
1834
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
1835
1835
|
"type": "number"
|
|
1836
1836
|
},
|
|
1837
1837
|
{
|
|
@@ -1848,17 +1848,17 @@
|
|
|
1848
1848
|
},
|
|
1849
1849
|
{
|
|
1850
1850
|
"name": "icon",
|
|
1851
|
-
"description": "Icon which represents the
|
|
1851
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
1852
1852
|
"type": "string"
|
|
1853
1853
|
},
|
|
1854
1854
|
{
|
|
1855
1855
|
"name": "label",
|
|
1856
|
-
"description": "The
|
|
1856
|
+
"description": "The component's default label.",
|
|
1857
1857
|
"type": "string"
|
|
1858
1858
|
},
|
|
1859
1859
|
{
|
|
1860
1860
|
"name": "layers",
|
|
1861
|
-
"description": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)
|
|
1861
|
+
"description": "A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)\nof layers of type [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html)\nthat are added to the componen for exploration.",
|
|
1862
1862
|
"type": "Collection<BuildingSceneLayer>"
|
|
1863
1863
|
},
|
|
1864
1864
|
{
|
|
@@ -1882,7 +1882,7 @@
|
|
|
1882
1882
|
},
|
|
1883
1883
|
{
|
|
1884
1884
|
"name": "state",
|
|
1885
|
-
"description": "The
|
|
1885
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - \tcomponent is being created\n* `loading` - layers and statistics are loading\n* `ready` - component is ready\n* `failed` - component failed to load data",
|
|
1886
1886
|
"type": "\"disabled\" | \"failed\" | \"loading\" | \"ready\""
|
|
1887
1887
|
}
|
|
1888
1888
|
],
|
|
@@ -2687,7 +2687,7 @@
|
|
|
2687
2687
|
},
|
|
2688
2688
|
{
|
|
2689
2689
|
"name": "arcgis-daylight",
|
|
2690
|
-
"description": "The Daylight component can be used to manipulate the lighting conditions of a [
|
|
2690
|
+
"description": "The Daylight component can be used to manipulate the lighting conditions of a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\n**Known limitations**\n\nDaylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n--\n\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.",
|
|
2691
2691
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/",
|
|
2692
2692
|
"attributes": [
|
|
2693
2693
|
{
|
|
@@ -2712,7 +2712,7 @@
|
|
|
2712
2712
|
},
|
|
2713
2713
|
{
|
|
2714
2714
|
"name": "date-or-season",
|
|
2715
|
-
"description": "Controls whether the
|
|
2715
|
+
"description": "Controls whether the component displays a date or a season picker.",
|
|
2716
2716
|
"default": "\"date\"",
|
|
2717
2717
|
"value": {
|
|
2718
2718
|
"type": [
|
|
@@ -2731,7 +2731,7 @@
|
|
|
2731
2731
|
},
|
|
2732
2732
|
{
|
|
2733
2733
|
"name": "heading-level",
|
|
2734
|
-
"description": "Indicates the heading level to use for the
|
|
2734
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
2735
2735
|
"default": "3",
|
|
2736
2736
|
"value": {
|
|
2737
2737
|
"type": "number"
|
|
@@ -2781,7 +2781,7 @@
|
|
|
2781
2781
|
},
|
|
2782
2782
|
{
|
|
2783
2783
|
"name": "icon",
|
|
2784
|
-
"description": "Icon which represents the
|
|
2784
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
2785
2785
|
"default": "\"brightness\"",
|
|
2786
2786
|
"value": {
|
|
2787
2787
|
"type": "string"
|
|
@@ -2789,7 +2789,7 @@
|
|
|
2789
2789
|
},
|
|
2790
2790
|
{
|
|
2791
2791
|
"name": "label",
|
|
2792
|
-
"description": "The
|
|
2792
|
+
"description": "The component's default label.",
|
|
2793
2793
|
"value": {
|
|
2794
2794
|
"type": "string"
|
|
2795
2795
|
}
|
|
@@ -2852,7 +2852,7 @@
|
|
|
2852
2852
|
{
|
|
2853
2853
|
"name": "arcgisUserDateTimeChange",
|
|
2854
2854
|
"type": "void",
|
|
2855
|
-
"description": "Fires when the user changes the date or time in the
|
|
2855
|
+
"description": "Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons."
|
|
2856
2856
|
}
|
|
2857
2857
|
],
|
|
2858
2858
|
"js": {
|
|
@@ -2869,7 +2869,7 @@
|
|
|
2869
2869
|
},
|
|
2870
2870
|
{
|
|
2871
2871
|
"name": "dateOrSeason",
|
|
2872
|
-
"description": "Controls whether the
|
|
2872
|
+
"description": "Controls whether the component displays a date or a season picker.",
|
|
2873
2873
|
"type": "\"date\" | \"season\""
|
|
2874
2874
|
},
|
|
2875
2875
|
{
|
|
@@ -2879,7 +2879,7 @@
|
|
|
2879
2879
|
},
|
|
2880
2880
|
{
|
|
2881
2881
|
"name": "headingLevel",
|
|
2882
|
-
"description": "Indicates the heading level to use for the
|
|
2882
|
+
"description": "Indicates the heading level to use for the component title.",
|
|
2883
2883
|
"type": "number"
|
|
2884
2884
|
},
|
|
2885
2885
|
{
|
|
@@ -2908,12 +2908,12 @@
|
|
|
2908
2908
|
},
|
|
2909
2909
|
{
|
|
2910
2910
|
"name": "icon",
|
|
2911
|
-
"description": "Icon which represents the
|
|
2911
|
+
"description": "Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).\n\nSee also: [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)",
|
|
2912
2912
|
"type": "string"
|
|
2913
2913
|
},
|
|
2914
2914
|
{
|
|
2915
2915
|
"name": "label",
|
|
2916
|
-
"description": "The
|
|
2916
|
+
"description": "The component's default label.",
|
|
2917
2917
|
"type": "string"
|
|
2918
2918
|
},
|
|
2919
2919
|
{
|
|
@@ -2950,7 +2950,7 @@
|
|
|
2950
2950
|
{
|
|
2951
2951
|
"name": "arcgisUserDateTimeChange",
|
|
2952
2952
|
"type": "void",
|
|
2953
|
-
"description": "Fires when the user changes the date or time in the
|
|
2953
|
+
"description": "Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons."
|
|
2954
2954
|
}
|
|
2955
2955
|
]
|
|
2956
2956
|
}
|
|
@@ -3383,7 +3383,7 @@
|
|
|
3383
3383
|
},
|
|
3384
3384
|
{
|
|
3385
3385
|
"name": "searchProperties",
|
|
3386
|
-
"description": "Controls the default properties used when
|
|
3386
|
+
"description": "Controls the default properties used when searching.",
|
|
3387
3387
|
"type": "DirectionsSearchProperties"
|
|
3388
3388
|
},
|
|
3389
3389
|
{
|
|
@@ -3417,7 +3417,7 @@
|
|
|
3417
3417
|
},
|
|
3418
3418
|
{
|
|
3419
3419
|
"name": "arcgis-direct-line-measurement-3d",
|
|
3420
|
-
"description": "The Direct Line Measurement 3D component calculates and displays the 3D distance between two points
|
|
3420
|
+
"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.",
|
|
3421
3421
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/",
|
|
3422
3422
|
"attributes": [
|
|
3423
3423
|
{
|
|
@@ -3469,6 +3469,7 @@
|
|
|
3469
3469
|
},
|
|
3470
3470
|
{
|
|
3471
3471
|
"name": "state",
|
|
3472
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3472
3473
|
"value": {
|
|
3473
3474
|
"type": [
|
|
3474
3475
|
"\"disabled\"",
|
|
@@ -3480,7 +3481,7 @@
|
|
|
3480
3481
|
},
|
|
3481
3482
|
{
|
|
3482
3483
|
"name": "unit",
|
|
3483
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3484
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3484
3485
|
"value": {
|
|
3485
3486
|
"type": [
|
|
3486
3487
|
"\"centimeters\"",
|
|
@@ -3516,7 +3517,7 @@
|
|
|
3516
3517
|
"properties": [
|
|
3517
3518
|
{
|
|
3518
3519
|
"name": "analysis",
|
|
3519
|
-
"description": "
|
|
3520
|
+
"description": "The [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\ncreated or modified by the component.\n\nIf no programmatically created analysis is provided, the component automatically creates an empty analysis on its own and adds it to the view.\nIn this case, the analysis will also be automatically removed from the view when the component is destroyed.\n\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 view component.\nviewElement.analyses.add(directLineAnalysis);\n// Connect the analysis to the measurement component:\ndirectLineMeasurement3d.analysis = directLineAnalysis;\n```",
|
|
3520
3521
|
"type": "DirectLineMeasurementAnalysis"
|
|
3521
3522
|
},
|
|
3522
3523
|
{
|
|
@@ -3545,16 +3546,17 @@
|
|
|
3545
3546
|
},
|
|
3546
3547
|
{
|
|
3547
3548
|
"name": "state",
|
|
3549
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3548
3550
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
3549
3551
|
},
|
|
3550
3552
|
{
|
|
3551
3553
|
"name": "unit",
|
|
3552
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3554
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3553
3555
|
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
3554
3556
|
},
|
|
3555
3557
|
{
|
|
3556
3558
|
"name": "unitOptions",
|
|
3557
|
-
"description": "List of unit systems (imperial, metric)
|
|
3559
|
+
"description": "List of available units and unit systems (imperial, metric) for displaying the distance values.\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.\nWith this, it is possible to limit which options are shown in the component's dropdown.",
|
|
3558
3560
|
"type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
|
|
3559
3561
|
}
|
|
3560
3562
|
],
|
|
@@ -3574,7 +3576,7 @@
|
|
|
3574
3576
|
},
|
|
3575
3577
|
{
|
|
3576
3578
|
"name": "arcgis-directline-measurement-3d",
|
|
3577
|
-
"description": "**Deprecated**. The
|
|
3579
|
+
"description": "**Deprecated**. The Directline Measurement 3D component calculates and displays the 3D distance between two points. It can be used in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component to measure the vertical, horizontal, and direct distance between two points.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.",
|
|
3578
3580
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directline-measurement-3d/",
|
|
3579
3581
|
"attributes": [
|
|
3580
3582
|
{
|
|
@@ -3626,6 +3628,7 @@
|
|
|
3626
3628
|
},
|
|
3627
3629
|
{
|
|
3628
3630
|
"name": "state",
|
|
3631
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3629
3632
|
"value": {
|
|
3630
3633
|
"type": [
|
|
3631
3634
|
"\"disabled\"",
|
|
@@ -3637,7 +3640,7 @@
|
|
|
3637
3640
|
},
|
|
3638
3641
|
{
|
|
3639
3642
|
"name": "unit",
|
|
3640
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3643
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3641
3644
|
"value": {
|
|
3642
3645
|
"type": [
|
|
3643
3646
|
"\"centimeters\"",
|
|
@@ -3673,7 +3676,7 @@
|
|
|
3673
3676
|
"properties": [
|
|
3674
3677
|
{
|
|
3675
3678
|
"name": "analysis",
|
|
3676
|
-
"description": "
|
|
3679
|
+
"description": "The [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\ncreated or modified by the component.\n\nIf no programmatically created analysis is provided, the component automatically creates an empty analysis on its own and adds it to the view.\nIn this case, the analysis will also be automatically removed from the view when the component is destroyed.\n\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 view component.\nviewElement.analyses.add(directLineAnalysis);\n// Connect the analysis to the measurement component:\ndirectLineMeasurement3d.analysis = directLineAnalysis;\n```",
|
|
3677
3680
|
"type": "DirectLineMeasurementAnalysis"
|
|
3678
3681
|
},
|
|
3679
3682
|
{
|
|
@@ -3702,16 +3705,17 @@
|
|
|
3702
3705
|
},
|
|
3703
3706
|
{
|
|
3704
3707
|
"name": "state",
|
|
3708
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - not ready yet\n* `ready` - ready for measuring\n* `measuring` - currently measuring\n* `measured` - measuring has finished",
|
|
3705
3709
|
"type": "\"disabled\" | \"measured\" | \"measuring\" | \"ready\""
|
|
3706
3710
|
},
|
|
3707
3711
|
{
|
|
3708
3712
|
"name": "unit",
|
|
3709
|
-
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values.",
|
|
3713
|
+
"description": "Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](#unitOptions).",
|
|
3710
3714
|
"type": "\"centimeters\" | \"decimeters\" | \"feet\" | \"imperial\" | \"inches\" | \"kilometers\" | \"meters\" | \"metric\" | \"miles\" | \"millimeters\" | \"nautical-miles\" | \"us-feet\" | \"yards\""
|
|
3711
3715
|
},
|
|
3712
3716
|
{
|
|
3713
3717
|
"name": "unitOptions",
|
|
3714
|
-
"description": "List of unit systems (imperial, metric)
|
|
3718
|
+
"description": "List of available units and unit systems (imperial, metric) for displaying the distance values.\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.\nWith this, it is possible to limit which options are shown in the component's dropdown.",
|
|
3715
3719
|
"type": "Array<\"imperial\" | \"metric\" | \"millimeters\" | \"centimeters\" | \"decimeters\" | \"meters\" | \"kilometers\" | \"inches\" | \"feet\" | \"yards\" | \"miles\" | \"nautical-miles\" | \"us-feet\">"
|
|
3716
3720
|
}
|
|
3717
3721
|
],
|
|
@@ -4253,7 +4257,7 @@
|
|
|
4253
4257
|
},
|
|
4254
4258
|
{
|
|
4255
4259
|
"name": "icon",
|
|
4256
|
-
"description": "Icon which represents the
|
|
4260
|
+
"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/)",
|
|
4257
4261
|
"default": "\"altitude\"",
|
|
4258
4262
|
"value": {
|
|
4259
4263
|
"type": "string"
|
|
@@ -4261,7 +4265,7 @@
|
|
|
4261
4265
|
},
|
|
4262
4266
|
{
|
|
4263
4267
|
"name": "label",
|
|
4264
|
-
"description": "The
|
|
4268
|
+
"description": "The component's default label.",
|
|
4265
4269
|
"value": {
|
|
4266
4270
|
"type": "string"
|
|
4267
4271
|
}
|
|
@@ -4292,7 +4296,7 @@
|
|
|
4292
4296
|
},
|
|
4293
4297
|
{
|
|
4294
4298
|
"name": "state",
|
|
4295
|
-
"description": "The
|
|
4299
|
+
"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",
|
|
4296
4300
|
"default": "\"disabled\"",
|
|
4297
4301
|
"value": {
|
|
4298
4302
|
"type": [
|
|
@@ -4356,7 +4360,7 @@
|
|
|
4356
4360
|
},
|
|
4357
4361
|
{
|
|
4358
4362
|
"name": "effectiveUnits",
|
|
4359
|
-
"description": "Units which have been selected according to the magnitude of the elevations and distances
|
|
4363
|
+
"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.",
|
|
4360
4364
|
"type": "EffectiveUnits"
|
|
4361
4365
|
},
|
|
4362
4366
|
{
|
|
@@ -4403,7 +4407,7 @@
|
|
|
4403
4407
|
},
|
|
4404
4408
|
{
|
|
4405
4409
|
"name": "icon",
|
|
4406
|
-
"description": "Icon which represents the
|
|
4410
|
+
"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/)",
|
|
4407
4411
|
"type": "string"
|
|
4408
4412
|
},
|
|
4409
4413
|
{
|
|
@@ -4413,7 +4417,7 @@
|
|
|
4413
4417
|
},
|
|
4414
4418
|
{
|
|
4415
4419
|
"name": "label",
|
|
4416
|
-
"description": "The
|
|
4420
|
+
"description": "The component's default label.",
|
|
4417
4421
|
"type": "string"
|
|
4418
4422
|
},
|
|
4419
4423
|
{
|
|
@@ -4422,7 +4426,7 @@
|
|
|
4422
4426
|
},
|
|
4423
4427
|
{
|
|
4424
4428
|
"name": "profiles",
|
|
4425
|
-
"description": "Collection of elevation profile lines which are to be generated and displayed in the
|
|
4429
|
+
"description": "Collection of elevation profile lines which are to be generated and displayed in the component's chart.",
|
|
4426
4430
|
"type": "Collection<ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineView>"
|
|
4427
4431
|
},
|
|
4428
4432
|
{
|
|
@@ -4437,7 +4441,7 @@
|
|
|
4437
4441
|
},
|
|
4438
4442
|
{
|
|
4439
4443
|
"name": "state",
|
|
4440
|
-
"description": "The
|
|
4444
|
+
"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",
|
|
4441
4445
|
"type": "\"created\" | \"creating\" | \"disabled\" | \"ready\" | \"selected\" | \"selecting\""
|
|
4442
4446
|
},
|
|
4443
4447
|
{
|
|
@@ -8625,7 +8629,7 @@
|
|
|
8625
8629
|
},
|
|
8626
8630
|
{
|
|
8627
8631
|
"name": "arcgis-line-of-sight",
|
|
8628
|
-
"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()](
|
|
8632
|
+
"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.",
|
|
8629
8633
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-line-of-sight/",
|
|
8630
8634
|
"attributes": [
|
|
8631
8635
|
{
|
|
@@ -10356,7 +10360,7 @@
|
|
|
10356
10360
|
},
|
|
10357
10361
|
{
|
|
10358
10362
|
"name": "arcgis-navigation-toggle",
|
|
10359
|
-
"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\
|
|
10363
|
+
"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>`",
|
|
10360
10364
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-navigation-toggle/",
|
|
10361
10365
|
"attributes": [
|
|
10362
10366
|
{
|
|
@@ -10386,7 +10390,7 @@
|
|
|
10386
10390
|
},
|
|
10387
10391
|
{
|
|
10388
10392
|
"name": "navigation-mode",
|
|
10389
|
-
"description": "The navigation mode of the view.
|
|
10393
|
+
"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.",
|
|
10390
10394
|
"default": "\"pan\"",
|
|
10391
10395
|
"value": {
|
|
10392
10396
|
"type": [
|
|
@@ -10466,7 +10470,7 @@
|
|
|
10466
10470
|
},
|
|
10467
10471
|
{
|
|
10468
10472
|
"name": "navigationMode",
|
|
10469
|
-
"description": "The navigation mode of the view.
|
|
10473
|
+
"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.",
|
|
10470
10474
|
"type": "\"pan\" | \"rotate\""
|
|
10471
10475
|
},
|
|
10472
10476
|
{
|
|
@@ -11513,7 +11517,7 @@
|
|
|
11513
11517
|
},
|
|
11514
11518
|
{
|
|
11515
11519
|
"name": "arcgis-scene",
|
|
11516
|
-
"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)",
|
|
11520
|
+
"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)",
|
|
11517
11521
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/",
|
|
11518
11522
|
"attributes": [
|
|
11519
11523
|
{
|
|
@@ -11541,35 +11545,35 @@
|
|
|
11541
11545
|
},
|
|
11542
11546
|
{
|
|
11543
11547
|
"name": "camera-fov",
|
|
11544
|
-
"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()](
|
|
11548
|
+
"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)",
|
|
11545
11549
|
"value": {
|
|
11546
11550
|
"type": "number"
|
|
11547
11551
|
}
|
|
11548
11552
|
},
|
|
11549
11553
|
{
|
|
11550
11554
|
"name": "camera-heading",
|
|
11551
|
-
"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()](
|
|
11555
|
+
"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)",
|
|
11552
11556
|
"value": {
|
|
11553
11557
|
"type": "number"
|
|
11554
11558
|
}
|
|
11555
11559
|
},
|
|
11556
11560
|
{
|
|
11557
11561
|
"name": "camera-position",
|
|
11558
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
11562
|
+
"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)",
|
|
11559
11563
|
"value": {
|
|
11560
11564
|
"type": "string"
|
|
11561
11565
|
}
|
|
11562
11566
|
},
|
|
11563
11567
|
{
|
|
11564
11568
|
"name": "camera-tilt",
|
|
11565
|
-
"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()](
|
|
11569
|
+
"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)",
|
|
11566
11570
|
"value": {
|
|
11567
11571
|
"type": "number"
|
|
11568
11572
|
}
|
|
11569
11573
|
},
|
|
11570
11574
|
{
|
|
11571
11575
|
"name": "center",
|
|
11572
|
-
"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()](
|
|
11576
|
+
"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)",
|
|
11573
11577
|
"value": {
|
|
11574
11578
|
"type": "string"
|
|
11575
11579
|
}
|
|
@@ -11606,7 +11610,7 @@
|
|
|
11606
11610
|
},
|
|
11607
11611
|
{
|
|
11608
11612
|
"name": "quality-profile",
|
|
11609
|
-
"description": "
|
|
11613
|
+
"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)",
|
|
11610
11614
|
"value": {
|
|
11611
11615
|
"type": [
|
|
11612
11616
|
"\"high\"",
|
|
@@ -11617,7 +11621,7 @@
|
|
|
11617
11621
|
},
|
|
11618
11622
|
{
|
|
11619
11623
|
"name": "scale",
|
|
11620
|
-
"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()](
|
|
11624
|
+
"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)",
|
|
11621
11625
|
"value": {
|
|
11622
11626
|
"type": "number"
|
|
11623
11627
|
}
|
|
@@ -11643,7 +11647,7 @@
|
|
|
11643
11647
|
},
|
|
11644
11648
|
{
|
|
11645
11649
|
"name": "zoom",
|
|
11646
|
-
"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()](
|
|
11650
|
+
"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)",
|
|
11647
11651
|
"value": {
|
|
11648
11652
|
"type": "number"
|
|
11649
11653
|
}
|
|
@@ -11668,7 +11672,7 @@
|
|
|
11668
11672
|
{
|
|
11669
11673
|
"name": "arcgisViewChange",
|
|
11670
11674
|
"type": "void",
|
|
11671
|
-
"description": "This event is for view related property changes
|
|
11675
|
+
"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`."
|
|
11672
11676
|
},
|
|
11673
11677
|
{
|
|
11674
11678
|
"name": "arcgisViewClick",
|
|
@@ -11758,7 +11762,7 @@
|
|
|
11758
11762
|
{
|
|
11759
11763
|
"name": "arcgisViewReadyChange",
|
|
11760
11764
|
"type": "void",
|
|
11761
|
-
"description": "This event is for the [ready](
|
|
11765
|
+
"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.\n\n```js\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```"
|
|
11762
11766
|
}
|
|
11763
11767
|
],
|
|
11764
11768
|
"js": {
|
|
@@ -11795,37 +11799,37 @@
|
|
|
11795
11799
|
},
|
|
11796
11800
|
{
|
|
11797
11801
|
"name": "camera",
|
|
11798
|
-
"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
|
|
11802
|
+
"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.",
|
|
11799
11803
|
"type": "Camera"
|
|
11800
11804
|
},
|
|
11801
11805
|
{
|
|
11802
11806
|
"name": "cameraFov",
|
|
11803
|
-
"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()](
|
|
11807
|
+
"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)",
|
|
11804
11808
|
"type": "number"
|
|
11805
11809
|
},
|
|
11806
11810
|
{
|
|
11807
11811
|
"name": "cameraHeading",
|
|
11808
|
-
"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()](
|
|
11812
|
+
"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)",
|
|
11809
11813
|
"type": "number"
|
|
11810
11814
|
},
|
|
11811
11815
|
{
|
|
11812
11816
|
"name": "cameraPosition",
|
|
11813
|
-
"description": "The position of the camera defined by a map point. It can be
|
|
11817
|
+
"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)",
|
|
11814
11818
|
"type": "Array<number> | Point | string"
|
|
11815
11819
|
},
|
|
11816
11820
|
{
|
|
11817
11821
|
"name": "cameraTilt",
|
|
11818
|
-
"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()](
|
|
11822
|
+
"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)",
|
|
11819
11823
|
"type": "number"
|
|
11820
11824
|
},
|
|
11821
11825
|
{
|
|
11822
11826
|
"name": "center",
|
|
11823
|
-
"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()](
|
|
11827
|
+
"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)",
|
|
11824
11828
|
"type": "Array<number> | Point | string"
|
|
11825
11829
|
},
|
|
11826
11830
|
{
|
|
11827
11831
|
"name": "clippingArea",
|
|
11828
|
-
"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 [local scene](
|
|
11832
|
+
"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 [local scene](#viewingMode).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#clippingArea)",
|
|
11829
11833
|
"type": "Extent"
|
|
11830
11834
|
},
|
|
11831
11835
|
{
|
|
@@ -11845,7 +11849,7 @@
|
|
|
11845
11849
|
},
|
|
11846
11850
|
{
|
|
11847
11851
|
"name": "extent",
|
|
11848
|
-
"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()](
|
|
11852
|
+
"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()](#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)",
|
|
11849
11853
|
"type": "Extent"
|
|
11850
11854
|
},
|
|
11851
11855
|
{
|
|
@@ -11950,7 +11954,7 @@
|
|
|
11950
11954
|
},
|
|
11951
11955
|
{
|
|
11952
11956
|
"name": "qualityProfile",
|
|
11953
|
-
"description": "
|
|
11957
|
+
"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)",
|
|
11954
11958
|
"type": "\"high\" | \"low\" | \"medium\""
|
|
11955
11959
|
},
|
|
11956
11960
|
{
|
|
@@ -11960,12 +11964,12 @@
|
|
|
11960
11964
|
},
|
|
11961
11965
|
{
|
|
11962
11966
|
"name": "resolution",
|
|
11963
|
-
"description": "Represents the current value of one pixel in the unit of the view's\n[spatialReference](
|
|
11967
|
+
"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 view's [extent width](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Extent.html#width)\nby [its width](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#width).",
|
|
11964
11968
|
"type": "number"
|
|
11965
11969
|
},
|
|
11966
11970
|
{
|
|
11967
11971
|
"name": "scale",
|
|
11968
|
-
"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()](
|
|
11972
|
+
"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)",
|
|
11969
11973
|
"type": "number"
|
|
11970
11974
|
},
|
|
11971
11975
|
{
|
|
@@ -11985,7 +11989,7 @@
|
|
|
11985
11989
|
},
|
|
11986
11990
|
{
|
|
11987
11991
|
"name": "theme",
|
|
11988
|
-
"description": "This property specifies the base colors used by some
|
|
11992
|
+
"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.",
|
|
11989
11993
|
"type": "Theme"
|
|
11990
11994
|
},
|
|
11991
11995
|
{
|
|
@@ -12010,7 +12014,7 @@
|
|
|
12010
12014
|
},
|
|
12011
12015
|
{
|
|
12012
12016
|
"name": "viewpoint",
|
|
12013
|
-
"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()](
|
|
12017
|
+
"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)",
|
|
12014
12018
|
"type": "Viewpoint"
|
|
12015
12019
|
},
|
|
12016
12020
|
{
|
|
@@ -12020,7 +12024,7 @@
|
|
|
12020
12024
|
},
|
|
12021
12025
|
{
|
|
12022
12026
|
"name": "zoom",
|
|
12023
|
-
"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()](
|
|
12027
|
+
"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)",
|
|
12024
12028
|
"type": "number"
|
|
12025
12029
|
}
|
|
12026
12030
|
],
|
|
@@ -12043,7 +12047,7 @@
|
|
|
12043
12047
|
{
|
|
12044
12048
|
"name": "arcgisViewChange",
|
|
12045
12049
|
"type": "void",
|
|
12046
|
-
"description": "This event is for view related property changes
|
|
12050
|
+
"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`."
|
|
12047
12051
|
},
|
|
12048
12052
|
{
|
|
12049
12053
|
"name": "arcgisViewClick",
|
|
@@ -12133,7 +12137,7 @@
|
|
|
12133
12137
|
{
|
|
12134
12138
|
"name": "arcgisViewReadyChange",
|
|
12135
12139
|
"type": "void",
|
|
12136
|
-
"description": "This event is for the [ready](
|
|
12140
|
+
"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.\n\n```js\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n const layer = new GraphicsLayer({ title: \"My layer\"});\n viewElement.map.add(layer);\n});\n```"
|
|
12137
12141
|
}
|
|
12138
12142
|
]
|
|
12139
12143
|
}
|
|
@@ -12307,7 +12311,7 @@
|
|
|
12307
12311
|
},
|
|
12308
12312
|
{
|
|
12309
12313
|
"name": "state",
|
|
12310
|
-
"description": "The current state
|
|
12314
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
12311
12315
|
"default": "\"ready\"",
|
|
12312
12316
|
"value": {
|
|
12313
12317
|
"type": [
|
|
@@ -12522,7 +12526,7 @@
|
|
|
12522
12526
|
},
|
|
12523
12527
|
{
|
|
12524
12528
|
"name": "state",
|
|
12525
|
-
"description": "The current state
|
|
12529
|
+
"description": "The current state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#state)",
|
|
12526
12530
|
"type": "\"disabled\" | \"loading\" | \"ready\" | \"searching\""
|
|
12527
12531
|
},
|
|
12528
12532
|
{
|
|
@@ -12628,7 +12632,7 @@
|
|
|
12628
12632
|
},
|
|
12629
12633
|
{
|
|
12630
12634
|
"name": "arcgis-shadow-cast",
|
|
12631
|
-
"description": "The Shadow Cast component displays the cumulative shadows of 3D features in a [
|
|
12635
|
+
"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>`",
|
|
12632
12636
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-shadow-cast/",
|
|
12633
12637
|
"attributes": [
|
|
12634
12638
|
{
|
|
@@ -12736,7 +12740,7 @@
|
|
|
12736
12740
|
},
|
|
12737
12741
|
{
|
|
12738
12742
|
"name": "icon",
|
|
12739
|
-
"description": "Icon which represents the
|
|
12743
|
+
"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/)",
|
|
12740
12744
|
"default": "\"measure-building-height-shadow\"",
|
|
12741
12745
|
"value": {
|
|
12742
12746
|
"type": "string"
|
|
@@ -12744,7 +12748,7 @@
|
|
|
12744
12748
|
},
|
|
12745
12749
|
{
|
|
12746
12750
|
"name": "label",
|
|
12747
|
-
"description": "The
|
|
12751
|
+
"description": "The component's default label.",
|
|
12748
12752
|
"value": {
|
|
12749
12753
|
"type": "string"
|
|
12750
12754
|
}
|
|
@@ -12783,7 +12787,7 @@
|
|
|
12783
12787
|
},
|
|
12784
12788
|
{
|
|
12785
12789
|
"name": "state",
|
|
12786
|
-
"description": "The
|
|
12790
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
12787
12791
|
"default": "\"disabled\"",
|
|
12788
12792
|
"value": {
|
|
12789
12793
|
"type": [
|
|
@@ -12794,7 +12798,7 @@
|
|
|
12794
12798
|
},
|
|
12795
12799
|
{
|
|
12796
12800
|
"name": "utc-offset",
|
|
12797
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
12801
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
12798
12802
|
"value": {
|
|
12799
12803
|
"type": "number"
|
|
12800
12804
|
}
|
|
@@ -12837,12 +12841,12 @@
|
|
|
12837
12841
|
},
|
|
12838
12842
|
{
|
|
12839
12843
|
"name": "discreteOptions",
|
|
12840
|
-
"description": "The configuration used when the
|
|
12844
|
+
"description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"discrete\".",
|
|
12841
12845
|
"type": "DiscreteOptions"
|
|
12842
12846
|
},
|
|
12843
12847
|
{
|
|
12844
12848
|
"name": "durationOptions",
|
|
12845
|
-
"description": "The configuration used when the
|
|
12849
|
+
"description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"duration\".",
|
|
12846
12850
|
"type": "DurationOptions"
|
|
12847
12851
|
},
|
|
12848
12852
|
{
|
|
@@ -12897,12 +12901,12 @@
|
|
|
12897
12901
|
},
|
|
12898
12902
|
{
|
|
12899
12903
|
"name": "icon",
|
|
12900
|
-
"description": "Icon which represents the
|
|
12904
|
+
"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/)",
|
|
12901
12905
|
"type": "string"
|
|
12902
12906
|
},
|
|
12903
12907
|
{
|
|
12904
12908
|
"name": "label",
|
|
12905
|
-
"description": "The
|
|
12909
|
+
"description": "The component's default label.",
|
|
12906
12910
|
"type": "string"
|
|
12907
12911
|
},
|
|
12908
12912
|
{
|
|
@@ -12921,17 +12925,17 @@
|
|
|
12921
12925
|
},
|
|
12922
12926
|
{
|
|
12923
12927
|
"name": "state",
|
|
12924
|
-
"description": "The
|
|
12928
|
+
"description": "The component's state. The values mean the following:\n\n* `disabled` - component is being created\n* `ready` - component is ready",
|
|
12925
12929
|
"type": "\"disabled\" | \"ready\""
|
|
12926
12930
|
},
|
|
12927
12931
|
{
|
|
12928
12932
|
"name": "thresholdOptions",
|
|
12929
|
-
"description": "The configuration used when the
|
|
12933
|
+
"description": "The configuration used when the component's [visualizationType](#visualizationType)\nis set to \"threshold\".",
|
|
12930
12934
|
"type": "ThresholdOptions"
|
|
12931
12935
|
},
|
|
12932
12936
|
{
|
|
12933
12937
|
"name": "utcOffset",
|
|
12934
|
-
"description": "The difference in hours between UTC time and the times displayed in the
|
|
12938
|
+
"description": "The difference in hours between UTC time and the times displayed in the component.",
|
|
12935
12939
|
"type": "number"
|
|
12936
12940
|
},
|
|
12937
12941
|
{
|
|
@@ -13505,7 +13509,7 @@
|
|
|
13505
13509
|
},
|
|
13506
13510
|
{
|
|
13507
13511
|
"name": "arcgis-slice",
|
|
13508
|
-
"description": "The Slice component is a 3D analysis tool that can be used to reveal occluded content in a
|
|
13512
|
+
"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).",
|
|
13509
13513
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-slice/",
|
|
13510
13514
|
"attributes": [
|
|
13511
13515
|
{
|
|
@@ -13615,7 +13619,7 @@
|
|
|
13615
13619
|
"properties": [
|
|
13616
13620
|
{
|
|
13617
13621
|
"name": "analysis",
|
|
13618
|
-
"description": "The [
|
|
13622
|
+
"description": "The [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\ncreated or modified by the component.\n\nIf no programmatically created analysis is provided, the component automatically creates an empty analysis on its own and adds it to the view.\nIn this case, the analysis will also be automatically removed from the view when the component is destroyed.\n\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 measurement 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 view component.\nviewElement.analyses.add(sliceAnalysis);\n// Connect the analysis to the slice component:\nslice.analysis = sliceAnalysis;\n```",
|
|
13619
13623
|
"type": "SliceAnalysis"
|
|
13620
13624
|
},
|
|
13621
13625
|
{
|
|
@@ -13663,7 +13667,7 @@
|
|
|
13663
13667
|
},
|
|
13664
13668
|
{
|
|
13665
13669
|
"name": "shape",
|
|
13666
|
-
"description": "The shape used to slice elements in a 3D scene. Currently the only supported shape is a
|
|
13670
|
+
"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).",
|
|
13667
13671
|
"type": "SlicePlane"
|
|
13668
13672
|
},
|
|
13669
13673
|
{
|
|
@@ -16920,7 +16924,7 @@
|
|
|
16920
16924
|
},
|
|
16921
16925
|
{
|
|
16922
16926
|
"name": "arcgis-weather",
|
|
16923
|
-
"description": "The Weather component provides an interface for easily selecting and configuring the weather effects in a [
|
|
16927
|
+
"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.",
|
|
16924
16928
|
"doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-weather/",
|
|
16925
16929
|
"attributes": [
|
|
16926
16930
|
{
|