@arcgis/map-components
Version:
ArcGIS Map Components
1 lines • 1.59 MB
JSON
{"$schema":"https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json","name":"@arcgis/map-components","version":"5.1.12","description-markup":"markdown","contributions":{"html":{"elements":[{"name":"arcgis-area-measurement-2d","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).\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 ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","doc-url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/","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.","default":"false","value":{"type":"boolean"}},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","default":"false","value":{"type":"boolean"}},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","default":"false","value":{"type":"boolean"}},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","default":"false","value":{"type":"boolean"}},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","default":"\"measure-area\"","value":{"type":"string"}},{"name":"label","description":"The component's default label.","value":{"type":"string"}},{"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.","value":{"type":["string","object"]}},{"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).","value":{"type":["\"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\""]}}],"events":[{"name":"arcgisPropertyChange","type":"{ name: \"analysis\" | \"state\"; }","description":"Emitted when the value of a property is changed. Use this to listen to changes to properties."},{"name":"arcgisReady","type":"void","description":"Emitted when the component associated with a map or scene view is ready to be interacted with."}],"js":{"properties":[{"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":"AreaMeasurementAnalysis"},{"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":"boolean"},{"name":"hideStartButton","description":"If true, the button that starts a new measurement will be hidden.","type":"boolean"},{"name":"hideUnitSelect","description":"If true, the unit selection dropdown will be hidden.","type":"boolean"},{"name":"hideVisualization","description":"Indicates whether the component's visualization is hidden in the view.","type":"boolean"},{"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":"Icon[\"icon\"] | undefined"},{"name":"label","description":"The component's default label.","type":"string | undefined"},{"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.","type":"ArcgisReferenceElement | string | undefined"},{"name":"snappingOptions","description":"The [SnappingOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/SnappingOptions/) for measuring.","type":"SnappingOptions"},{"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":"AreaMeasurement2DState"},{"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":"SystemOrAreaUnit"},{"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":"Array<SystemOrAreaUnit>"},{"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":"MapView | undefined"}],"events":[{"name":"arcgisPropertyChange","type":"{ name: \"analysis\" | \"state\"; }","description":"Emitted when the value of a property is changed. Use this to listen to changes to properties."},{"name":"arcgisReady","type":"void","description":"Emitted when the component associated with a map or scene view is ready to be interacted with."}]}},{"name":"arcgis-area-measurement-3d","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/)\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 ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","doc-url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/","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.","default":"false","value":{"type":"boolean"}},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","default":"false","value":{"type":"boolean"}},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","default":"false","value":{"type":"boolean"}},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","default":"false","value":{"type":"boolean"}},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","default":"\"measure-area\"","value":{"type":"string"}},{"name":"label","description":"The component's default label.","value":{"type":"string"}},{"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.","value":{"type":["string","object"]}},{"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).","value":{"type":["\"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\""]}}],"events":[{"name":"arcgisPropertyChange","type":"{ name: \"analysis\" | \"state\"; }","description":"Emitted when the value of a property is changed. Use this to listen to changes to properties."},{"name":"arcgisReady","type":"void","description":"Emitted when the component associated with a map or scene view is ready to be interacted with."}],"js":{"properties":[{"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":"AreaMeasurementAnalysis"},{"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":"boolean"},{"name":"hideStartButton","description":"If true, the button that starts a new measurement will be hidden.","type":"boolean"},{"name":"hideUnitSelect","description":"If true, the unit selection dropdown will be hidden.","type":"boolean"},{"name":"hideVisualization","description":"Indicates whether the component's visualization is hidden in the view.","type":"boolean"},{"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":"Icon[\"icon\"] | undefined"},{"name":"label","description":"The component's default label.","type":"string | undefined"},{"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.","type":"ArcgisReferenceElement | string | undefined"},{"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":"AreaMeasurement3DState"},{"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":"SystemOrAreaUnit"},{"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":"Array<SystemOrAreaUnit>"},{"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":"SceneView | undefined"}],"events":[{"name":"arcgisPropertyChange","type":"{ name: \"analysis\" | \"state\"; }","description":"Emitted when the value of a property is changed. Use this to listen to changes to properties."},{"name":"arcgisReady","type":"void","description":"Emitted when the component associated with a map or scene view is ready to be interacted with."}]}},{"name":"arcgis-attachments","description":"### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","doc-url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachments/","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-attachments/#destroy) method when you are done to\nprevent memory leaks.","default":"false","value":{"type":"boolean"}},{"name":"display-type","description":"String indicating how to [display](https://developers.arcgis.com/javascript/latest/references/core/widgets/Attachments/#displayType) the attachments.\n\n| Value | Description |\n| ------ | ----------- |\n| auto | Default value. If a feature layer's capabilities supports [resizing attachments](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities), the popup will display attachments in `preview` mode.|\n| preview | Shows a thumbnail image of the attachment.|\n| list | Shows a list of attachment links. |","default":"\"auto\"","value":{"type":["\"list\"","\"auto\"","\"preview\""]}},{"name":"hide-add-button","description":"Indicates whether to hide the `Add` button which prompts the dialog to add a new attachment.","default":"false","value":{"type":"boolean"}},{"name":"hide-add-submit-button","description":"Indicates whether to hide the `add` button after selecting the attachment to add..","default":"false","value":{"type":"boolean"}},{"name":"hide-cancel-add-button","description":"Indicates whether to hide the `cancel` button after selecting the attachment to add.","default":"false","value":{"type":"boolean"}},{"name":"hide-cancel-update-button","description":"Indicates whether to hide the `cancel` button after selecting an attachment to update an existing attachment.","default":"false","value":{"type":"boolean"}},{"name":"hide-delete-button","description":"Indicates whether to hide the `delete` button to delete an existing attachment.","default":"false","value":{"type":"boolean"}},{"name":"hide-error-message","description":"Indicates whether to hide an error message if adding or updating an attachment results in errors.","default":"false","value":{"type":"boolean"}},{"name":"hide-progress-bar","description":"Indicates whether to hide a progress bar when adding an attachment.","default":"false","value":{"type":"boolean"}},{"name":"hide-update-button","description":"Indicates whether to hide an `update` button to allow updating on existing attachments.","default":"false","value":{"type":"boolean"}},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","default":"\"attachment\"","value":{"type":"string"}},{"name":"label","description":"The component's default label.","value":{"type":"string"}},{"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.","value":{"type":["string","object"]}}],"events":[{"name":"arcgisPropertyChange","type":"{ name: \"submitting\" | \"state\" | \"attachmentInfos\"; }","description":"Emitted when the value of a property is changed. Use this to listen to changes to properties."},{"name":"arcgisReady","type":"void","description":"Emitted when the component associated with a map or scene view is ready to be interacted with."}],"js":{"properties":[{"name":"attachmentInfos","description":"A collection of [AttachmentInfo](https://developers.arcgis.com/javascript/latest/references/core/rest/query/support/AttachmentInfo/) defined on a feature.","type":"Collection<AttachmentInfo>"},{"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":"Array<string> | null | undefined"},{"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":"Array<\"image\" | \"model\" | \"text\" | \"video\" | \"application\" | \"audio\"> | null | undefined"},{"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":"boolean"},{"name":"capabilities","description":"The capabilities needed for the attachments component.","type":"AttachmentsCapabilities"},{"name":"displayType","description":"String indicating how to [display](https://developers.arcgis.com/javascript/latest/references/core/widgets/Attachments/#displayType) the attachments.\n\n| Value | Description |\n| ------ | ----------- |\n| auto | Default value. If a feature layer's capabilities supports [resizing attachments](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities), the popup will display attachments in `preview` mode.|\n| preview | Shows a thumbnail image of the attachment.|\n| list | Shows a list of attachment links. |","type":"AttachmentsDisplay"},{"name":"graphic","description":"The graphic for the attachments.","type":"Graphic | null | undefined"},{"name":"hideAddButton","description":"Indicates whether to hide the `Add` button which prompts the dialog to add a new attachment.","type":"boolean | undefined"},{"name":"hideAddSubmitButton","description":"Indicates whether to hide the `add` button after selecting the attachment to add..","type":"boolean | undefined"},{"name":"hideCancelAddButton","description":"Indicates whether to hide the `cancel` button after selecting the attachment to add.","type":"boolean | undefined"},{"name":"hideCancelUpdateButton","description":"Indicates whether to hide the `cancel` button after selecting an attachment to update an existing attachment.","type":"boolean | undefined"},{"name":"hideDeleteButton","description":"Indicates whether to hide the `delete` button to delete an existing attachment.","type":"boolean | undefined"},{"name":"hideErrorMessage","description":"Indicates whether to hide an error message if adding or updating an attachment results in errors.","type":"boolean | undefined"},{"name":"hideProgressBar","description":"Indicates whether to hide a progress bar when adding an attachment.","type":"boolean | undefined"},{"name":"hideUpdateButton","description":"Indicates whether to hide an `update` button to allow updating on existing attachments.","type":"boolean | undefined"},{"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":"IconName"},{"name":"label","description":"The component's default label.","type":"string | null | undefined"},{"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.","type":"ArcgisReferenceElement | string | undefined"},{"name":"state","description":"The current state of the component.","type":"AttachmentsViewModelState"},{"name":"submitting","description":"Indicates whether there is currently an attachment being added, updated or deleted.","type":"boolean"}],"events":[{"name":"arcgisPropertyChange","type":"{ name: \"submitting\" | \"state\" | \"attachmentInfos\"; }","description":"Emitted when the value of a property is changed. Use this to listen to changes to properties."},{"name":"arcgisReady","type":"void","description":"Emitted when the component associated with a map or scene view is ready to be interacted with."}]}},{"name":"arcgis-basemap-gallery","description":"The Basemap Gallery component displays a collection images representing basemaps from [ArcGIS.com](https://www.arcgis.com/index.html) or a user-defined set of map or image services. When a new basemap is selected from the Basemap Gallery, the map's basemap layers are removed and replaced with the basemap layers of the associated basemap selected in the gallery.\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 ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","doc-url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/","attributes":[{"name":"active-basemap","description":"The map's current [basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap).","value":{"type":["string","object"]}},{"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-basemap-gallery/#destroy) method when you are done to\nprevent memory leaks.","default":"false","value":{"type":"boolean"}},{"name":"disabled","description":"When true, the component is visually withdrawn and cannot receive user interaction.","default":"false","value":{"type":"boolean"}},{"name":"heading-level","description":"Indicates the heading level to use for the message \"No basemaps available\"\nwhen no basemaps are available in the Basemap Gallery.","default":"2","value":{"type":["6","1","2","3","4","5"]}},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","default":"\"basemap\"","value":{"type":"string"}},{"name":"label","description":"The component's default label.","default":"\"\"","value":{"type":"string"}},{"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.","value":{"type":["string","object"]}}],"events":[{"name":"arcgisPropertyChange","type":"{ name: \"activeBasemap\" | \"state\"; }","description":"Emitted when the value of a property is changed. Use this to listen to changes to properties."},{"name":"arcgisReady","type":"void","description":"Emitted when the component associated with a map or scene view is ready to be interacted with."}],"js":{"properties":[{"name":"activeBasemap","description":"The map's current [basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap).","type":"BasemapProperties | string | undefined"},{"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-basemap-gallery/#destroy) method when you are done to\nprevent memory leaks.","type":"boolean"},{"name":"disabled","description":"When true, the component is visually withdrawn and cannot receive user interaction.","type":"boolean"},{"name":"headingLevel","description":"Indicates the heading level to use for the message \"No basemaps available\"\nwhen no basemaps are available in the Basemap Gallery.","type":"HeadingLevel"},{"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":"string"},{"name":"label","description":"The component's default label.","type":"string"},{"name":"messageOverrides","description":"Replace localized message strings with your own strings.\n\n_**Note**: Individual message keys may change between releases._","type":"Record<string, unknown> | undefined"},{"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.","type":"ArcgisReferenceElement | string | undefined"},{"name":"source","description":"The source for basemaps that the component will display.","type":"LocalBasemapsSource | PortalBasemapsSource"},{"name":"state","description":"The current state of the component.","type":"BasemapGalleryViewModelState"},{"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-basemap-gallery component will be associated with a map or scene component rather than using the `view` property.","type":"MapViewOrSceneView | null | undefined"}],"events":[{"name":"arcgisPropertyChange","type":"{ name: \"activeBasemap\" | \"state\"; }","description":"Emitted when the value of a property is changed. Use this to listen to changes to properties."},{"name":"arcgisReady","type":"void","description":"Emitted when the component associated with a map or scene view is ready to be interacted with."}]}},{"name":"arcgis-basemap-layer-list","description":"The Basemap Layer List component provides a way to display a list of [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/) layers and switch on/off their visibility. [Base layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#baseLayers) and [reference layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#referenceLayers) are divided into separate sections. When editing is enabled, layers can be reordered by dragging and dropping between the lists and the title can be edited.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\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 ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","doc-url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/","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-basemap-layer-list/#destroy) method when you are done to\nprevent memory leaks.","default":"false","value":{"type":"boolean"}},{"name":"base-filter-text","description":"The value of the filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.","default":"\"\"","value":{"type":"string"}},{"name":"basemap-title","description":"The current basemap's title.","value":{"type":"string"}},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","default":"false","value":{"type":"boolean"}},{"name":"collapsed","description":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","default":"false","value":{"type":"boolean"}},{"name":"drag-enabled","description":"Indicates whether [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) may be reordered within the list by dragging and dropping.\nMapImageLayer [sublayers](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/#sublayers) can be reordered only within their parent MapImageLayer and can not be dragged out as a separate layer.","default":"false","value":{"type":"boolean"}},{"name":"editing-title","description":"Indicates whether the form to edit the basemap's title is currently visible.\nAny edits made will only be shown locally and will not be saved.","default":"false","value":{"type":"boolean"}},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.","default":"\"\"","value":{"type":"string"}},{"name":"heading-level","description":"Indicates the heading level to use for the component's title (i.e. \"Navigation\").\nBy default, the basemap's title is rendered\nas a level 2 heading (e.g. `<h2>Navigation</h2>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","default":"2","value":{"type":["6","1","2","3","4","5"]}},{"name":"hide-base-layers","description":"Indicates whether the base layers will be displayed.","default":"false","value":{"type":"boolean"}},{"name":"hide-heading","description":"Indicates whether the basemap layer list displays a heading. The heading text is the title of the basemap. The heading level can be set with the [BasemapLayerList#headingLevel](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#headingLevel).","default":"false","value":{"type":"boolean"}},{"name":"hide-reference-layers","description":"Indicates whether to the reference layers will be displayed.","default":"false","value":{"type":"boolean"}},{"name":"hide-status-indicators","description":"Indicates whether the status indicators will be displayed.","default":"false","value":{"type":"boolean"}},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","default":"\"layers\"","value":{"type":"string"}},{"name":"label","description":"The component's default label.","value":{"type":"string"}},{"name":"min-filter-items","description":"The minimum number of list items required to display the [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) input box.","default":"10","value":{"type":"number"}},{"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.","value":{"type":["string","object"]}},{"name":"reference-filter-text","description":"The value of the filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.","default":"\"\"","value":{"type":"string"}},{"name":"selection-mode","description":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#selectedItems) property.\n\n| Value | Description |\n| ----- | ----------- |\n| multiple | Allows any number of items to be selected at once. This is useful when you want to apply an operation to multiple items at the same time. |\n| none | Disables selection. Use this when you want to prevent selecting items. |\n| single | Allows only one item to be selected at a time. If another item is selected, the previous selection is cleared. This is useful when you want to ensure that a maximum of one item is selected at a time. |\n| single-persist | Allows only one item to be selected at a time and prevents de-selection. Once an item is selected, it remains selected until another item is selected. This is useful when you want to ensure that there is always exactly one selected item. |","default":"\"none\"","value":{"type":["\"multiple\"","\"single\"","\"none\"","\"single-persist\""]}},{"name":"show-close-button","description":"Indicates whether to display a close button in the header.","default":"false","value":{"type":"boolean"}},{"name":"show-collapse-button","description":"Indicates whether to display a collapse button in the header.","default":"false","value":{"type":"boolean"}},{"name":"show-edit-title-button","description":"Indicates whether to display a button in the header to edit the basemap title.","default":"false","value":{"type":"boolean"}},{"name":"show-errors","description":"Indicates whether to display layers with load errors.","default":"false","value":{"type":"boolean"}},{"name":"show-filter","description":"Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in [BasemapLayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#minFilterItems), allowing users to filter layers by their title.","default":"false","value":{"type":"boolean"}},{"name":"show-temporary-layer-indicators","description":"Indicates whether temporary layer indicators will be displayed for layers with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#persistenceEnabled) set to `false`. A [temporary icon](https://developers.arcgis.com/calcite-design-system/icons/?icon=temporary&library=Calcite%20UI&query=temporary) will be displayed on the near side of the layer title.","default":"false","value":{"type":"boolean"}},{"name":"visibility-appearance","description":"Determines the icons used to indicate visibility.\n\n| Value | Description | Example |\n| ----- | ----------- | ------- |\n| default | Displays view icons on the far side. Icons are hidden except on hover or if they have keyboard focus. See [view-visible](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-visible&library=Calcite%20UI&query=view) and [view-hide](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-hide&library=Calcite%20UI&query=view) calcite icons. |  |\n| checkbox | Displays checkbox icons on the near side. See [check-square-f](https://developers.arcgis.com/calcite-design-system/icons/?icon=check-square-f&library=Calcite%20UI&query=check) and [square](https://developers.arcgis.com/calcite-design-system/icons/?icon=square&library=Calcite%20UI&query=square) calcite icons. |  |","default":"\"default\"","value":{"type":["\"checkbox\"","\"default\""]}}],"events":[{"name":"arcgisClose","type":"void","description":"Emitted when the compo