@arcgis/map-components
Version:
ArcGIS Map Components
1 lines • 2.7 MB
JSON
{"name":"@arcgis/map-components","timestamp":"2026-07-09T17:16:28","compiler":{"name":"@arcgis/lumina-compiler","version":"5.1.12","typescriptVersion":"6.0.2"},"schemaVersion":"2.1.0","modules":[{"kind":"javascript-module","path":"index","sourcePath":"src/index.ts","declarations":[{"kind":"function","name":"getAssetPath","description":"Get a resolved path from where an asset can be loaded.","parameters":[{"name":"suffix","description":"The relative path for the asset.","type":{"text":"string"}}],"return":{"type":{"text":"string"}}},{"kind":"function","name":"setAssetPath","description":"Used to manually set the base path where package assets (like localization\nand icons) can be found.\n\nBy default, the package assets are loaded from\n`https://js.arcgis.com/<version>/<simplified-package-name>/`. We are hosting\nour assets on a CDN (Content Delivery Network) to ensure fast and reliable\naccess. It is CORS-enabled, so you can load the assets from any domain. This\nis the recommended way to load the assets and avoid bundling them with your\napplication.\n\nHowever, if you need to host the assets locally, you can copy them manually\nas part of your build process and use `setAssetPath` to customize where the\nbrowser will load the assets from.","parameters":[{"name":"path","description":"Relative or absolute path to the assets folder.","type":{"text":"URL | string","references":[{"name":"URL","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/API/URL","start":0,"end":3}]}}],"return":{"type":{"text":"void"}}}]},{"kind":"javascript-module","path":"components/types","sourcePath":"src/components/types.ts","declarations":[{"kind":"interface","name":"ArcgisReferenceElement","type":{"text":"ArcgisLinkChart | ArcgisMap | ArcgisScene","references":[{"name":"ArcgisLinkChart","module":"components/arcgis-link-chart","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#ArcgisLinkChart","start":0,"end":15},{"name":"ArcgisMap","module":"components/arcgis-map","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#ArcgisMap","start":18,"end":27},{"name":"ArcgisScene","module":"components/arcgis-scene","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#ArcgisScene","start":30,"end":41}]}},{"kind":"interface","name":"IconName","type":{"text":"Icon[\"icon\"]","references":[{"name":"Icon","module":"components/calcite-icon","package":"@esri/calcite-components","start":0,"end":4}]}},{"kind":"interface","name":"HeadingLevel","type":{"text":"1 | 2 | 3 | 4 | 5 | 6"}},{"kind":"interface","name":"LoadErrorSource","description":"A potential source of load errors.","type":{"text":"Basemap | Ground | Layer | WebLinkChart | WebMap | WebScene","references":[{"name":"default","module":"Basemap.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/Basemap/","start":0,"end":7},{"name":"default","module":"Ground.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/Ground/","start":10,"end":16},{"name":"default","module":"layers/Layer.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/","start":19,"end":24},{"name":"default","module":"WebLinkChart.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/WebLinkChart/","start":27,"end":39},{"name":"default","module":"WebMap.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/WebMap/","start":42,"end":48},{"name":"default","module":"WebScene.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/WebScene/","start":51,"end":59}]}},{"kind":"interface","name":"GoToOverride","members":[{"kind":"call-signature","parameters":[{"name":"view","type":{"text":"ArcGISView & GoToOwner","references":[{"name":"ArcGISView","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/types/#ArcGISView","start":0,"end":10},{"name":"GoToOwner","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/types/#GoToOwner","start":13,"end":22}]}},{"name":"goToParameters","type":{"text":"GoToParameters","references":[{"name":"GoToParameters","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/types/#GoToParameters","start":0,"end":14}]}}],"return":{"type":{"text":"Promise<void>","references":[{"name":"Promise","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise","start":0,"end":7}]}}}]},{"kind":"interface","name":"GoToOwner","supertypes":[{"name":"Pick","package":"global:","viewUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys","typeArguments":[{"text":"LinkChartView","references":[{"name":"default","module":"views/LinkChartView.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/","start":0,"end":13}]},{"text":"\"goTo\""}]},{"name":"Pick","package":"global:","viewUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys","typeArguments":[{"text":"MapView","references":[{"name":"default","module":"views/MapView.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/MapView/","start":0,"end":7}]},{"text":"\"goTo\""}]},{"name":"Pick","package":"global:","viewUrl":"https://www.typescriptlang.org/docs/handbook/utility-types.html#picktype-keys","typeArguments":[{"text":"SceneView","references":[{"name":"default","module":"views/SceneView.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/","start":0,"end":9}]},{"text":"\"goTo\""}]}]},{"kind":"interface","name":"ArcGISView","type":{"text":"LinkChartView | MapView | SceneView","references":[{"name":"default","module":"views/LinkChartView.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/","start":0,"end":13},{"name":"default","module":"views/MapView.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/MapView/","start":16,"end":23},{"name":"default","module":"views/SceneView.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/","start":26,"end":35}]}},{"kind":"interface","name":"GoToParameters","supertypes":[{"name":"GoToParameters2D","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/types/#GoToParameters2D"},{"name":"GoToParameters3D","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/types/#GoToParameters3D"}]},{"kind":"interface","name":"GoToParameters2D","members":[{"kind":"field","name":"target","description":"The target location/viewpoint/extent to animate to.","docsTags":[{"name":"since","text":"5.0"}],"type":{"text":"GoToTarget2D","references":[{"name":"GoToTarget2D","module":"views/types.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/types/#GoToTarget2D","start":0,"end":12}]}},{"kind":"field","name":"options","description":"Options defining the animation and duration of the navigation.","docsTags":[{"name":"since","text":"5.0"}],"type":{"text":"GoToOptions2D | undefined","references":[{"name":"GoToOptions2D","module":"views/types.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/types/#GoToOptions2D","start":0,"end":13}]}}]},{"kind":"interface","name":"GoToParameters3D","members":[{"kind":"field","name":"target","type":{"text":"GoToTarget3D","references":[{"name":"GoToTarget3D","module":"views/types.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/types/#GoToTarget3D","start":0,"end":12}]}},{"kind":"field","name":"options","type":{"text":"GoToOptions3D | undefined","references":[{"name":"GoToOptions3D","module":"views/types.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/types/#GoToOptions3D","start":0,"end":13}]}}]}]},{"kind":"javascript-module","path":"components/arcgis-area-measurement-2d","sourcePath":"src/components/area-measurement-2d/area-measurement-2d.tsx","declarations":[{"kind":"class","name":"ArcgisAreaMeasurement2d","customElement":true,"tagName":"arcgis-area-measurement-2d","pascalCaseName":"ArcgisAreaMeasurement2d","description":"The Area Measurement 2D component can be added to an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent to calculate and display the area and perimeter of a polygon.\n\nHow areas and perimeters are computed depends on the map's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, areas and perimeters are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, areas and perimeters are computed in a Euclidean manner (in their respective PCS).","docsTags":[{"name":"since","text":"4.28"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/"},{"description":"Area Measurement 2D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-area-measurement-2d--demo&singleStory=true"}],"superclass":{"name":"HTMLElement","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/API/HTMLElement"},"members":[{"kind":"field","name":"analysis","description":"The [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)\ncreated or modified by the component.\n\nWhen connecting the Area Measurement 2D component to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent, it automatically creates an empty analysis and adds it to the Map's\n[arcgis-map.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#analyses) collection.\nYou can then wait for the [AreaMeasurementAnalysisView2D](https://developers.arcgis.com/javascript/latest/references/core/views/2d/analysis/AreaMeasurementAnalysisView2D/)\nto be created before accessing the analysis results.\n\n```js\n// Get the Map component and the Area Measurement 2D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\nconst areaMeasurement2dElement = document.querySelector(\"arcgis-area-measurement-2d\");\nawait areaMeasurement2dElement.componentOnReady();\n\n// Get the AreaMeasurementAnalysis created by the Area Measurement 2D component.\nconst analysis = areaMeasurement2dElement.analysis;\n\n// Get the AreaMeasurementAnalysisView2D and watch for results.\nconst analysisView = await viewElement.whenAnalysisView(analysis);\nconst handle = reactiveUtils.watch(\n () => analysisView?.result,\n () => {\n console.log(\"Analysis results:\", analysisView.result);\n },\n);\n```\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)\ncan be provided to the component.\nThen, the application itself needs to add it to and later remove it from the analyses collection of the Map component.\n\n```js\n// Create the AreaMeasurementAnalysis.\nconst areaMeasurementAnalysis = new AreaMeasurementAnalysis({\n geometry: new Polygon({\n rings: [\n [\n [-80.208889, 25.775278], // Maimi, Florida\n [-64.782, 32.293], // Hamilton, Bermuda\n [-66.063889, 18.406389], // San Juan, Puerto Rico\n [-80.208889, 25.775278], // Maimi, Florida\n ],\n ],\n }),\n});\n\n// Get the Map component and the Area Measurement 2D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-map\");\nawait viewElement.viewOnReady();\nconst areaMeasurement2dElement = document.querySelector(\"arcgis-area-measurement-2d\");\nawait areaMeasurement2dElement.componentOnReady();\n\n// Add the analysis to the analyses collection of the Map component.\nviewElement.analyses.add(areaMeasurementAnalysis);\n\n// Connect the analysis to the measurement component:\nareaMeasurement2dElement.analysis = areaMeasurementAnalysis;\n```","type":{"text":"AreaMeasurementAnalysis","references":[{"name":"default","module":"analysis/AreaMeasurementAnalysis.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/","start":0,"end":23}]}},{"kind":"field","name":"autoDestroyDisabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"auto-destroy-disabled"},{"kind":"field","name":"hideStartButton","description":"If true, the button that starts a new measurement will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"hide-start-button"},{"kind":"field","name":"hideUnitSelect","description":"If true, the unit selection dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"hide-unit-select"},{"kind":"field","name":"hideVisualization","description":"Indicates whether the component's visualization is hidden in the view.","docsTags":[{"name":"since","text":"5.0"}],"type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"hide-visualization"},{"kind":"field","name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"type":{"text":"Icon[\"icon\"] | undefined","references":[{"name":"Icon","module":"components/calcite-icon","package":"@esri/calcite-components","start":0,"end":4}],"values":[{"type":"string"}]},"default":"\"measure-area\"","attribute":"icon","reflects":true},{"kind":"field","name":"label","description":"The component's default label.","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"label"},{"kind":"field","name":"referenceElement","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"type":{"text":"ArcgisReferenceElement | string | undefined","references":[{"name":"ArcgisReferenceElement","module":"components/types","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/types/#ArcgisReferenceElement","start":0,"end":22}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"field","name":"snappingOptions","description":"The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/) for measuring.","docsTags":[{"name":"since","text":"4.28"}],"type":{"text":"SnappingOptions","references":[{"name":"default","module":"views/interactive/snapping/SnappingOptions.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/","start":0,"end":15}]}},{"kind":"field","name":"state","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","type":{"text":"AreaMeasurement2DState","references":[{"name":"AreaMeasurement2DState","module":"components/arcgis-area-measurement-2d/types","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/types#AreaMeasurement2DState","start":0,"end":22}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"unsupported"},{"type":"string","value":"measured"},{"type":"string","value":"measuring"}]},"readonly":true},{"kind":"field","name":"unit","description":"Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#unitOptions).","type":{"text":"SystemOrAreaUnit","references":[{"name":"SystemOrAreaUnit","module":"core/units.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/core/units/#SystemOrAreaUnit","start":0,"end":16}],"values":[{"type":"string","value":"metric"},{"type":"string","value":"imperial"},{"type":"string","value":"square-inches"},{"type":"string","value":"square-feet"},{"type":"string","value":"square-yards"},{"type":"string","value":"square-miles"},{"type":"string","value":"square-nautical-miles"},{"type":"string","value":"square-us-feet"},{"type":"string","value":"square-millimeters"},{"type":"string","value":"square-centimeters"},{"type":"string","value":"square-decimeters"},{"type":"string","value":"square-meters"},{"type":"string","value":"square-kilometers"},{"type":"string","value":"acres"},{"type":"string","value":"ares"},{"type":"string","value":"hectares"}]},"attribute":"unit"},{"kind":"field","name":"unitOptions","description":"List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [unit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#unit) values can only be a subset of this list.","type":{"text":"Array<SystemOrAreaUnit>","references":[{"name":"Array","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array","start":0,"end":5},{"name":"SystemOrAreaUnit","module":"core/units.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/core/units/#SystemOrAreaUnit","start":6,"end":22}]}},{"kind":"field","name":"view","description":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-area-measurement-2d component will be associated with a map or scene component rather than using the `view` property.","type":{"text":"MapView | undefined","references":[{"name":"default","module":"views/MapView.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/MapView/","start":0,"end":7}]}},{"kind":"method","name":"clear","description":"Clears the current measurement.","return":{"type":{"text":"Promise<void>","references":[{"name":"Promise","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise","start":0,"end":7}]}},"signature":"(): Promise<void>"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAreaMeasurement2d = document.createElement(\"arcgis-area-measurement-2d\");\ndocument.body.append(arcgisAreaMeasurement2d);\nawait arcgisAreaMeasurement2d.componentOnReady();\nconsole.log(\"arcgis-area-measurement-2d is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"this"},"signature":"(): Promise<this>"},{"kind":"method","name":"destroy","description":"Permanently destroy the component.","return":{"type":{"text":"Promise<void>","references":[{"name":"Promise","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise","start":0,"end":7}]}},"signature":"(): Promise<void>"},{"kind":"method","name":"start","description":"Starts a new measurement.","return":{"type":{"text":"Promise<void>","references":[{"name":"Promise","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise","start":0,"end":7}]}},"signature":"(): Promise<void>"}],"attributes":[{"name":"auto-destroy-disabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"autoDestroyDisabled"},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"hideStartButton"},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"hideUnitSelect"},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"hideVisualization"},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","type":{"text":"string","values":[{"type":"string"}]},"default":"\"measure-area\"","fieldName":"icon"},{"name":"label","description":"The component's default label.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"label"},{"name":"reference-element","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"},{"name":"unit","description":"Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#unitOptions).","type":{"text":"\"metric\" | \"imperial\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"acres\" | \"ares\" | \"hectares\"","values":[{"type":"string","value":"metric"},{"type":"string","value":"imperial"},{"type":"string","value":"square-inches"},{"type":"string","value":"square-feet"},{"type":"string","value":"square-yards"},{"type":"string","value":"square-miles"},{"type":"string","value":"square-nautical-miles"},{"type":"string","value":"square-us-feet"},{"type":"string","value":"square-millimeters"},{"type":"string","value":"square-centimeters"},{"type":"string","value":"square-decimeters"},{"type":"string","value":"square-meters"},{"type":"string","value":"square-kilometers"},{"type":"string","value":"acres"},{"type":"string","value":"ares"},{"type":"string","value":"hectares"}]},"fieldName":"unit"}],"events":[{"name":"arcgisPropertyChange","description":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","type":{"text":"{ name: \"analysis\" | \"state\"; }"}},{"name":"arcgisReady","description":"Emitted when the component associated with a map or scene view is ready to be interacted with.","type":{"text":"void"}}],"importPath":"components/arcgis-area-measurement-2d"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-area-measurement-2d","declaration":{"name":"ArcgisAreaMeasurement2d"}}]},{"kind":"javascript-module","path":"components/arcgis-area-measurement-2d/types","sourcePath":"src/components/area-measurement-2d/types.ts","declarations":[{"kind":"interface","name":"AreaMeasurement2DState","type":{"text":"\"disabled\" | \"measured\" | \"measuring\" | \"ready\" | \"unsupported\""}}]},{"kind":"javascript-module","path":"components/arcgis-area-measurement-3d","sourcePath":"src/components/area-measurement-3d/area-measurement-3d.tsx","declarations":[{"kind":"class","name":"ArcgisAreaMeasurement3d","customElement":true,"tagName":"arcgis-area-measurement-3d","pascalCaseName":"ArcgisAreaMeasurement3d","description":"The Area Measurement 3D component can be added to an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponent to calculate and display area and perimeter of polygons.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow the area and perimeter are computed depends on the scene's spatial reference and the length of the measured perimeter.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- If the measurement's perimeter is below 100 km, they are computed in a Euclidean manner,\n in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets).\n- If the perimeter is above 100 km, they are computed geodetically, and the visualization takes\n the curvature of the planet into consideration.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, the area and perimeter\nare always calculated in a Euclidean manner (in their respective PCS).\n\nThe area may be visualized and calculated in two ways:\n1. If all the vertices are mostly coplanar (lying on the same plane),\n the measurement polygon is formed on that plane, and area and perimeter are calculated from its geometry.\n2. If the vertices don't form a planar surface, the measurement polygon\n is projected to a horizontal plane, and area and perimeter are calculated from its geometry.\n\n\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\n\n**Things to consider**\n\n* Area Measurement 3D is designed to work in the Scene component. For measurements in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent, use [arcgis-area-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/).\n* Snapping is enabled by default. Holding the `CTRL` key disables it.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/).\n\n**See also**\n\n- [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)\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/)","docsTags":[{"name":"since","text":"4.28"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/"},{"description":"Area Measurement 3D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-area-measurement-3d--demo&singleStory=true"}],"superclass":{"name":"HTMLElement","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/API/HTMLElement"},"members":[{"kind":"field","name":"analysis","description":"The [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)\ncreated or modified by the component.\n\nWhen connecting the Area Measurement 3D component to the [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponent, it automatically creates an empty analysis and adds it to the Scene's\n[arcgis-scene.analyses](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#analyses) collection.\nYou can then wait for the [AreaMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/AreaMeasurementAnalysisView3D/)\nto be created before accessing the analysis results.\n\n```js\n// Get the Scene component and the Area Measurement 3D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst areaMeasurement3dElement = document.querySelector(\"arcgis-area-measurement-3d\");\nawait areaMeasurement3dElement.componentOnReady();\n\n// Get the AreaMeasurementAnalysis created by the Area Measurement 3D component.\nconst analysis = areaMeasurement3dElement.analysis;\n\n// Get the AreaMeasurementAnalysisView3D and watch for results.\nconst analysisView = await viewElement.whenAnalysisView(analysis);\nconst handle = reactiveUtils.watch(\n () => analysisView?.result,\n () => {\n console.log(\"Analysis results:\", analysisView.result);\n },\n);\n```\nWhenever the component is destroyed, the analysis is automatically removed from the collection.\n\nAlternatively, a programmatically created [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)\ncan be provided to the component.\nThen, the application itself needs to add it to and later remove it from the analyses collection of the Scene component.\n\n```js\n// Create the AreaMeasurementAnalysis.\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 component and the Area Measurement 3D component, and wait until both are ready.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\nconst areaMeasurement3dElement = document.querySelector(\"arcgis-area-measurement-3d\");\nawait areaMeasurement3dElement.componentOnReady();\n\n// Add the analysis to the analyses collection of the Scene component.\nviewElement.analyses.add(areaMeasurementAnalysis);\n\n// Connect the analysis to the measurement component:\nareaMeasurement3dElement.analysis = areaMeasurementAnalysis;\n```","type":{"text":"AreaMeasurementAnalysis","references":[{"name":"default","module":"analysis/AreaMeasurementAnalysis.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/","start":0,"end":23}]}},{"kind":"field","name":"autoDestroyDisabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"auto-destroy-disabled"},{"kind":"field","name":"hideStartButton","description":"If true, the button that starts a new measurement will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"hide-start-button"},{"kind":"field","name":"hideUnitSelect","description":"If true, the unit selection dropdown will be hidden.","docsTags":[{"name":"since","text":"5.0"}],"type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"hide-unit-select"},{"kind":"field","name":"hideVisualization","description":"Indicates whether the component's visualization is hidden in the view.","docsTags":[{"name":"since","text":"5.0"}],"type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","attribute":"hide-visualization"},{"kind":"field","name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","docsTags":[{"name":"see","text":"[Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)"}],"type":{"text":"Icon[\"icon\"] | undefined","references":[{"name":"Icon","module":"components/calcite-icon","package":"@esri/calcite-components","start":0,"end":4}],"values":[{"type":"string"}]},"default":"\"measure-area\"","attribute":"icon","reflects":true},{"kind":"field","name":"label","description":"The component's default label.","type":{"text":"string | undefined","values":[{"type":"string"}]},"attribute":"label"},{"kind":"field","name":"referenceElement","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","docsTags":[{"name":"see","text":"[Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)"}],"type":{"text":"ArcgisReferenceElement | string | undefined","references":[{"name":"ArcgisReferenceElement","module":"components/types","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/types/#ArcgisReferenceElement","start":0,"end":22}],"values":[{"type":"string"},{"type":"object"}]},"attribute":"reference-element"},{"kind":"field","name":"state","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","type":{"text":"AreaMeasurement3DState","references":[{"name":"AreaMeasurement3DState","module":"components/arcgis-area-measurement-3d/types","viewUrl":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/types#AreaMeasurement3DState","start":0,"end":22}],"values":[{"type":"string","value":"disabled"},{"type":"string","value":"ready"},{"type":"string","value":"unsupported"},{"type":"string","value":"measured"},{"type":"string","value":"measuring"}]},"readonly":true},{"kind":"field","name":"unit","description":"Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#unitOptions).","type":{"text":"SystemOrAreaUnit","references":[{"name":"SystemOrAreaUnit","module":"core/units.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/core/units/#SystemOrAreaUnit","start":0,"end":16}],"values":[{"type":"string","value":"metric"},{"type":"string","value":"imperial"},{"type":"string","value":"square-inches"},{"type":"string","value":"square-feet"},{"type":"string","value":"square-yards"},{"type":"string","value":"square-miles"},{"type":"string","value":"square-nautical-miles"},{"type":"string","value":"square-us-feet"},{"type":"string","value":"square-millimeters"},{"type":"string","value":"square-centimeters"},{"type":"string","value":"square-decimeters"},{"type":"string","value":"square-meters"},{"type":"string","value":"square-kilometers"},{"type":"string","value":"acres"},{"type":"string","value":"ares"},{"type":"string","value":"hectares"}]},"attribute":"unit"},{"kind":"field","name":"unitOptions","description":"List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.\nBy default, the following units are included: `metric`, `imperial`, `square-inches`, `square-feet`, `square-us-feet`, `square-yards`, `square-miles`, `square-meters`, `square-kilometers`, `acres`, `ares`, `hectares`.\nPossible [unit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#unit) values can only be a subset of this list.","type":{"text":"Array<SystemOrAreaUnit>","references":[{"name":"Array","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array","start":0,"end":5},{"name":"SystemOrAreaUnit","module":"core/units.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/core/units/#SystemOrAreaUnit","start":6,"end":22}]}},{"kind":"field","name":"view","description":"The view associated with the component. \n > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-area-measurement-3d component will be associated with a map or scene component rather than using the `view` property.","type":{"text":"SceneView | undefined","references":[{"name":"default","module":"views/SceneView.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/","start":0,"end":9}]}},{"kind":"method","name":"clear","description":"Clears the current measurement.","return":{"type":{"text":"Promise<void>","references":[{"name":"Promise","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise","start":0,"end":7}]}},"signature":"(): Promise<void>"},{"kind":"method","name":"componentOnReady","description":"Creates a promise that resolves once the component is fully loaded.","docsTags":[{"name":"example","text":"```js\nconst arcgisAreaMeasurement3d = document.createElement(\"arcgis-area-measurement-3d\");\ndocument.body.append(arcgisAreaMeasurement3d);\nawait arcgisAreaMeasurement3d.componentOnReady();\nconsole.log(\"arcgis-area-measurement-3d is ready to go!\");\n```"}],"return":{"type":{"text":"Promise<this>","references":[{"name":"Promise","module":"lib/lib.es5.d.ts","package":"typescript","start":0,"end":7}]}},"inheritedFrom":{"name":"this"},"signature":"(): Promise<this>"},{"kind":"method","name":"destroy","description":"Permanently destroy the component.","return":{"type":{"text":"Promise<void>","references":[{"name":"Promise","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise","start":0,"end":7}]}},"signature":"(): Promise<void>"},{"kind":"method","name":"start","description":"Starts a new measurement.","return":{"type":{"text":"Promise<void>","references":[{"name":"Promise","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise","start":0,"end":7}]}},"signature":"(): Promise<void>"}],"attributes":[{"name":"auto-destroy-disabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"autoDestroyDisabled"},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"hideStartButton"},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"hideUnitSelect"},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","type":{"text":"boolean","values":[{"type":"boolean"}]},"default":"false","fieldName":"hideVisualization"},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","type":{"text":"string","values":[{"type":"string"}]},"default":"\"measure-area\"","fieldName":"icon"},{"name":"label","description":"The component's default label.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"label"},{"name":"reference-element","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","type":{"text":"string","values":[{"type":"string"}]},"fieldName":"referenceElement"},{"name":"unit","description":"Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#unitOptions).","type":{"text":"\"metric\" | \"imperial\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"acres\" | \"ares\" | \"hectares\"","values":[{"type":"string","value":"metric"},{"type":"string","value":"imperial"},{"type":"string","value":"square-inches"},{"type":"string","value":"square-feet"},{"type":"string","value":"square-yards"},{"type":"string","value":"square-miles"},{"type":"string","value":"square-nautical-miles"},{"type":"string","value":"square-us-feet"},{"type":"string","value":"square-millimeters"},{"type":"string","value":"square-centimeters"},{"type":"string","value":"square-decimeters"},{"type":"string","value":"square-meters"},{"type":"string","value":"square-kilometers"},{"type":"string","value":"acres"},{"type":"string","value":"ares"},{"type":"string","value":"hectares"}]},"fieldName":"unit"}],"events":[{"name":"arcgisPropertyChange","description":"Emitted when the value of a property is changed. Use this to listen to changes to properties.","type":{"text":"{ name: \"analysis\" | \"state\"; }"}},{"name":"arcgisReady","description":"Emitted when the component associated with a map or scene view is ready to be interacted with.","type":{"text":"void"}}],"importPath":"components/arcgis-area-measurement-3d"}],"exports":[{"kind":"custom-element-definition","name":"arcgis-area-measurement-3d","declaration":{"name":"ArcgisAreaMeasurement3d"}}]},{"kind":"javascript-module","path":"components/arcgis-area-measurement-3d/types","sourcePath":"src/components/area-measurement-3d/types.ts","declarations":[{"kind":"interface","name":"AreaMeasurement3DState","type":{"text":"\"disabled\" | \"measured\" | \"measuring\" | \"ready\" | \"unsupported\""}}]},{"kind":"javascript-module","path":"components/arcgis-attachments","sourcePath":"src/components/attachments/attachments.tsx","declarations":[{"kind":"class","name":"ArcgisAttachments","customElement":true,"tagName":"arcgis-attachments","pascalCaseName":"ArcgisAttachments","docsTags":[{"name":"internal"}],"demos":[{"description":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachments/"}],"superclass":{"name":"HTMLElement","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/API/HTMLElement"},"members":[{"kind":"field","name":"attachmentInfos","description":"A collection of [AttachmentInfo](https://developers.arcgis.com/javascript/latest/references/core/rest/query/support/AttachmentInfo/) defined on a feature.","docsTags":[{"name":"see","text":"[ArcGIS REST API - Attachment Infos (Feature Service)](https://developers.arcgis.com/rest/services-reference/attachment-infos-feature-service-.htm)"}],"type":{"text":"Collection<AttachmentInfo>","references":[{"name":"default","module":"core/Collection.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/core/Collection/","start":0,"end":10},{"name":"default","module":"rest/query/support/AttachmentInfo.js","package":"@arcgis/core","viewUrl":"https://developers.arcgis.com/javascript/latest/references/core/rest/query/support/AttachmentInfo/","start":11,"end":25}]},"readonly":true},{"kind":"field","name":"attachmentKeywords","description":"An array of strings used to identify attachment(s). When attachments are displayed, this property is used to query attachments using an exact match on the keywords provided.","type":{"text":"Array<string> | null | undefined","references":[{"name":"Array","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array","start":0,"end":5}]}},{"kind":"field","name":"attachmentTypes","description":"An array of strings representing MIME types. When attachments are displayed, this property is used to query attachments based on MIME type. Valid values: application, audio, image, model, text, and video.","type":{"text":"Array<\"image\" | \"model\" | \"text\" | \"video\" | \"application\" | \"audio\"> | null | undefined","references":[{"name":"Array","package":"global:","viewUrl":"https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array","start":0,"end":5}]}},{"kind":"field","name":"autoDestroyDisabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachments/#destroy) method when you are done to\nprevent memory leaks.","type"