@arcgis/map-components 5.2.0-next.160 → 5.2.0-next.161

package/dist/docs/vscode.html-custom-data.json

@@ -1 +1 @@
-{"$schema":"https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json","version":1.1,"tags":[{"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 for user interaction.\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.","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.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"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-2d/#unitOptions).\n\nWhen no unit is explicitly set on the component or its analysis, this property uses the area unit configured in the view through\n[view.options.displayUnits.area](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#unitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the area unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"metric"},{"name":"imperial"},{"name":"square-inches"},{"name":"square-feet"},{"name":"square-yards"},{"name":"square-miles"},{"name":"square-nautical-miles"},{"name":"square-us-feet"},{"name":"square-millimeters"},{"name":"square-centimeters"},{"name":"square-decimeters"},{"name":"square-meters"},{"name":"square-kilometers"},{"name":"acres"},{"name":"ares"},{"name":"hectares"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/"},{"name":"Area Measurement 2D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-area-measurement-2d--demo&singleStory=true"}]},{"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[![measurement-area-3d](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/3D_AreaMeasurement_widget.avif)](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![area-measurement-3d-types](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/area-measurement-3d-types.avif)\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 for user interaction.\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.","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.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"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).\n\nWhen no unit is explicitly set on the component or its analysis, this property uses the area unit configured in the view through\n[view.options.displayUnits.area](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#unitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the area unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"metric"},{"name":"imperial"},{"name":"square-inches"},{"name":"square-feet"},{"name":"square-yards"},{"name":"square-miles"},{"name":"square-nautical-miles"},{"name":"square-us-feet"},{"name":"square-millimeters"},{"name":"square-centimeters"},{"name":"square-decimeters"},{"name":"square-meters"},{"name":"square-kilometers"},{"name":"acres"},{"name":"ares"},{"name":"hectares"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/"},{"name":"Area Measurement 3D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-area-measurement-3d--demo&singleStory=true"}]},{"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 for user interaction.\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.","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.","values":[]},{"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 support [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. |","values":[{"name":"list"},{"name":"auto"},{"name":"preview"},{"name":"carousel"}]},{"name":"hide-add-button","description":"Indicates whether to hide the `Add` button which prompts the dialog to add a new attachment.","values":[]},{"name":"hide-add-submit-button","description":"Indicates whether to hide the `add` button after selecting the attachment to add.","values":[]},{"name":"hide-cancel-add-button","description":"Indicates whether to hide the `cancel` button after selecting the attachment to add.","values":[]},{"name":"hide-cancel-update-button","description":"Indicates whether to hide the `cancel` button after selecting an attachment to update an existing attachment.","values":[]},{"name":"hide-delete-button","description":"Indicates whether to hide the `delete` button to delete an existing attachment.","values":[]},{"name":"hide-error-message","description":"Indicates whether to hide an error message if adding or updating an attachment results in errors.","values":[]},{"name":"hide-progress-bar","description":"Indicates whether to hide a progress bar when adding an attachment.","values":[]},{"name":"hide-update-button","description":"Indicates whether to hide an `update` button to allow updating of existing attachments.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachments/"}]},{"name":"arcgis-basemap-gallery","description":"The Basemap Gallery component displays a collection of 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 for user interaction.\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.","attributes":[{"name":"active-basemap","description":"The map's current [basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap).","values":[]},{"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.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"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).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/"},{"name":"Basemap Gallery","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-basemap-gallery--demo&singleStory=true"}]},{"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> [!WARNING]\n> In version 6.0, the implementation of [arcgis-basemap-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/) will be updated under the hood to that of [arcgis-basemap-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/), and the way events for [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#catalogLayerList) are handled will change. We encourage using the [arcgis-basemap-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/) component and providing feedback.\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 for user interaction.\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.","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.","values":[]},{"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.","values":[]},{"name":"basemap-title","description":"The current basemap's title.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","values":[]},{"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.","values":[]},{"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.","values":[]},{"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.","values":[]},{"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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-base-layers","description":"Indicates whether the base layers will be displayed.","values":[]},{"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).","values":[]},{"name":"hide-reference-layers","description":"Indicates whether to the reference layers will be displayed.","values":[]},{"name":"hide-status-indicators","description":"Indicates whether the status indicators will be displayed.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"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.","values":[]},{"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.","values":[]},{"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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"Indicates whether to display a close button in the header.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to display a collapse button in the header.","values":[]},{"name":"show-edit-title-button","description":"Indicates whether to display a button in the header to edit the basemap title.","values":[]},{"name":"show-errors","description":"Indicates whether to display layers with load errors.","values":[]},{"name":"show-filter","description":"Indicates whether to display a filter input box when the 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.","values":[]},{"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.","values":[]},{"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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-checkbox.avif) |","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/"},{"name":"Basemap Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-basemap-layer-list--demo&singleStory=true"}]},{"name":"arcgis-basemap-layer-list-next","description":"> [!WARNING]\n> The Basemap Layer List (next) component is the successor to the Basemap Layer List component, provided to you early for testing and feedback.\nIn version 6.0, the implementation of [arcgis-basemap-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/) will be updated under the hood to that of [arcgis-basemap-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/),\nand this component will be removed. There is a breaking change in the name of the events for [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#catalogLayerList) compared to the [arcgis-basemap-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/).\nTo update at version 6.0, simply remove `-next` from the component name.\n\nThe Basemap Layer List (next) 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.\n[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.\n--\n\n### Events\n- **arcgisBaseFilterChange** - Emitted when the value of the [baseFilterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#baseFilterText) changes.\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisOpenedLayersChange** - Emitted when the collection of [openedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#openedLayers) changes.\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 for user interaction.\n- **arcgisReferenceFilterChange** - Emitted when the value of the [referenceFilterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#referenceFilterText) changes.\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.","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-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"base-filter-text","description":"The value of the [base layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#baseLayers)\nfilter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#showFilter) is true.","values":[]},{"name":"basemap-title","description":"The current basemap's title.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed. When collapsed, only the collapse button and heading are displayed.","values":[]},{"name":"drag-enabled","description":"Indicates whether [items](https://developers.arcgis.com/javascript/latest/references/core/layerList/Item/) may be reordered within the list by dragging and dropping. MapImageLayer [MapImageLayer#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.","values":[]},{"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.","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input when filtering is enabled.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-base-layers","description":"This property provides the ability to show or hide the\n[base layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#baseLayers).","values":[]},{"name":"hide-catalog-layer-list","description":"Indicates whether to hide the catalog layer list in the component.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's heading.","values":[]},{"name":"hide-no-filter-results-notice","description":"Indicates whether to hide the notice that appears when no results are found after filtering.","values":[]},{"name":"hide-no-items-notice","description":"Indicates whether to hide the notice that appears when there are no items to display.","values":[]},{"name":"hide-reference-layers","description":"This property provides the ability to show or hide the\n[reference layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#referenceLayers).","values":[]},{"name":"hide-status-indicators","description":"Indicates whether to hide status indicators in the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"list-mode-disabled","description":"Specifies whether to ignore the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property to display all layers. A common use case for `listModeDisabled` is when you want to use the component to manage and configure a layer's `listMode` value.","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the filter input box.","values":[]},{"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.","values":[]},{"name":"reference-filter-text","description":"The value of the [reference layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#referenceLayers)\nfilter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#showFilter) is true.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode. Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-edit-title-button","description":"This property provides the ability to show or hide the edit title button in the header.","values":[]},{"name":"show-errors","description":"This property provides the ability to show or hide layer error indicators.","values":[]},{"name":"show-filter","description":"This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-temporary-layer-indicators","description":"This property provides the ability to show or hide the temporary layer indicators 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.","values":[]},{"name":"visibility-appearance","description":"Determines the icons used to indicate visibility.\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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-checkbox.avif) |\n","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/"},{"name":"Basemap Layer List Next","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-basemap-layer-list-next--demo&singleStory=true"}]},{"name":"arcgis-basemap-toggle","description":"The Basemap Toggle component allows an end-user to switch between two basemaps.\n\nThe basemaps can have different spatial references.\n\nStarting at 5.2, when the `activeBasemap` changes, the selected basemap is announced to assistive technologies.\nVisit the [Accessibility guide](https://developers.arcgis.com/javascript/latest/accessibility/#assistive-technologies) to learn more about live announcements supporting more audiences.\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 for user interaction.\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.\n- `toggle(): Promise<any>` - Toggles to the [nextBasemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/#nextBasemap).","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-toggle/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"next-basemap","description":"The next basemap for toggling.","values":[]},{"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.","values":[]},{"name":"show-title","description":"Indicates if the Basemap title is displayed.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/"},{"name":"Basemap Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-basemap-toggle--demo&singleStory=true"}]},{"name":"arcgis-bookmarks","description":"The Bookmarks component allows end users to quickly navigate to a particular area of interest.\nIt displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/),\nwhich are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks).\n\nEach bookmark may contain the following properties: `name`, `thumbnail`, `viewpoint` (defines rotation, scale, and target geometry), and `timeExtent`.\nWhen a bookmark with a timeExtent is selected, the [arcgis-map.timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeExtent) of the Map will be set to the timeExtent of the selected bookmark.\nTo disable time capability in the Bookmarks component, set [timeDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#timeDisabled) to `true`.\n\nStarting with version `5.1`, on [@arcgisBookmarkSelect](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#event-arcgisBookmarkSelect) the selected bookmark's name is announced to assistive technologies. Visit the [Accessibility guide](https://developers.arcgis.com/javascript/latest/accessibility/#assistive-technologies) to learn more\nabout live announcements supporting more audiences.\n\nThe Bookmarks component can be used to create, edit, reorder, and delete bookmarks.\nTo enable these features, set the following properties to `true`:\n[showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showAddBookmarkButton), [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showEditBookmarkButton), and [dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#dragEnabled).\n\n**Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) only if they come from a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks) or are provided manually from [bookmarks](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#bookmarks). [Presentation](https://developers.arcgis.com/javascript/latest/references/core/webscene/Presentation/) provides a similar experience for [WebScenes](https://developers.arcgis.com/javascript/latest/references/core/webscene/Presentation/).\n--\n\n### Events\n- **arcgisBookmarkEdit** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/) is edited.\n- **arcgisBookmarkSelect** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/) is selected.\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 for user interaction.\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.\n- `goTo(bookmark: Bookmark): Promise<void>` - Zoom to a specific bookmark.","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-bookmarks/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"bookmarks","description":"A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/)s. These are typically defined inside of a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks), but can also be defined manually, as shown in the code snippet below.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"drag-enabled","description":"Indicates if a Bookmark is able to be dragged in order to update its position in the list.","values":[]},{"name":"filter-placeholder","description":"Defines the text used as a placeholder when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showFilter) is set to `true`.","values":[]},{"name":"filter-text","description":"Defines the text used to filter the bookmarks when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showFilter) is set to `true`.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the message \"No bookmarks\" when no bookmarks\nare available. By default, this message is rendered\nas a level 2 heading (e.g. `<h2>No bookmarks</h2>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-thumbnail","description":"Indicates whether the thumbnail associated with the bookmark is hidden.","values":[]},{"name":"hide-time","description":"Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-add-bookmark-button","description":"Indicates whether to display the button to add a new bookmark.","values":[]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-edit-bookmark-button","description":"Indicates whether to display the button to edit a bookmark.","values":[]},{"name":"show-filter","description":"Indicates whether to display the bookmark filter.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]},{"name":"time-disabled","description":"Indicates whether to disable the time capability of the Bookmarks component.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/"},{"name":"Bookmarks","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-bookmarks--demo&singleStory=true"}]},{"name":"arcgis-building-explorer","description":"The Building Explorer component is used to filter and explore the various building elements of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of building elements grouped in sublayers. Using the Building Explorer component, buildings can be filtered by [level](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#level), [phase](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#phase) or by disciplines and categories.\nThe visibility of these elements can be configured using the component's [hideLevels](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hideLevels), [hidePhases](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hidePhases) and [hideDisciplines](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hideDisciplines) properties.\n\n[![building-explorer](https://developers.arcgis.com/javascript/latest/assets/references/components/building-explorer/building-explorer.avif)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-filter/)\n\nThe [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) to be explored have to be set on the [layers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#layers) property of the component. When setting multiple layers, the filters set by the Building Explorer component will be applied on all layers. The component doesn't allow the user to select between multiple layers present in a scene.\n\nOften, [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) contain an _Overview_ [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingComponentSublayer/) that serves as an exterior shell and views the building model as a single feature. When a layer is added to the Building Explorer component, the visibility of the _Overview_ layer is turned off, so that the user can directly interact with the individual features in the _Full Model_ [BuildingGroupSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingGroupSublayer/).\n\nThe Level element of the Building Explorer component allows users to select a single level in one or several buildings. When selecting a level, the levels above it are hidden and the levels below it become semi-transparent for added visual context.\n\nSome [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) include information indicating the phase in which building elements, such as doors or pipes, were created and, optionally, when they were demolished. If a layer has multiple construction phases, these will be displayed in the Construction phases element. When selecting a construction phase, all the building elements created during or before the phase are selected. Demolished building elements aren't displayed.\n\nDiscipline layers are [group layers](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingGroupSublayer/) that organize the [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) content into architectural, structural, mechanical, or electrical groups. These layers contain a number of Category layers such as walls, windows, furniture, and lighting fixtures. These layers can be turned on and off in the Disciplines and Categories list.\n\nThe Building Explorer component can only display filters set by the component itself. Filters set by other applications will be ignored.\n\n**Known limitations**\n\nBuilding Explorer is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [Sample - Filter BuildingSceneLayer with Building Explorer](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-filter/)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)\n--\n\n### Events\n- **arcgisBuildingLevelChange** - Emitted when the user changes the selected building level, or when a new filter instance is loaded.\n- **arcgisBuildingPhaseChange** - Emitted when the user changes the selected construction phase, or when a new filter instance is loaded.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-building-explorer/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-disciplines","description":"If true, the disciplines tree will be hidden.","values":[]},{"name":"hide-level-heading","description":"If true, the Level heading will be hidden without hiding the levels filter.\nTo hide the entire filter, use [hideLevels](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hideLevels).","values":[]},{"name":"hide-levels","description":"If true, the levels filter will be hidden.\nThe filter is also hidden when fewer than two levels are available.","values":[]},{"name":"hide-phases","description":"If true, the phases filter will be hidden.\nThe filter is also hidden when fewer than two phases are available.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"level","description":"The currently selected value for the building level filter.","values":[]},{"name":"phase","description":"The currently selected value for the construction phase filter.\nConstruction phases are used to track site development for a [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/). Setting a construction phase in the Building Explorer selects everything in the layer which is already constructed at that phase (created phase <= selected phase) but not yet demolished (demolished phase > selected phase). The goal is to display what the building or construction site looks like at that selected phase.","values":[]},{"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.","values":[]},{"name":"toggle-siblings-visibility","description":"If true, Ctrl-clicking or Command-clicking a discipline or category checkbox\nalso toggles its siblings, matching the BuildingExplorer widget.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/"},{"name":"Building Explorer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-building-explorer--demo&singleStory=true"}]},{"name":"arcgis-catalog-layer-list","description":"The Catalog Layer List provides a way to display and interact with [CatalogLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/).\nThe component displays a list of layers in the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer)\nand allows you to toggle their visibility.\n\nThe [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.\n\n> [!WARNING]\n> In version 6.0, the implementation of [arcgis-catalog-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/) will be updated under the hood to that of [arcgis-catalog-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/). We encourage using the [arcgis-catalog-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/) component and providing feedback.\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 for user interaction.\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.","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-catalog-layer-list/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and the heading are displayed.","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter) is true.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component.\nBy default, the heading is rendered as a level 2 heading (e.g., `<h2>Catalog Layer List</h2>`).\nDepending on the component's placement in your app, you may need to adjust this heading for proper semantics.\nThis is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-status-indicators","description":"Indicates whether the status indicators will be displayed.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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-catalog-layer-list/#showFilter) input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"Indicates whether to display a close button in the header.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to display a collapse button in the header.","values":[]},{"name":"show-errors","description":"Indicates whether to display layers with load errors.","values":[]},{"name":"show-filter","description":"Indicates whether to display a filter input box when the number of list items is equal to or greater than the value set in [CatalogLayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"Indicates whether to display the component's heading. The heading text is \"Layer List\". The heading level can be set with the [CatalogLayerList#headingLevel](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#headingLevel).","values":[]},{"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.","values":[]},{"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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-checkbox.avif) |","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/"},{"name":"Catalog Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-catalog-layer-list--demo&singleStory=true"}]},{"name":"arcgis-catalog-layer-list-next","description":"> [!WARNING]\n> The Catalog Layer List (next) component is the successor to the Catalog Layer List component, provided to you early for testing and feedback.\nIn version 6.0, the implementation of [arcgis-catalog-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/) will be updated under the hood to that of [arcgis-catalog-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/),\nand this component will be removed. To update at version 6.0, simply remove `-next` from the component name.\n\nThe Catalog Layer List provides a way to display and interact with [CatalogLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/).\nThe component displays a list of layers in the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer)\nand allows you to toggle their visibility.\n\nThe [Item](https://developers.arcgis.com/javascript/latest/references/core/layerList/Item/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.\n--\n\n### Events\n- **arcgisCatalogItemsChange** - Emitted when the [catalogItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#catalogItems) changes.\n- **arcgisFilterChange** - Emitted when the value of the [filterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#filterText) input changes.\n- **arcgisOpenedLayersChange** - Emitted when the collection of [openedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#openedLayers) changes.\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 for user interaction.\n- **arcgisSelectedItemsChange** - Emitted when the collection of [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#selectedItems) changes.\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.","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-catalog-layer-list-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed. When collapsed, only the collapse button and heading are displayed.","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input when filtering is enabled.","values":[]},{"name":"filter-text","description":"The value of the filter input text string when filtering is enabled.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-catalog-layer-list","description":"Indicates whether to hide the catalog layer list in the component.","values":[]},{"name":"hide-no-filter-results-notice","description":"Indicates whether to hide the notice that appears when no results are found after filtering.","values":[]},{"name":"hide-no-items-notice","description":"Indicates whether to hide the notice that appears when there are no items to display.","values":[]},{"name":"hide-status-indicators","description":"Indicates whether to hide status indicators in the component.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"list-mode-disabled","description":"Specifies whether to ignore the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property to display all layers. A common use case for `listModeDisabled` is when you want to use the component to manage and configure a layer's `listMode` value.","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the filter input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode. Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#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. |","values":[{"name":"multiple"},{"name":"none"},{"name":"single-persist"},{"name":"single"}]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-errors","description":"This property provides the ability to show or hide layer error indicators.","values":[]},{"name":"show-filter","description":"This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]},{"name":"show-temporary-layer-indicators","description":"This property provides the ability to show or hide the temporary layer indicators 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.","values":[]},{"name":"top-layer-disabled","values":[]},{"name":"visibility-appearance","description":"Determines the icons used to indicate visibility.\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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-checkbox.avif) |\n","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/"},{"name":"Catalog Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-catalog-layer-list-next--demo&singleStory=true"}]},{"name":"arcgis-compass","description":"The Compass component indicates where north is in relation to the current view [rotation](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/references/core/Camera/#heading).\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 for user interaction.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>`\n- `reset(): 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-compass/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon displayed in the component's button.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-compass/"},{"name":"Compass","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-compass--demo&singleStory=true"}]},{"name":"arcgis-coordinate-conversion","description":"> [!NOTE]\n> In version 6.0, the implementation of [arcgis-coordinate-conversion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/) will be updated under the hood to that of [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/) , and deprecated properties on this component will be removed. We encourage using the [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/) component and providing feedback.\n\nThe Coordinate Conversion component provides a way to display user cursor position either as map coordinates or\nas any of several popular coordinate notations.  Additionally, the component provides a way to convert\nuser input coordinates into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).\n\n\nSeveral common formats are included by default:\n* XY - Longitude, Latitude (WGS84)\n* MGRS - [Military Grid Reference System](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#mgrs)\n* UTM - [Universal Transverse Mercator](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#utm)\n* DD - Decimal Degrees\n* DDM - Degrees Decimal Minutes\n* DMS - Degrees Minutes Seconds\n* Basemap - X, Y in the coordinate system used by the current basemap in the units used by the basemap.\nWeb Mercator is the standard for Esri-provided basemaps.\n\nAdditional formats can be created by a developer and made available\nthrough the component\n--\n\n### Events\n- **arcgisConversionChange** - Emitted when a conversion is added or removed, or when the order of conversions changes.\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 for user interaction.\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.\n- `reverseConvert(coordinate: string, format: Format): Promise<Point | null | undefined>` - Attempt to convert a string into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).  The format of the\nstring must be specified.  A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of available formats can be\nobtained from the [formats](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/#formats) property.","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-coordinate-conversion/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the coordinate input and coordinate settings headings. By default,\nthese headings are rendered as level 4 headings (e.g. `<h4>Input coordinate</h4>`). Depending on the coordinate conversion component's\nplacement in your app, you may need to adjust this heading for proper semantics. This is important for meeting\naccessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"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).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.","values":[]},{"name":"ignore-coordinate-precision","description":"If false, the component will estimate coordinate precision based on the current state of the\nview. As the view is zoomed farther out, fewer decimal places will be shown. Only affects `DD`,\n`DDM`, `DMS`, and `XY` formats.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"mode","description":"Describes the current mode of the component.\n\n* While in `live` mode, the component will update as the cursor moves.\n* While in `capture` mode, the component will update on mouse click and display a graphic\nmarking the current location.","values":[{"name":"capture"},{"name":"live"},{"name":"idle"}]},{"name":"multiple-conversions-disabled","description":"If this property is set to `true`, multiple conversions will be disabled, and only a single conversion will be displayed. Otherwise, multiple conversions will be shown.","values":[]},{"name":"orientation","description":"Determines whether the component should expand up or down.  If set to `auto`,\nthe component will be oriented based on its position in the view.","values":[{"name":"auto"},{"name":"expand-down"},{"name":"expand-up"}]},{"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.","values":[]},{"name":"remove-leading-zeros","description":"Determines whether leading zeros will be shown in `DD`, `DDM`, and `DMS` formats.\nWhen false: 01.37°N, 008.71°E\nWhen true: 1.37°N, 8.71°E","values":[]},{"name":"storage-disabled","description":"If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/references/core/widgets/CoordinateConversion/#storageType))\nwill not be used to hydrate and persist the component's state.","values":[]},{"name":"storage-type","description":"This property determines whether sessionStorage or localStorage will be used to store component's state.","values":[{"name":"local"},{"name":"session"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/"},{"name":"Coordinate Conversion","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-coordinate-conversion--demo&singleStory=true"}]},{"name":"arcgis-coordinate-conversion-next","description":"> [!WARNING]\n> The Coordinate Conversion (next) component is the successor to the [arcgis-coordinate-conversion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/) component, provided to you for early testing and feedback.\n> It provides a more consistent design and improved user experience.\n> In version 6.0, the implementation of [arcgis-coordinate-conversion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/) will be updated under the hood to that of [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/) and this component will be removed.\n> To update at version 6.0, simply remove `-next` from the component name.\n\nThe Coordinate Conversion component provides a way to display user cursor position either as map coordinates or\nas any of several popular coordinate notations.  Additionally, the component provides a way to convert\nuser input coordinates into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).\n\n\nSeveral common formats are included by default:\n* XY - Longitude, Latitude (WGS84)\n* MGRS - [Military Grid Reference System](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#mgrs)\n* UTM - [Universal Transverse Mercator](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#utm)\n* DD - Decimal Degrees\n* DDM - Degrees Decimal Minutes\n* DMS - Degrees Minutes Seconds\n* Basemap - X, Y in the coordinate system used by the current basemap in the units used by the basemap.\nWeb Mercator is the standard for Esri-provided basemaps.\n\nAdditional formats can be created by a developer and made available\nthrough the component\n--\n\n### Events\n- **arcgisConversionChange** - Emitted when a conversion is added or removed, or when the order of conversions changes.\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 for user interaction.\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.\n- `reverseConvert(coordinate: string, format: Format): Promise<Point | null | undefined>` - Attempt to convert a string into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).  The format of the\nstring must be specified.  A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of available formats can be\nobtained from the [arcgis-coordinate-conversion.formats](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/#formats) property.","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-coordinate-conversion-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the coordinate input and coordinate settings headings. By default,\nthese headings are rendered as level 4 headings (e.g. `<h4>Input coordinate</h4>`). Depending on the coordinate conversion component's\nplacement in your app, you may need to adjust this heading for proper semantics. This is important for meeting\naccessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-capture-section","description":"Determines whether the capture section will be shown in the component. If `true`, the capture section will be hidden.","values":[]},{"name":"hide-input-section","description":"Determines whether the input section will be shown in the component. If `true`, the input section will be hidden.","values":[]},{"name":"hide-settings-button","description":"Determines whether the settings button will be shown in the component. If `true`, the settings button will be hidden.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.","values":[]},{"name":"ignore-coordinate-precision","description":"If false, the component will estimate coordinate precision based on the current state of the\nview. As the view is zoomed farther out, fewer decimal places will be shown. Only affects `DD`,\n`DDM`, `DMS`, and `XY` formats.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"mode","description":"Describes the current mode of the component.\n\n* While in `live` mode, the component will update as the cursor moves.\n* While in `capture` mode, the component will update on mouse click and display a graphic\nmarking the current location.\n* While in `idle` mode, the component will not update based on cursor movement or mouse clicks.\nThis mode can be used to \"pause\" the component without losing the current location.","values":[{"name":"capture"},{"name":"live"},{"name":"idle"}]},{"name":"multiple-conversions-disabled","description":"If this property is set to `true`, multiple conversions will be disabled, and only a single conversion will be displayed. Otherwise, multiple conversions will be shown.","values":[]},{"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.","values":[]},{"name":"remove-leading-zeros","description":"Determines whether leading zeros will be shown in `DD`, `DDM`, and `DMS` formats.\nWhen false: 01.37°N, 008.71°E\nWhen true: 1.37°N, 8.71°E","values":[]},{"name":"show-elevation","description":"Determines whether the elevation of the current location will be shown. Only applicable when the view is a SceneView.","values":[]},{"name":"storage-disabled","description":"If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/references/core/widgets/CoordinateConversion/#storageType))\nwill not be used to hydrate and persist the component's state.","values":[]},{"name":"storage-type","description":"This property determines whether sessionStorage or localStorage will be used to store component's state.","values":[{"name":"local"},{"name":"session"}]},{"name":"vertical-unit","description":"Indicates the vertical unit to use when displaying elevation.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"}]},{"name":"visual-scale","description":"Determines the component's scale. Options are small (\"s\"), medium (\"m\"), and large (\"l\").","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/"},{"name":"Coordinate Conversion Next","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-coordinate-conversion-next--main-demo&singleStory=true"},{"name":"Single conversion only","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-coordinate-conversion-next--single-conversion-demo&singleStory=true"},{"name":"Minimal configuration","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-coordinate-conversion-next--minimal-demo&singleStory=true"}]},{"name":"arcgis-daylight","description":"The Daylight component can be used to manipulate the lighting conditions of an\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\nTo achieve this, the component modifies the `lighting` property of the\n[arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment) of the Scene component.\n\nTo illuminate the scene, one can either use a configuration of date and time to position the\n[sun](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/) or switch to the\n[virtual](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/VirtualLighting/) mode,\nwhere the light source is relative to the camera.\n\nWhen illuminating the scene with **[sunlight](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/)**\nand adjusting the time and date, the positions of the sun and stars are updated accordingly. This also updates the\n[date](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/#date) property of\n[arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment).\n\n**How date, time, and timezone work**\n\nIn sunlight mode, `SunLighting.date` is the source of truth for the scene lighting instant. The daylight component's\n`utcOffset` controls how that instant is displayed (date and slider time) and how user-entered local values are\nconverted back to UTC.\n\nThis means changing only [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#utcOffset) updates the displayed local date/time but\npreserves the same lighting instant. Changing [localDate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#localDate) and/or\n[timeSliderPosition](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#timeSliderPosition) writes a new `SunLighting.date` instant.\n\n> [!IMPORTANT]\n>\n> Daylight does not use [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone). Changing the scene's time zone does not update the\n> date and time shown in Daylight or change the lighting instant. Support for using the scene's time zone is planned\n> for a future release.\n\n[![daylight-default](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-default.avif)](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n\nThe component has an option to select the timezone. When the user makes any adjustments here, a new time\nin the chosen timezone is calculated and displayed in the slider. The timezone selector can be disabled\nby using the [hideTimezone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#hideTimezone) property.\n\nBy default, a calendar is displayed to select the day, month, and year.\nWith the [dateOrSeason](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#dateOrSeason) property, the calendar can be replaced with\na dropdown menu where a season can be selected instead:\n\n![daylight-seasons](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-seasons.avif)\n\nThere are two play buttons: one corresponds to the time-of-day slider and animates the lighting\nover the course of a day, while the other corresponds to the date picker\nand animates the lighting over the course of a year (month by month). The speed of the time-of-day animation can\nbe set using the [playSpeedMultiplier](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#playSpeedMultiplier) property.\n\n<video src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-animation.webm\" autoplay loop muted playsinline></video>\n\nExcept for the daytime slider, all the elements in the Daylight component can be hidden:\n\n![daylight-no-elements](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-no-elements.avif)\n\nWhenever the sun position option is unchecked, the scene applies the\n**[virtual light](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/VirtualLighting/)** source relative to the camera.\nWith this, the component's time slider, timezone, and date picker get automatically disabled:\n\n![daylight-virtual](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-virtual.avif)\n\n**Things to consider**\n\n* Daylight is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n* The Daylight component uses a numeric UTC offset and does not track an IANA time zone. It does not account for daylight saving time transitions in different countries and regions.\n* When using the [virtual light](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/VirtualLighting/),\nsetting the time and date programmatically does not have an influence on the lighting conditions of the scene.\n* When using the [sunlight](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/),\nthe time slider and time zone automatically react to the changes of the camera (e.g., position, rotation, pan, zoom) because the position of the simulated sun\nis updated to maintain a consistent solar time of day based on the camera's current longitude. This can be adjusted using the\n[cameraTrackingEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/#cameraTrackingEnabled)\nproperty on [arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment). This camera-based timezone behavior is an approximation based on longitude.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisUserDateTimeChange** - Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons.\n\nThis event is user-action only. It does not fire for internal synchronization (for example, initial state sync\nwhen the view becomes ready).\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.","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-daylight/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"current-season","description":"Sets the season that is used when the component displays the season picker.\nEach season uses a fixed date corresponding to the seasonal equinoxes and solstices.","values":[{"name":"fall"},{"name":"spring"},{"name":"summer"},{"name":"winter"}]},{"name":"date-or-season","description":"Controls whether the component displays a date or a season picker. When the date picker is set, the user selects the date from a calendar. The season picker allows the user to choose a season from a drop-down list. Each season uses a fixed month and day corresponding to the equinoxes and solstices in the current local date's year.","values":[{"name":"date"},{"name":"season"}]},{"name":"day-playing","description":"Starts or pauses the daytime animation cycling through the minutes of the day.\nSet the property to `true` to start the animation and to `false` to pause it.\n\n`dayPlaying` and [yearPlaying](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#yearPlaying) are mutually exclusive.\nWhen virtual lighting is active, playback is stopped.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-date-picker","values":[]},{"name":"hide-header","values":[]},{"name":"hide-play-buttons","values":[]},{"name":"hide-shadows-toggle","values":[]},{"name":"hide-sun-lighting-toggle","values":[]},{"name":"hide-timezone","values":[]},{"name":"icon","description":"Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"local-date","description":"The calendar date in the timezone given by [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#utcOffset).\n\nDate-only ISO strings in `YYYY-MM-DD` format are preserved as-is to avoid day shifts in negative local\ntimezones. Other valid `Date`, `number`, and `string` values are normalized to canonical `YYYY-MM-DD`.","values":[]},{"name":"play-speed-multiplier","description":"Controls the daytime animation speed.","values":[]},{"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.","values":[]},{"name":"time-slider-position","description":"Slider position for the time of day in the timezone\ngiven by [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#utcOffset). The position represents the time\nof the day in minutes. Values are normalized to a single day (0-1439).","values":[]},{"name":"time-slider-steps","description":"Sets the interval, in minutes, with which the time slider increments or decrements as it is dragged or changed via the keyboard.","values":[]},{"name":"time-zone-mode","description":"Time zone mode. Not supported after the component has loaded.","values":[{"name":"offset"},{"name":"region"}]},{"name":"utc-offset","description":"The difference in hours between UTC time and the time displayed in the component.\n\nIn sunlight mode, changing only this property preserves the current `SunLighting.date` instant and recomputes\ndisplayed local date/time in the new offset. When this property changes together with\n[localDate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#localDate) and/or [timeSliderPosition](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#timeSliderPosition),\nthe date/time values are applied as one local selection and a new lighting instant is written.\nThis property is separate from [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone). Changing one does not update the other.","values":[]},{"name":"year-playing","description":"Starts or pauses the date animation cycling through the months of the year.\nSet the property to `true` to start the animation and to `false` to pause it.\n\n`yearPlaying` and [dayPlaying](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#dayPlaying) are mutually exclusive.\nWhen virtual lighting is active, playback is stopped.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/"},{"name":"Daylight","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-daylight--demo&singleStory=true"}]},{"name":"arcgis-directional-pad","description":"A directional pad (D-Pad) component can be used to control the position and\nrotation of the map. The D-Pad provides eight directions of movement, a small\ncompass which indicates the current orientation of the map and a slider for\nrotating the map.\n\nIt is also possible to disable the map's rotation controls or change the size\nof the component.\n\nThe Directional Pad component is not supported in 3D.\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 for user interaction.\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.","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-directional-pad/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-directional-buttons","description":"Whether to hide directional pad buttons.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-rotation-reset-button","description":"Whether to display the button to reset the rotation angle. This only takes\neffect if showRotationSlider is true.","values":[]},{"name":"show-rotation-slider","description":"Whether to display the map rotation slider.","values":[]},{"name":"visual-scale","description":"Determines the size of directional pad buttons and the slider.\n\nIn addition to this parameter, you can set the width on the component\ncontainer to dictate directional pad size.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directional-pad/"},{"name":"Directional Pad","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-directional-pad--demo&singleStory=true"}]},{"name":"arcgis-directions","description":"The Directions component provides a way to calculate directions, between two or more input locations with a [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/), using ArcGIS Online and custom Network Analysis Route services.\nThis component generates a route finding a least-cost path between multiple points using the routing service associated with the assigned RouteLayer. The route is calculated based on the stops and barriers added to the RouteLayer. The component provides a user interface for adding, removing, and reordering stops and barriers. Once the route is solved, the component displays the route on the map and provides turn-by-turn directions in a list format.\n\nDirections uses the [Search component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/) to locate each stop, either by selecting a point on the map, or by entering a search term into the textbox.\nSearch uses settings defined in the `Search properties`. This includes the `locationType`, which defines the type of geocoding result that is returned, and defaults to \"street\".\n\nDirections requires a RouteLayer to be associated with the `layer` property or using the `useDefaultRouteLayer` property. A RouteLayer can be programmatically created or derived from an external source like a portal item or webmap.\nPlease note that in order to view or interact with routing inputs and results, the RouteLayer must be added to the map. Routing service and symbology are configured in the layer, specifically the `url` and `defaultSymbols` properties respectively.\n\nThe ArcGIS Online routing service requires authentication. If an API key is specified at the app level (see [Config#apiKey](https://developers.arcgis.com/javascript/latest/references/core/config/#Config-apiKey)) or component level (see [apiKey](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#apiKey)) then this key will accompany requests to both the routing service and geocoder/reverse-geocoder.\nPlease refer to the Search component for more information on geocoding.\n\nLocations on the map can be reverse geocoded and used as stops in the route. Click the button with a crosshairs icon to associate a location with a new or existing stop.  After clicking the button, click the map once. To cancel this process, press the `escape` key.\nThe resulting driving directions are automatically collapsed and can be optionally saved to a new or existing portal item. This can be achieved programmatically with `save` and `saveAs`. The `Clear` button calls the `reset()` method, which removes all stops, directions, and the solved route.\n\nSelecting the `Edit route` button allows you to add/move/remove stops, add/move/remove/reshape polyline barriers, and add/move/remove waypoints. To add a new waypoint, first hover the cursor over the route and select the desired point. Then select and drag the point to move and place the waypoint. By default the route will be automatically resolved at the completion of any editing operation. For more complex routes, it may be advantageous to disable auto-solving and solve as and when needed with the dedicated solve button. Currently, this is only supported in 2D MapViews.\n\n**Note:** Printing in Directions is in beta and considered experimental. The print preview dialog, in some scenarios, may not display as anticipated.\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 for user interaction.\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.\n- `getDirections(): Promise<RouteLayerSolveResult>` - Computes a route and directions. If successfully computed, results will be assigned to the [lastRoute](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#lastRoute) property.\n- `save(): Promise<PortalItem>` - Saves the currently assigned [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/)\n(see [layer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#layer)) to an existing portal item.\n- `saveAs(portalItem: PortalItem, options: { folder: PortalFolder; }): Promise<PortalItem>` - Saves the currently assigned [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/)\n(see [layer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#layer)) to a new portal item.\n- `startEditing(): Promise<void>` - Starts an edit session for interactive addition, modification, and deletion of stops, barriers, and waypoints.\n- `stopEditing(): Promise<void>` - Ends an interactive edit session.\n- `zoomToRoute(): Promise<void>` - Zoom so that the entire route is displayed within the current map extent.","attributes":[{"name":"api-key","description":"An authorization string used to access a resource or service.\n[API keys](https://developers.arcgis.com/documentation/security-and-authentication/api-key-authentication/) are generated\nand managed in the portal. An API key is tied\nexplicitly to an ArcGIS account; it is also used to monitor service usage.\nSetting a fine-grained API key on a specific class overrides the [global API key](https://developers.arcgis.com/javascript/latest/references/core/config/#ConfigWithApiKey).\n\nBy default, the following URLs will be used (unless overwritten in the app, or if using different defaults from a portal):\n\nGeocoding URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`\n\nRouting URL: `https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World`","values":[]},{"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-directions/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-solve-on-edit-active","description":"When `true`, the route will re-solve continuously as an interactive operation is ongoing (e.g., while dragging a stop or waypoint).","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the origin and destination addresses (i.e. \"380 New York Street\").\nBy default, this is rendered\nas a level 2 heading (e.g. `<h2>380 New York Street</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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-layer-details","description":"Indicates whether to a link to the route layer portal-item (if any) will be displayed","values":[]},{"name":"hide-print-button","description":"Indicates whether to the Print button will be displayed","values":[]},{"name":"hide-save-as-button","description":"Indicates whether to the Save As button will be displayed","values":[]},{"name":"hide-save-button","description":"Indicates whether to the Save button will be displayed","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"map-layer-id","description":"The layer ID of a route layer in the associated map.\nWhen set, the component will attempt to find and use the layer with the provided ID from the map.\n\n> [!WARNING]\n> Use `layer`, `mapLayerId`, and `routeLayerItemId` independently; only one should be set at a time.","values":[]},{"name":"max-stops","description":"The maximum number of stops allowed for routing.","values":[]},{"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.","values":[]},{"name":"route-layer-item-id","values":[]},{"name":"unit","description":"Unit system (imperial, metric) or specific unit used for displaying the distance values.\nIf not set, the component will attempt to pick \"imperial\" or \"metric\" based on the user's portal settings.\n\nThis property will affect the summary distance as well as distance for each turn-by-turn maneuver.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]},{"name":"use-default-route-layer","description":"If `true`, a new [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/) will be created, added to the map and assigned to the `layer` property.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/"},{"name":"Directions","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-directions--demo&singleStory=true"}]},{"name":"arcgis-direct-line-measurement-3d","description":"The Direct Line 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 vertical, horizontal, and direct distances between two points.\n\n[![measurement-line-3d](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/3D_DirectLineMeasurement_widget.avif)](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow distances are computed depends on the scene's spatial reference.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- Direct distance is computed in a Euclidean manner, in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets);\n- Horizontal distance is computed geodetically, taking into consideration the curvature of the planet;\n- Vertical distance is computed as an elevation difference.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, all three distances (direct, horizontal, and vertical)\n are computed in a Euclidean manner (in their respective PCS).\n\nDirect Line Measurement 3D component visualizes and labels the direct, horizontal, and vertical distances and displays the same values\nin the UI panel. When the distance between the points is greater than 100 kilometers,\nthe measurement visualization is simplified, and only the horizontal and vertical distances are calculated.\nThe direct distance option becomes unavailable.\n\n![measurement-line-3d](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/direct-line-measurement-3d.avif)\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\nA second laser line shows the intersection of the scene with the vertical plane that passes through the checkered line.\n\n**Things to consider**\n\n* Direct Line Measurement 3D is designed to work in the Scene component. For measurements in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent, use [arcgis-distance-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/).\n* Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/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- [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/DirectLineMeasurementAnalysis/)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n- [Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-direct-line-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"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-direct-line-measurement-3d/#unitOptions).\n\nWhen no unit is explicitly set on the component or its analysis, this property uses the length unit configured in the view through\n[view.options.displayUnits.length](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-direct-line-measurement-3d/#unitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the distance unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-direct-line-measurement-3d/"},{"name":"Direct Line Measurement 3D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-direct-line-measurement-3d--demo&singleStory=true"}]},{"name":"arcgis-distance-measurement-2d","description":"The Distance 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 length of a polyline.\n\nHow distances are computed depends on the map's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, lengths are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, lengths 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 for user interaction.\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.","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-distance-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"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-distance-measurement-2d/#unitOptions).\n\nWhen no unit is explicitly set on the component or its analysis, this property uses the length unit configured in the view through\n[view.options.displayUnits.length](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/#unitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the distance unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/"},{"name":"Distance Measurement 2D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-distance-measurement-2d--demo&singleStory=true"}]},{"name":"arcgis-editor","description":"The Editor component provides an out-of-the-box editing experience to help streamline editing within a web application.\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 for user interaction.\n- **arcgisSketchCreate** - Fires when a user starts drawing a feature, is actively drawing a feature, and completes drawing a feature.\n- **arcgisSketchUpdate** - Fires when a user starts updating a feature's geometry, is actively updating a feature's geometry, and completes updating a feature's geometry.\n\n### Methods\n- `activateSelectionTool(toolName: SelectionToolName): Promise<SelectionOperation | undefined>` - Activates a selection tool specified by name. Additionally, cancels the previously active selection operation.\n- `cancelSelectionTool(): void` - Cancels any active selection operation.\n- `cancelWorkflow(options?: CancelWorkflowOptions): Promise<void>` - Cancels any active workflow.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `deleteFeatureFromWorkflow(): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `startCreateFeaturesWorkflowAtFeatureCreation(info: CreateFeaturesCreationInfo): Promise<void>`\n- `startCreateFeaturesWorkflowAtFeatureEdit(params: EditorStartCreateFeaturesWorkflowAtFeatureEditParameters): Promise<void>` - Initiates a CreateFeaturesWorkflow by displaying the form panel with the provided feature.\n- `startCreateFeaturesWorkflowAtFeatureTypeSelection(params?: EditorStartCreateFeaturesWorkflowAtFeatureTypeSelectionParameters): Promise<void>` - Initiates a CreateFeaturesWorkflow by displaying the FeatureTemplates panel.\n- `startMergeFeaturesWorkflow(features: FeatureInfo | Graphic[], options: EditorStartMergeFeaturesWorkflowOptions): Promise<void>` - Starts a [MergeFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/MergeFeaturesWorkflow/) using\nthe provided features. All features must belong to the same layer.\n- `startSplitFeatureWorkflow(feature: Graphic, options: EditorStartSplitFeatureWorkflowOptions): Promise<void>` - Starts a [SplitFeatureWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/SplitFeatureWorkflow/) using the provided feature.\n- `startUpdateFeaturesWorkflow(features: FeatureInfo | Graphic[]): Promise<void>` - Starts an [UpdateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/UpdateFeaturesWorkflow/) using\nthe provided features.\n- `startUpdateWorkflowAtFeatureEdit(feature: Graphic): Promise<void>`\n- `startUpdateWorkflowAtFeatureSelection(): Promise<void>`\n- `startUpdateWorkflowAtMultipleFeatureSelection(candidates: Graphic[]): 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-editor/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for title of the component. By default, the title (i.e. \"Editor\") is rendered\nas a level 4 heading (e.g. `<h4>Editor</h4>`). 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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-create-features-section","description":"Indicates whether to hide the \"create features\" section of the component in the default view.","values":[]},{"name":"hide-edit-features-section","description":"Indicates whether to hide the \"edit features\" section of the component in the default view.","values":[]},{"name":"hide-labels-toggle","description":"Indicates whether to hide the sketch labels toggle.","values":[]},{"name":"hide-merge-button","description":"Indicates whether to hide the \"Merge features\" button in contexts where that command is available. Default value is `true`.","values":[]},{"name":"hide-selection-toolbar","description":"Controls whether to use the fully featured selection experience. This includes the\nselection toolbar — which provides multiple selection tools — and the\nselection list, which allows modifying selections and starting\nmulti-feature editing workflows, like bulk updates and merges.\n\nIf set to `true`, the component will use a simplified selection experience,\nconsisting of a single \"Select\" button.","values":[]},{"name":"hide-settings-menu","description":"Indicates whether to hide the Settings menu. This menu contains snapping and tooltip options.","values":[]},{"name":"hide-sketch","description":"Determines whether the component should display an embedded Sketch component to provide graphical controls for choosing drawing tools.","values":[]},{"name":"hide-snapping-controls-elements-enabled-toggle","description":"Indicates whether to hide the `enabledToggle` (Enable snapping). This toggles\nthe [SnappingOptions#enabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#enabled) property.\n> [!WARNING]\n>\n> **Note**\n>\n> It is recommended to set `SnappingControls.snappingOptions.enabled = true` if `enabledToggle` is set to `false`.\n> This is because `selfEnabledToggle` and `featureEnabledToggle` require snapping globally to be enabled in order to be interactive. Otherwise, these toggles will not be responsive.","values":[]},{"name":"hide-snapping-controls-elements-feature-enabled-toggle","description":"Indicates whether to hide the `featureEnabledToggle` (Feature to feature). This toggles\nthe [SnappingOptions#featureEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#featureEnabled) property.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls","description":"Indicates whether to hide the `gridControls` (configuration of the snapping grid).","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-color-selection","description":"Indicates whether to hide the `colorSelection` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-dynamic-scale-toggle","description":"Indicates whether to hide the `dynamicScaleToggle` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-line-interval-input","description":"Indicates whether to hide the `lineIntervalInput` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-numeric-inputs","description":"Indicates whether to hide the `numericInputs` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-out-of-scale-warning","description":"Indicates whether to hide the `outOfScaleWarning` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-placement-buttons","description":"Indicates whether to hide the `placementButtons` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-rotate-with-map-toggle","description":"Indicates whether to hide the `rotateWithMapToggle` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-enabled-toggle","description":"Indicates whether to hide the `gridEnabledToggle` (snap-to-grid).","values":[]},{"name":"hide-snapping-controls-elements-layer-list","description":"Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/FeatureSnappingLayerSource/) layerList. The layerlist provides the available layer sources supported for snapping.","values":[]},{"name":"hide-snapping-controls-elements-self-enabled-toggle","description":"Indicates whether to hide the `selfEnabledToggle` (Geometry guides). This toggles\nthe [SnappingOptions#selfEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#selfEnabled) property.","values":[]},{"name":"hide-split-button","description":"Indicates whether to hide the \"Split\" button in contexts where that command is available. Default value is `true`.","values":[]},{"name":"hide-tooltips-toggle","description":"Indicates whether to hide the tooltips toggle. Default value is `true`.","values":[]},{"name":"hide-undo-redo-buttons","description":"Indicates whether to hide undo/redo buttons in the embedded Sketch toolbar. Default value is `true`.","values":[]},{"name":"hide-zoom-to-button","description":"Indicates whether to hide the \"Zoom to\" button when creating and editing features. Default value is `true`.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-snapping-controls-elements-header","description":"Indicates whether to display the header. Default is `false`.","values":[]},{"name":"sync-view-selection","description":"Controls whether the editor should sync with the view's selection manager.\nThis does not include selection sources, which must be configured independently\non the view's selection manager.","values":[]},{"name":"use-view-options","description":"If true, the component uses snapping, tooltips, display units, and input units from [ViewOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/).\n\nWhen this property is `true`:\n\n- Snapping and tooltip options are inherited from the view. The component's [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#snappingOptions) and [tooltipOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#tooltipOptions) are preserved but ignored.\n- Snapping controls and the tooltip toggle are hidden from the component's Settings menu.\n\nWhen `false`, the component uses its own snapping, tooltip, and unit options instead.\n\nLabel [options](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#labelOptions) and [direction mode](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ValueOptions/#directionMode) are not inherited from the view.\n\nChanges to this property apply when the next create or update operation starts, not to an operation already in progress.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/"},{"name":"Editor","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-editor--demo&singleStory=true"}]},{"name":"arcgis-elevation-profile","description":"The Elevation Profile component manages an [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/) and displays its elevation profiles.\n\n[![elevation profile poster](https://developers.arcgis.com/javascript/latest/assets/references/components/elevation-profile/elevation_profile_poster.avif)](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n\nThe component can visualize multiple profile lines, depending on whether it is used in an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) component or an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component and on the available elevation source data:\n\n* [**ElevationProfileLineGround**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineGround/): represents a profile line that uses elevation from [arcgis-map.ground](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#ground) of the connected Map or Scene component. The profile recomputes automatically when ground layers are added, removed, or their visibility changes.\n* [**ElevationProfileLineInput**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineInput/): represents a profile line that reads elevation from the analysis geometry itself; typically used for polylines with z values. If the line lacks z values but is displayed with a non-draped elevation mode, a profile is still computed. If `elevationInfo` is set to `on-the-ground`, elevation comes from the Ground (when ground layers are present). An elevation offset can be applied. In a Map this requires client-side graphics that already contain z values.\n* [**ElevationProfileLineQuery**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineQuery/): represents a profile line that samples elevation from the elevation source set in the [source](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineQuery/#source) property. The elevation source can be an [ElevationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/) or an object with a method called `queryElevation` that has the same signature as [queryElevation()](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/#queryElevation).\n* [**ElevationProfileLineScene**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineScene/): represents a profile line that derives elevation from the `Scene` and all its volumetric objects (e.g. SceneLayer, IntegratedMeshLayer).\n\nYou can choose to display one or several profile lines in the chart, by setting them in the [profiles](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#profiles) property.\n\nHovering over the chart shows an overlaid tooltip with elevation values of all profiles, and displays colored dot markers at the matching positions.\n\nCheckboxes in the legend allow hiding individual profiles. Chart units can be set via the settings menu to metric, imperial or a specific unit.\n\nScrolling the chart zooms in to a specific part of the profile chart. When zoomed in, click the minus button to reset the zoom. On touch devices, pinch to zoom in and out.\n\nHow distance values are computed depends on the map's spatial reference:\n\n* In geographic coordinate systems (GCS) and in Web Mercator, distances are computed geodetically.\n* In projected coordinate systems (PCS), apart from Web Mercator, distances are computed in a Euclidean manner (in their respective PCS).\n\n**Known limitations**\n\n- [ElevationProfileLineInput](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineInput/) in 2D is only valid when the analysis [geometry](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#geometry) has z values, `hasZ===true` and no [elevationInfo](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#elevationInfo) is set.\n- [ElevationProfileLineScene](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineScene/) is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/)\n- [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n- [Sample - Elevation Profile analysis](https://developers.arcgis.com/javascript/latest/sample-code/analysis-elevation-profile/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current elevation profile. If an interactive operation is in progress, it will also be stopped.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `select(): Promise<void>` - Start an interactive operation to pick an existing polyline feature in the view to use as the input for the\nelevation profile. The operation ends when the user presses the <kbd>Escape</kbd> key.\nTo programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#stop) method.\n- `start(): Promise<void>` - Start an interactive operation that lets the user sketch a new path in the view along which the elevation profile\nwill be generated. The operation completes when the user double-clicks, presses the <kbd>Escape</kbd> key or clicks\nthe Done button in the UI.\nTo programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#stop) method.\n- `stop(): Promise<void>` - Stop any ongoing interactive operation (for example, selecting or sketching a profile line). This can be used to\nprogrammatically cancel operations started by [start()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#start) or\n[select()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#select).\n\n### Slots\n- **settings-start** - Slot for adding custom UI before the built-in settings controls.\n- **settings-end** - Slot for adding custom UI after the built-in settings controls.","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-elevation-profile/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"distance-unit","description":"The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display distance values\nin the chart, results and legend.\n\nWhen no distance unit is explicitly set on the component or its analysis, this property uses the length unit configured in the view through\n[view.options.displayUnits.length](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [distanceUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#distanceUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the distance unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]},{"name":"elevation-unit","description":"The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display elevation values\nin the chart, results and legend.\n\nWhen no elevation unit is explicitly set on the component or its analysis, this property uses the vertical length unit configured in the view through\n[view.options.displayUnits.verticalLength](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [elevationUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#elevationUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the elevation unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]},{"name":"hide-chart","description":"If true, the elevation profile chart will be hidden.","values":[]},{"name":"hide-chart-axis-labels","description":"If true, the elevation profile chart axis labels will be hidden.","values":[]},{"name":"hide-chart-grid-lines","description":"If true, the elevation profile chart grid lines will be hidden.","values":[]},{"name":"hide-clear-button","description":"If true, the clear button will be hidden.","values":[]},{"name":"hide-distance-display-unit-select","description":"If true, the distance display unit dropdown will be hidden in the settings popover.","values":[]},{"name":"hide-elevation-display-unit-select","description":"If true, the elevation display unit dropdown will be hidden in the settings popover.","values":[]},{"name":"hide-legend","description":"If true, the legend will be hidden.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-select-button","description":"If true, the button to select features in the view will be hidden.","values":[]},{"name":"hide-settings-button","description":"If true, the button which opens the settings popover will be hidden.","values":[]},{"name":"hide-start-button","description":"If true, the button to start sketching a new profile line will be hidden.","values":[]},{"name":"hide-uniform-chart-scaling-toggle","description":"If true, the uniform chart scaling toggle will be hidden in the settings popover.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"highlight-disabled","description":"If true, the component will not highlight features selected in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"uniform-chart-scaling","description":"Whether the chart should use a uniform scale for the X and Y axes.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/"},{"name":"Elevation Profile","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-elevation-profile--demo&singleStory=true"}]},{"name":"arcgis-expand","description":"Expand acts as a clickable button for displaying interactive content, most commonly other components.\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 for user interaction.\n\n### Methods\n- `collapse(): Promise<void>` - Collapse the component.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `expand(): Promise<void>` - Expand the component.","attributes":[{"name":"auto-collapse","description":"Automatically collapses the Expand component when the\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/core/views/View/#viewpoint) updates.","values":[]},{"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-expand/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"close-on-esc-disabled","description":"When `true`, the Expand component will not close itself if the Escape key is pressed while its content has keyboard focus.\nThis property can also be set to a function that returns a boolean, allowing for more customization for when to allow the\nExpand component to be closed via the Escape key.","values":[]},{"name":"collapse-icon","description":"Calcite icon used to style the Expand when it can be collapsed.","values":[]},{"name":"collapse-tooltip","description":"Tooltip to display to indicate the Expand can be collapsed.","values":[]},{"name":"expanded","description":"Indicates whether the component is currently expanded or not.","values":[]},{"name":"expand-icon","description":"Calcite icon used to style the Expand when it can be expanded.\nThe component will automatically use the icon of the component placed within the Expand if it has one.","values":[]},{"name":"expand-tooltip","description":"Tooltip to display to indicate Expand can be expanded.","values":[]},{"name":"focus-trap-disabled","description":"Whether the user's keyboard focus should be trapped in the expanded panel state. If `true`, tabbing\nforward or backward will cycle through elements only within the panel content.","values":[]},{"name":"group","description":"This value associates two or more Expand components with each other, allowing one\ncomponent to auto collapse when another in the same group is expanded. For auto collapsing\nto take effect, all components in the group must be included in the same Map, Scene, or Link Chart component.\n\nFor example, if you place multiple Expand components in the `top-left` slot of the Map, you can assign them to a\ngroup called `top-left`. If one Expand component is expanded and the user clicks on a different component in the\n`top-left` group, then the first component is collapsed, allowing the content of the second component to be\nfully visible.","values":[]},{"name":"icon-number","description":"A number to display at the corner of the component to indicate the number of, for example, open issues or unread notices.\n\n![expand component icon number](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/expand-with-iconnumber.avif)","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"modal-disabled","description":"When true, disables the modal behavior of the [Calcite Sheet](https://developers.arcgis.com/calcite-design-system/components/sheet/) when the Expand component is in \"drawer\" [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-expand/#mode).\nThis property is in beta and its behavior will change at 6.0.","values":[]},{"name":"mode","description":"The mode in which the component displays. These modes are listed below:\n\n- `auto`: This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application.\n- `floating`: Use this mode if you wish to always display the component as floating in a [Calcite Popover component](https://developers.arcgis.com/calcite-design-system/components/popover/) regardless of browser size.\n- `drawer`: Use this mode if you wish to always display the component in a [Calcite Sheet component](https://developers.arcgis.com/calcite-design-system/components/sheet/) regardless of browser size.","values":[{"name":"auto"},{"name":"drawer"},{"name":"floating"}]},{"name":"placement","description":"The placement used by the [Calcite Popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.","values":[{"name":"top-start"},{"name":"top-end"},{"name":"bottom-start"},{"name":"bottom-end"},{"name":"bottom"},{"name":"left"},{"name":"right"},{"name":"top"},{"name":"auto"},{"name":"auto-start"},{"name":"auto-end"},{"name":"right-start"},{"name":"right-end"},{"name":"left-start"},{"name":"left-end"},{"name":"leading-start"},{"name":"leading"},{"name":"leading-end"},{"name":"trailing-end"},{"name":"trailing"},{"name":"trailing-start"}]},{"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.","values":[]},{"name":"top-layer-disabled","description":"When true, disables rendering in the top layer (above overlays and modals).\nThis can be useful for controlling stacking context in complex UI layouts.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-expand/"},{"name":"Expand with Custom Content\nThe Expand component with custom content.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-expand--custom-content&singleStory=true"},{"name":"Expand with Component Content\nThe Expand component with the [Basemap Gallery](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/) component.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-expand--component-content&singleStory=true"}]},{"name":"arcgis-exploratory-analysis","description":"The Exploratory Analysis component provides a container for measurement and analysis components and displays one active analysis at a time.\nAdd one or more supported components as child elements.\n\nSupported components include:\n\n- [arcgis-area-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/)\n- [arcgis-area-measurement-3d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/)\n- [arcgis-direct-line-measurement-3d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-direct-line-measurement-3d/)\n- [arcgis-distance-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/)\n- [arcgis-elevation-profile](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/)\n- [arcgis-volume-measurement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/)\n\nWhen multiple measurement components are provided, their `icon` and `label` properties are used to create a toolbar for switching between them.\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 for user interaction.\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.","attributes":[{"name":"active-analysis","description":"The active child component. Set using the child component's tag name (i.e. `arcgis-distance-measurement-2d`).\nWhen set, this will display the specified analysis tool as the active component.","values":[{"name":"arcgis-area-measurement-2d"},{"name":"arcgis-area-measurement-3d"},{"name":"arcgis-direct-line-measurement-3d"},{"name":"arcgis-distance-measurement-2d"},{"name":"arcgis-elevation-profile"},{"name":"arcgis-volume-measurement"}]},{"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-exploratory-analysis/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-start-disabled","description":"Specifies whether selecting an analysis tool from the action bar waits for the user to start a new analysis via the button.\nBy default, a new analysis is started once you click on the icon in the toolbar.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"preserve-analysis-on-change","description":"Specifies whether analysis results are preserved when the active analysis component changes.\nBy default, the current analysis is cleared before another analysis component becomes active.","values":[]},{"name":"require-active-analysis","description":"Specifies whether an analysis tool must remain active after it is selected.\nWhen enabled, selecting the active tool again does not collapse the component.","values":[]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-exploratory-analysis/"},{"name":"Exploratory Analysis","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-exploratory-analysis--exploratory-analysis&singleStory=true"}]},{"name":"arcgis-feature","description":"The Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\nThis component is useful in instances where you want to display information about a feature but without\nthe use of an [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/).\n\nIf wanting to show a feature's content with [actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), [related](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/), or [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate), etc., then use the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) component.\n\nWhen Arcade expressions that use `$map` or [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) are defined in any popup template content or as expression elements,\nthe [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#map) and [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#spatialReference) properties need to be defined in the Feature component.\n\n> [!WARNING]\n> In version 6.0, the implementation of [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) will be updated under the hood to that of [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/), and deprecated properties on this component will be removed. We encourage using the [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/) component and providing feedback.\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 for user interaction.\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.\n- `nextMedia(contentElementIndex: number): Promise<void>` - Paginates to the next [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.\n- `previousMedia(contentElementIndex: number): Promise<void>` - Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>` - Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info object. For example,\nyou may have [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) content which contains\nmultiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos`\nyou wish to display.\n- `updateGeometry(): Promise<void>` - Updates the geometry of the graphic.","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-feature/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"chart-animation-disabled","description":"Disables chart animation within the component.","values":[]},{"name":"default-popup-template-enabled","description":"Enables automatic creation of a popup template for layers that have popups enabled but no\npopupTemplate defined. Automatic popup templates are supported for layers that\nsupport the `createPopupTemplate()` method. (Supported for\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OGCFeatureLayer/)\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/PointCloudLayer/),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/StreamLayer/), and\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/)).\n\n**Note:**\nStarting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat)\nrather than `long-month-day-year` in the default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#heading) of the component.\nBy default, the title is rendered\nas a level 2 heading (e.g. `<h2>Title of content</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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-attachments-content","description":"This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","values":[]},{"name":"hide-content","description":"This property provides the ability to hide or show content within the component.","values":[]},{"name":"hide-custom-content","description":"This property provides the ability to hide or show [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","values":[]},{"name":"hide-expression-content","description":"This property provides the ability to hide or show [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","values":[]},{"name":"hide-fields-content","description":"This property provides the ability to hide or show [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","values":[]},{"name":"hide-heading","description":"This property provides the ability to hide or show the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#heading).","values":[]},{"name":"hide-last-edited-info","description":"This property provides the ability to hide or show the last edited info within the component.","values":[]},{"name":"hide-media-content","description":"This property provides the ability to hide or show [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","values":[]},{"name":"hide-text-content","description":"This property provides the ability to hide or show [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-relationship-content","description":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","values":[]},{"name":"show-utility-network-content","description":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from the associated [MapView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#timeZone) or [SceneView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#timeZone). When a view is not associated with the component,\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and times are not adjusted for any timezone.\n- Specified IANA timezone: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/"},{"name":"Feature\nThe Feature component displays on hover.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-feature--hover&singleStory=true"}]},{"name":"arcgis-feature-form","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 for user interaction.\n- **arcgisSubmit** - Fires when the [submit()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-form/#submit) method is called.\n- **arcgisValueChange** - Fires when a field value is updated.\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.\n- `getValues(): Promise<any>` - Returns all of the field values, regardless of update status.\n- `submit(): Promise<void>` - Fires the submit event.","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-feature-form/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"edit-type","description":"The edit type for the form, which determines the editing context and behavior.\n\nThis property is used in two primary ways:\n\n1. **Arcade Expressions Context**: When evaluating [Arcade expressions](https://developers.arcgis.com/javascript/latest/arcade/#form-calculation),\nthe value of this property is assigned to the `$editContext.editType` variable.\n   This allows Arcade expressions to adapt their behavior based on the type of edit\n   being performed (e.g., \"INSERT\", \"UPDATE\", \"DELETE\", or \"NA\").\n\n2. **Layer Editing Capabilities**: This property is also used to determine whether\n   the layer allows the specified type of edit. For example:\n   - If `editType` is set to `\"INSERT\"` but the layer has `supportsAdd: false`,\n     all inputs in the form will be read-only.\n   - If `editType` is set to `\"UPDATE\"` but the layer has `supportsUpdate: false`,\n     all inputs will also be read-only.\n\nThis behavior applies regardless of whether a form template or Arcade expressions\nare present. For instance:\n- If a layer has `{ supportsAdd: true, supportsUpdate: false }` and no form template,\n  setting `editType` to `\"INSERT\"` will allow the user to modify all fields, while\n  setting it to `\"UPDATE\"` will make all fields read-only.\n- If a form template is present with field elements that include `editableExpression`\n  or `valueExpression`, the `editType` still determines whether the layer permits\n  editing in the given context.","values":[{"name":"INSERT"},{"name":"UPDATE"},{"name":"DELETE"},{"name":"NA"}]},{"name":"group-display","description":"String indicating the\n[groupDisplay](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureForm/#groupDisplay) and how they will be displayed to the end user. This only applies if using [grouped field elements](https://developers.arcgis.com/javascript/latest/references/core/form/elements/GroupElement/) configured in the Editor's [layer infos](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/types/#LayerInfo).\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\nall | All groups will be expanded.\nsequential | A single group will be expanded at a time.","values":[{"name":"all"},{"name":"sequential"}]},{"name":"heading-level","description":"Indicates the heading level to use for the [FormTemplate#title](https://developers.arcgis.com/javascript/latest/references/core/form/FormTemplate/#title) of the form.\nBy default, the title is rendered as a level 2 heading (e.g. `<h2>Form title</h2>`).\nIn addition, group element labels default to a level 3 heading (e.g. `<h3>Group element label</h3>`).\nDepending 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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-read-only-notice","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the form use this time zone. By default, the time zone is inherited from the associated [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) or [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone). When no view is associated, the time zone defaults to `system`.\n\nIf `unknown`, the form uses the layer's [FeatureLayer#preferredTimeZone](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#preferredTimeZone). If the layer does not define a preferred time zone, the form uses UTC.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-form/"},{"name":"Feature Form","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-feature-form--demo&singleStory=true"}]},{"name":"arcgis-add-attachment-view","description":"Displays the attachment add/replace page. Composes a file-picker,\nvalidation notices, and information about the file to be replaced,\nif any.\n--\n\n### Events\n- **arcgisFilesSelect**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"form-disabled","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-add-attachment-view/"}]},{"name":"arcgis-attachment-preview","description":"Displays a preview of an attachment.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `pause(): void`","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachment-preview/"}]},{"name":"arcgis-attachment-thumbnail","description":"Displays a thumbnail of an attachment. If possible, an image preview\nis shown, otherwise falls back to a generic calcite icon appropriate\nfor the attachment type.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"icon-only","description":"Optionally skip any attempt to load a preview. Used to support situations where the thumbnail is a fallback for a failed-to-load preview image.","values":[]},{"name":"skip-filename-alt","description":"Indicates that the alt for the img element should be cleared. This should only be\nset if the thumbnail is shown in a context where filename is already visible.\n\nhttps://www.w3.org/WAI/tutorials/images/decorative/","values":[]},{"name":"visual-scale","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachment-thumbnail/"}]},{"name":"arcgis-attachment-validation-view","description":"Displays validation criteria for an attachment input.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"include-count-criteria","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachment-validation-view/"}]},{"name":"arcgis-file-picker","description":"Provides file browsing and drag/drop interactions, principally for attachments.\n--\n\n### Events\n- **arcgisFilesSelect** - This component does not enforce attachment count or file type limits.\nDo not rely on these events having only payloads consistent with\nthe configured multipleEnabled/fileTypeCategories properties.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `open(): Promise<void>`","attributes":[{"name":"disabled","values":[]},{"name":"heading","values":[]},{"name":"icon","values":[]},{"name":"multiple-enabled","description":"Controls whether the native input is configured to enable multiple file selection.\n\nThis does not enforce the limit, particularly if the user pastes or drags and drops attachments;\nthe event can include multiple files even when this property is false.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-file-picker/"}]},{"name":"arcgis-feature-form-field","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `setFocus(): Promise<void>`","attributes":[{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"read-only","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-form-field/"}]},{"name":"arcgis-feature-form-field-number","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `setFocus(): Promise<void>`","attributes":[{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"read-only","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-form-field-number/"}]},{"name":"arcgis-feature-next","description":"> [!WARNING]\n> The Feature (next) component is the successor to the Feature component, provided to you early for testing and feedback. In version 6.0, the implementation of [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) will be updated under the hood to that of [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/), and this component will be removed. To update at version 6.0, simply remove `-next` from the component name.\n\nThe Feature (next) component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\nThis component is useful in instances where you want to display information about a graphic but without\nthe use of an [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/).\n\nTo show a graphic's content with [actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), [related records](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/), aggregate feature browser ([clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate) or [binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/#popupTemplate)), etc., then use the [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/) component.\n\nWhen Arcade expressions that use `$map` or [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) are defined in any popup template content or as expression elements,\nthe [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#map) and [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#spatialReference) properties need to be defined in the Feature (next) component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.\n- `nextMedia(contentElementIndex: number): void` - Paginates to the next [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.\n- `previousMedia(contentElementIndex: number): void` - Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): void` - Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info object. For example,\nyou may have [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) content which contains\nmultiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos`\nyou wish to display.\n- `updateGeometry(): Promise<void>` - Updates the geometry of the graphic.","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-feature-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"chart-animation-disabled","description":"Indicates whether to disable chart animation in the component.","values":[]},{"name":"default-popup-template-enabled","description":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","values":[]},{"name":"focus-trap-enabled","description":"When `true`, the component will trap focus when opened.\nThis ensures that keyboard navigation is contained within the component when it opens.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-attachments-content","description":"Indicates whether to hide [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","values":[]},{"name":"hide-content","description":"Indicates whether to hide the component's content.","values":[]},{"name":"hide-custom-content","description":"Indicates whether to hide [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","values":[]},{"name":"hide-empty-relationship-content","description":"Indicates whether to hide relationship content when there are no relationship items to display.","values":[]},{"name":"hide-expression-content","description":"Indicates whether to hide [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","values":[]},{"name":"hide-fields-content","description":"Indicates whether to hide [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#heading).","values":[]},{"name":"hide-last-edited-info","description":"Indicates whether to hide the last edited info in the component.","values":[]},{"name":"hide-media-content","description":"Indicates whether to hide [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","values":[]},{"name":"hide-text-content","description":"Indicates whether to hide [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-relationship-content","description":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","values":[]},{"name":"show-utility-network-content","description":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from the associated [MapView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#timeZone) or [SceneView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#timeZone). When a view is not associated with the component,\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and times are not adjusted for any timezone.\n- Specified IANA timezone: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/"},{"name":"Feature (Next)\nThe Feature (next) component displays on hover.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-feature-next--hover&singleStory=true"}]},{"name":"arcgis-feature-table","description":"The Feature Table component provides an interactive tabular view of each feature's attributes in a feature layer.\n--\n\n### Events\n- **arcgisCellClick** - Fires when a cell within the table is clicked.\n- **arcgisCellDblClick** - Fires when a cell within the table is double-clicked.\n- **arcgisCellKeydown** - Fires when a key is pressed down within a cell within the table.\n- **arcgisCellPointerout** - Fires when the mouse pointer is moved out of a cell within the table. This event is useful for scenarios highlighting for things like highlighting a feature in the view, while hovering, without requiring manual interaction to select a row. Another example: these events can also be used to show information about the cell in a tooltip attached to the mouse.\n- **arcgisCellPointerover** - Fires when the mouse pointer is moved over a cell within the table.\n- **arcgisColumnReorder** - Fires when a column is reordered via drag-and-drop.\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 for user interaction.\n- **arcgisSelectionChange** - Fires when a row selection is added or removed.\n\n### Methods\n- `addPendingEdits(edits: FeatureStoreEdits[]): void` - Creates a pending edit with the specified parameters.\nA pending edit is not immediately saved to the layer.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `deleteSelection(showWarningPrompt?: boolean): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `discardPendingEdits(edits?: DiscardPendingEditsParameters[] | null, showWarningPrompt?: boolean): Promise<boolean>` - Cancels any pending edits. This might be edits for a specific field or column, or\nall pending edits for a specific feature. If no parameters are supplied, all pending edits\nfor all features are discarded. Additionally, if showWarningPrompt is 'true', the value returned\nfrom this method will reflect whether or not the user chose to discard the pending edits.\n- `exportSelectionToCSV(includeGeometry?: boolean): Promise<void>`\n- `findColumn(fieldName: string): Promise<ActionColumn | AttachmentsColumn | Column | GroupColumn | RelationshipColumn | null | undefined>`\n- `getCachedFeaturesByPageIndex(pageIndex: number): Promise<FeatureStoreItem[] | undefined>` - Returns cached features for a specific page index.\n- `getFeatureStoreItemByObjectId(objectId: number | string): Promise<FeatureStoreItem | null | undefined>` - Returns information about the feature with the provided object ID from the internal store.\n- `goToPage(index: number): Promise<void>`\n- `hideColumn(fieldName: string): Promise<void>`\n- `nextPage(): Promise<void>`\n- `previousPage(): Promise<void>`\n- `refresh(): Promise<void>`\n- `refreshCellContent(): Promise<void>`\n- `savePendingEdits(): Promise<void>` - Attempts to save any pending edits. If any edits are invalid, the save will be rejected until the edits are in a valid state.\n- `scrollToBottom(): Promise<void>`\n- `scrollToIndex(index: number): Promise<void>`\n- `scrollToLeft(): Promise<void>`\n- `scrollToRow(objectId: number | string): Promise<void>`\n- `scrollToTop(): Promise<void>`\n- `showAllColumns(): Promise<void>`\n- `showColumn(fieldName: string): Promise<void>`\n- `sortColumn(path: string, direction: \"asc\" | \"desc\"): Promise<void>`\n- `toggleColumnVisibility(fieldName: string): Promise<void>`\n- `zoomToSelection(): Promise<void>`","attributes":[{"name":"attachments-enabled","description":"Indicates whether to display the `Attachments` field in the table. It displays the count of attachments per feature and is only applicable if the feature layer [supports attachments](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities).\n\n![featuretable attachmentsEnabled](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/featuretable/attachments-enabled.avif)","values":[]},{"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-feature-table/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-refresh-disabled","description":"Indicates whether the table should automatically refresh when the underlying data changes.","values":[]},{"name":"auto-save-disabled","description":"Indicates whether the table should automatically save when the underlying data changes.","values":[]},{"name":"closed","description":"Indicates whether the primary panel is closed. Once the panel is closed, the panel must be re-opened programmatically.","values":[]},{"name":"collapsed","description":"Indicates whether the primary panel is collapsed. This only applies if the 'showCollapse' property has also been set to true.","values":[]},{"name":"column-performance-mode-disabled","description":"Indicates whether to enable the table's column performance mode.\nThis mode is designed to improve the performance of the table when working with a large number of columns.","values":[]},{"name":"column-reordering-disabled","description":"Indicates whether the table should allow reordering of columns.","values":[]},{"name":"definition-expression","description":"The SQL where clause used to filter features visible in the table. Only the features that satisfy the definition\nexpression are displayed in the table. This value takes priority over any definition expression set on the\nassociated layer.","values":[]},{"name":"description","description":"Text displayed in the table header, under the title. This can be a basic string or custom function that returns a string. This is useful in situations where additional context is needed for the table.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"editing-enabled","description":"Indicates whether [editing](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#editing-in-featuretable) is enabled on the data within the feature table. Double-clicking in a cell will enable editing for that value. In order to edit a feature, the layer must be editable and the user must have the appropriate permissions. In addition, the layer must contain an object ID field.","values":[]},{"name":"filter-by-layer-scale-range","description":"Indicates whether the table respects layer view scale visibility. If no view is provided, this property is ignored.\nThe table is empty when no layer view is available or when the layer view is not visible at the current scale.","values":[]},{"name":"filter-by-selection-enabled","description":"Indicates whether the table only displays rows that are considered selected. Row selection can be modified by adding or removing associated object IDs from `highlightIds`. This will cause the store to fetch fresh features to ensure the expected sort order is honored.","values":[]},{"name":"filter-by-view-extent","description":"Indicates that the table should only display rows for features that are currently in the view's extent.\nThis property has no effect if the table has not been provided a view. If this property is true, the view's extent\nwill overwrite the current value of [filterGeometry](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#filterGeometry).","values":[]},{"name":"hide-column-descriptions","description":"Indicates whether to display descriptions in the header cells of individual columns.","values":[]},{"name":"hide-column-menu-items-sort-ascending","description":"Indicates whether to display the 'Sort Ascending' menu item in column menus.","values":[]},{"name":"hide-column-menu-items-sort-descending","description":"Indicates whether to display the 'Sort Descending' menu item in column menus.","values":[]},{"name":"hide-column-menus","description":"Indicates whether to display the menu items within the individual columns.","values":[]},{"name":"hide-column-visibility-menu","description":"Indicates whether to display the column visibility menu in the table header.","values":[]},{"name":"hide-column-visibility-menu-items-filter","description":"Indicates whether to display the filter in column visibility menu.","values":[]},{"name":"hide-column-visibility-menu-items-header","description":"Indicates whether to display the header in column visibility menu.","values":[]},{"name":"hide-column-visibility-menu-items-toggle-all","description":"Indicates whether to display the 'toggle all' button in column visibility menu.","values":[]},{"name":"hide-header","description":"Indicates whether to display the feature table's header.","values":[]},{"name":"hide-layer-dropdown-icons","description":"Indicates whether to display layer-specific icons in the layer drop down menu.","values":[]},{"name":"hide-menu","description":"Indicates whether to display the feature table's menu.","values":[]},{"name":"hide-menu-items-clear-selection","description":"Indicates whether to display the 'Clear selection' menu item.","values":[]},{"name":"hide-menu-items-delete-selection","description":"Indicates whether to display the' Delete Selection' menu item.","values":[]},{"name":"hide-menu-items-export-selection-to-csv","description":"Indicates whether to display the 'Export selection to CSV' menu item.","values":[]},{"name":"hide-menu-items-refresh-data","description":"Indicates whether to display the 'Refresh data' menu item.","values":[]},{"name":"hide-menu-items-selected-records-show-all-toggle","description":"Indicates whether to toggle between showing only selected records in the table to showing all of the records.","values":[]},{"name":"hide-menu-items-selected-records-show-selected-toggle","description":"Indicates whether to display the 'Show selected records' menu item.","values":[]},{"name":"hide-menu-items-zoom-to-selection","description":"Indicates whether to display the 'Zoom to selection' menu item.","values":[]},{"name":"hide-progress","description":"Indicates whether to display the progress indicator when the table is querying or syncing data.","values":[]},{"name":"hide-selection-column","description":"Indicates whether to display the selection column in the table.\nEach row has a checkbox that selects its corresponding feature.","values":[]},{"name":"hide-tooltips","description":"Indicates whether to display the tooltip for the Show/hide columns button.","values":[]},{"name":"highlight-disabled","description":"Indicates whether to highlight the associated feature when a row is selected by checking the corresponding checkbox. This property is only applicable when working with a map and the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#view) property is set.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"initial-size","description":"The user-provided number of total features accessed from the data source. This is used for initial load of the data store as opposed to querying a specified layer. Additionally, the table will query data counts to verify the data's integrity, or when requested via [refresh()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#refresh).","values":[]},{"name":"label","description":"The components label.","values":[]},{"name":"layer-id","description":"The layer ID of a layer in the service.\nUse with [layerItemId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#layerItemId) when the service contains multiple layers and you want to specify which layer to use.","values":[]},{"name":"layer-item-id","description":"The portal item ID of a layer.\n\n\n> [!WARNING]\n> * Use `layer`, `layerUrl`, `mapLayerId`, and `layerItemId` independently; only one should be set at a time.\n> * If referencing an item containing multiple layers, use [layerId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#layerId) or [tableId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#tableId) to specify which layer or standalone table to use.","values":[]},{"name":"layer-url","description":"The URL to a layer's REST endpoint.\n\n> [!WARNING]\n> Use `layer`, `layerUrl`, `mapLayerId`, and `layerItemId` independently; only one should be set at a time.","values":[]},{"name":"map-layer-id","description":"The layer ID of a layer in the associated map.\nWhen set, the component will attempt to find and use the layer with the provided ID from the map.\n\n> [!WARNING]\n> Use `layer`, `layerUrl`, `mapLayerId`, and `layerItemId` independently; only one should be set at a time.","values":[]},{"name":"max-size","description":"This property is applicable when working with layers that contain a large number of features, as it provides the ability to limit the displayed total feature count. If [paginationEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#paginationEnabled) is `true`, and `maxSize` is greater than the current value of [pageSize](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#pageSize), multiple pages usually display. If `maxSize` is less than [pageSize](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#pageSize), a single page shows the total number of features limited to `maxSize`.","values":[]},{"name":"multiple-selection-disabled","description":"Controls whether the table allows multiple selected rows.","values":[]},{"name":"multiple-sort-enabled","description":"Indicates whether sorting multiple columns is supported within the table.","values":[]},{"name":"multiple-sort-priority","description":"This property can be used to determine how newly-sorted columns are prioritized. By default, newly sorted columns are\ngiven the highest sort priority.","values":[{"name":"append"},{"name":"prepend"}]},{"name":"navigation-scale","description":"This property controls the scale of all components in the navigation bar displayed when\nviewing attachments or related records.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]},{"name":"no-data-message","description":"This property can be used to override the text displayed when the table is fully loaded but no rows are available.","values":[]},{"name":"page-index","description":"Represents the index of the page of the feature currently being displayed. The number of features per page can be adjusted by modifying the [pageSize](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#pageSize). [Pagination](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#paginationEnabled) must be enabled or the value of this property may not be reliable due to virtualization of visible pages.","values":[]},{"name":"page-size","description":"The default page size used when displaying features within the table. By default, the page loads the first 50 features returned by the service. It can be used with [paginationEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#paginationEnabled) to display a subset of features.\n\n> [!WARNING]\n>\n> It is not possible to overwrite the maximum page size on the server, ie. `maxRecordCount`, as this property only applies to set values less than the maximum page size, i.e. `maxRecordCount`, set on the service.","values":[]},{"name":"pagination-enabled","description":"Controls whether the table should only display a single page of features at any time. Current page can be determined via the [pageIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#pageIndex) property. The current page can be modified by calling the [goToPage()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#goToPage) method and passing in the desired [page index](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#pageIndex).","values":[]},{"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.","values":[]},{"name":"related-records-enabled","description":"Indicates whether to display any related records associated with rows within the table. Take note that related layers must be provided via the [layers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#layers) property when there is no associated [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#view).","values":[]},{"name":"return-geometry-enabled","description":"Indicates whether to fetch geometries for the corresponding features displayed in the table.\n\n> [!WARNING]\n>\n> Setting this to `true` can potentially impact the component's performance.","values":[]},{"name":"return-m-enabled","description":"Indicates whether geometries fetched for the corresponding features contain M values, if supported.\nThe [returnGeometryEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#returnGeometryEnabled) property must also be true.\n\n> [!WARNING]\n>\n> Setting this to `true` can potentially impact the component's performance.","values":[]},{"name":"return-z-enabled","description":"Indicates whether the fetched features' geometries contain Z values. This is only applicable if Z-values are supported.\nThe [returnGeometryEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#returnGeometryEnabled) property must also be true.\n\n> [!WARNING]\n>\n> Setting this to `true` can potentially impact the component's performance.","values":[]},{"name":"show-close","description":"Indicates whether to display a close button in the table panel header.","values":[]},{"name":"show-collapse","description":"Indicates whether to display a collapse button in the table panel header.","values":[]},{"name":"show-layer-dropdown","description":"Indicates whether to display the feature table's layer switch drop down menu.","values":[]},{"name":"sync-template-on-changes-disabled","description":"Indicates whether the table should synchronize the current attributeTableTemplate\nbeing used based on changes made to the table's UI.","values":[]},{"name":"sync-view-selection","description":"Controls whether the table should sync with the view's selection manager.\nThis does not include selection sources, which must be configured independently\non the view's selection manager.","values":[]},{"name":"table-id","description":"The table ID of a layer in the service.\nUse with [layerItemId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#layerItemId) when the service contains multiple layers and tables, and you want to specify which table to use.","values":[]},{"name":"table-title","description":"Replacement title for the table. This can be a basic string or custom function that returns a string. This is useful in situations where it may be necessary to dynamically update titles based on the current state of the table.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be in terms of this time zone. If not supplied, the view's time zone is used (if available). Depending on the field type, individual columns may have their own unique time zone behavior when the time zone itself is `unknown`.\n\n> [!WARNING]\n>\n> The following considerations apply when working with date, time, and big integer field types:\n>\n> By default, the FeatureTable displays time zones for `date` and `timestamp-offset` field [types](https://developers.arcgis.com/javascript/latest/references/core/layers/support/Field/#type) using the associated view's time zone. This time zone can be overridden by setting the table's [timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#timeZone) property.\n> If the table's [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#view) isn't set, and, (if applicable), a [Feature.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#timeZone) isn't set, the table defaults to `system` time. The only instance where this is not the case is when there is a [FeatureLayer#preferredTimeZone](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#preferredTimeZone) set on the table's layer. If the latter is true, the preferred time zone is used as opposed to `system`.","values":[]},{"name":"view-time-enabled","description":"Controls [time extent](https://developers.arcgis.com/javascript/latest/references/core/time/TimeExtent/) filtering behavior for the table. When `true`, the [table's time extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#timeExtent) will\nbe derived from the intersection of the [view](https://developers.arcgis.com/javascript/latest/references/core/views/View/#timeExtent)\nand [layer's](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#timeExtent) `timeExtent`.\nWhen `false`, only the [layer's `timeExtent`](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#timeExtent)\nwill be considered.\nWhen [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#timeExtent) is defined on the\ntable, only that [time extent](https://developers.arcgis.com/javascript/latest/references/core/time/TimeExtent/) will be used and this property will\nbe ignored.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/"},{"name":"Feature Table","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-feature-table--demo&singleStory=true"}]},{"name":"arcgis-feature-templates","description":"The FeatureTemplates component is part of an editing workflow. Its main purpose is to display [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) templates from one or more feature layers.\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 for user interaction.\n- **arcgisSelectTemplate** - The user has selected a template\n- **arcgisTemplatesChanged** - The source of templates has changed.\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","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-feature-templates/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"disable-templates-mode","description":"Decide if templates should be disabled when the layer is not visible, or not visible at the current scale.","values":[{"name":"never"},{"name":"scale"},{"name":"visible"}]},{"name":"display","description":"Determine if templates should be shown grouped, or in a single flat list","values":[{"name":"flat"},{"name":"grouped"}]},{"name":"exclude-tables","description":"Determines if feature templates for tables should be shown","values":[]},{"name":"favorites-enabled","description":"Include a favorites used tab","values":[]},{"name":"favorites-filter-text","description":"The text the user has entered to filter the list on the favorites tab","values":[]},{"name":"filter-text","description":"The text the user has entered to filter the list","values":[]},{"name":"group-by","description":"When templates are grouped, determine the group by policy. Note: if the component has been supplied with applicationTemplates, the templates will keep the supplied groupings.","values":[{"name":"geometry"},{"name":"layer"}]},{"name":"hide-template-description","description":"Determine if the template description should be displayed","values":[]},{"name":"hide-templates-mode","description":"Decide if templates should be hidden when the layer is not visible, or not visible at the current scale.","values":[{"name":"never"},{"name":"scale"},{"name":"visible"}]},{"name":"min-required-filter-count","description":"Automatically hide the filter if below a certain number of templates.","values":[]},{"name":"recent-filter-text","description":"The text the user has entered to filter the list on the recent tab","values":[]},{"name":"recently-used-enabled","description":"Include a recently used tab","values":[]},{"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.","values":[]},{"name":"section-sort-by","description":"When templates are grouped, determine how the groups are sorted. If the component has been supplied with a sectionSortByFunction then this will be used instead.","values":[{"name":"alphabetical"},{"name":"system"}]},{"name":"selected-template-id","description":"Currently selected template id","values":[]},{"name":"shared-templates-disabled","description":"Fetch shared templates, if the layer's in the view have shared Templates.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to display the collapse button.","values":[]},{"name":"show-filter","description":"Indicates whether to show the templates filter","values":[]},{"name":"template-sort-by","description":"Determines how templates are ordered. This will either be in alphabetical order\nor the order they are defined in the layer schema.","values":[{"name":"alphabetical"},{"name":"system"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-templates/"}]},{"name":"arcgis-template-image","description":"The Template Image component generates a feature swatch representing a\nFeature Template.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-template-image/"}]},{"name":"arcgis-feature-templates-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe FeatureTemplates component is part of an editing workflow. Its main purpose is to display [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) templates from one or more feature layers.\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 for user interaction.\n- **arcgisSelect**\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.\n- `select(item: null | undefined | TemplateItem): void` - Selects the template item to use.","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-feature-templates-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"enable-list-scroll","description":"Indicates whether the list of available feature [template items](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/) should scroll within its containing element.","values":[]},{"name":"filter-text","description":"Text used to filter items.","values":[]},{"name":"group-by","description":"It is possible to group [template items](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/). This can aid\nin managing various template items and how they display within the component. The values are discussed below.\n\nType | Description | Example\n----- | ----------- | -------\nlayer | This is the *default* grouping. Groups template items by layers. | ![featureTemplatesGroupByLayer](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupByLayers.avif)\ngeometry | Groups template items by geometry type. | ![FeatureTemplatesGroupByGeometry](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupByGeometry.avif)\nnone | The component displays everything in one list with no grouping. | ![featureTemplatesGroupByLayer](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupByNone.avif)\n[GroupByFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/types/#GroupByFunction) | Custom function that takes an object containing a [FeatureTemplate](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureTemplate/) and [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/). | ![FeatureTemplatesGroupByCustomGroupFunction](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupCustomGroup.avif)","values":[{"name":"layer"},{"name":"none"},{"name":"geometry"}]},{"name":"heading-level","description":"Indicates the heading level to use for the labels of grouped feature templates.\nBy default, the group label is rendered\nas a level 4 heading (e.g. `<h4>Group label</h4>`). 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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-filter","description":"Indicates whether the templates filter displays.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection behavior of list items. The `\"single\"` selection mode keeps the clicked list item selected. Whereas, `\"none\"` does not preserve the selection after clicking the list item.","values":[{"name":"none"},{"name":"single"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-templates-legacy/"}]},{"name":"arcgis-features","description":"The Features component allows users to view a feature's popupTemplate content such as attributes,\nactions, related records, etc., without having to be tied to an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\nThis component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component,\nhowever unlike Popup, the Features component can be placed outside of the map or scene component.\nFor example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/),\nthe [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opens within the map whether it is docked\nor anchored to the selected feature.\nWith the Features component, the same information that Popup provides is shown in a separate container from the map, such as\na HTML div within a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\nIf multiple features are passed into the Features component, the component provides buttons to page though the features and a feature menu that allows the\nlist of features to be displayed so the user can choose which feature content to display in the component. The component also respects\nfeature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate).\n\nThe Features component should be used if needing to use the Popup functionality outside of the map or scene component. To show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) component.\n\n> [!WARNING]\n> In version 6.0, the implementation of [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) will be updated under the hood to that of [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/), and deprecated properties on this component will be removed. We encourage using the [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/) component and providing feedback.\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 for user interaction.\n- **arcgisTriggerAction** - Fires after the user clicks on an action in the component.\nThis event may be used to define a custom function to execute when particular actions are clicked.\n\n### Methods\n- `clear(): Promise<void>` - Removes [promises](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#promises), [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#content), and\n[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading) from the Features component.\n- `close(): Promise<void>` - A convenience method to close the component.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): Promise<FeaturesViewModel>` - Selects the feature at the next index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature).\n\n> [!WARNING]\n> The return type of `FeaturesViewModel` on the `next()` method is deprecated. At 6.0, this method will return void. See [arcgis-features-next.next()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#next) for the updated usage.\n- `previous(): Promise<FeaturesViewModel>` - Selects the feature at the previous index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature).\n\n> [!WARNING]\n> The return type of `FeaturesViewModel` on the `previous()` method is deprecated. At 6.0, this method will return void. See [arcgis-features-next.previous()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#previous) for the updated usage.\n- `setFocus(): Promise<void>` - Use this method to give focus to the Component if the component is able to be focused.","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-features/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"chart-animation-disabled","description":"Disables chart animation within the component.","values":[]},{"name":"collapsed","description":"Indicates whether the component displays its content. If `true`, only the header displays.\nThis property is only honored if [showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#showCollapseButton) is `true`.","values":[]},{"name":"collapse-direction","description":"Controls the direction the content collapses when the collapse button is used.\nWhen unset, the component chooses a direction based on the [feature navigation placement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#featureNavigationTop).","values":[{"name":"down"},{"name":"up"}]},{"name":"content","description":"The content of the component. When set directly on the component, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content).","values":[]},{"name":"default-popup-template-enabled","description":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","values":[]},{"name":"feature-count","description":"The number of [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) available in the component.","values":[]},{"name":"feature-menu-open","description":"This property enables multiple features in the component to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features. This value will only be honored if [initialDisplayMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#initialDisplayMode) is set to \"feature\".","values":[]},{"name":"feature-menu-title","description":"Sets the title to display on the component while viewing the feature menu.","values":[]},{"name":"feature-navigation-top","description":"Indicates whether the feature navigation arrows are displayed at the top of the component.\nBy default, the navigation arrows are displayed at the bottom of the component.\nThis property also controls the collapse button's icon direction when the [collapseDirection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#collapseDirection) property is not set. When `featureNavigationTop` is `true`, the collapse button icon defaults to collapsing \"up\" and when `false` it defaults to collapsing \"down\".","values":[]},{"name":"features-per-page","description":"The number of features to fetch at one time.","values":[]},{"name":"heading","description":"The title of the Features component. This can be set to any string value no\nmatter the features that are selected. If the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/), then the title set in the\ncorresponding template is used here.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading) of the component.\nBy default, the heading is rendered\nas a level 2 heading (e.g. `<h2>Popup title</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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#actions).","values":[]},{"name":"hide-attachments-content","description":"This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","values":[]},{"name":"hide-close-button","description":"Indicates whether to hide the close button in the component.","values":[]},{"name":"hide-content","description":"This property provides the ability to hide or show content within the component.","values":[]},{"name":"hide-custom-content","description":"This property provides the ability to hide or show [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","values":[]},{"name":"hide-expression-content","description":"This property provides the ability to hide or show [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","values":[]},{"name":"hide-feature-list-layer-title","description":"Indicates whether to hide the group heading for a list of multiple features.","values":[]},{"name":"hide-feature-menu-heading","description":"Indicates whether to hide the feature menu heading and description in the component's feature menu list.","values":[]},{"name":"hide-feature-navigation","description":"Indicates whether to hide the feature navigation in the component. This allows the user to scroll through various [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) using pagination arrows.","values":[]},{"name":"hide-fields-content","description":"This property provides the ability to hide or show [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading).","values":[]},{"name":"hide-last-edited-info","description":"This property provides the ability to hide or show the last edited info within the component.","values":[]},{"name":"hide-media-content","description":"This property provides the ability to hide or show [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","values":[]},{"name":"hide-relationship-content","description":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","values":[]},{"name":"hide-select-feature","description":"Indicates whether to hide the *select feature* action when viewing associated and related features.","values":[]},{"name":"hide-spinner","description":"Indicates whether to hide the spinner in the component.","values":[]},{"name":"hide-text-content","description":"This property provides the ability to hide or show [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","values":[]},{"name":"hide-utility-network-content","description":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","values":[]},{"name":"highlight-disabled","description":"Indicates whether to highlight the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature) in the associated\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"include-default-actions-disabled","description":"Indicates whether to include the default actions in the component.\nIn order to disable any default actions, it is necessary to set `includeDefaultActionsDisabled` to `true`.","values":[]},{"name":"initial-display-mode","description":"Indicates whether to initially display a list of features, or the content for one feature.","values":[{"name":"list"},{"name":"feature"}]},{"name":"label","description":"The component's default label.","values":[]},{"name":"open","description":"Indicates whether the component is visible. This property is `true` when the component is querying for results, even if it is not open. Use this property to check if the component is visible.","values":[]},{"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.","values":[]},{"name":"selected-feature-index","description":"Index of the feature that is [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) are set,\nthe first index is automatically selected.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to show the collapse button in the component.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from the associated [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) or [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone) if the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#view) property is set. When a view is not associated with the component\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and times are not adjusted for any timezone.\n- `Specified IANA timezone`: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","values":[]},{"name":"update-location-enabled","description":"Indicates whether to update the component's location when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex) changes.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/"},{"name":"Features\nThe Features component displays in a Calcite shell panel on click.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-features--demo&singleStory=true"},{"name":"Hide heading\nDisplays Features with a heading value while hideHeading is enabled.\nThe title area should not render the heading text.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-features--hide-heading&singleStory=true"}]},{"name":"arcgis-features-next","description":"> [!WARNING]\n> The Features (next) component is the successor to the Features component, provided to you early for testing and feedback. In version 6.0, the implementation of [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) will be updated under the hood to that of [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/), and this component will be removed. To update at version 6.0, simply remove `-next` from the component name.\n\nThe Features (next) component allows users to view a feature's popupTemplate content such as attributes,\nactions, related records, etc., without living inside a view component.\nThis component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component,\nhowever unlike Popup, the Features (next) component can be placed outside of a view component.\nFor example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/),\nthe [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opens within the map whether it is docked\nor anchored to the selected feature.\nWith the Features (next) component, the same information that Popup provides is shown in a separate container from the map, such as a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\nIf multiple features are passed into the Features (next) component, the component provides buttons to page though the features and a feature menu that allows the\nlist of features to be displayed so the user can choose which feature content to display in the component. The component also respects\nfeature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate).\n\nThe Features (next) component should be used if needing to use the Popup functionality outside of the map or scene component. To show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/) component.\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 for user interaction.\n- **arcgisTriggerAction** - Fires after the user clicks on an action in the component.\nThis event may be used to define a custom function to execute when particular actions are clicked.\n\n### Methods\n- `clear(): void` - Removes [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#content), and\n[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading) from the component.\n- `close(): void` - A convenience method to close the component.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): void` - Selects the feature at the next index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature).\n- `previous(): void` - Selects the feature at the previous index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature).\n- `setFocus(): Promise<void>` - Use this method to give focus to the Component if the component is able to be focused.\n\n### Slots\n- **actions-start** - _Since 5.2._ Slot for adding Calcite [actions](https://developers.arcgis.com/calcite-design-system/components/action/) or [action groups](https://developers.arcgis.com/calcite-design-system/components/action-group/) to the start of the action bar. Multiple actions or action groups can be placed in this slot. Slotted actions remain at the start of the action bar and are not automatically grouped if they exceed the available width. To group actions, place them in a Calcite action group. Actions in this slot remain separate from other actions, including default actions (such as \"Zoom to\" and \"Browse features\"), [PopupTemplate actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), and [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions).\n\nTo display text on the action, use the `text-enabled` attribute of the Calcite [action](https://developers.arcgis.com/calcite-design-system/components/action/#api-reference-properties-textEnabled).\n- **actions-end** - _Since 5.2._ Slot for adding Calcite [actions](https://developers.arcgis.com/calcite-design-system/components/action/) or [action groups](https://developers.arcgis.com/calcite-design-system/components/action-group/) to the end of the action bar. Multiple actions or action groups can be placed in this slot. Slotted actions remain at the end of the action bar and are not automatically grouped if they exceed the available width. To group actions, place them in a Calcite action group. Actions in this slot remain separate from other actions, including default actions (such as \"Zoom to\" and \"Browse features\"), [PopupTemplate actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), and [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions).\n\nTo display text on the action, use the `text-enabled` attribute of the Calcite [action](https://developers.arcgis.com/calcite-design-system/components/action/#api-reference-properties-textEnabled).","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-features-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"chart-animation-disabled","description":"Indicates whether to disable chart animation in the component.","values":[]},{"name":"collapsed","description":"Indicates whether the component displays its content. If `true`, only the header displays.\nThis property is only honored if [showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#showCollapseButton) is `true`.","values":[]},{"name":"collapse-direction","description":"Controls the direction the content collapses when the collapse button is used.\nWhen unset, the component chooses a direction based on the [feature navigation placement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#featureNavigationTop).","values":[{"name":"down"},{"name":"up"}]},{"name":"content","description":"The content of the component. When set directly on the component, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content).","values":[]},{"name":"default-popup-template-enabled","description":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","values":[]},{"name":"feature-count","description":"The number of [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) available in the component.","values":[]},{"name":"feature-menu-open","description":"This property enables multiple features in the component to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features. This value will only be honored if [initialDisplayMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#initialDisplayMode) is set to \"feature\".","values":[]},{"name":"feature-menu-title","description":"Sets the title to display on the component while viewing the feature menu.","values":[]},{"name":"feature-navigation-top","description":"Indicates whether the feature navigation arrows are displayed at the top of the component.\nBy default, the navigation arrows are displayed at the bottom of the component.\nThis property also controls the collapse button's icon direction when the [collapseDirection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#collapseDirection) property is not set. When `featureNavigationTop` is `true`, the collapse button icon defaults to collapsing \"up\" and when `false` it defaults to collapsing \"down\".","values":[]},{"name":"features-per-page","description":"The number of features to fetch at one time.","values":[]},{"name":"focus-trap-enabled","description":"When `true`, the component will trap focus when opened.\nThis ensures that keyboard navigation is contained within the component when it opens.","values":[]},{"name":"heading","description":"The title of the Features component. This can be set to any string value no\nmatter the features that are selected. If the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/), then the title set in the corresponding template is used here.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions).","values":[]},{"name":"hide-attachments-content","description":"Indicates whether to hide [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","values":[]},{"name":"hide-close-button","description":"Indicates whether to hide the close button in the component.","values":[]},{"name":"hide-content","description":"Indicates whether to hide the component's content.","values":[]},{"name":"hide-custom-content","description":"Indicates whether to hide [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","values":[]},{"name":"hide-empty-relationship-content","description":"Indicates whether to hide relationship content when there are no relationship items to display.","values":[]},{"name":"hide-expression-content","description":"Indicates whether to hide [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","values":[]},{"name":"hide-feature-list-layer-title","description":"Indicates whether to hide the group heading for a list of multiple features.","values":[]},{"name":"hide-feature-menu-heading","description":"Indicates whether to hide the feature menu heading and description in the component's feature menu list.","values":[]},{"name":"hide-feature-navigation","description":"Indicates whether to hide the feature navigation in the component. This allows the user to scroll through various [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) using pagination arrows.","values":[]},{"name":"hide-fields-content","description":"Indicates whether to hide [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading).","values":[]},{"name":"hide-last-edited-info","description":"Indicates whether to hide the last edited info in the component.","values":[]},{"name":"hide-media-content","description":"Indicates whether to hide [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","values":[]},{"name":"hide-relationship-content","description":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","values":[]},{"name":"hide-select-feature","description":"Indicates whether to hide the *select feature* action when viewing associated and related features.","values":[]},{"name":"hide-spinner","description":"Indicates whether to hide the spinner in the component.","values":[]},{"name":"hide-text-content","description":"Indicates whether to hide [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","values":[]},{"name":"hide-utility-network-content","description":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","values":[]},{"name":"highlight-disabled","description":"Indicates whether to highlight the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature) in the associated\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"include-default-actions-disabled","description":"Indicates whether to include the default actions in the component.\nIn order to disable any default actions, it is necessary to set `includeDefaultActionsDisabled` to `true`.","values":[]},{"name":"initial-display-mode","description":"Indicates whether to initially display a list of features, or the content for one feature.\nBy default, a list is displayed when the associated view has `focusRegionVisible` enabled; otherwise, the content for one feature is displayed.","values":[{"name":"list"},{"name":"feature"}]},{"name":"label","description":"The component's default label.","values":[]},{"name":"open","description":"Indicates whether the component is visible. This property is `true` when the component is querying for results, even if it is not open. Use this property to check if the component is visible.","values":[]},{"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.","values":[]},{"name":"selected-feature-index","description":"Index of the feature that is [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) are set,\nthe first index is automatically selected.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to show the collapse button in the component.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from the associated [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) or [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone) if the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#view) property is set. When a view is not associated with the component\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and times are not adjusted for any timezone.\n- `Specified IANA timezone`: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","values":[]},{"name":"update-location-enabled","description":"Indicates whether to update the feature location when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeatureIndex) changes.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/"},{"name":"Features (Next)\nThe Features (Next) component displays in a Calcite shell panel on click.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-features-next--demo&singleStory=true"}]},{"name":"arcgis-filter-builder","description":"The Filter Builder component can be used to create and manage filter conditions for a specific layer.\nIt provides a user interface for defining filter criteria, allowing users to build complex queries based on\nthe attributes of the selected layer.\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 for user interaction.\n\n### Methods\n- `addCondition(params?: AddConditionParameters, index?: number): Promise<void>` - Adds a new filter condition to the filter builder. The new condition can be configured with an optional field name, operator, and value.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>`\n- `duplicateConditionByIndex(index: number): Promise<void>` - Duplicates the filter condition at the specified index. The duplicated condition will be inserted immediately after the original condition.\n- `removeConditionByIndex(index: number): Promise<void>` - Removes the filter condition at the specified index from the filter builder.\n- `reset(): Promise<void>` - Resets the filter builder by removing all existing conditions and clearing the generated WHERE clause.\nThis method effectively returns the filter builder to its initial state.","attributes":[{"name":"auto-destroy-disabled","values":[]},{"name":"condition-operator","description":"The logical operator used to combine multiple filter conditions.","values":[{"name":"AND"},{"name":"OR"}]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-fab","description":"Controls visibility of the floating action button used to add new conditions. If true, the button will be hidden.","values":[]},{"name":"hide-header","description":"Controls visibility of the header section of the filter builder. If true, the header will be hidden.","values":[]},{"name":"hide-menu","description":"Controls visibility of the menu used to delete or duplicate conditions. If true, the menu will be hidden.","values":[]},{"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.","values":[]},{"name":"visual-scale","description":"Controls the visual scale of the filter builder component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-filter-builder/"},{"name":"Filter Builder","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-filter-builder--demo&singleStory=true"}]},{"name":"arcgis-floor-filter","description":"The Floor Filter component simplifies visualization of GIS data for a specific floor of a\nbuilding in your application. It allows you to filter down the floor plan data displayed in your\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) to a [site](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#site), a [facility](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#facility) in the site,\nor a [level](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#level) in the facility.\n\nTo visualize your data based on [site](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#site), [facility](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#facility), or [level](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#level), your map must contain the related\nfloor plan layers, with features linked together in a floor plan hierarchy.\nOnce you define your map as floor-aware in the map properties, the interactive, on-screen\nFloor Filter component appears and can be used to explore the floor-aware data based on the\nconfigured site, facility, and levels layers.\nThe Floor Filter component currently supports\n[FeatureLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),\n[SceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/) and\n[MapImageLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/) (map services).\n\nThe component can also be used alongside other filtering functionalities, such as definition queries,\nselection, range, and time, to further control visualization.\nFor example, you may want to visualize all of the features on a specific level in a facility,\nor all the office units within a range of levels in a facility.\n\n**Note**\n\nIf a default site, facility, or level is selected in the floor filter when sharing a floor-aware web map from ArcGIS Pro,\nit will also be the default selection within the Floor Filter component.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.\n- `updateWebDocument(webMap: WebMap | WebScene): 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-floor-filter/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"facility","description":"The currently selected facility.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the headings separating floors in buildings.\nBy default, the building name is rendered\nas a level 2 heading (e.g. `<h2>Building name</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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"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).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"level","description":"The currently selected floor level.","values":[]},{"name":"long-names","description":"Determines if the component is expanded or collapsed.\nIf the value is `true`, the component is expanded and the long names appear.\nOtherwise, short names are used and icons appear alone on buttons.","values":[]},{"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.","values":[]},{"name":"site","description":"The currently selected site.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/"},{"name":"Floor Filter","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-floor-filter--demo&singleStory=true"}]},{"name":"arcgis-fullscreen","description":"The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\nUse the escape key (`esc`) to exit fullscreen mode.\n\n**Known limitations**\n\n* Fullscreen only works with browsers that implement the [Fullscreen](https://developer.mozilla.org/docs/Web/API/Fullscreen_API) API.\n  Thus, iOS Safari is not supported.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"element","description":"The [HTMLElement](https://developer.mozilla.org/docs/Web/API/HTMLElement) to present in fullscreen mode.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"state","values":[{"name":"active"},{"name":"disabled"},{"name":"ready"},{"name":"unsupported"}]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-fullscreen/"},{"name":"Fullscreen","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-fullscreen--demo&singleStory=true"}]},{"name":"arcgis-grid-controls","description":"The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- Grid Controls is only supported in a 2D Map component.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.\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 for user interaction.\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.\n- `trySetDisplayEnabled(enabled: boolean): void` - Call this to turn the grid on/off.","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-grid-controls/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"custom-color","description":"The custom color used for drawing the grid, if any.","values":[]},{"name":"dynamic-scaling","description":"Returns `true` if the grid is set to scale dynamically. When dynamic scaling is enabled,\ngrid cells are added or removed to ensure that grid cells are a reasonable size on screen as the user zooms.\nThe way additional grid lines are shown is controlled by the [majorLineInterval](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#majorLineInterval) property.","values":[]},{"name":"effective-spacing-after-dynamic-scaling","description":"Returns the actual spacing of grid lines after dynamic scaling has been applied at the current scale.","values":[]},{"name":"grid-color","description":"Controls the color of the major grid lines. Minor grid lines are a slightly transparent version of this color.","values":[]},{"name":"grid-out-of-scale","description":"True if the grid is currently not displayed (and therefore also not a valid snap target),\nbecause [dynamicScaling](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#dynamicScaling) is off and the grid cells are too small\nto render at the current scale.","values":[]},{"name":"hide-color-selection","description":"Controls display of the color and theme selection options.","values":[]},{"name":"hide-dynamic-scale-toggle","description":"Controls display of the dynamic scaling toggle. Dynamic scaling adjusts the size of the grid to work\nwell regardless of view scale.","values":[]},{"name":"hide-grid-enabled-toggle","description":"Controls display of the grid enabled toggle. This toggle controls whether the grid is displayed.","values":[]},{"name":"hide-grid-snap-enabled-toggle","description":"Controls display of the grid snapping enabled toggle. This toggle controls whether snapping is enabled.","values":[]},{"name":"hide-line-interval-input","description":"Controls display of the line interval input field for setting the interval between major grid lines.","values":[]},{"name":"hide-numeric-inputs","description":"Controls display of the numeric input fields for setting grid spacing and rotation.","values":[]},{"name":"hide-out-of-scale-warning","description":"Controls display of the out of scale warning. This warning is displayed when the grid is not shown\nbecause it would be too small at the current scale and dynamic scaling is disabled.","values":[]},{"name":"hide-placement-buttons","description":"Controls display of the grid placement buttons. These buttons allow the user to start interactive\nconfiguration of the grid.","values":[]},{"name":"hide-rotate-with-map-toggle","description":"Controls display of the rotate with map toggle. This toggle controls whether the grid rotates with the map.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interactive-placement-state","description":"Sets the interactive placement state, either starting or ending a draw operation that implicitly adjusts the grid.\nInteractive placement allows the user to define the center of the grid, then the scale and rotation of the grid by\ndrawing a second point. Setting this to \"place\" allows the user to move the grid center only. Setting this to \"rotate\"\nkeeps the scale and center of the grid constant while rotating the grid by defining a second point.","values":[{"name":"rotate"},{"name":"place"},{"name":"interactive"}]},{"name":"label","description":"The component's default label.","values":[]},{"name":"major-line-interval","description":"Controls the number of grid cells shown between major grid lines. Can be anything between 1 and 15.\nNo minor grid lines are shown when this is set to 1.","values":[]},{"name":"placement-disabled","description":"Use this property to disable the interactive grid placement buttons as needed.\nAn example use case might be to block interaction while another interactive operation\n(e.g. sketching) is in progress.","values":[]},{"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.","values":[]},{"name":"rotate-with-map","description":"Controls whether the grid rotates with the map, or stays fixed to the screen.","values":[]},{"name":"rotation","description":"Rotation of the grid in radians. NOTE: UI controls convert to and from degrees automatically.","values":[]},{"name":"snapping-enabled","description":"Controls snapping behavior if [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#snappingOptions) has been defined.\nIf [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#snappingOptions) have been defined, disabling or enabling grid snapping will\nalso disable or enable grid display.","values":[]},{"name":"spacing","description":"Length of a grid cell. Grid cells are always square. Defined in [unit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#unit).","values":[]},{"name":"theme","description":"The color scheme used to display the grid. This will be light, dark, or custom. When theme is set to custom,\nthe [customColor](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#customColor) is shown, otherwise a default light or dark theme color is used.","values":[{"name":"dark"},{"name":"light"},{"name":"custom"}]},{"name":"unit","description":"Unit of measure (foot, meter, etc) used when defining the [spacing](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#spacing) grid cell.\nNote that units are defined relatively to the map's spatial reference length unit,\nwhich will not correspond to geographic distance unless using a special-purpose basemap\nwithin a supported target area.\n\nWhen using Web Mercator, the projection defines the length of a meter in projection system units;\nthis length is equal to a geographic meter only at the equator. On screen, the size of the grid cells is constant\nfrom the equator to the poles, but the real-world size of the grid cell is much larger further from the equator.\n\nThe length of the grid cells can usefully correspond to a geographic length when the Grid is used with an\nappropriate spatial reference (for example a local system or a State Plane system) within the reference's area of interest.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/"},{"name":"Grid Controls","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-grid-controls--demo&singleStory=true"}]},{"name":"arcgis-histogram-range-slider","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 for user interaction.\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.\n- `generateWhereClause(field: string): Promise<string | null | undefined>` - Generates a SQL where clause based on a given field and the slider's\nrangeType","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-histogram-range-slider/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"average","description":"The statistical average of the data in the histogram. You would typically\nget this value from the `avg` property of\n[SummaryStatisticsResult](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/types/#SummaryStatisticsResult),\nwhich is the result of the\n[summaryStatistics](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/summaryStatistics/) function.\n\nWhen set, this value will render on the histogram with a line and an average symbol.","values":[]},{"name":"excluded-bar-color","description":"Sets the color of the histogram bars that are excluded based on the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType). For example, when a rangeType of `between` is used,\nall bars **not** between the slider thumbs will be rendered with the color set here.\n\nTo change the style of histogram bars representing included data based on the\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType), use the [includedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#includedBarColor) property.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"included-bar-color","description":"Sets the color of the histogram bars that are included in the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType). For example, when a rangeType of `between` is used,\nall bars between the slider thumbs will be rendered with the color set here.\n\nTo change the style of histogram bars representing excluded data based on the\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType), use the [excludedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#excludedBarColor) property.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. If the largest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) _in the constructor_ is greater than the `maxValue` set in\nthis property, then the `maxValue` will update to match the largest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values).","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. If the smallest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) _in the constructor_ is greater than the `minValue` set in\nthis property, then the `minValue` will update to match the smallest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values).","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb values should round to when they have been moved.\n\nThis value also indicates the precision of thumb [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/HistogramRangeSliderViewModel/#labels) when the data range\n([max](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#max) - [min](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#min)) is less than `10`.\n\nWhen the data range is larger than `10`, [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/HistogramRangeSliderViewModel/#labels) display with a precision of\nno more than two decimal places, though actual slider thumb values will maintain the\nprecision specified in this property.\n\nFor example, given the default precision of `4`, and the following slider configuration,\nThe label of the thumb will display two decimal places, but the precision of the actual\nthumb value will not be lost even when the user slides or moves the thumb.\n\n```js\nconst slider = new HistogramRangeSliderViewModel({\n  min: 20,\n  max: 100,  // data range of 80\n  values: [50.4331],\n  // thumb label will display 50.43\n  // thumb value will maintain precision, so\n  // value will remain at 50.4331\n});\n```\n\nIf the user manually enters a value that has a higher precision than what's indicated by\nthis property, the precision of that thumb value will be maintained until the thumb\nis moved by the user. At that point, the value will be rounded according to the indicated precision.\n\nKeep in mind this property rounds thumb [values](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) and shouldn't be used exclusively\nfor formatting purposes. To format thumb `labels`, use the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#labelFormatFunction)\nproperty.","values":[]},{"name":"range-type","description":"Indicates how the histogram bins should be rendered as the user slides the thumbs. By default,\nblue bars indicate data bins included in the range. Gray bars indicate data bins excluded from\nthe range. These colors can be customized with the [includedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#includedBarColor) and\n[excludedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#includedBarColor) properties.\n\nThis property also determines the SQL where clause generated in [generateWhereClause()](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#generateWhereClause)\nfor filtering purposes. The value set here determines the number of [values](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values)\nallowed on the slider.\n\nSee the table below for a description and requirements of all possible values. `value1` refers to\nthe value of the first thumb position. `value2` refers to the value of the final thumb position, if applicable.\n\nPossible Value | Number of [values](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) | [Where clause](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#generateWhereClause)\n---------------|----------------------------|----------------------\nequal | 1 | `${field} = ${value1}`\nnot-equal | 1 | `${field} <> ${value1}`\nless-than | 1 | `${field} < ${value1}`\ngreater-than | 1 | `${field} > ${value1}`\nat-most | 1 | `${field} <= ${value1}`\nat-least | 1 | `${field} >= ${value1}`\nbetween | 2 | `${field} BETWEEN ${value1} AND ${value2}`\nnot-between | 2 | `${field} NOT BETWEEN ${value1} AND ${value2}`","values":[{"name":"equal"},{"name":"between"},{"name":"not-between"},{"name":"not-equal"},{"name":"less-than"},{"name":"greater-than"},{"name":"at-most"},{"name":"at-least"}]},{"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.","values":[]},{"name":"standard-deviation","description":"Indicates the standard deviation of the dataset.\nWhen set, computed [dataLines](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#dataLines) will render on the histogram\nat the location of the given standard deviation\nabove and below the `average`.","values":[]},{"name":"standard-deviation-count","description":"Indicates the number of standard deviation lines to render on the histogram\nfrom the [average].","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-histogram-range-slider/"}]},{"name":"arcgis-home","description":"The Home component is a button that navigates back to the\ninitial [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/)\nor a previously defined `viewpoint`.\n--\n\n### Events\n- **arcgisGo** - Fires when the go() method is called.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `cancelGo(): Promise<void>` - This function provides the ability to interrupt and cancel the process\nof navigating back to the initial extent.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `go(): Promise<void>` - Animates the map or scene to its initial Viewpoint or the\nvalue of `viewpoint`.","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-home/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon displayed in the component's button.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-home/"},{"name":"Home","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-home--demo&singleStory=true"}]},{"name":"arcgis-layer-list","description":"The Layer List provides a way to display a list of layers and switch on/off their visibility.\nThe [listItemCreatedFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#listItemCreatedFunction) and the [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.\n\n> **Notes**\n>\n> - The Layer List does not emit an event when the visibility of a layer changes. To respond to layer visibility changes, watch the [visible](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#visible) property of layers in the [allLayers](https://developers.arcgis.com/javascript/latest/references/core/Map/#allLayers) property with [reactiveUtils](https://developers.arcgis.com/javascript/latest/references/core/core/reactiveUtils/).\n> - To hide layers in the map from the Layer List, you must set the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property on the desired layers to `hide`.\n> - When a [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/) is present in the map, the Layer List will display the [tables](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/#tables) as a [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#tableList) ListItem.\n> - When a [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) is present in the map, the Layer List will display the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer) in a [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#catalogLayerList) ListItem.\n\n> **Keyboard Navigation**\n>\n> - The Layer List supports keyboard navigation using the [Treegrid Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/treegrid/) for improved accessibility. Refer to the Calcite List component documentation for detailed keyboard interaction guidelines: [Calcite List Keyboard Navigation](https://developers.arcgis.com/calcite-design-system/components/list/#keyboard-navigation).\n\n> [!WARNING]\n> In version 6.0, the implementation of [arcgis-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/) will be updated under the hood to that of [arcgis-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/), and the way events for [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#catalogLayerList) and [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#tableList) are handled will change. We encourage using the [arcgis-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/) component and providing feedback.\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 for user interaction.\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.\n- `triggerAction(action: ActionButton | ActionToggle, item: ListItem): 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-layer-list/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","values":[]},{"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 [MapImageLayer#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.\nDrag won't be enabled until the number of list items is equal to or greater than the value set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#visibleElements) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#visibleElements) is true.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component.\nBy default, the heading is rendered as a level 2 heading (e.g., `<h2>Layer List</h2>`).\nDepending on the component's placement in your app, you may need to adjust this heading for proper semantics.\nThis is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-catalog-layer-list","description":"Indicates whether to display the [LayerList#catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#catalogLayerList).","values":[]},{"name":"hide-status-indicators","description":"Indicates whether the status indicators will be displayed.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"min-drag-enabled-items","description":"The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#dragEnabled).","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the [visibleElements.filter](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/LayerListVisibleElements/) input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"Indicates whether to display a close button in the header.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to display a collapse button in the header.","values":[]},{"name":"show-errors","description":"Indicates whether to display layers with load errors.","values":[]},{"name":"show-filter","description":"Indicates whether to display a filter input box when the number of list items is equal to or greater than the value set in [LayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"Indicates whether to display the layer list heading. The heading text is \"Layer List\". The heading level can be set with the [LayerList#headingLevel](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#headingLevel).","values":[]},{"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.","values":[]},{"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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-checkbox.avif) |","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/"},{"name":"Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-layer-list--demo&singleStory=true"}]},{"name":"arcgis-layer-list-next","description":"> [!WARNING]\n> The Layer List (next) component is the successor to the Layer List component, provided to you early for testing and feedback.\nIn version 6.0, the implementation of [arcgis-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/) will be updated under the hood to that of [arcgis-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/),\nand this component will be removed. There is a breaking change in the name of the events for [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#catalogLayerList) and\n[tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#tableList) compared to [arcgis-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/). To update at version 6.0, simply remove `-next` from the component name.\n\nThe Layer List (next) provides a way to display a list of layers and switch on/off their visibility.\nThe [listItemCreatedFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#listItemCreatedFunction) and the [Item](https://developers.arcgis.com/javascript/latest/references/core/layerList/Item/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.\nTrack info items can also be configured with custom panel content. Legend panel content is not supported for individual track info parts.\n\n> **Notes**\n>\n> - The Layer List does not emit an event when the visibility of a layer changes. To respond to layer visibility changes, watch the [visible](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#visible) property of layers in the [allLayers](https://developers.arcgis.com/javascript/latest/references/core/Map/#allLayers) property with [reactiveUtils](https://developers.arcgis.com/javascript/latest/references/core/core/reactiveUtils/).\n> - To hide layers in the map from the Layer List, you must set the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property on the desired layers to `hide`.\n> - When a [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/) is present in the map, the Layer List will display the [tables](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/#tables) as a [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#tableList) ListItem.\n> - When a [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) is present in the map, the Layer List will display the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer) in a [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#catalogLayerList) ListItem.\n\n> **Keyboard Navigation**\n>\n> - The Layer List supports keyboard navigation using the [Treegrid Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/treegrid/) for improved accessibility. Refer to the Calcite List component documentation for detailed keyboard interaction guidelines: [Calcite List Keyboard Navigation](https://developers.arcgis.com/calcite-design-system/components/list/#keyboard-navigation).\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisFilterChange** - Emitted when the value of the [filterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#filterText) input changes.\n- **arcgisOpenedLayersChange** - Emitted when the collection of [openedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#openedLayers) changes.\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 for user interaction.\n- **arcgisSelectedItemsChange** - Emitted when the collection of [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#selectedItems) changes.\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.","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-layer-list-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed. When collapsed, only the collapse button and heading are displayed.","values":[]},{"name":"drag-enabled","description":"Indicates whether [items](https://developers.arcgis.com/javascript/latest/references/core/layerList/Item/) may be reordered within the list by dragging and dropping. MapImageLayer [MapImageLayer#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. Drag and drop won't be enabled until the number of list items is equal to or greater than than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input when filtering is enabled.","values":[]},{"name":"filter-text","description":"The value of the filter input text string when filtering is enabled.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-catalog-layer-list","description":"Indicates whether to hide the catalog layer list in the component.","values":[]},{"name":"hide-no-filter-results-notice","description":"Indicates whether to hide the notice that appears when no results are found after filtering.","values":[]},{"name":"hide-no-items-notice","description":"Indicates whether to hide the notice that appears when there are no items to display.","values":[]},{"name":"hide-status-indicators","description":"Indicates whether to hide status indicators in the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"list-mode-disabled","description":"Specifies whether to ignore the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property to display all layers. A common use case for `listModeDisabled` is when you want to use the component to manage and configure a layer's `listMode` value.","values":[]},{"name":"min-drag-enabled-items","description":"The minimum number of list items required to enable drag and drop reordering.","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the filter input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode. Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-errors","description":"This property provides the ability to show or hide layer error indicators.","values":[]},{"name":"show-filter","description":"This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]},{"name":"show-temporary-layer-indicators","description":"This property provides the ability to show or hide the temporary layer indicators 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.","values":[]},{"name":"visibility-appearance","description":"Determines the icons used to indicate visibility.\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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-checkbox.avif) |\n","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/"},{"name":"Layer List Next","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-layer-list-next--demo&singleStory=true"}]},{"name":"arcgis-legend","description":"The Legend component displays the symbols and labels used to represent layers in an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\nOnly layers and sublayers visible in the view are shown, unless [ignoreLayerVisibility](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#ignoreLayerVisibility) is set to `true`.\n\nThe legend automatically updates when:\n - the visibility of a layer or sublayer changes\n - a layer is added or removed from the map\n - a layer's `renderer`, `opacity`, or `title` is changed\n - the `legendEnabled` property is changed (set to `true` or `false` on the layer)\n\n## Known Limitations\n\n* Currently, the legend component does not support the following layer types:\n[ElevationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/),\n[GeospatialPDFLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeospatialPDFLayer/),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/IntegratedMeshLayer/),\n[KMLLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KMLLayer/),\n[MapNotesLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MapNotesLayer/),\n[OpenStreetMapLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OpenStreetMapLayer/),\n[SketchLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SketchLayer/),\n[VectorTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/), and\n[WebTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WebTileLayer/).\n* [Symbol3D](https://developers.arcgis.com/javascript/latest/references/core/symbols/Symbol3D/) with more than one\n[symbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/Symbol3DLayer/) are not supported.\n* [DictionaryRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/DictionaryRenderer/) is not supported.\n* [TrackInfo](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TrackInfo/) is not supported.\n* CIM Symbol [primitiveOverride](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/#PrimitiveOverride) is not supported.\n* RasterStretchRenderer [dynamicRangeAdjustment](https://developers.arcgis.com/javascript/latest/references/core/renderers/RasterStretchRenderer/#dynamicRangeAdjustment) is not supported.\n\n## Various examples of legends based on renderer type.\n\n### Unique values\n\n[![Unique values](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-unique-values.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-location-types/)\n\n### Continuous color\n\n[![Continuous color](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-color-vv.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-vv-color/)\n\n### Classed color\n\n[![Classed color](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-class-breaks.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-classbreaks/)\n\n### Continuous size\n\n[![Continuous size](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-size.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-size/)\n\n### Size - above and below\n\n[![Size - above and below](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-size-themes.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-size-themes/)\n\n### Dot density\n\n[![Dot density](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-dot-density.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-dot-density/)\n\n### Predominance\n\n[![Predominance](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-predominance.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-arcade/)\n\n### Relationship\n\n[![Relationship](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-relationship.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-relationship/)\n\n\n## Legend labels\n\nLegend text is directly controlled through the [layer](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/) and [renderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/Renderer/) properties. For example, `layer.title` is directly used by the legend to present a layer's symbology to the end user. To override this text, you can directly update `layer.title`.\n\nFurthermore, you can control date and number formatting in Legend by using the [FieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FieldConfiguration/) formatting options on the layer. As an alternative to this, you can override Legend text via the renderer's properties. For example, the renderer may have a [legendOptions](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#legendOptions) property (or a label property in the case of visual variable stops or UniqueValueInfos) that can be used to override default legend text describing the renderer element in question. The [Update legend text sample](https://developers.arcgis.com/javascript/latest/sample-code/legend-update/) provides an example of overriding legend text via the renderer.\n\nNote that when you override legend text, all formatting and localization that would otherwise be dynamically applied to labels will no longer apply.\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 for user interaction.\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.","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-legend/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"basemap-legend-visible","description":"Indicates whether to show the [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/) layers in the Legend. If you set this property to\n`true` and specify [layerInfos](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#layerInfos) that include the basemap layers, the basemap will be displayed in the legend.\n\n> **Known limitation:**\n>\n> [VectorTileLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer/) in the basemap are not currently supported in the legend.\n> This includes most Esri basemaps such as \"Streets\", \"Topographic\", \"Navigation\", and others that use vector tiles.","values":[]},{"name":"card-style-layout","description":"Indicates the layout of the legend when the [legendStyle](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#legendStyle) is set to the string value of `\"card\"`.\nThe layout determines how the legend's content is arranged.\n\n[![card-style-layout](https://developers.arcgis.com/javascript/latest/assets/references/components/legend/card-style-layout.avif)](https://developers.arcgis.com/javascript/latest/sample-code/legend-card/)","values":[{"name":"auto"},{"name":"side-by-side"},{"name":"stack"}]},{"name":"heading-level","description":"Indicates the heading level to use for the legend title. By default, legend titles are rendered as level 3 headings (e.g. `<h3>Legend title</h3>`). Depending on the legend placement\nin your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-layers-not-in-current-view","description":"When `true`, layers will only be shown in the legend if they are visible in the view's extent. When data from a layer\nis not visible in the view, the layer's legend information will be hidden. Only layers that implement the `createQuery()`\nand `queryFeatureCount()` methods are supported by `hideLayersNotInCurrentView`.\n\nTo hide layers completely from the legend, you should set the `legendEnabled` property of the layer to `false`.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"ignore-layer-visibility","description":"Determines whether to respect the properties of the layers in the map that control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`).\nBy default, a layer's legend elements **will not render** in the legend given the following conditions:\n\n- The layer's [legendEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#legendEnabled) property\nis set to `false`.\n- If the view's scale is outside the visibility range\ndefined by the layer's [minScale](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#minScale) and\n[maxScale](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#maxScale) properties.\n\nWhen the `ignoreLayerVisibility` property of the legend is set to `true`, the legend elements for each\nlayer in the map will always display, thus disregarding the `minScale`, `maxScale`,\nand `legendEnabled` properties for each layer in the map.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"legend-style","description":"Indicates the style of the legend. The style determines the legend's layout and behavior.\nYou can either specify a string or an object to indicate the style. The known string values are the same values listed in\nthe table within the `type` property.\n\n[![legend-style](https://developers.arcgis.com/javascript/latest/assets/references/components/legend/legend-style.avif)](https://developers.arcgis.com/javascript/latest/sample-code/legend-card/)","values":[{"name":"card"},{"name":"classic"}]},{"name":"loading","description":"Indicates whether the legend is currently loading.","values":[]},{"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.","values":[]},{"name":"respect-layer-definition-expression","description":"If a layer uses a unique value renderer, only features that satisfy the layer's\n[definition](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#definitionExpression)\nwill be displayed in the legend when set to true.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/"},{"name":"Legend","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-legend--demo&singleStory=true"}]},{"name":"arcgis-line-of-sight","description":"The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysis/)\nin an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/). Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including the ground, integrated meshes, and 3D objects such as buildings or trees.\n\n![line-of-sight](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/line-of-sight.avif)\n\nThe analysis results are displayed as colored lines, where areas visible to the observer are\nshown green and occluded parts are marked in red. Also, the color of the target points indicates their visibility.\nWhen the line of sight cannot be calculated, it will be displayed with a gray color. This may happen if either\nthe target or the observer is not in the view.\n\nWhen creating a new line of sight analysis, the first click in the Scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysisObserver/)\nand subsequent clicks place the [targets](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysisTarget/).\nBoth the observer and target points can be moved by dragging. Additionally, the target points can be removed with a right click.\n\n**Things to consider**\n\n* Line Of Sight is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n* The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.\n* Snapping, tooltips, display units, and input units are inherited from\n[ViewOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/).\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- [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysis/)\n- [Sample - Line of sight component](https://developers.arcgis.com/javascript/latest/sample-code/line-of-sight/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current observer and any targets. After calling this method, the user can set a new observer and targets.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `continue(): Promise<void>` - After [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-line-of-sight/#stop) was called, this method allows to continue the line of sight analysis and add more targets.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start a new line of sight analysis.\n- `stop(): Promise<void>` - Stops the current placing of line of sight analysis. Any lines added so far are kept in the view.\nUsers can still interact with existing targets and the observer, but they cannot place new target points.","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-line-of-sight/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-continue-button","description":"If true, the button that allows the user to continue placing more targets will be hidden.","values":[]},{"name":"hide-done-button","description":"If true, the button that ends the current placement will be hidden.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new analysis will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-line-of-sight/"},{"name":"Line of Sight","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-line-of-sight--demo&singleStory=true"}]},{"name":"arcgis-link-chart","description":"Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/references/core/WebLinkChart/) from an [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/).\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisLoadError** - Fires when an arcgis-link-chart fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\n- **arcgisViewAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/#event-analysis-view-create)\n- **arcgisViewAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDoubleTapDrag** - Fires while the pointer is dragged following a double-tap gesture on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewFocusRegionSelect** - Fires when the focus region is selected using the `Enter` or `Space` key. Use this event to react to the selection of the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegion) via keyboard input and perform any necessary actions based on that selection, such as performing a `hitTest()` on the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegion) and passing the returned graphics to the [selectionManager](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#selectionManager).\n\nCall `event.detail.preventDefault()` to suppress the default behavior of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opening with the features in the focus region.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the link chart has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the link chart.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\n- **arcgisViewVerticalTwoFingerDrag** - Fires while the two pointers are dragged vertically on the view.\n\n### Methods\n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `fetchPopupFeatures(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise<AsyncGenerator<Graphic>>` - Use this method to query for features at a given screen location. These features come from origins (layers and sublayers) configured with a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [FeatureLayer.popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled) set. One example could be a custom side panel that displays feature-specific information based on an end user's click location. This method allows a developer to control how the input location is handled, and then subsequently, what to do with the results.\n> [!WARNING]\n> Using [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) as the hit target is considered **[beta](https://developers.arcgis.com/javascript/latest/faq/#what-does-the-beta-tag-mean)** functionality.\n- `goTo(target: GoToTarget2D, options?: GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `openPopup(options?: ViewPopupOpenOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `toMap(screenPoint: MouseEvent | ScreenPoint): Point`\n- `toScreen(point: Point, options?: ToScreenOptions2D): ScreenPoint | null | undefined`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView(analysis: Analysis): Promise<AnalysisView2DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/#whenAnalysisView)\n- `whenLayerView(layer: Layer): Promise<LayerView>` - Gets the LayerView created on the view for the given layer.\n- `zoomIn(): Promise<void>` - Zooms in the view component by a factor of 2.\n- `zoomOut(): Promise<void>` - Zooms out the view component by a factor of 2.\n\n### Slots\n- _default_ - Default slot for adding components to the link chart. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n- **popup** - Slot for the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot.\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the view. \n- **--arcgis-table-row-background-color** - _Since 5.1_ Specifies the background color for table rows. \n- **--arcgis-table-row-alt-background-color** - _Since 5.1_ Specifies the background color for alternate table rows. \n- **--arcgis-focus-region-outer-border-color** - _Since 5.2_ Specifies the outer border color of the focus region. \n- **--arcgis-focus-region-inner-border-color** - _Since 5.2_ Specifies the inner border color of the focus region. \n- **--arcgis-focus-region-border-width** - _Since 5.2_ Specifies the border width of the focus region. ","attributes":[{"name":"animations-disabled","description":"Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/PictureMarkerSymbol/)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/FlowRenderer/)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The display mode used for the attribution. Defaults to null.\n\nSet this property to \"auto\" to automatically synchronize the attribution with the nearest [Calcite mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes). If no Calcite mode is detected, the attribution defaults to light mode. **The \"auto\" mode was added in version 5.2.**\n\nSet this property to \"light\" or \"dark\" to explicitly use that mode without synchronization.","values":[{"name":"dark"},{"name":"light"},{"name":"auto"}]},{"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-link-chart/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"base-cypher-query","description":"A Knowledge Open Cypher Query that will be used to generate the link chart.  The serviceUrl property must also be set\n\nPlease note that this query only runs once and is used to initialize the link chart.  Once link charts are generated, their membership is \"locked\" unless modified by the WebLinkChart API.  Refresh events on the link chart canvas do not re-run the query for new data","values":[]},{"name":"basemap","description":"Specifies a basemap for the link chart. The basemap is only visible when the link\nchart is set to a geographic layout. See\n[documentation on layouts](https://enterprise.arcgis.com/en/knowledge/latest/knowledge-studio/change-the-layout-applied-to-a-link-chart.htm)\nfor more detail. The basemap is a set of layers that give\ngeographic context to the LinkChartView and the other operational layers\nin the link chart.","values":[]},{"name":"center","description":"Represents the position of the view's center. The property can be set with\na [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) or a string representing\na longitude/latitude pair (`\"-100.4593, 36.9014\"`).\nSetting the center immediately changes the current view.\nFor animating the view, see this component's goTo() method.","values":[]},{"name":"display-filter-disabled","description":"Indicates whether a layer's displayFilter is honored when rendering layers in the view.\nIf `true`, display filters are ignored and all features are rendered.","values":[]},{"name":"focus-region-shortcut-enabled","description":"Enables the `Shift` + `Alt`/`Option` + `O` keyboard shortcut for showing the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegion). When `undefined`, the shortcut is enabled only when a [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component is slotted into the ArcgisLinkChart component, or when [popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupComponentEnabled) is set, and when the [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupDisabled) property is `false`. Set to `true` to handle focus-region selection in a custom application, or `false` to disable the shortcut. When `false`, the shortcut does not change the [focusRegionVisible](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegionVisible) property.","values":[]},{"name":"focus-region-visible","description":"Indicates whether the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegion) is visible. Set this property to `true` to show the centered focus region, or `false` to hide it.\nThe focus region can also be shown or hidden by focusing on the ArcgisLinkChart component and pressing the `Shift` + `Alt`/`Option` + `O` keyboard shortcut. By default, this shortcut is available only when a popup component is available and [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupDisabled) is `false`. Use [focusRegionShortcutEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegionShortcutEnabled) to explicitly enable or disable it.\n\n**Note:** When the focus region is enabled, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) or slotted [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) will be docked with the dock button hidden by default to prevent it from overlapping the focus region.","values":[]},{"name":"hide-attribution","description":"Indicates whether the attribution is hidden in the view.\n\nEsri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content.\nFor detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation.\nFor information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/).","values":[]},{"name":"item-id","description":"The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/references/core/config/#portalUrl) before the Link Chart component loads.","values":[]},{"name":"popup-component-enabled","description":"Indicates whether the [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) (beta) is enabled  as the default popup. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) property (representing the component) will be used for popups instead of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popup) property (representing the widget).\n\n**Note:** This is a beta feature and may change in future releases. At version 6.0, the Popup component will be used by default instead of the Popup widget and the `popup-component-enabled` attribute will no longer be necessary.","values":[]},{"name":"popup-disabled","description":"Controls whether the default popup opens automatically when users click on the view. This controls both the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) and [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popup) properties. When set to `true`, the popup will not open on click or when triggered programmatically.","values":[]},{"name":"resize-align","description":"Defines which anchor stays still while resizing the browser window. The default, `center`,\nensures the view's center point remains constantly visible as the window size changes. The other\noptions allow  the respective portion of the view to remain visible when the window's size is changed.","values":[{"name":"top-left"},{"name":"top-right"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"center"},{"name":"bottom"},{"name":"left"},{"name":"right"},{"name":"top"}]},{"name":"rotation","description":"The clockwise rotation of due north in relation to the top of the view in degrees.\nThe view may be rotated by directly setting\nthe rotation or by using the following mouse event: `Right-click + Drag`.\nWebLinkChart rotation may be disabled by setting the `rotationEnabled` property\nin [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#constraints) to `false`.","values":[]},{"name":"scale","description":"Represents the link chart scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's goTo() method.","values":[]},{"name":"service-url","description":"The URL of the Knowledge Graph Service to load the link chart from.\n\nIf no Base Cypher Query is defined, then the entire dataset will be used to generate the link chart.","values":[]},{"name":"suspended","description":"Indicates if the view is visible on the page.","values":[]},{"name":"time-zone","description":"Defines the time zone of the view.\nThe time zone property determines how dates and times are represented to the user,\nbut the underlying data is unchanged.","values":[]},{"name":"zoom","description":"Represents the level of detail (LOD) at the center of the view.\nA zoom level (or scale) is a number that defines how large or small the contents of a link chart appear in a link chart view.\nZoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.\nA value of -1 means the view has no LODs.\nWhen setting the zoom value, the LinkChartView converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\nLinkChartView can display link charts with different projections at a full range of scales, and so use the scale property on this component rather than zoom level.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's goTo() method.\nSetting this property in conjunction with `center` is a convenient way to set the initial extent of the view.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/"},{"name":"Link Chart","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-link-chart--demo&singleStory=true"}]},{"name":"arcgis-link-chart-layout-switcher","description":"A component for use in link charts that allows users to switch between different layouts. See [documentation on layouts](https://enterprise.arcgis.com/en/knowledge/latest/knowledge-studio/change-the-layout-applied-to-a-link-chart.htm) for more details.\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\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 for user interaction.\n- **arcgisSwitchLayout** - Fires when the component has completed the layout switch.\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.\n- `switchLayout(newLayout: \"basic-grid\" | \"chronological-mono-timeline\" | \"chronological-multi-timeline\" | \"geographic-organic-standard\" | \"hierarchical-bottom-to-top\" | \"organic-community\" | \"organic-standard\" | \"radial-root-centric\" | \"tree-left-to-right\"): Promise<void>` - Switches the layout of the link chart to the value provided.","attributes":[{"name":"appearance","description":"The appearance of the layout switcher. `dropdown` displays a button that is clicked to reveal a dropdown menu, while `menu-bar` displays a menu bar.","values":[{"name":"dropdown"},{"name":"menu-bar"}]},{"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-link-chart-layout-switcher/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"close-on-select-disabled","description":"When `true`, the layout menu will not close when a layout is selected. Only applicable when `appearance` is `dropdown`.","values":[]},{"name":"icon","description":"Icon displayed in the component's button, when `appearance` is `dropdown`.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"prevent-extent-update","description":"Prevents extent from updating on changes to the layout.","values":[]},{"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.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart-layout-switcher/"},{"name":"Link Chart Layout Switcher","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-link-chart-layout-switcher--demo&singleStory=true"}]},{"name":"arcgis-link-chart-nonspatial-visibility-toggle","description":"The <link-chart-nonspatial-visibility-toggle> component is used in conjunction with link chart. The component toggles visibility of nonspatial data.\n\nNote: Use the following credentials to sign in to the demo:\n  - Username: `viewer01`\n  - Password: `I68VGU^nMurF`\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 for user interaction.\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.\n- `switchNonspatialVisibility(nonspatialVisibilitySetting: NonspatialMode): Promise<void>` - Switches the nonspatial visibility setting","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-link-chart-nonspatial-visibility-toggle/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"reference-element","description":"By assigning the `id` attribute of the LinkChart component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the LinkChart.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart-nonspatial-visibility-toggle/"},{"name":"Link Chart Nonspatial Visibility Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-link-chart-nonspatial-visibility-toggle--demo&singleStory=true"}]},{"name":"arcgis-locate","description":"The Locate component animates the Map or Scene to the user's current location.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/docs/Web/Security/Defenses/Secure_Contexts), such as HTTPS.\n`localhost` is considered \"potentially secure\" and can be used for testing.\n\n> [!WARNING]\n>\n> **Note**\n>\n> To avoid unexpected navigation, especially when using custom spatial references, configure the view [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#constraints)\n> such as `extent`, `minZoom`, and `maxZoom`.\n> This helps when the geolocated position is inaccurate or causes the map to navigate\n> to a location that is no longer visible because it is outside of\n> a layer's `fullExtent`.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`","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-locate/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"go-to-location-disabled","description":"Indicates whether navigation to the position and scale of the geolocated result is disabled.","values":[]},{"name":"icon","description":"Icon displayed in the component's button.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"popup-disabled","values":[]},{"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.","values":[]},{"name":"scale","description":"Indicates the scale to set on the view when navigating to the position of the geolocated\nresult, after a location is returned from the [@arcgisSuccess](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-locate/#event-arcgisSuccess) event.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-locate/"},{"name":"Locate","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-locate--demo&singleStory=true"}]},{"name":"arcgis-map","description":"The ArcGIS Map component is used to add 2D maps to web applications. For 3D maps, use the\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\n\n#### Initializing the Map component\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/)\nand can be initialized in one of three ways:\n\n##### 1. Using a WebMap\nLoad a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/) from [ArcGIS Online](https://www.arcgis.com/home/index.html)\nor an [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html) by specifying the [itemId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#itemId) attribute.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\"></arcgis-map>\n```\n\n##### 2. Setting Map component attributes directly\nDefine the Map component using attributes like [basemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#basemap), [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#center), and [zoom](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#zoom) directly.\n\n```html\n<arcgis-map basemap=\"satellite\" center=\"-154.88, 19.46\" zoom=\"15\"></arcgis-map>\n```\n\n##### 3. Providing a Map instance\nAlternatively, you can provide your own [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/) instance to the component.\nThis allows full control over map configuration, including [basemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#basemap), operational [layers](https://developers.arcgis.com/javascript/latest/references/core/Map/#layers)\nand [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReference). See the [Select features by rectangle sample](https://developers.arcgis.com/javascript/latest/sample-code/highlight-features-by-geometry/)\nfor an example of this approach in action.\n\n```html\n<arcgis-map></arcgis-map>\n<script type=\"module\">\n  const viewElement = document.querySelector(\"arcgis-map\");\n\n  // set the basemap of the map to states feature layer\n  // add national parks feature layer and a polygon graphics layer\n  viewElement.map = new Map({\n    basemap: new Basemap({ baseLayers: [states] }),\n    layers: [nationalParksLayer, polygonGraphicsLayer]\n  });\n\n  // set the spatial reference of the map to NAD 1983 Albers contiguous USA\n  viewElement.spatialReference = { wkid: 102003 };\n</script>\n```\n#### Adding components and customizing the Map\n\nOther components can be added and connected to the Map component.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\">\n  <arcgis-zoom slot=\"top-left\"></arcgis-zoom>\n  <arcgis-legend slot=\"bottom-left\"></arcgis-legend>\n</arcgis-map>\n```\n\nThe Map component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/references/core/) of the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n  const layer = new GraphicsLayer({ title: \"My Layer\" });\n  viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Map component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-map)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisLoadError** - Fires when an arcgis-map fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\n- **arcgisViewAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-create)\n- **arcgisViewAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is triggered when view-related properties change, such as [zoom](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#zoom), [scale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#scale), [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#center), [rotation](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#rotation), [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#extent),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#viewpoint), or [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#stationary).\nIt reflects user interactions (e.g. panning or zooming) or programmatic updates to the view.\n\n> The `arcgisViewChange` event may be emitted before the view is fully ready.\n> This means the event can fire before the component's `stationary` property is `true` or before the view has completed its initial setup.\n> For actions that require the view to be ready and stationary, combine this event with checks on the component's `stationary` and `ready` properties.\n- **arcgisViewClick** - Fires after a user clicks on the view. This event emits slightly slower than an [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick)\nevent to make sure that an [@arcgisViewDoubleClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewDoubleClick) event isn't triggered instead. The `arcgisViewImmediateClick`\nevent can be used for responding to an `arcgisViewClick` event without delay.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDoubleTapDrag** - Fires while the pointer is dragged following a double-tap gesture on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-double-tap-drag)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewFocusRegionSelect** - Fires when the focus region is selected using the `Enter` or `Space` key. Use this event to react to the selection of the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegion) via keyboard input and perform any necessary actions based on that selection, such as performing a `hitTest()` on the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegion) and passing the returned graphics to the [selectionManager](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#selectionManager).\n\nCall `event.detail.preventDefault()` to suppress the default behavior of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opening with the features in the focus region.\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view. In contrast to the [@arcgisViewClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewClick) event, the `arcgisViewImmediateClick`\nis emitted as soon as the user clicks on the view, and is not inhibited by a [@arcgisViewDoubleClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewDoubleClick) event.\nThis event is useful for interactive experiences that require feedback without delay.\n- **arcgisViewImmediateDoubleClick** - Fires after two consecutive [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick) events. In contrast to [@arcgisViewDoubleClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewDoubleClick),\nan `arcgisViewImmediateDoubleClick` cannot be prevented by use of `stopPropagation()` on the [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick)\nevent and can therefore be used to react to double-clicking independently of usage of the [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick) event.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding\n[LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)\ncreated and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error occurs during the creation of a [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)\nafter a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)\nis destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and is emitted when the view is ready.\nFires also when the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#map) is updated.\n- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\n- **arcgisViewVerticalTwoFingerDrag** - Fires while the two pointers are dragged vertically on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-vertical-two-finger-drag)\n\n### Methods\n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `fetchPopupFeatures(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise<AsyncGenerator<Graphic>>` - Use this method to query for features at a given screen location. These features come from origins (layers and sublayers) configured with a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [FeatureLayer.popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled) set. One example could be a custom side panel that displays feature-specific information based on an end user's click location. This method allows a developer to control how the input location is handled, and then subsequently, what to do with the results.\n> [!WARNING]\n> Using [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) as the hit target is considered **[beta](https://developers.arcgis.com/javascript/latest/faq/#what-does-the-beta-tag-mean)** functionality.\n- `goTo(target: GoToTarget2D, options?: GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `hitTest(hitTarget: MouseEvent | ScreenPoint | ScreenPolygon | ScreenRect, options?: HitTestOptions): Promise<ViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/references/core/views/types/#ViewHitTestResult) from each layer that intersects the specified hit target.\nThe returned object contains an array of different [result types](https://developers.arcgis.com/javascript/latest/references/core/views/types/#ViewHit)\nsuch as graphics, raster pixels, media elements, or routes.\n\n**2D hitTest() behavior by layer type**\n| Layer type | Hit test behavior |\n| :--- | :--- |\n| [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer), [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/catalog/CatalogFootprintLayer), [CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer), [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OGCFeatureLayer), [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OrientedImageryLayer), [ParquetLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ParquetLayer), [StreamLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/StreamLayer), [SubtypeGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SubtypeGroupLayer), [WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer) | Returns all [features](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) that intersect the hit target. |\n| [GeoRSSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoRSSLayer), [GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer), [KMLLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KMLLayer), [SketchLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SketchLayer) | Returns all [features](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) that intersect the hit target. |\n| [ImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer),  [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryTileLayer)| Returns a [result](https://developers.arcgis.com/javascript/latest/references/core/views/types/#RasterHit) containing raster pixel value used in rendering and bandId info on intersecting pixels. Support was added in version 5.1. For a `ScreenRect` hit target, the hit result is returned for the center of the specified shape. |\n| [VectorTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer) | Returns a result for all intersecting [features](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) containing attributes of style layers (as of version 4.29; in prior releases, only the topmost style layer result was returned). In addition, the graphic's [origin](https://developers.arcgis.com/javascript/latest/references/core/Graphic#origin) contains the style layer's [id](https://maplibre.org/maplibre-style-spec/layers/#id) and layer index within the [vector tile style](https://doc.arcgis.com/en/arcgis-online/reference/tile-layers.htm#ESRI_SECTION1_8F68399EB47B48FF9EF46719FCC96978). Spatial information about the actual feature represented in the style layer is returned only if the style layer is a [symbol layer](https://maplibre.org/maplibre-style-spec/layers/#symbol). Otherwise, the graphic's geometry is `null`. |\n| [MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer) | Returns a [result](https://developers.arcgis.com/javascript/latest/references/core/views/types/#MediaHit) for each media element that intersects the hit target. |\n| [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer) | Returns a [result](https://developers.arcgis.com/javascript/latest/references/core/views/types/#RouteHit) for each route element that intersects the hit target. |\n\n**Note:** If the [Polygon](https://developers.arcgis.com/javascript/latest/references/core/geometry/Polygon) feature's symbol [SimpleFillSymbol.style](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol#style) is set to \"none\", the hitTest method will not\nreturn results when the fill is clicked. However, it will return results when the outline is clicked. To get results when clicking the fill, set the\n[SimpleFillSymbol.color](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol#color) to a transparent color instead.\n\nRelease-specific changes:\n* At version 5.2, support for [ScreenPolygon](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenPolygon) hit targets was added.\n* At version 5.1, support for [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) hit targets was added.\n- `openPopup(options?: ViewPopupOpenOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `takeScreenshot(options?: UserSettings): Promise<Screenshot>` - Create a screenshot of the current view.\n- `toMap(screenPoint: MouseEvent | ScreenPoint): Point`\n- `toScreen(point: Point, options?: ToScreenOptions2D): ScreenPoint | null | undefined`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView(analysis: Analysis): Promise<AnalysisView2DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#whenAnalysisView)\n- `whenLayerView<TLayer extends Layer>(layer: TLayer): Promise<LayerView2DFor<TLayer>>` - Gets the LayerView created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#whenLayerView)\n- `zoomIn(): Promise<void>` - Zooms in the view component by a factor of 2.\n- `zoomOut(): Promise<void>` - Zooms out the view component by a factor of 2.\n\n### Slots\n- _default_ - Default slot for adding components to the map. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n- **popup** - Slot for the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot.\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the view. \n- **--arcgis-table-row-background-color** - _Since 5.1_ Specifies the background color for table rows. \n- **--arcgis-table-row-alt-background-color** - _Since 5.1_ Specifies the background color for alternate table rows. \n- **--arcgis-focus-region-outer-border-color** - _Since 5.2_ Specifies the outer border color of the focus region. \n- **--arcgis-focus-region-inner-border-color** - _Since 5.2_ Specifies the inner border color of the focus region. \n- **--arcgis-focus-region-border-width** - _Since 5.2_ Specifies the border width of the focus region. ","attributes":[{"name":"animations-disabled","description":"Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/PictureMarkerSymbol/)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/FlowRenderer/)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The display mode used for the attribution. Defaults to null.\n\nSet this property to \"auto\" to automatically synchronize the attribution with the nearest [Calcite mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes). If no Calcite mode is detected, the attribution defaults to light mode. **The \"auto\" mode was added in version 5.2.**\n\nSet this property to \"light\" or \"dark\" to explicitly use that mode without synchronization.","values":[{"name":"dark"},{"name":"light"},{"name":"auto"}]},{"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-map/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"basemap","description":"Specifies a basemap for the map. The basemap is a set of layers that give\ngeographic context to the view and the other operational layers\nin the map.\n\nThe basemap can be set from a basemap ID string from the [basemap styles service](https://developers.arcgis.com/javascript/latest/references/core/support/BasemapStyle/), such as `arcgis/navigation`, or from the [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/) class.\n\n> [!NOTE]\n> Accessing the basemap styles service requires authentication, see [Authentication and access tokens](https://developers.arcgis.com/javascript/latest/authentication/access-tokens/) for more information.","values":[]},{"name":"center","description":"Represents the view's center point; when setting the center, you may pass a\n[Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) instance, numbers representing\na longitude/latitude pair (`[-100.4593, 36.9014]`), or a string attribute representing a longitude/latitude pair (\"-100.4593, 36.9014\").\nSetting the `center` immediately changes the current view. For animating the view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) method.\n\nThe returned [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) object is always\nin the spatial reference of the view and may be modified internally.\nTo persist the returned object, create a clone using [clone()](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/#clone) method.\n\n**Notes**\n\n* If the spatial reference of `center` set in the constructor does not match the [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReference) of the view, then the\n[projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/) will be loaded dynamically.\n* At runtime, the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/) must be\n[loaded](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#load) when\nsetting the `center` to a spatial reference that doesn't match the view spatial reference. You can check if the projectOperator is\nloaded prior to setting the center by calling [isLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#isLoaded)\nmethod. If it is not yet loaded, you can call [load()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#load) method.","values":[]},{"name":"display-filter-disabled","description":"Indicates whether a layer's `displayFilterInfo` is honored when rendering layers in the view.\nIf `true`, display filters are ignored and all features are rendered.","values":[]},{"name":"focus-region-shortcut-enabled","description":"Enables the `Shift` + `Alt`/`Option` + `O` keyboard shortcut for showing the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegion). When `undefined`, the shortcut is enabled only when a [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component is slotted into the ArcgisMap component, or when [popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupComponentEnabled) is set, and when the [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupDisabled) property is `false`. Set to `true` to handle focus-region selection in a custom application, or `false` to disable the shortcut. When `false`, the shortcut does not change the [focusRegionVisible](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegionVisible) property.","values":[]},{"name":"focus-region-visible","description":"Indicates whether the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegion) is visible. Set this property to `true` to show the centered focus region, or `false` to hide it.\nThe focus region can also be shown or hidden by focusing on the ArcgisMap component and pressing the `Shift` + `Alt`/`Option` + `O` keyboard shortcut. By default, this shortcut is available only when a popup component is available and [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupDisabled) is `false`. Use [focusRegionShortcutEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegionShortcutEnabled) to explicitly enable or disable it.\n\n**Note:** When the focus region is enabled, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) or slotted [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) will be docked with the dock button hidden by default to prevent it from overlapping the focus region.","values":[]},{"name":"ground","description":"Specifies the surface properties for the map.","values":[]},{"name":"hide-attribution","description":"Indicates whether the attribution is hidden in the view.\n\nEsri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content.\nFor detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation.\nFor information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/).","values":[]},{"name":"item-id","description":"The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/references/core/config/#portalUrl) before the Map component loads.","values":[]},{"name":"popup-component-enabled","description":"Indicates whether the [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) (beta) is enabled  as the default popup. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) property (representing the component) will be used for popups instead of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popup) property (representing the widget).\n\n**Note:** This is a beta feature and may change in future releases. At version 6.0, the Popup component will be used by default instead of the Popup widget and the `popup-component-enabled` attribute will no longer be necessary.","values":[]},{"name":"popup-disabled","description":"Controls whether the default popup opens automatically when users click on the view. This controls both the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) and [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popup) properties. When set to `true`, the popup will not open on click or when triggered programmatically.","values":[]},{"name":"resize-align","description":"Defines which anchor stays still while resizing the browser window. The default, `center`,\nensures the view's center point remains constantly visible as the window size changes. The other\noptions allow  the respective portion of the view to remain visible when the window's size is changed.","values":[{"name":"top-left"},{"name":"top-right"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"center"},{"name":"bottom"},{"name":"left"},{"name":"right"},{"name":"top"}]},{"name":"rotation","description":"The clockwise rotation of due north in relation to the top of the view in degrees.\nThe view may be rotated by directly setting\nthe rotation or by using the following mouse event: `Right-click + Drag`.\nMap rotation may be disabled by setting the `rotationEnabled` property\nin [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#constraints) to `false`. See the code snippet below for\nan example of this.","values":[]},{"name":"scale","description":"Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) method.","values":[]},{"name":"spatial-reference-locked","description":"Indicates if the map's [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReference) can be changed after it is ready.\nThe default is `false`, indicating the map's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the map's spatial reference\nwill be disabled in [arcgis-basemap-gallery](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/) components and the map's spatialReference cannot be changed at runtime.","values":[]},{"name":"suspended","description":"Indicates if the view is visible on the page.","values":[]},{"name":"time-zone","description":"Defines the time zone of the view.\nThe time zone property determines how dates and times are represented to the user,\nbut the underlying data is unchanged.","values":[]},{"name":"zoom","description":"Represents the level of detail (LOD) at the center of the map.\nA zoom level (or scale) is a number that defines how large or small the contents of a map appear in a Map component.\nZoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.\nA value of -1 means the map has no LODs.\nWhen setting the zoom value, the component converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) method.\nSetting this property in conjunction with `center` is a convenient way to set the initial extent of the view.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/"},{"name":"Map","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-map--demo&singleStory=true"}]},{"name":"arcgis-navigation-toggle","description":"The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\n**Known limitations**\n\nNavigation Toggle is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n @since 4.28\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 for user interaction.\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.\n- `toggle(): 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-navigation-toggle/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layout","description":"The layout direction of the component.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"name":"navigation-mode","description":"The navigation mode of the view. The possible values:\n\n* `pan` - The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\n* `rotate` - The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.","values":[{"name":"pan"},{"name":"rotate"}]},{"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.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-navigation-toggle/"},{"name":"Navigation Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-navigation-toggle--demo&singleStory=true"}]},{"name":"arcgis-oriented-imagery-viewer","description":"The Oriented Imagery Viewer component allows the user to explore and use their oriented images.\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 for user interaction.\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.\n- `loadBestImage(mapPoint: Point, options?: AbortOptions): Promise<void>` - Loads the best available image for a given map point and displays it in the viewer. The method takes a `Point` object as an argument, which represents the location on the map for which the best image should be loaded. The viewer will analyze the available images for that location and select the one that best matches the given location.\n- `reset(): void` - /**\nResets the viewer to its initial state.\nThis method clears the currently displayed image or video from the viewer and removes all associated graphics from the map.\n- `showImageByObjectId(objectId: ObjectId, options?: ShowImageByObjectIdOptions): Promise<void>` - Displays the image corresponding to the specified object ID.","attributes":[{"name":"action-bar-position","description":"Specifies the position of the action bar within the oriented imagery viewer.\n| Position | Description |\n|----------|-------------|\n| bottom   | Action bar is positioned at the bottom of the viewer. |\n| end      | Action bar is positioned at the end of the viewer. |\n| start    | Action bar is positioned at the start of the viewer. |\n| top      | Action bar is positioned at the top of the viewer. |","values":[{"name":"bottom"},{"name":"end"},{"name":"start"},{"name":"top"}]},{"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-oriented-imagery-viewer/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"current-coverage-visible","description":"Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer.\nCurrent footprint coverage allows you to better understand how the images in the oriented imagery layer relate to the map.\nThe footprint of the image is symbolized with red fill on the map. If you zoom or pan in the oriented imagery viewer,\nthe footprint coverage graphic will update on the map to highlight the area on the map that is visible in the image.","values":[]},{"name":"data-capture-enabled","description":"Indicates whether the data capture tools are enabled in the oriented imagery viewer for digitization.\nWhen set to `true`, the data capture (edit) option will be visible on the digitizable overlayed feature layers available in the image overlays tab.\nOn clicking the data capture option, the digitization tools will appear at the bottom of the viewer once the overlay tab is closed.","values":[]},{"name":"disabled","description":"When `false`, the view click interaction is enabled for the oriented imagery viewer component. This allows users to pick a location on the map and display the best image to the viewer.\nWhen `true`, the view click interaction will be defaulted to map navigation.","values":[]},{"name":"gallery-opened","description":"Indicates if the image gallery functionality is available in the component.\nTo visualize additional images of the same location, select the image gallery from the oriented imagery viewer.\nThe gallery is a carousel of low-resolution thumbnails of all images that depict the selected map location. Click a thumbnail to view the full-resolution image in the oriented imagery viewer.","values":[]},{"name":"hide-additional-camera-locations-toggle","description":"Indicates whether to hide the action button that toggles visibility of camera locations\nfor additional images, meaning images other than the currently displayed image.","values":[]},{"name":"hide-additional-footprints-toggle","description":"Indicates whether to hide the action button that toggles visibility of footprints\nfor additional images, meaning images other than the currently displayed image.","values":[]},{"name":"hide-current-footprint-toggle","description":"Indicates whether to hide the action button that toggles visibility of the footprint\nfor the currently displayed image.","values":[]},{"name":"hide-directional-navigation-toggle","description":"Indicates whether to hide the action button that toggles directional navigation mode.","values":[]},{"name":"hide-display-image-toggle","description":"Indicates whether to hide the action button that displays imagery for the clicked feature.\nUnlike explore-images mode, this action uses the feature returned from the click location\ninstead of performing a spatial query for the best image.","values":[]},{"name":"hide-enhancement-tool-toggle","description":"Indicates whether to hide the action button that opens the image enhancement controls.","values":[]},{"name":"hide-explore-images3d-toggle","description":"Indicates whether to hide the action button that toggles 3D explore-images mode.","values":[]},{"name":"hide-explore-images-toggle","description":"Indicates whether to hide the action button that toggles explore-images mode,\nallowing the user to click the map and load imagery for that location.","values":[]},{"name":"hide-header","description":"Indicates whether to hide the header of the widget.","values":[]},{"name":"hide-image-gallery-toggle","description":"Indicates whether to hide the action button that opens the image gallery.","values":[]},{"name":"hide-image-measurement-tools-group","description":"Indicates whether to hide the top-level action bar group for measurement tools.","values":[]},{"name":"hide-image-navigation-group","description":"Indicates whether to hide the top-level action bar group for image navigation tools.","values":[]},{"name":"hide-image-overlays-toggle","description":"Indicates whether to hide the action button that opens the image overlays UI.","values":[]},{"name":"hide-map-image-location-tool-toggle","description":"Indicates whether to hide the action button that toggles the map-image conversion tool.","values":[]},{"name":"hide-menu","description":"Indicates whether to hide the action bar of the widget.","values":[]},{"name":"hide-navigation-tool-toggle","description":"Indicates whether to hide the action button that toggles the navigation tool.","values":[]},{"name":"hide-overlays-group","description":"Indicates whether to hide the top-level action bar group for overlay controls.","values":[]},{"name":"hide-popups-action","description":"Indicates whether to hide the action button that shows image popups and attributes.","values":[]},{"name":"hide-search-group","description":"Indicates whether to hide the top-level action bar group for search and image discovery tools.","values":[]},{"name":"hide-sequential-navigation-toggle","description":"Indicates whether to hide the action button that toggles sequential navigation mode.","values":[]},{"name":"hide-superimpose-view-toggle","description":"Indicates whether to hide the action button that toggles superimposition of the current image\nin a 3D scene when the required camera properties and metadata are available.","values":[]},{"name":"hide-utilities-group","description":"Indicates whether to hide the top-level action bar group for utility tools.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"image-enhancement-tool-active","description":"Indicates if the image enhancement tool is active. When `true`, the component displays the functionalities to adjust the brightness, contrast, and sharpness of the\nimage in the oriented imagery viewer using interactive sliders.\nSettings will be preserved for subsequent images loaded in the oriented imagery viewer.","values":[]},{"name":"image-overlays-opened","description":"Indicates whether the image overlays tab in the oriented imagery viewer is open.\nWhen set to `true`, the overlays tab appears at the bottom of the viewer. It includes two toggle options: overlay camera locations and overlay map features.\nThese options enable users to visualize and overlay map features that intersect with the image’s footprint within the viewer.","values":[]},{"name":"is-additional-coverage-visible","description":"Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer.\nThe footprint graphics (appearing in blue) show the coverage footprints of all the additional images in the\nlayer that depict the location selected by the user.","values":[]},{"name":"is-additional-point-sources-visible","description":"Indicates if the additional camera locations are visible for the selected image loaded in the viewer.\nThe point location graphics (appearing in blue) show the camera locations for additional images that depict the location the user selects.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"map-image-conversion-tool-state","description":"Indicates if the map-image location tool is available in the component.\nWhen `true`, the user can select a point on the map and the corresponding location in pixel space will be displayed in the image, and vice versa.","values":[]},{"name":"map-layer-id","description":"The layer ID of an Oriented Imagery Layer in the associated map.\nWhen set, the component will attempt to find and use the layer with the provided ID from the map.\n\n> [!WARNING]\n> Use `layer`, `mapLayerId`, and `orientedImageryLayerItemId` independently; only one should be set at a time.","values":[]},{"name":"navigation-tool-active","description":"When `true`, the navigation tool is available in the component.\nThe navigation tool can be used to explore the images that contain the selected location on the map using a compass.\nTo view a different image of the selected map location, click the camera locations (blue dots), or click a segment to view\nthe best image from that segment (segments with images are shown in white; segments without images are gray).","values":[]},{"name":"oriented-imagery-layer-item-id","description":"The portal item ID of an Oriented Imagery Layer to load and use in the component.\n\n> [!WARNING]\n> Use `layer`, `mapLayerId`, and `orientedImageryLayerItemId` independently; only one should be set at a time.","values":[]},{"name":"preload-media","description":"When true, loading an image via directional or sequential navigation caches all neighboring images associated with that image.\nNavigating to adjacent images then uses the cached assets, reducing load times and improving viewer performance.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-oriented-imagery-viewer/"},{"name":"Oriented Imagery Viewer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-oriented-imagery-viewer--demo&singleStory=true"}]},{"name":"arcgis-oriented-imagery-viewer-non-panoramic-viewer","description":"### Methods\n- `addGraphic(graphic: Graphic): void`\n- `addGraphics(graphics: Graphic[]): void`\n- `clearGraphics(): void`\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `mediaOnLoad(): Promise<NonPanoramicMedia | undefined>`\n- `removeGraphic(graphic: Graphic): void`\n- `removeGraphics(graphics: Graphic[]): void`","attributes":[{"name":"hide-header","values":[]},{"name":"hide-loader","values":[]},{"name":"hide-video-controls","values":[]},{"name":"hide-zoom-controls","values":[]},{"name":"rotation","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-oriented-imagery-viewer-non-panoramic-viewer/"}]},{"name":"arcgis-oriented-imagery-viewer-panoramic-viewer","description":"### Methods\n- `addGraphic(graphic: Graphic): void`\n- `addGraphics(graphics: Graphic[]): void`\n- `clearGraphics(): void`\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `mediaOnLoad(): Promise<PanoramicMedia | undefined>`\n- `removeGraphic(graphic: Graphic): void`\n- `removeGraphics(graphics: Graphic[]): void`\n- `zoomIn(): void`\n- `zoomOut(): void`","attributes":[{"name":"hide-loader","values":[]},{"name":"hide-title","values":[]},{"name":"hide-video-controls","values":[]},{"name":"hide-zoom-controls","values":[]},{"name":"pitch","values":[]},{"name":"yaw","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-oriented-imagery-viewer-panoramic-viewer/"}]},{"name":"arcgis-oriented-imagery-viewer-panoramic-viewer-zoom","description":"### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.\n- `zoomFOV(fov: number): void`\n- `zoomIn(): void`\n- `zoomOut(): 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-oriented-imagery-viewer-panoramic-viewer-zoom/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layout","description":"Determines the layout/orientation of the Zoom component.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"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.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-oriented-imagery-viewer-panoramic-viewer-zoom/"}]},{"name":"arcgis-oriented-imagery-viewer-video-controls","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-oriented-imagery-viewer-video-controls/"}]},{"name":"arcgis-paste","description":"The Paste component provides a UX for working with a Clipboard and\ncopy and pasting features and/or geometries.\n--\n\n### Events\n- **arcgisApplyPasteCommand** - The user has initiated a paste command.\n- **arcgisApplyPasteError** - An error occurred performing a paste command\n- **arcgisBeforeClipboardMove** - The clipboard move interactive operation is about to start\n- **arcgisClipboardMoveStateChanged** - The clipboard move interactive operation has changed state.\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 for user interaction.\n\n### Methods\n- `cancelMoveClipboard(): Promise<void>` - Cancels any running Clipboard Move Interaction\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component\n- `executePasteCommand(id: SupportedPasteCommand, options?: {\n    silent?: boolean;\n    showFeatureForm?: boolean;\n}): Promise<PasteExecuteResult>` - Execute a paste command without opening the panel.\n\nparam id - The paste commands identifier\nparam options.silent - Determines if the command is being run without UX, or if it is running with the panel open\n- `registerPasteCommand(pasteCommand: CustomPasteCommand): Promise<void>` - Registers a custom Paste Command\n- `reset(): Promise<void>` - Resets the Paste panel to its home page\n- `showClipboardItems(visible: boolean): Promise<void>` - Method to show the clipboard items on the map\n- `startMoveClipboard(continuous: boolean): Promise<void>` - Start an interactive clipboard move operation\n- `writeChanges(applySet: ApplySet): Promise<(ApplySetLayerEditResult | ApplySetServiceEditResult)[]>` - Method to write the paste edits to the geodatabase(s).\n\n### Slots\n- **home-header-actions-start** - Slot for adding actions to the start of the header on the entry page.\n- **header-actions-end** - Slot for adding actions to the end of the header.\n- **gallery-page-message** - Slot for adding content to the template gallery page.\n- **commands-page-message** - Slot for adding content to commands page.\n\n### CSS Properties\n- **--arcgis-paste-height** - Specifies the height of the component. \n- **--arcgis-paste-width** - Specifies the width of the component. \n- **--arcgis-paste-blocks-padding** - Specifies the padding for elements within the component. ","attributes":[{"name":"always-show-feature-form","description":"Determines if the attributes panel should be shown for newly created paste features. If not set\nthe panel will only be shown if there are mandatory fields that have not been provided.","values":[]},{"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-paste/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When true, the component will be hidden.","values":[]},{"name":"close-on-apply","description":"Determines if the panel will automatically close after it has applied a Paste.","values":[]},{"name":"disable-templates-mode","description":"Decide if templates should be disabled when the layer is not visible, or not visible at the current scale.","values":[{"name":"scale"},{"name":"never"},{"name":"visible"}]},{"name":"hide-error-notice","description":"Determines if the component should show error notices","values":[]},{"name":"hide-footer","description":"Determines if the footer should be hidden.","values":[]},{"name":"hide-footer-cancel-button","description":"Determines if the attributes panel should have a Cancel button in the Footer, or rely on the close header action","values":[]},{"name":"hide-header-close-button","description":"Determines if the component should have a close button. A close button can be added by using the header-actions-end slot.","values":[]},{"name":"hide-tooltips","description":"Indicates whether to display the tooltip for clipboard and other actions.","values":[]},{"name":"hide-view-clipboard","description":"Determines if the view clipboard action is available","values":[]},{"name":"highlight-group","description":"The highlight group to use when highlighting features when they are being created.","values":[]},{"name":"maximum-feature-count","description":"The maximum number of features that can be created by a paste operation.","values":[]},{"name":"maximum-feature-count-with-complex-forms","description":"The maximum number of features that can be created by a paste operation.\nwhen there are complex Arcade expressions that must be executed.","values":[]},{"name":"paste-with-multiple-features-enabled","description":"Determines whether pasting multiple features is supported","values":[]},{"name":"paste-with-multiple-layers-enabled","description":"Determines whether pasting new features into multiple layers is allowed","values":[]},{"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.","values":[]},{"name":"supported-commands","description":"The list of supported paste operations. New types of operations can be registered using the 'registerPasteOperation'","values":[{"name":"paste"},{"name":"paste-append"},{"name":"paste-as"},{"name":"paste-merge"},{"name":"paste-subtract"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-paste/"}]},{"name":"arcgis-clipboard","description":"The Feature Clipboard displays the current contents of the clipboard.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"hide-tooltips","description":"Indicates whether to display tooltips on clipboard items.","values":[]},{"name":"max-show-count","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-clipboard/"}]},{"name":"arcgis-feature-image","description":"The Feature Image component generates a feature swatch representing a\nFeature.\nThe component can be configured to only generate a swatch, when the element\nis within the visible scope of the page.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"height-in-pixels","description":"The generated thumbnail height","values":[]},{"name":"min-width","values":[]},{"name":"use-true-shape","description":"Specifies whether to use the shape of the feature. If set to false, then a simple symbol swatch will be used.","values":[]},{"name":"width-in-pixels","description":"The generated thumbnail width","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-image/"}]},{"name":"arcgis-feature-title","description":"The Feature Title component generates a feature title for a graphic\nThe component can be configured to only generate a title, when the element\nis within the visible scope of the page.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"is-new-feature","description":"Flag to indicate that the graphic is a new feature and may not have an OID field","values":[]},{"name":"no-title-label","description":"Label to show if the feature does not have a","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-title/"}]},{"name":"arcgis-multi-feature-form","description":"The Multi Feature Form component provides a Feature Form which works with\nlayer FeatureForm templates. It allows for multiple features to be edited at once.\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 for user interaction.\n- **arcgisSubmit** - Fires when the [submit()](https://developers.arcgis.com/javascript/latest/references/core/widgets/BatchAttributeForm/#submit) method is called.\n- **arcgisValueChange** - Fires when a field value is updated.\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.\n- `getValues(graphic: Graphic): Record<string, unknown>`\n- `goToFirstError(): void`\n- `userChangesHaveMadeFeatureInvalid(feature: Graphic): boolean`","attributes":[{"name":"active-feature-index","values":[]},{"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-multi-feature-form/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","values":[]},{"name":"edit-type","values":[{"name":"INSERT"},{"name":"UPDATE"},{"name":"DELETE"},{"name":"NA"}]},{"name":"group-display","values":[{"name":"all"},{"name":"sequential"}]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"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).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"maximum-feature-count","values":[]},{"name":"maximum-feature-count-with-complex-forms","values":[]},{"name":"read-only","values":[]},{"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.","values":[]},{"name":"submit-has-been-attempted","values":[]},{"name":"time-zone","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-multi-feature-form/"}]},{"name":"arcgis-popup","description":"## Overview\nThe Popup component allows users to view content from feature attributes. Popups enhance web applications\nby providing users with a simple way to interact with and view attributes in a layer.\nThey play an important role in relaying information to the user, which improves the storytelling capabilities of the application.\n\nThe popup component can be added to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) using the `popup` slot.\nWhen added to a view component, the popup is automatically populated with content from the selected feature in the view and displays when clicking on features in the view.\nThe content of the popup is determined based on the [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) assigned to the selected feature.\n\n```html\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\">\n  <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n```\n\nThe Popup component can also be opened manually at a specific location using the [open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#open) property.\nTo prevent the popup from opening automatically when clicking on features within view components, set the `popup-disabled` attribute to `true` and add the Popup component to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) using the `popup` slot.\nBefore setting the `open` property to `true`, you must set the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) property to specify where the popup should open.\n\nExample of opening the popup at a clicked location with custom content:\n\n```html\n<!-- Set popup-disabled and popup-component-enabled attributes -->\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\" popup-disabled>\n  <!-- Add the popup component to the popup slot. -->\n  <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n<script>\nconst viewElement = document.querySelector(\"arcgis-map\");\nconst popupComponent = document.querySelector(\"arcgis-popup\");\n// Listen for clicks on the view and open the popup at the clicked location with custom content.\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n  const { mapPoint } = event.detail;\n  popupComponent.location = mapPoint;\n  popupComponent.heading = \"You clicked here\";\n  popupComponent.content = \"Latitude: \" + mapPoint.latitude.toFixed(3) + \", Longitude: \" + mapPoint.longitude.toFixed(3);\n  popupComponent.open = true;\n});\n</script>\n```\n\nAlternatively, you can call the [arcgis-map.fetchPopupFeatures()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#fetchPopupFeatures) method within the view element's click event listener to open the popup with features at the clicked location.\n```html\n<!-- Set popup-disabled and popup-component-enabled attributes -->\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\" popup-disabled>\n  <!-- Add the popup component to the popup slot. -->\n  <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n<script>\nconst viewElement = document.querySelector(\"arcgis-map\");\nconst popupComponent = document.querySelector(\"arcgis-popup\");\n// Listen for clicks on the view and populate the popup with features at that location.\nviewElement.addEventListener(\"arcgisViewClick\", async (event) => {\n const generator = await viewElement.fetchPopupFeatures(event.detail.screenPoint, {\n   pointerType: event.detail.pointerType,\n });\n\n const features = await Array.fromAsync(generator);\n popupComponent.features = features;\n});\n// Open the popup when the features property changes.\nreactiveUtils.watch(\n() => popupComponent.features,\n() => {\n  popupComponent.open = popupComponent.features ? true : false;\n});\n</script>\n```\n\nThe popup component can be used with the view components by default. Set the `popup-component-enabled` attribute to `true` using [arcgis-map.popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupComponentEnabled), [arcgis-scene.popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupComponentEnabled), or [arcgis-link-chart.popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupComponentEnabled) to open the popup component automatically when clicking on features.\n\n```html\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\" popup-component-enabled></arcgis-map>\n```\n> At version 6.0, the Popup component will be used by default and setting the `popup-component-enabled` attribute will no longer be necessary.\n\n## Popup UI\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) components contain a default popup.\nThis popup can display generic content, which is set in its [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading)\nand [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content) properties.\nWhen  content is set directly on the Popup instance it is not tied to a specific feature or layer.\n\n![popup-basic-example](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popup-basic.avif)\n\nIn the image above, the text \"Marriage in Nassau County Census Tract 5177.01\" is the popup's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading).\nThe remaining text is the popup's [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content).\nA dock button is displayed in the top right corner of the popup allowing the user to dock the popup to one of the sides or corners of the view.\nThe options for docking may be set in the [dockOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#dockOptions) property.\nThe popup may also be collapsed by clicking the collapse button (the down arrow icon) in the top right corner of the popup.\nWhen collapsed, only the heading of the popup displays.\nThe popup may be closed by clicking the close button (the \"x\" icon) in the top right corner of the popup.\n\nPopups can also contain [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions) which execute a function defined by the developer when clicked.\nBy default, every popup has a \"Zoom to\" action (as shown in the image above with the magnifying glass) that allows users to zoom to the selected feature.\nSee the [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions) property for information about adding custom actions to a popup.\n\nThe Popup component is tied to an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) component, whether it's docked or anchored to the selected feature.\nIf wanting to utilize the Popup functionality outside of [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/), the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) component can be used to display the same content\nin its own container.\n\n## Popup and PopupTemplate\n[PopupTemplates](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) are closely related to Popup, but are more specific to [layers](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/)\nand [graphics](https://developers.arcgis.com/javascript/latest/references/core/Graphic/). Popup templates allow you to define custom titles and content templates based on the source of the\n[selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature). When a layer or a graphic has a defined\npopup template, the popup will display the content defined in the popup template when the feature is clicked.\nThe content may contain field values from the attributes of the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature).\n\nCustom PopupTemplates may also be assigned directly to a popup by setting [graphics](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) on the\n[features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) property.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange**\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisTriggerAction** - Fires after the user clicks on an action in the Popup component.\nThis event may be used to define a custom function to execute when particular actions are clicked.\n\n### Methods\n- `clear(): Promise<void>` - Removes all [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content),\n[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading), and [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) from the Popup.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): Promise<void>` - Selects the feature at the next index in relation to the selected feature.\n- `openFeatureStream(options: OpenFeatureStreamOptions): Promise<void>` - Opens the popup with a location and a feature stream. Promise batches are converted to a feature stream internally. While waiting, the popup remains at its current location and becomes active when the first feature is available.\nIf both `featureStream` and `promises` are provided, `featureStream` is used.\nIf the location is `null` or `undefined`, the first feature's geometry determines the popup location. If no features become available, the popup closes without changing its location.\n- `previous(): Promise<void>` - Selects the feature at the previous index in relation to the selected feature.\n- `setFocus(): Promise<void>` - Use this method to give focus to the component if the component is able to be focused.\n\n### Slots\n- **actions-start** - _Since 5.2._ Slot for adding Calcite [actions](https://developers.arcgis.com/calcite-design-system/components/action/) or [action groups](https://developers.arcgis.com/calcite-design-system/components/action-group/) to the start of the action bar. Multiple actions or action groups can be placed in this slot. Slotted actions remain at the start of the action bar and are not automatically grouped if they exceed the available width. To group actions, place them in a Calcite action group. Actions in this slot remain separate from other actions, including default actions (such as \"Zoom to\" and \"Browse features\"), [PopupTemplate actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), and [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions).\n\nSince the popup component is tied to the view, the actions in this slot will be responsive to the view's size and show/hide the action's text accordingly.\n- **actions-end** - _Since 5.2._ Slot for adding Calcite [actions](https://developers.arcgis.com/calcite-design-system/components/action/) or [action groups](https://developers.arcgis.com/calcite-design-system/components/action-group/) to the end of the action bar. Multiple actions or action groups can be placed in this slot. Slotted actions remain at the end of the action bar and are not automatically grouped if they exceed the available width. To group actions, place them in a Calcite action group. Actions in this slot remain separate from other actions, including default actions (such as \"Zoom to\" and \"Browse features\"), [PopupTemplate actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), and [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions).\n\nSince the popup component is tied to the view, the actions in this slot will be responsive to the view's size and show/hide the action's text accordingly.","attributes":[{"name":"alignment","description":"Position of the popup in relation to the selected feature. The default behavior\nis to display above the feature and adjust if not enough room. If needing\nto explicitly control where the popup displays in relation to the feature, choose\nan option besides `auto`.","values":[{"name":"top-center"},{"name":"top-left"},{"name":"top-right"},{"name":"bottom-center"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-start"},{"name":"top-end"},{"name":"bottom-start"},{"name":"bottom-end"},{"name":"auto"}]},{"name":"auto-close-enabled","description":"This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/) changes.","values":[]},{"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-popup/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"collapsed","description":"Indicates whether the popup displays its content. If `true`, only the header displays.","values":[]},{"name":"content","description":"The content of the component. When set directly on the component, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content).","values":[]},{"name":"default-popup-template-enabled","description":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","values":[]},{"name":"dock-enabled","description":"Indicates whether the placement of the popup is docked to the side of the view.\n\nDocking the popup allows for a better user experience, particularly when opening\npopups in apps on mobile devices. When a popup is \"dockEnabled\" it means the popup no\nlonger points to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature) or the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location)\nassigned to it. Rather it is attached to a side, the top, or the bottom of the view.\n\nSee [dockOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#dockOptions) to override default options related to docking the popup.","values":[]},{"name":"feature-menu-open","description":"This property enables multiple features in the component to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features. This value will only be honored if [initialDisplayMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#initialDisplayMode) is set to \"feature\".","values":[]},{"name":"feature-menu-title","description":"Sets the title to display on the component while viewing the feature menu.","values":[]},{"name":"focus-trap-disabled","description":"When `true`, this prevents the popup from trapping focus when opened.\nPreventing focus trapping can be used in scenarios where interactions are expected within the user interface, such as when the popup resides in a panel.","values":[]},{"name":"heading","description":"The title of the popup. This can be set generically on the popup no\nmatter the features that are selected. If the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/), then the title set in the\ncorresponding template is used here.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading) of the popup.\nBy default, the heading is rendered\nas a level 2 heading (e.g. `<h2>Popup title</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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions).","values":[]},{"name":"hide-close-button","description":"Indicates whether to hide the close button in the component.","values":[]},{"name":"hide-collapse-button","description":"Indicates whether to hide the collapse button in the component.","values":[]},{"name":"hide-empty-relationship-content","description":"Indicates whether to hide relationship content when there are no relationship items to display.","values":[]},{"name":"hide-feature-list-layer-title","description":"Indicates whether to hide the group heading for a list of multiple features.","values":[]},{"name":"hide-feature-menu-heading","description":"Indicates whether to hide the feature menu heading and description in the component's feature menu list.","values":[]},{"name":"hide-feature-navigation","description":"Indicates whether to hide the feature navigation in the component. This allows the user to scroll through various [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) using pagination arrows.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading).","values":[]},{"name":"hide-spinner","description":"Indicates whether to hide the spinner in the component.","values":[]},{"name":"highlight-disabled","description":"Indicates if the selected feature will be highlighted.\nThis is done using the [arcgis-map.highlights](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#highlights) or the [arcgis-scene.highlights](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#highlights).","values":[]},{"name":"include-default-actions-disabled","description":"Indicates whether to include the default actions in the component.\nIn order to disable any default actions, it is necessary to set `includeDefaultActionsDisabled` to `true`.","values":[]},{"name":"initial-display-mode","description":"Indicates whether to initially display a list of features, or the content for one feature.\nBy default, a list is displayed when the associated view has `focusRegionVisible` enabled; otherwise, the content for one feature is displayed.","values":[{"name":"list"},{"name":"feature"}]},{"name":"label","description":"The component's default label.","values":[]},{"name":"open","description":"Indicates whether the component is visible. This property is `true` when the component is querying for results, even if it is not open. Use this property to check if the component is visible.","values":[]},{"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.","values":[]},{"name":"selected-feature-index","description":"Index of the feature that is [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) are set,\nthe first index is automatically selected.","values":[]},{"name":"top-layer-disabled","description":"When true, disables rendering in the top layer (above overlays and modals).\nThis can be useful for controlling stacking context in complex UI layouts.","values":[]},{"name":"update-location-enabled","description":"Indicates whether to update the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeatureIndex) changes.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/"},{"name":"Popup\nThe Popup component opens on view element click.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-popup--demo&singleStory=true"},{"name":"Custom Popup\nThe Popup component opens manually within a click event.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-popup--custom-popup&singleStory=true"},{"name":"Small Map","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-popup--small-map&singleStory=true"}]},{"name":"arcgis-presentation","description":"The Presentation component allows to present slides of a web scene in a presentation mode\nand supports navigating between the slides of a web scene.\n--\n\n### Events\n- **arcgisPopupFeatureNotFound** - Fires after a slide with a popup reference element has been applied, but the component was unable to retrieve the popup feature.\nThis event may be used to show a custom error message for such cases.\n- **arcgisPopupFeaturesRetrieved** - Fires after the popup feature(s) of a slide have been retrieved from the service or from the view.\nThis event may be used to show the popup graphic not in a popup, but in another component, e.g. ArcgisFeature.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisSlideApplyCancel** - Fires after applying a slide to the Scene View has been canceled.\nIt only fires if the slide cancelled is in the list of slides of the webscene presentation.\n- **arcgisSlideApplyComplete** - Fires after applying a slide to the Scene View has been completed.\nIt only fires if the slide canceled is in the list of slides of the webscene presentation.\n- **arcgisSlideApplyStart** - Fires after a slide has been applied to the Scene View.\nIt only fires if the slide applied is in the list of slides of the webscene presentation.\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","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-presentation/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"keyboard-navigation-enabled","description":"Enable navigation with the keyboard\nby using the arrow keys or page up/page down keys","values":[]},{"name":"navigation-hidden","description":"Hide the presentation navigation in the UI.\nSlide elements will still be shown when a slide is applied to the view.","values":[]},{"name":"slice-analysis-interactive","description":"Show the slice analysis of a slide interactive so manipulators will be displayed, allowing users to click and drag to edit the analysis.\nPer default interactive is set to false.","values":[]},{"name":"slide-captions-disabled","description":"Disable display of captions when slide is applied.\nPer default the display of captions is enabled.","values":[]},{"name":"slide-id","description":"The id of the slide applied to the view","values":[]},{"name":"slide-legend-disabled","description":"Disable display of slide legend when slide is applied.\nPer default the display of legend is enabled.\nDisabling the legend after creation of the component will hide the legend if it is displayed from a slide previously applied.","values":[]},{"name":"slide-popup-disabled","description":"Disable display of slide popup when slide with popup is applied.\nPer default the display of popup is enabled.\nThe events arcgisPopupFeaturesRetrieved and arcgisPopupFeatureNotFound will be emitted also when popups are disabled.","values":[]},{"name":"visual-scale","description":"specifies the size of the component","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-presentation/"}]},{"name":"arcgis-print","description":"The Print component connects your application with a [printing service](https://doc.esri.com/en/arcgis-enterprise/latest/administer/configure-the-portal-to-print-maps.html) to allow the map to be printed.\nIt takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS,\nwhich can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc.\nThe Print component works with the [print](https://developers.arcgis.com/javascript/latest/references/core/rest/print/) module, which generates a printer-ready version of the map.\n\nThe Print component uses the ArcGIS Online print service by default, but it can be configured to use a custom print service with the [printServiceUrl](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#printServiceUrl) property.\nThe component can preserve map scale or map extent in the printout. By default, the map extent is preserved. Use\n[TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/Print/TemplateOptions/#scaleEnabled) to preserve scale instead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/references/core/rest/support/PrintTemplate/#layout)\nexcept `map-only`. If using a custom print service, then `customTextElements` are supported for each print\ntemplate. Values found there will be populated in the Print component under `Advanced options`. These values can\nbe overwritten in the Print component UI, or programmatically using the\n[templateCustomTextElements](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/references/core/rest/support/PrintTemplate/#exportOptions).\n\n**Known limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/references/core/rest/print/) for a detailed list of known limitations.\n\n```html\n<arcgis-map item-id=\"45725ba7d9fb47a0925398919b13d1fa\">\n <arcgis-print slot=\"top-right\"></arcgis-print>\n</arcgis-map>\n```\n\n```js\n// get a reference to the component\nconst components = document.querySelectorAll(\"arcgis-print\");\n\nconst portal = new Portal({\n url: \"https://user.maps.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://user.maps.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```\n--\n\n### Events\n- **arcgisBrowseTemplatesChange** - Emitted when the collection of browse templates changes.\n- **arcgisComplete** - Emitted when the component is complete.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisSaveAs** - Emitted when the user saves an exported map printout.\n- **arcgisSubmit** - Emitted when the component is submitted.\n\n### Methods\n- `addPortalTemplate(portalItem: PortalItem): Promise<void>` - Adds a portal item to a collection of browse templates available in the Print component UI.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","attributes":[{"name":"allowed-formats","description":"Specify the print output file format(s) that the user can select based on the options available from the print service.\nThis property can take a string value or an array of string values.\n\nWhen this value is \"all\" (default value), all the print service formats are available to be used.\nWhen an array of string values is used, only those values that match the options available from the print service will be used.\nIf none of the input string values match those available from the print service, `allowedFormats` will fallback to default behavior.","values":[{"name":"all"}]},{"name":"allowed-formats-for-saving","description":"Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.","values":[{"name":"all"}]},{"name":"allowed-layouts","description":"Specify the print output layout(s) that the user can select based on the options available from the print service.\nThis property can take a string value or an array of string values.\n\nWhen this value is \"all\" (default value), all the print service layouts are available to be used.\nWhen an array of string values is used, only those values that match the options available from the print service will be used.\nIf none of the input string values match those available from the print service, `allowedLayouts` will fallback to default behavior.","values":[{"name":"all"}]},{"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-print/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-populate-author","description":"Indicates whether to automatically populate the author field in the print layout advanced options\nwith the username of the current portal user.\n\nThis only takes effect if there is a portal with a signed-in user assigned to the [portal](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#portal) property.","values":[]},{"name":"exclude-default-templates","description":"Indicates whether or not to include [defaultTemplates](https://developers.arcgis.com/javascript/latest/references/core/widgets/Print/PrintViewModel/#defaultTemplates).","values":[]},{"name":"exclude-organization-templates","description":"Indicates whether or not to include templates from an organization's portal.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-advanced-options","description":"Indicates whether the advanced options section in the Print component UI is hidden.","values":[]},{"name":"hide-feature-attributes","values":[]},{"name":"hide-header","description":"Indicates whether the component's header is hidden.","values":[]},{"name":"hide-include-tables","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"print-service-url","description":"The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#portal) property is set, this property will use the portal's print service URL.","values":[]},{"name":"reference-element","description":"By passing the `id` of the Map or Scene component into this property, you can position components from the `@arcgis/map-components`\npackage anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component).","values":[]},{"name":"show-print-area-enabled","description":"The initial state of the print area toggle in the Print component UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.","values":[]},{"name":"show-save-as","description":"Indicates whether to show the \"Save As\" option in the Print component UI.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/"},{"name":"Print","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-print--demo&singleStory=true"}]},{"name":"arcgis-reverse-geocode-list","description":"The Reverse Geocode List component displays a list of addresses obtained by reverse geocoding a given location.\nThis is the component behind the What's Here functionality in Map Viewer. This class was created for MV for 5.0,\nbut is internal for 5.0, and will be wider released at 5.1 or later.\n--\n\n### Events\n- **arcgisReverseGeocodeCopy**\n- **arcgisReverseGeocodeResultsChange**\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.","attributes":[{"name":"auto-destroy-disabled","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-coordinates","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-reverse-geocode-list/"},{"name":"Reverse Geocode List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-reverse-geocode-list--demo&singleStory=true"}]},{"name":"arcgis-scale-bar","description":"The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-scale-bar/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"bar-style","description":"The style for the scale bar.\nWhen `unit` is set to `dual`, the style will always be `line`.","values":[{"name":"line"},{"name":"ruler"}]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"unit","description":"Units to use for the scale bar.\nWhen using `dual`, the scale bar displays both metric and imperial units.\nWhen metric, distances will be shown in either kilometers, meters, centimeters, or millimeters depending on the scale. Similarly, imperial\nunits will be shown in either miles, feet, or inches.","values":[{"name":"metric"},{"name":"imperial"},{"name":"dual"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scale-bar/"},{"name":"Scale Bar","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-scale-bar--demo&singleStory=true"}]},{"name":"arcgis-scene","description":"The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/references/core/WebScene/) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n  basemap=\"satellite\"\n  ground=\"world-elevation\"\n  camera-position=\"12.3808, 46.3959, 4400\"\n  camera-tilt=\"75\"\n  camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n   <arcgis-layer-list slot=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/references/core/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nconst layer = new GraphicsLayer({ title: \"My layer\"});\nviewElement.map.add(layer);\n```\n\n**See also**\n\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisLoadError** - Fires when an arcgis-scene fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\n- **arcgisViewAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-analysis-view-create)\n- **arcgisViewAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes: [zoom](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#zoom), [scale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#scale), [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#center), [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#camera), [viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#viewpoint). This event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#stationary) toggles from `true` to `false`.\n\n> The `arcgisViewChange` event may be emitted before the view is fully ready.\n> This means the event can fire before the component's `stationary` property is `true` or before the view has completed its initial setup.\n> For actions that require the view to be ready and stationary, combine this event with checks on the component's `stationary` and `ready` properties.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n   viewElement.hitTest(event.detail).then((response) => {\n      const result = response.results[0];\n      // ....\n   });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-double-click)\n- **arcgisViewDoubleTapDrag** - Fires while the pointer is dragged following a double-tap gesture on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-double-tap-drag)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-drag)\n- **arcgisViewFocusRegionSelect** - Fires when the focus region is selected using the `Enter` or `Space` key. Use this event to react to the selection of the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegion) via keyboard input and perform any necessary actions based on that selection, such as performing a `hitTest()` on the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegion) and passing the returned graphics to the [selectionManager](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#selectionManager).\n\nCall `event.detail.preventDefault()` to suppress the default behavior of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opening with the features in the focus region.\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map) property is changed.\n- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\n- **arcgisViewVerticalTwoFingerDrag** - Fires while the two pointers are dragged vertically on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-vertical-two-finger-drag)\n\n### Methods\n- `closePopup(): Promise<void>` - Closes the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup).\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map), [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup),\nand removes components or other UI DOM elements added to it.\n- `fetchPopupFeatures(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise<AsyncGenerator<Graphic>>` - Use this method to query for features at a given screen location. These features come from origins (layers and sublayers) configured with a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [FeatureLayer.popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled) set. One example could be a custom side panel that displays feature-specific information based on an end user's click location. This method allows a developer to control how the input location is handled, and then subsequently, what to do with the results.\n> [!WARNING]\n> Using [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) as the hit target is considered **[beta](https://developers.arcgis.com/javascript/latest/faq/#what-does-the-beta-tag-mean)** functionality.\n- `goTo(target: GoToTarget3D, options?: GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#goTo)\n- `hitTest(hitTarget: MouseEvent | ScreenPoint | ScreenPolygon | ScreenRect, options?: HitTestOptions3D): Promise<SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n   viewElement.hitTest(event.detail).then((response) => {\n      const result = response.results[0];\n      if (result?.type === \"graphic\") {\n         const { longitude, latitude } = result.mapPoint;\n         console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n      } else {\n         console.log(\"Did not hit any graphic\");\n      }\n   });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#hitTest)\n- `openPopup(options?: ViewPopupOpenOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#openPopup)\n- `takeScreenshot(options?: UserSettings): Promise<Screenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#takeScreenshot)\n- `toMap(screenPoint: MouseEvent | ScreenPoint, options?: HitTestOptions3D): Point | null | undefined` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).\n- `toScreen(point: Point): ScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView<AnalysisType extends Analysis>(analysis: AnalysisType): Promise<AnalysisView3DFor<AnalysisType>>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#whenAnalysisView)\n- `whenLayerView<TLayer extends Layer>(layer: TLayer): Promise<Layer extends TLayer ? LayerView : LayerView3DFor<TLayer>>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#whenLayerView)\n- `zoomIn(): Promise<void>` - Zooms in the view component by a factor of 2.\n- `zoomOut(): Promise<void>` - Zooms out the view component by a factor of 2.\n\n### Slots\n- _default_ - Default slot for adding components to the scene. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n- **popup** - Slot for the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot.\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the view. \n- **--arcgis-table-row-background-color** - _Since 5.1_ Specifies the background color for table rows. \n- **--arcgis-table-row-alt-background-color** - _Since 5.1_ Specifies the background color for alternate table rows. \n- **--arcgis-focus-region-outer-border-color** - _Since 5.2_ Specifies the outer border color of the focus region. \n- **--arcgis-focus-region-inner-border-color** - _Since 5.2_ Specifies the inner border color of the focus region. \n- **--arcgis-focus-region-border-width** - _Since 5.2_ Specifies the border width of the focus region. ","attributes":[{"name":"alpha-compositing-enabled","description":"Allows the view to be partially or fully transparent when composited with the webpage elements behind it.\n\nThis property can only be set once at construction time. When alpha compositing is enabled, web scenes are less\nperformant. It is important to set this property to `true` only when you need to apply transparency on the view.","values":[]},{"name":"animations-disabled","description":"Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/PictureMarkerSymbol/)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/FlowRenderer/)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The display mode used for the attribution. Defaults to null.\n\nSet this property to \"auto\" to automatically synchronize the attribution with the nearest [Calcite mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes). If no Calcite mode is detected, the attribution defaults to light mode. **The \"auto\" mode was added in version 5.2.**\n\nSet this property to \"light\" or \"dark\" to explicitly use that mode without synchronization.","values":[{"name":"dark"},{"name":"light"},{"name":"auto"}]},{"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-scene/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"basemap","description":"Specifies a basemap for the map. The basemap is a set of layers that give\ngeographic context to the view and the other operational layers\nin the map.\nIt can either be set using a basemap ID string ([see values](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap)),\n[Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/)\nor [BasemapStyle](https://developers.arcgis.com/javascript/latest/references/core/support/BasemapStyle/).\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap)","values":[]},{"name":"camera-fov","description":"The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#fov)","values":[]},{"name":"camera-heading","description":"The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#heading)","values":[]},{"name":"camera-position","description":"The position of the camera defined by a map point. It can either be set with a\n[Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#position)","values":[]},{"name":"camera-tilt","description":"The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#tilt)","values":[]},{"name":"center","description":"Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#center)","values":[]},{"name":"display-filter-disabled","description":"Indicates whether a layer's `displayFilter` is honored when rendering layers in the view.\nIf `true`, the display filters are ignored and all features are rendered.","values":[]},{"name":"focus-region-shortcut-enabled","description":"Enables the `Shift` + `Alt`/`Option` + `O` keyboard shortcut for showing the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegion). When `undefined`, the shortcut is enabled only when a [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component is slotted into the ArcgisScene component, or when [popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupComponentEnabled) is set, and when the [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupDisabled) property is `false`. Set to `true` to handle focus-region selection in a custom application, or `false` to disable the shortcut. When `false`, the shortcut does not change the [focusRegionVisible](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegionVisible) property.","values":[]},{"name":"focus-region-visible","description":"Indicates whether the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegion) is visible. Set this property to `true` to show the centered focus region, or `false` to hide it.\nThe focus region can also be shown or hidden by focusing on the ArcgisScene component and pressing the `Shift` + `Alt`/`Option` + `O` keyboard shortcut. By default, this shortcut is available only when a popup component is available and [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupDisabled) is `false`. Use [focusRegionShortcutEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegionShortcutEnabled) to explicitly enable or disable it.\n\n**Note:** When the focus region is enabled, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) or slotted [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) will be docked with the dock button hidden by default to prevent it from overlapping the focus region.","values":[]},{"name":"ground","description":"Specifies the surface properties for the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map). It can be either a [Ground](https://developers.arcgis.com/javascript/latest/references/core/Ground/)\ninstance or a string with one of the following values:\n   * `\"world-elevation\"`\n   * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Map/#ground)","values":[]},{"name":"hide-attribution","description":"Indicates whether the attribution is hidden in the view.\n\nEsri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content.\nFor detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation.\nFor information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/).","values":[]},{"name":"item-id","description":"The ID of a [WebScene](https://developers.arcgis.com/javascript/latest/references/core/WebScene/) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html).\n\nTo configure the portal url you must set the [config.portalUrl](https://developers.arcgis.com/javascript/latest/references/core/config/#portalUrl) property before the Scene component loads.","values":[]},{"name":"popup-component-enabled","description":"Indicates whether the [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) (beta) is enabled  as the default popup. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) property (representing the component) will be used for popups instead of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup) property (representing the widget).\n\n**Note:** This is a beta feature and may change in future releases. At version 6.0, the Popup component will be used by default instead of the Popup widget and the `popup-component-enabled` attribute will no longer be necessary.","values":[]},{"name":"popup-disabled","description":"Controls whether the default popup opens automatically when users click on the view. This controls both the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) and [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup) properties. When set to `true`, the popup will not open on click or when triggered programmatically.","values":[]},{"name":"quality-profile","description":"Scenes can be drawn in three different quality modes: `high`, `medium` and `low`.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#qualityProfile)","values":[{"name":"medium"},{"name":"low"},{"name":"high"}]},{"name":"scale","description":"Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#scale)","values":[]},{"name":"suspended","description":"Indicates if the view is visible on the page.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#suspended)","values":[]},{"name":"time-zone","description":"Defines the time zone of the view.\nThe time zone property determines how dates and times are represented to the user,\nbut the underlying data is unchanged.\n\n> [!IMPORTANT]\n>\n> This property does not apply to the [arcgis-daylight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/) or\n> [arcgis-shadow-cast](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/) components. They use their own `utcOffset` properties. Support for using the\n> scene's time zone in these components is planned for a future release.\n\nThe time zone can be set to one of the following values:\n\n**Possible Values**\n\n| Value | Description |\n| ----- | ----------- |\n| system | Dates and times will be displayed in the time zone of the device or browser. |\n| unknown | Dates and times will be displayed based on the time zone that has been defined for the layer. No adjustments are made to the display of date info. The [arcgis-time-bar](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/) component is disabled. |\n| Specified IANA time zone | Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |","values":[]},{"name":"viewing-mode","description":"The viewing mode sets whether the view renders the earth as a sphere (global mode) or on a flat plane (local mode).\n\nNote that the viewing mode must be set before the Scene component loads.\nDepending on the viewing mode different [supported coordinate systems](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#supported-coordinate-systems) are available.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#viewingMode)","values":[{"name":"global"},{"name":"local"}]},{"name":"zoom","description":"Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\nSetting this property in conjunction with [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#zoom)","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/"},{"name":"Scene","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-scene--demo&singleStory=true"}]},{"name":"arcgis-search","description":"The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,\nBuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the\n`findAddressCandidates` operation is used, whereas queries are used on feature layers.\n\nBy default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.\nIf a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey\nis present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property. See the\n[Authentication and access tokens](https://developers.arcgis.com/javascript/latest/authentication/access-tokens/) guide to learn more.\n\nFor popups, we recommend using either [popup-component-enabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupComponentEnabled),\nor adding the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) to your view components as a best practice.\n\nThe Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data\nsources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property\nof the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.\nHowever, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a\nspecified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.\nThis behavior can be changed by using the localSearchDisabled property.\n\nStarting with version `5.1`, on [@arcgisSelectResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#event-arcgisSelectResult) the selected search result is announced to assistive technologies. Visit the [Accessibility guide](https://developers.arcgis.com/javascript/latest/accessibility/#assistive-technologies) to learn more\nabout live announcements supporting more audiences.\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 for user interaction.\n- **arcgisSearchClear** - Fires when a result is cleared from the input box or a new result is selected.\n- **arcgisSearchComplete** - Fires when the [search()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#search) method is called and returns its results.\n- **arcgisSearchStart** - Fires when the [search()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#search) method starts.\n- **arcgisSelectResult** - Fires when a search result is selected.\n- **arcgisSuggestComplete** - Fires when the [suggest()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#suggest) method is called and returns its results.\n- **arcgisSuggestStart** - Fires when the [suggest()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#suggest) method starts.\n\n### Methods\n- `clear(): void` - Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.\nIt also hides any open menus.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `search(searchItem?: Graphic | null | undefined | number[] | Point | SuggestResult | string): Promise<null | undefined | SearchResponse>` - Depending on the sources specified, search() queries the feature layer(s) and/or performs\naddress matching using any specified [locator(s)](https://developers.arcgis.com/javascript/latest/references/core/rest/locator/) and\nreturns any applicable results.\n- `setFocus(): Promise<void>` - Brings focus to the component's text input.\n- `suggest(query?: string): Promise<null | undefined | SuggestResponse>` - Performs a suggest() request on the active Locator. It also uses the current value of\nthe component or one that is passed in.\n\nSuggestions are available if working with a 10.3 or greater geocoding service that has\n[suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e.\n`supportsPagination = true`.","attributes":[{"name":"active-menu","description":"The current active menu of the Search component.","values":[{"name":"source"},{"name":"none"},{"name":"suggestion"}]},{"name":"active-source-index","description":"The selected source's index. This value is `-1` when all sources are selected.","values":[]},{"name":"all-placeholder","description":"String value used as a hint for input text when searching on multiple sources. See\nthe image below to view the location and style of this text in the context of the component.\n\n![search-allPlaceholder](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-allplaceholder.avif)","values":[]},{"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-search/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-navigate-disabled","description":"Indicates whether to automatically navigate to the selected result. If `true`, will not automatically navigate to the selected result.","values":[]},{"name":"auto-select-disabled","description":"By default, the component will automatically select and zoom to the first geocoded result. When `true`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [@arcgisSearchComplete](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#event-arcgisSearchComplete) event handler and get the results\nthrough the event object.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-sources-menu","description":"When `true`, hides the sources menu even when multiple sources are available.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"include-default-sources-disabled","description":"When `true`, will not include [defaultSources](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/SearchViewModel/#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns a collection of Search sources.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"location-disabled","description":"When `true`, will disable location services within the component.\n\n![locationDisabled](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-locationEnabled.avif)\n\n**Note:**\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that support\n[Window.isSecureContext](https://developer.mozilla.org/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).","values":[]},{"name":"max-results","description":"The maximum number of results returned by the component if not specified by the source.","values":[]},{"name":"max-suggestions","description":"The maximum number of suggestions returned by the component if not specified by the source.\n\nIf working with the default\n[ArcGIS Online Geocoding service](https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm),\nthe default remains at `5`.","values":[]},{"name":"min-suggest-characters","description":"The minimum number of characters needed for the search if not specified by the source.","values":[]},{"name":"popup-disabled","description":"By default, the graphic can be clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/).\nWhen `true`, disables displaying the [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/) on feature click.","values":[]},{"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.","values":[]},{"name":"result-graphic-disabled","description":"If `true`, the [resultGraphic](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#resultGraphic) will not display at the\nlocation of the selected feature.","values":[]},{"name":"search-all-disabled","description":"By default, the \"All\" option is displayed by default to search all sources:\n\n![search-searchAllDisabled-true](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-enablesearchingall-true.avif)\n\nWhen `true`, no option to search all sources at once is available:\n\n![search-searchAllDisabled-false](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-enablesearchingall-false.avif)","values":[]},{"name":"search-term","description":"The value of the search box input text string.","values":[]},{"name":"suggestions-disabled","description":"If `true`, disables suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.","values":[]},{"name":"top-layer-disabled","description":"When true, disables rendering in the top layer (above overlays and modals).\nThis can be useful for controlling stacking context in complex UI layouts.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/"},{"name":"Search","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-search--demo&singleStory=true"}]},{"name":"arcgis-search-result-renderer","description":"The Search Result Renderer renders the Search component results and supports selecting alternate matches.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-search-result-renderer/#destroy) method when you are done to\nprevent memory leaks.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search-result-renderer/"}]},{"name":"arcgis-selection-list","description":"The `Selection List` component displays selected features in a hierarchical list organized by group and layer. It is intended for applications that need to present the current selection and support browsing, filtering, and interaction with selected features.\n\nThe component can be used with the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component and reflects selections made through a [selection manager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/), including the [view](https://developers.arcgis.com/javascript/latest/references/core/views/View/#selectionManager), the [Selection Toolbar](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/), or the [selection manager API](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/).\n--\n\n### Events\n- **arcgisClear** - Fires when the active selection is cleared via the close button on the selection count chip.\nThis event does not fire when the selection is cleared programmatically, or when the selection is\ncleared by a different component. For more information about selection changes, use the\n[selection-change](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/#event-selection-change) event emitted by the associated [selection manager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/).\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 for user interaction.\n\n### Methods\n- `clear(): Promise<void>` - Clears all active selections for all groups, layers and features.\n- `collapseAll(): Promise<void>` - Utility method for collapsing all parent list items.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `deselectItem(item: ListItem): Promise<void>` - Utility method to deselect any group, layer or feature item.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `expandAll(): Promise<void>` - Utility method for expanding all parent list items.\n- `findLayerItem(layer: SelectableLayer): Promise<LayerItem | null | undefined>` - Utility method for finding the corresponding LayerItem for a given layer.\n- `findParentItem(layer: SelectableLayer): Promise<null | undefined | ParentItem>` - Utility method for finding the corresponding parent item for a given layer.\n- `goToItem(item: ListItem): Promise<void>` - Repositions the view to center based on the chosen item.\n- `removeFromSelection(params: {\n    layer: SelectableLayer;\n    selection: SelectionIdentifier[];\n}): Promise<void>` - Removes specific features from the selection, based on the provided layer and object IDs.\n- `replace(params: {\n    layer: SelectableLayer;\n    selection: SelectionIdentifier[];\n}): Promise<void>` - Replaces an active selection, based on the provided layer and object IDs.\n- `selectItem(item: ListItem): Promise<void>` - Selects all features contextual to a given item. Deselects all other features.","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-selection-list/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"display-mode","description":"Controls how the list is displayed. If this value is set to `\"group\"`, the list displays [feature](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) and [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) items nested under\ntheir associated [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) and [group](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/GroupLayerItem/) items. If this value is set to `\"layer\"`, the list displays [feature](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) items nested under\ntheir associated [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) item, while excluding [group](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/GroupLayerItem/) items. If this value is set to `\"feature\"` the list only displays\n[feature](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) items, while excluding [group](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/GroupLayerItem/) and [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) items.","values":[{"name":"feature"},{"name":"group"},{"name":"layer"}]},{"name":"filter-text","description":"Current value of the list's text filter.","values":[]},{"name":"hide-chip","description":"Indicates whether the selection count chip should be hidden. The chip shows the total\ncount of selected features and a `close` button for clearing the selection.","values":[]},{"name":"hide-chip-close-button","description":"Indicates whether the 'close' button on the selection count chip should be hidden.\nThe 'close' button allows users to clear the current selection.","values":[]},{"name":"hide-filter","description":"Indicates that the filter should be hidden.","values":[]},{"name":"hide-filter-notice","description":"Indicates that the filter notice should be hidden.","values":[]},{"name":"hide-header","description":"Indicates that the header should be hidden.","values":[]},{"name":"hide-item-close-actions","description":"Indicates that the close actions for individual list items should be hidden.","values":[]},{"name":"hide-item-count","description":"Indicates that the count for individual list items should be hidden.","values":[]},{"name":"hide-item-icons","description":"Indicates that the icons for individual list items should be hidden.","values":[]},{"name":"hide-item-menus","description":"Indicates that the menus for individual list items should be hidden.","values":[]},{"name":"hide-layer-filter","description":"Indicates that the layer filter should be hidden.","values":[]},{"name":"hide-menu","description":"Indicates that the primary menu should be hidden.","values":[]},{"name":"hide-zoom-to-button","description":"Indicates that the 'zoom to' button should be hidden.","values":[]},{"name":"highlight-on-hover-disabled","description":"Property controlling whether corresponding features on the view should be highlighted when\nhovering over the associated list item. Only applies to list items representing individual features.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"max-visible-feature-count-per-layer","description":"Maximum number of selected [feature items](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) displayed per layer.\nDoes not limit or restrict the selection itself.","values":[]},{"name":"menu-scale","description":"Default scale of all menus.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]},{"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.","values":[]},{"name":"visual-scale","description":"Controls the visual scale of any rendered Calcite elements.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-list/"},{"name":"Selection List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-selection-list--demo&singleStory=true"}]},{"name":"arcgis-selection-toolbar","description":"The selection toolbar component can be used to modify selected features on a provided [MapView](/references/core/views/MapView/) or [SceneView](/references/core/views/SceneView/). It provides an interface for performing [selection operations](/references/core/views/selection/SelectionOperation/) such as adding, removing, or replacing selected features.\nThis component can be used in conjunction with other components. Examples such as [arcgis-selection-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-list/) and [arcgis-feature-table](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/).\n--\n\n### Events\n- **arcgisBeforeActivate** - Fires before any [selection operation](/references/core/views/selection/SelectionOperation/) is activated.\n- **arcgisClear** - Fires when the active selection is cleared via the close button on the selection count chip.\nThis event does not fire when the selection is cleared programmatically, or when the selection is\ncleared by a different component. For more information about selection changes, use the\n'selection-change' event emitted by the associated [selection manager](/references/core/views/SelectionManager/).\n- **arcgisComplete** - Fires when the [selection operation](/references/core/views/selection/SelectionOperation/) is complete\nor canceled and results have been processed.\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 for user interaction.\n- **arcgisSelectionChange** - Fires when the potential selection set changes while drawing. This event will not fire unless\nthe [syncWhileDrawing](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/#syncWhileDrawing) property is set to `true`. For the final selection set, use the [complete ](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/#event-arcgisComplete) event\nor refer to the associated [selection manager](/references/core/views/SelectionManager/).\n\n### Methods\n- `activate(options?: SelectionOperationProperties): Promise<SelectionOperation | undefined>` - Activates the specified tool using the provided options and cancels any active [selection operation](/references/core/views/selection/SelectionOperation/). This method has no effect when the toolbar is disabled.\n- `activateTool(toolName: SelectionToolName): Promise<SelectionOperation | undefined>` - Activates the specified tool by name and cancels any [selection operation](/references/core/views/selection/SelectionOperation/). This method has no effect when the toolbar is disabled.\n- `cancel(): Promise<void>` - Cancels any active operation and, when applicable, emits a [complete](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/#event-arcgisComplete) event. The event includes an [aborted](/references/core/views/selection/types/#SelectionCompleteEventInfo-aborted) property that indicates whether the operation was canceled.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `syncSources(): Promise<void>` - Synchronizes the effective [selection manager](/references/core/views/SelectionManager/)\nwith the current layers and tables in the view.\n\nCall this method after adding or removing layers or tables from the view,\nespecially when using a custom [selection manager](/references/core/views/SelectionManager/). Newly added [sources](/references/core/views/SelectionManager/#sources)\nare otherwise excluded from selection results.\n\nThis method has no effect if the effective [selection manager](/references/core/views/SelectionManager/)\ndoes not have an assigned view.\n- `toggleTool(toolName: SelectionToolName): Promise<SelectionOperation | undefined>` - Toggles the active state of the specified tool. If\nthe tool is currently active, it is canceled.\nOtherwise, the tool is activated after canceling\nany active [selection operation](/references/core/views/selection/SelectionOperation/).","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-selection-toolbar/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"continuous-selection-enabled","description":"Determines if the selection toolbar should automatically reactivate a new [selection operation](/references/core/views/selection/SelectionOperation/) after the completion of an active [selection operation](/references/core/views/selection/SelectionOperation/), using options from the previous operation.\nThis only applies if the previous [selection operation](/references/core/views/selection/SelectionOperation/) was completed, and not canceled.","values":[]},{"name":"default-operation-type","description":"The default [selection operation type](/references/core/views/selection/types/#SelectionOperationType) to use when starting a new [selection operation](/references/core/views/selection/SelectionOperation/).\nThis value can be changed via the [selection operation type](/references/core/views/selection/types/#SelectionOperationType) dropdown.","values":[{"name":"remove"},{"name":"replace"},{"name":"add"}]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-chip","description":"Indicates whether the selection count chip should be hidden. The chip shows the total\ncount of selected features and a `close` button for clearing the selection.","values":[]},{"name":"hide-chip-close-button","description":"Indicates whether the 'close' button on the selection count chip should be hidden.\nThe 'close' button allows users to clear the current selection.","values":[]},{"name":"hide-lasso-tool","description":"Indicates whether the lasso tool should be hidden. The lasso tool allows for freehand selection of features.","values":[]},{"name":"hide-operation-type-controls","description":"Indicates whether the [selection operation type](/references/core/views/selection/types/#SelectionOperationType) controls should be hidden. The operation type controls\nallow for changing the selection operation type (e.g., `replace`, `add`, `remove`).","values":[]},{"name":"hide-pan-tool","description":"Indicates whether the pan tool is hidden. The pan tool allows users\nto navigate the view without initiating a [selection operation](/references/core/views/selection/SelectionOperation/) and\nis active by default when no [selection operation](/references/core/views/selection/SelectionOperation/) is in progress.","values":[]},{"name":"hide-point-tool","description":"Indicates whether the point tool should be hidden. The point tool allows for selecting features by clicking on them.\nThe point tool will include all features that intersect the selected point, rather than only the top-most feature.","values":[]},{"name":"hide-polygon-tool","description":"Indicates whether the polygon tool should be hidden. The polygon tool allows for selecting features\nby drawing a polygon.","values":[]},{"name":"hide-progress","description":"Indicates whether the progress indicator should be hidden.\n\nThe progress indicator shows when a [selection operation](/references/core/views/selection/SelectionOperation/) is processing results. The processing time can vary depending on the potential number of selected\nfeatures, or whether the [selection operation](/references/core/views/selection/SelectionOperation/) is querying source layers or [layer views](/references/core/views/layers/LayerView/) for results.","values":[]},{"name":"hide-rectangle-tool","description":"Indicates whether the rectangle selection tool is hidden. The\nrectangle tool allows users to select features by drawing a\nrectangular area.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layer-preference-enabled","description":"Indicates whether [selection operations](/references/core/views/selection/SelectionOperation/) should always query source layers rather than their associated [layer views](/references/core/views/layers/LayerView/) when determining selection results. Querying the source layer may be necessary when the most up-to-date feature data is required. Changing this property while a [selection operation](/references/core/views/selection/SelectionOperation/) is in progress will not affect the active operation. The change will apply only to subsequent operations.","values":[]},{"name":"layout","description":"Controls the orientation of the component.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"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.","values":[]},{"name":"return-feature-title-fields","description":"Determines whether selected features include the fields required to\ndisplay feature titles as defined by the [web map](/references/core/WebMap/).\n\nWhen enabled, these fields are available on features returned by selection\nevents. They are not stored in the [selection manager](/references/core/views/SelectionManager/),\nwhich stores only selected feature Object IDs.\n\nEnabling this property may require additional queries and can affect\nselection performance.","values":[]},{"name":"return-geometry-disabled","description":"Indicates whether to omit feature geometries from features returned by\nselection events. Disable this property when selected feature geometries\nare needed by an application.\n\nGeometries are not stored in the [selection manager](/references/core/views/SelectionManager/), which stores only selected feature Object IDs.\n\nDisabling geometry results may improve selection performance when geometries are not needed.","values":[]},{"name":"show-text-labels","description":"Indicates text labels should be displayed next to each tool.","values":[]},{"name":"sync-results-disabled","description":"Indicates whether results from new [selection operations](/references/core/views/selection/SelectionOperation/) are automatically synchronized with the associated [selection manager](/references/core/views/SelectionManager/). When set to `false`, events emitted by the selection-toolbar will still include the updated selection results, but the associated [selection manager](/references/core/views/SelectionManager/) will not be updated when the [selection operation](/references/core/views/selection/SelectionOperation/) completes.","values":[]},{"name":"sync-while-drawing","description":"Indicates whether the [selection operation](/references/core/views/selection/SelectionOperation/) continuously evaluates the potential\nselection while the associated draw tool is active and emits updates through events.\nWhen set to `false`, the selection is evaluated only once after drawing is complete.\n\nPotential selection results are not stored or reflected by the associated [selection manager](/references/core/views/SelectionManager/). Set this property to `true` to receive continuous updates to the working\nselection set, such as for highlighting potential features while drawing. This\nproperty does not control whether the final selection results are stored by the\n[selection manager](/references/core/views/SelectionManager/); use [syncResultsDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/#syncResultsDisabled) for that\nbehavior.","values":[]},{"name":"visual-scale","description":"Controls the scale of any rendered [Calcite](https://developers.arcgis.com/calcite-design-system/components) elements.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/"},{"name":"Selection Toolbar","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-selection-toolbar--demo&singleStory=true"}]},{"name":"arcgis-shadow-cast","description":"The Shadow Cast component visualizes shadows cast by 3D features or sunlight exposure in an\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/). This is helpful in urban development, where projects may need to satisfy shadow or\nsunlight exposure requirements for a selected day and time range.\n\n[![shadow cast component](https://developers.arcgis.com/javascript/latest/assets/references/core/analysis/shadow-cast-analysis-duration.avif)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\nBy default, the component visualizes shadows. When [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true`,\nit visualizes sunlight exposure instead.\n\nThe component provides controls for the date, time range, timezone, visualization mode, colors, intervals, and whether\nto visualize shadows or sunlight.\n\nThe [date](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#date), [startTimeOfDay](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#startTimeOfDay),\n[endTimeOfDay](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#endTimeOfDay), and [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#utcOffset) properties\ndefine the date, time range, and UTC offset used to compute the analysis overlay. They do not change the lighting in\nthe scene. To control scene lighting, use the [arcgis-daylight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/) component.\n\nThe [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#utcOffset) property determines the time zone used to interpret the selected\ndate and time range.\n\n> [!IMPORTANT]\n>\n> Shadow Cast does not use [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone). Changing the scene's time zone does not affect\n> the analysis. Support for using the scene's time zone is planned for a future release.\n\nThe [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) property controls how shadow or sunlight exposure is visualized:\n\n| Mode | Use for | Details |\n| --- | --- | --- |\n| `min-duration` | Highlighting areas that meet or exceed a minimum shadow or sunlight duration. | The threshold is defined by [minDuration](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDuration). |\n| `total-duration` | Showing cumulative shadow or sunlight duration across the analysis area. | Supports continuous visualization or 1-hour intervals. Areas with no duration remain transparent, intermediate values are interpolated, and the highest duration uses the opacity from [totalDurationColor](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#totalDurationColor). |\n| `discrete` | Displaying individual shadow or sunlight samples at regular intervals. | The interval is defined by [discreteInterval](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#discreteInterval). For example, a one-hour range with a 30-minute interval displays samples at the start, middle, and end of the range. |\n\nHovering over the scene displays a tooltip showing the shadow or sunlight duration at that location, rounded to\n15-minute intervals. To disable this tooltip, set\n[hideShadowDurationTooltip](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#hideShadowDurationTooltip) to `true`.\n\n**Known limitations**\n\n* Shadow Cast is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n* Terrain does not cast shadows in this analysis.\n* As a result, shadow duration may be underestimated and sunlight duration may be overestimated in areas where terrain\nwould normally block sunlight. To avoid incorrect visualization, `startTimeOfDay` should be set after local sunrise\nand `endTimeOfDay` before local sunset.\n* The analysis does not take daylight savings into account. Use the timezone picker to adjust the offset from the\nCoordinated Universal Time (UTC) and account for daylight saving time.\n* The timezone is automatically detected by the component based on the camera location. In some situations, this might\nnot be accurate. In case of an inaccurate timezone, users can set it manually using the timezone picker.\n\n**See also**\n\n- [Sample - Shadow Cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n- [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/)\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 for user interaction.\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.\n- `getDurationAtScreen(point: ScreenPoint): Promise<number>` - Returns the duration (in milliseconds) for a certain point on the screen based on the current analysis settings.\nBy default, this method returns the time spent in shadow. When\n[visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true`, this method returns the time spent in sunlight.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/#getDurationAtScreen)","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-shadow-cast/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"date","description":"The calendar date used to calculate the shadow or sunlight visualization. This date excludes the time. If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.\nIf no date is set, then it defaults to the current date in local system time.\n\n_See also_\n\n* [Date](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)","values":[]},{"name":"discrete-interval","description":"Individual shadow or sunlight samples are displayed at this time interval in `\"discrete\"`\n[mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode), starting with the start time of day. The interval is expressed in\nmilliseconds. If set to 0, the analysis uses the smallest possible interval, up to a maximum of 255 samples.","values":[]},{"name":"end-time-of-day","description":"Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#date)) when the shadow or sunlight computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#endTimeOfDay)","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-date-picker","description":"If true, the date picker will be hidden.","values":[]},{"name":"hide-discrete-color-picker","description":"If true, the color picker will be hidden in the discrete mode options.","values":[]},{"name":"hide-discrete-interval","description":"If true, the interval selector will be hidden in the discrete mode options.","values":[]},{"name":"hide-discrete-options","description":"If true, the visualization options will be hidden in discrete mode.","values":[]},{"name":"hide-min-duration-color-picker","description":"If true, the color picker will be hidden in the minimum duration mode options.","values":[]},{"name":"hide-min-duration-context-color-picker","description":"If true, the color picker will be hidden in the context options in minimum duration mode.","values":[]},{"name":"hide-min-duration-context-interval","description":"If true, the interval selector will be hidden in the context options in minimum duration mode.","values":[]},{"name":"hide-min-duration-context-options","description":"If true, the context options will be hidden in the minimum duration mode options.","values":[]},{"name":"hide-min-duration-context-toggle","description":"If true, the toggle used to show or hide the context options will be hidden.","values":[]},{"name":"hide-min-duration-options","description":"If true, the visualization options will be hidden in minimum duration mode.","values":[]},{"name":"hide-min-duration-slider","description":"If true, the minimum duration slider will be hidden in the minimum duration mode options.","values":[]},{"name":"hide-shadow-duration-tooltip","description":"If true, the tooltip which displays the shadow or sunlight duration at a certain location will be hidden.","values":[]},{"name":"hide-time-range-slider","description":"If true, the time range slider will be hidden.","values":[]},{"name":"hide-timezone","description":"If true, the timezone picker will be hidden.","values":[]},{"name":"hide-total-duration-color-picker","description":"If true, the color picker will be hidden in the total duration mode options.","values":[]},{"name":"hide-total-duration-mode-select","description":"If true, the mode selector will be hidden in the total duration mode options.","values":[]},{"name":"hide-total-duration-options","description":"If true, the visualization options will be hidden in the total duration mode.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"hide-visualization-options","description":"If true, the visualization options will be hidden.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"max-min-duration","description":"Maximum allowed value for the [minDuration](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDuration) property, in milliseconds.","values":[]},{"name":"min-duration","description":"The minimum duration (in milliseconds) used in `\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) to\ndetermine which shadowed or sunlit areas are displayed.","values":[]},{"name":"min-duration-context-enabled","description":"Whether to enable additional context showing discrete shadows at the same time as displaying shadows above a\nminimum duration when in `\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode). The [minDurationContextColor](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextColor)\nand [minDurationContextInterval](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextInterval) properties are used to configure the visualization of the\ndiscrete shadows when context is enabled. This context is hidden when\n[visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true` because the equivalent sunlight context would show\nbroad areas not in shadow at each sample and can obscure the threshold result.","values":[]},{"name":"min-duration-context-interval","description":"The interval in milliseconds used when showing additional context in `\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) when\n[minDurationContextEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextEnabled) is true. This context applies to shadow\nvisualization and is not used when [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true`.","values":[]},{"name":"min-min-duration","description":"Minimum allowed value for the [minDuration](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDuration) property, in milliseconds.","values":[]},{"name":"mode","description":"Mode of analysis to use when computing and displaying shadows or sunlight.\n\n- `\"discrete\"`: Displays individual shadow or sunlight snapshots at regular time intervals within the selected time range.\n- `\"min-duration\"`: Displays areas where accumulated shadow or sunlight exceeds a user-defined minimum duration within the selected time range. When visualizing shadows, optional discrete shadow overlays can provide additional context.\n- `\"total-duration\"`: Displays total shadow or sunlight accumulation within the selected time range. Supports continuous or 1-hour aggregated modes.","values":[{"name":"discrete"},{"name":"min-duration"},{"name":"total-duration"}]},{"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.","values":[]},{"name":"start-time-of-day","description":"Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#date)) when the shadow or sunlight computation should start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#startTimeOfDay)","values":[]},{"name":"time-zone-mode","description":"Controls whether the component uses its legacy UTC-offset model or the scene's regional time zone.","values":[{"name":"offset"},{"name":"region"}]},{"name":"total-duration-mode","description":"Mode in which the cumulative shadow or sunlight duration should be displayed in `\"total-duration\"`\n[mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode): as a continuous surface or as an hourly aggregation of values.","values":[{"name":"continuous"},{"name":"hourly"}]},{"name":"utc-offset","description":"The UTC offset in hours used to interpret the selected date and time range for the analysis. If not specified, the\ncomponent automatically determines an approximate UTC offset based on the camera location.\nThis property is separate from [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone). Changing one does not update the other.","values":[]},{"name":"visualize-sunlight","description":"When `true`, the component visualizes sunlight duration instead of shadow duration. This applies to all modes,\ntheir respective options, and the duration returned by\n[getDurationAtScreen()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#getDurationAtScreen). In sunlight mode, the discrete context controls in the\n`\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) are hidden because the equivalent sunlight context\nwould show broad areas not in shadow at each sample and can obscure the threshold result.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#visualizeSunlight)","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/"},{"name":"Shadow Cast","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-shadow-cast--demo&singleStory=true"},{"name":"Sunlight","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-shadow-cast--sunlight&singleStory=true"}]},{"name":"arcgis-sketch","description":"The Sketch component provides a simple UI for creating and updating graphics on a [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/) or a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).\n--\n\n### Events\n- **arcgisCreate** - Fires when a user starts sketching a graphic, is actively sketching a graphic and completes sketching a graphic.\n- **arcgisDelete** - Fires when a user deletes selected graphics by clicking the Delete feature button on the Sketch widget or when the `delete()` method is called.\n- **arcgisDuplicate** - Fires when the user duplicates selected graphics.\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 for user interaction.\n- **arcgisRedo** - Fires in response to redo action during creation of a new graphic or updating existing graphics. The undo/redo stack is for an individual sketch operation, meaning you can undo/redo actions while creating or updating a graphic.\n- **arcgisUndo** - Fires in response to undo action during creation of a new graphic or updating existing graphics. The undo/redo stack is for an individual sketch operation, meaning you can undo/redo actions while creating or updating a graphic.\n- **arcgisUpdate** - Fires when the user starts updating graphics, is actively updating graphics, and completes updating graphics.\n\n### Methods\n- `cancel(): Promise<void>`\n- `complete(): Promise<void>`\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `create(tool: CreateTool, createOptions?: CreateOptions): Promise<void>`\n- `delete(): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `dismissFloatingElements(): Promise<void>`\n- `duplicate(): Promise<void>`\n- `redo(): Promise<void>`\n- `setContextualToolLocation(location: \"inline-end\" | \"inline\" | \"separate\"): Promise<void>`\n- `setCustomTools(createToolOptions?: CustomToolOptions[] | null, customActionOptions?: CustomActionProperties[] | null): Promise<void>`\n- `setGroupCollapsePriorities(priorities: Map<SketchGroupName, number> | null): Promise<void>` - Note: `setGroupAllowCollapseOptions` has been removed in favor of a single priority setting.\nSet the group's priority to `LayoutPriorities.NeverCollapse` (1000) or `LayoutPriorities.ForceCollapse` (0)\nto control collapse behavior.\n- `triggerUpdate(graphic: Parameters<SketchViewModel[\"update\"]>[0], updateOptions?: Parameters<SketchViewModel[\"update\"]>[1]): Promise<void>`\n- `undo(): 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-sketch/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"cancel-update-on-click-away-disabled","description":"Indicates whether clicking away from an update graphic should not end the current update operation.","values":[]},{"name":"creation-mode","description":"Defines the default behavior once the [create()](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#create) operation is completed. By default, the user will be\nable to continuously create graphics with same geometry types.\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\ncontinuous | This is the default. Users can continue creating graphics with same geometry types.\nsingle | User can create a single graphic with the specified geometry type. User must choose an operation once the graphic is created.\nupdate | The graphic will be selected for an [update()](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#update) operation once the `create` operation is completed.","values":[{"name":"update"},{"name":"single"},{"name":"continuous"}]},{"name":"default-graphics-layer-disabled","description":"By default, sketch will create and manage a graphics layer.\n\nSet this prop to true to disable this behavior. Disabling the default\ngraphics layer is recommended if supplying your own layer.","values":[]},{"name":"hide-create-tools-circle","description":"Indicates whether to hide the circle sketch tool.","values":[]},{"name":"hide-create-tools-multipoint","description":"Indicates whether to hide the multipoint tool. Regardless of setting, multipoint is not available when working with a scene view.\n\nThe multipoint tool is excluded from `availableCreateTools` by default. Even if this property is false,\nmultipoint will not be available until it is added to `availableCreateTools`.","values":[]},{"name":"hide-create-tools-point","description":"Indicates whether to hide the point sketch tool.","values":[]},{"name":"hide-create-tools-polygon","description":"Indicates whether to hide the polygon sketch tool.","values":[]},{"name":"hide-create-tools-polyline","description":"Indicates whether to hide the polyline sketch tool.","values":[]},{"name":"hide-create-tools-rectangle","description":"Indicates whether to hide the rectangle sketch tool.","values":[]},{"name":"hide-delete-button","description":"Indicates whether to hide the 'delete' button while a graphic is selected. Do not hide this button without giving users on touch devices another way to delete selected geometries.","values":[]},{"name":"hide-duplicate-button","description":"Indicates whether to hide the 'duplicate' button while a graphic is selected.","values":[]},{"name":"hide-geometry-simplification-activity-indicator","description":"Indicates whether to hide display of the geometry simplification progress indicator while geometry simplification is in progress.\n\nWhen set to `false`, the progress indicator is not shown","values":[]},{"name":"hide-labels-toggle","description":"Indicates whether to hide the sketch labels toggle`.","values":[]},{"name":"hide-selection-count-label","description":"Indicates whether to hide a label indicating the length of the currently selected feature set.","values":[]},{"name":"hide-selection-tools-lasso-selection","description":"Indicates whether to hide the 'lasso' (freehand polygon) selection tool.","values":[]},{"name":"hide-selection-tools-rectangle-selection","description":"Indicates whether to hide the rectangle selection tool.","values":[]},{"name":"hide-settings-menu","description":"Indicates whether to hide the settings menu. The settings menu includes controls for tooltips, segment labels,\ngrid display, and snapping.","values":[]},{"name":"hide-single-plugin-back-button","description":"Indicates whether to hide the back button on the segment drawing toolbar when only one create tool is available.","values":[]},{"name":"hide-snapping-controls","description":"Indicates whether to hide the snapping controls portion of the settings menu.","values":[]},{"name":"hide-snapping-controls-elements-enabled-toggle","description":"Indicates whether to hide the `enabledToggle` (Enable snapping). This toggles\nthe [SnappingOptions#enabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#enabled) property.\n> [!WARNING]\n>\n> **Note**\n>\n> It is recommended to set `SnappingControls.snappingOptions.enabled = true` if `enabledToggle` is set to `false`.\n> This is because `selfEnabledToggle` and `featureEnabledToggle` require snapping globally to be enabled in order to be interactive. Otherwise, these toggles will not be responsive.","values":[]},{"name":"hide-snapping-controls-elements-feature-enabled-toggle","description":"Indicates whether to hide the `featureEnabledToggle` (Feature to feature). This toggles\nthe [SnappingOptions#featureEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#featureEnabled) property.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls","description":"Indicates whether to hide the `gridControls` (configuration of the snapping grid).","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-color-selection","description":"Indicates whether to hide the `colorSelection` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-dynamic-scale-toggle","description":"Indicates whether to hide the `dynamicScaleToggle` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-line-interval-input","description":"Indicates whether to hide the `lineIntervalInput` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-numeric-inputs","description":"Indicates whether to hide the `numericInputs` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-out-of-scale-warning","description":"Indicates whether to hide the `outOfScaleWarning` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-placement-buttons","description":"Indicates whether to hide the `placementButtons` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-rotate-with-map-toggle","description":"Indicates whether to hide the `rotateWithMapToggle` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-enabled-toggle","description":"Indicates whether to hide the `gridEnabledToggle` (snap-to-grid).","values":[]},{"name":"hide-snapping-controls-elements-layer-list","description":"Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/FeatureSnappingLayerSource/) layerList. The layerlist provides the available layer sources supported for snapping.","values":[]},{"name":"hide-snapping-controls-elements-self-enabled-toggle","description":"Indicates whether to hide the `selfEnabledToggle` (Geometry guides). This toggles\nthe [SnappingOptions#selfEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#selfEnabled) property.","values":[]},{"name":"hide-tooltips-toggle","description":"Indicates whether to hide the tooltips toggle`.","values":[]},{"name":"hide-undo-redo-menu","description":"Indicates whether to hide the undo/redo menu within the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layout","description":"Determines the layout/orientation of the Sketch component.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"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.","values":[]},{"name":"relative-position","description":"Relative position is used to control the appearance of elements rendered by `arcgis-sketch`. If used within\nthe slots of an `arcgis-map` or `arcgis-scene` component, you do not need to manually set this value.\n\nExamples of elements that depend on relative position include the split button chevrons (in vertical layout), the settings\npopover, and tooltips.","values":[{"name":"top-left"},{"name":"top-right"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-start"},{"name":"top-end"},{"name":"bottom-start"},{"name":"bottom-end"}]},{"name":"show-create-tools-freehand-polygon","description":"Indicates whether to display the freehandPolygon tool.","values":[]},{"name":"show-create-tools-freehand-polyline","description":"Indicates whether to display the freehandPolyline tool.","values":[]},{"name":"show-create-tools-text","description":"Indicates whether to display the text tool.","values":[]},{"name":"show-snapping-controls-elements-header","description":"Indicates whether to display the header.","values":[]},{"name":"toolbar-kind","description":"Controls the appearance of the sketch component, allowing the toolbar to adapt its appearance appropriately based on context.\n\nSet this to `docked` for use within the Expand component, or any other situation\nwhere Sketch is not floating within a large canvas.","values":[{"name":"docked"},{"name":"floating"}]},{"name":"update-on-graphic-click-disabled","description":"Controls whether the user can click a graphic in the layer to start updating it.","values":[]},{"name":"use-view-options","description":"If true, the component uses snapping, tooltips, display units, and input units from [ViewOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/).\n\nWhen this property is `true`:\n\n- Snapping and tooltip options are inherited from the view. The component's [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#snappingOptions) and [tooltipOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#tooltipOptions) are preserved but ignored.\n- Snapping controls and the tooltip toggle are hidden from the component's Settings menu.\n- Units set through [valueOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#valueOptions) override the corresponding units on the view, such as length or area, without changing the view's options. Setting a unit to `null` or `undefined` restores inheritance for that measurement type.\n\nWhen `false`, the component uses its own snapping, tooltip, and unit options instead.\n\nLabel [options](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#labelOptions) and [direction mode](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ValueOptions/#directionMode) are not inherited from the view.\n\nChanges to this property apply when the next create or update operation starts, not to an operation already in progress.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/"},{"name":"Sketch","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-sketch--demo&singleStory=true"}]},{"name":"arcgis-sketch-tooltip-controls","description":"The sketch-tooltip-controls component provides a user interface to set specific options within Sketch's [SketchTooltipOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchTooltipOptions/), [SketchLabelOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchLabelOptions/), and [SketchValueOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchValueOptions/) classes.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"direction-mode","description":"Indicates whether the direction (deflection) of the segment being drawn\nis measured relative to the previous segment or from the main axis of the map\n(usually north). See [SketchTooltipOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchTooltipOptions/) and [SketchValueOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchValueOptions/#directionMode).","values":[{"name":"absolute"},{"name":"relative"}]},{"name":"hide-labels-toggle","description":"Controls whether the labels toggle is shown for this component.\n\n> **Note:**  If this component is contained in another component, the parent\ncomponent is responsible for setting this property based on any\nknown limitations, including properties on the view. Specifically,\nas of 5.1, if the view is a 2d video or linkchart instead of a map,\nthe parent component should set this property to `true`.","values":[]},{"name":"hide-tooltips-toggle","description":"Controls whether the tooltips toggle is shown for this component.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"labels-enabled","description":"Indicates whether labels are shown next to each segment of the graphic being sketched.","values":[]},{"name":"show-direction-mode-picker","description":"Controls whether the direction mode picker is shown for this component.","values":[]},{"name":"show-header","description":"Controls whether a header is shown for this component.","values":[]},{"name":"tooltips-enabled","description":"Indicates whether tooltips are shown while sketching and editing.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch-tooltip-controls/"}]},{"name":"arcgis-slice","description":"The Slice component is a 3D analysis tool that can be used to reveal occluded content in a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/). It applies\n[slice analysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/SliceAnalysis/)\nto any layer type, making it possible to see inside buildings or to explore geological surfaces.\n\n<a href=\"https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html\"><video src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/slice.webm\" autoplay loop muted playsinline></video></a>\n\nThe slicing [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape)\nis always a [plane](https://developers.arcgis.com/javascript/latest/references/core/analysis/SlicePlane/).\nBy default, the plane is either horizontal or vertical. To allow a tilt angle for the plane, set\n[tiltEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#tiltEnabled)\nto `true`. The slice hides any content in front of the surface. The handles on the sides of the plane can be used to adjust\nthe size, heading, tilt, and position of the slice plane.\nThe [SlicePlane](https://developers.arcgis.com/javascript/latest/references/core/analysis/SlicePlane/)\ncan be set or retrieved using the [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape) property.\n\nOnce the slice plane is applied, layers can be excluded from the slicing. For example, by excluding the sublayers which include\ncolumns and floor slabs, the inner structure of a building can investigated.\n\n[![slice-exclude](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/slice-exclude.avif)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nHolding the `Shift` key while placing a new slice applies it vertically.\n\n**Known limitation**\n\nSlice is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [SliceAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/SliceAnalysis/)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `clear(): Promise<void>` - Clear the [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape) of the slice, effectively removing it from the view. Other properties like [excludedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#excludedLayers)\nand [excludeGroundSurface](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#excludeGroundSurface) are not modified.\nCalling this method changes the [state](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#state) to `ready`.\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>` - Start the interactive placement of a new slice, clearing the previous [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape).\nCalling this method changes the [state](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#state) to `slicing`.","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-slice/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"exclude-ground-surface","description":"Indicates whether the [Ground](https://developers.arcgis.com/javascript/latest/references/core/Ground/) and layers that\nare draped on the ground surface are excluded from the slice.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the \"Excluded layers\" heading.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-start-button","description":"If true, the button that starts a new slice will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"tilt-enabled","description":"Enable tilting the slice shape. If set to true, the slice shape will orient itself as best as\npossible to the surface under the cursor when first placing the shape. If set to false, the slice shape is\nrestricted to be either horizontal or vertical.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/"},{"name":"Slice","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slice--demo&singleStory=true"}]},{"name":"arcgis-slider-binary-color-size-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained.\nAt that point, development should use the native component.\n\nThe Binary Color Size Slider component is intended for authoring and exploring diverging data-driven visualizations in any\nlayer that can be rendered with an above and below theme for a [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/).\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/BinaryColorSizeSlider/#fromRendererResult)\nmethod can be used to intelligently populate slider properties including [max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#min), [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nconfiguration, and the slider's histogram after the renderer has been created from the result of the\n[createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer) method.\n\n```js\nconst univariateColorSizeRendererCreator = await import(\n  \"@arcgis/core/smartMapping/renderers/univariateColorSize.js\"\n);\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst binaryColorSizeSlider = document.querySelector(\"arcgis-slider-binary-color-size-legacy\");\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  field: \"B17020_calc_pctPovE\",\n  view: viewElement.view,\n  theme: \"above-and-below\",\n};\n\nconst rendererResult = await univariateColorSizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nawait binaryColorSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update an above and below (diverging) visualization in a layer's renderer.\nIt is the responsibility of the app developer to set up event listeners on that update the size variable of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = async () => {\n  const result = await binaryColorSizeSlider.updateRenderer(featureLayer.renderer);\n  featureLayer.renderer = result;\n};\n\nbinaryColorSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nbinaryColorSizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nbinaryColorSizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateFromRendererResult(rendererResult: RendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties of a Binary Color Size Slider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#RendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\nmethod. This method is useful for cases when the app allows the end user to switch data variables used to render the data.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.\n- `updateRenderer(renderer: ClassBreaksRenderer): Promise<ClassBreaksRenderer | null | undefined>` - A convenience function used to update the input renderer based on\nthe values of the slider [stops](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/BinaryColorSizeSlider/#stops).","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-slider-binary-color-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"handles-synced-to-primary","description":"This property indicates whether the position of the outside handles are synced with the middle, or primary,\nhandle. When enabled, if the primary handle is moved then the outside handle positions are updated\nwhile maintaining a fixed distance from the primary handle.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","values":[]},{"name":"persist-size-range-enabled","description":"When `true`, ensures symbol sizes in the `above` range\nare consistent with symbol sizes in the `below` range for all slider thumb positions.\nIn other words, the size values in the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#stops) will adjust\nproportionally according to the positions of the data values within the\nconstraints of the size range (maxSize - minSize) as the slider thumbs update.\nWhen `false`, size values in the stops will remain the same even when slider thumb values\nchange.\n\nIn most cases, this should be set to `true` to keep sizes in the `above` range consistent with\nsizes in the `below` range to avoid map misinterpretation.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/"},{"name":"Slider Binary Color Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-binary-color-size-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-classed-color-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Classed Color Slider component is designed for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with color in a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![Classed Color Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/classedcolorslider-labels.avif \"Classed Color Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/ClassedColorSlider/#fromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos) configuration,\nand the slider's histogram after the renderer has been created from the result of the\n[createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createClassBreaksRenderer) method.\n\n```js\nconst colorRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/color.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst classedColorSlider = document.querySelector(\"arcgis-slider-classed-color-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  field: \"B17020_calc_pctPovE\",\n  view: viewElement.view,\n  numClasses: 4\n};\n\nconst rendererResult = await colorRendererCreator.createClassBreaksRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nawait classedColorSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nin a ClassBreaksRenderer. It is the responsibility of the app developer\nto set up event listeners on this slider that update the breaks of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = async () => {\n  const renderer = featureLayer?.renderer?.clone();\n  if (!renderer || !(\"classBreakInfos\" in renderer) || !renderer.classBreakInfos?.[0]) {\n    return;\n  }\n\n  const updatedClassBreakInfos = await classedColorSlider.updateClassBreakInfos(renderer.classBreakInfos);\n  if (!updatedClassBreakInfos) {\n    return;\n  }\n\n  renderer.classBreakInfos = updatedClassBreakInfos;\n  featureLayer.renderer = renderer;\n};\n\nclassedColorSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nclassedColorSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nclassedColorSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateClassBreakInfos(breakInfos: ClassBreakInfo[]): Promise<ClassBreakInfo[] | null | undefined>` - A convenience function used to update the\n[classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nof a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) associated with this slider.\n\nThe number of breaks from the renderer must match the number of breaks in the slider.\nGenerally, the input breaks for this method should come from the same renderer as one\nused to create the slider with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#updateFromRendererResult) method.\n- `updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties of a ClassedColorSlider from the result\nof the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createClassBreaksRenderer) method.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","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-slider-classed-color-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/"},{"name":"Slider Classed Color (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-classed-color-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-classed-size-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Classed Size Slider component is designed for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with size in a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/).\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Classed Size Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/classedsizeslider-labels.avif \"Classed Size Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos) configuration,\nand the slider's histogram after the renderer has been created from the result of the [createClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer)\nmethod.\n\n```js\nconst sizeRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/size.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst classedSizeSlider = document.querySelector(\"arcgis-slider-classed-size-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Median_Income_by_Race_and_Age_Selp_Emp_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  field: \"B19049_001E\",\n  view: viewElement.view,\n  numClasses: 4,\n};\n\nconst rendererResult = await sizeRendererCreator.createClassBreaksRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nawait classedSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nin a ClassBreaksRenderer. It is the responsibility of the app developer\nto set up event listeners on this slider that update the breaks of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = async () => {\n  const renderer = featureLayer?.renderer?.clone();\n  if (!renderer || !(\"classBreakInfos\" in renderer) || !renderer.classBreakInfos?.[0]) {\n    return;\n  }\n  renderer.classBreakInfos = (await classedSizeSlider.updateClassBreakInfos(renderer.classBreakInfos);\n  featureLayer.renderer = renderer;\n};\n\nclassedSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nclassedSizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nclassedSizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateClassBreakInfos(breakInfos: ClassBreakInfo[]): Promise<ClassBreakInfo[] | null | undefined>` - A convenience function used to update the\n[classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nof a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) associated with this slider.\n\nThe number of breaks from the renderer must match the number of breaks in the slider.\nGenerally, the input breaks for this method should come from the same renderer as one\nused to create the slider with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method.\n- `updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties of a ClassedSizeSlider from the result\nof the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer) method.\nThis method is used to configure an empty ClassedSizeSlider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","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-slider-classed-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/"},{"name":"Slider Classed Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-classed-size-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-color-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Color Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [ColorVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![Color Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/colorslider-2-labels.avif \"Color Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#min), the [color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) configuration,\nand the slider's histogram after the renderer has been created from the result of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createContinuousRenderer) method.\n\n```js\nconst colorRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/color.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst colorSlider = document.querySelector(\"arcgis-slider-color-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params: ContinuousRendererParameters = {\n  layer: featureLayer,\n  field: \"B17020_calc_pctPovE\",\n  view: viewElement.view,\n  theme: \"above-and-below\",\n};\n\nconst rendererResult = await colorRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\ncolorSlider.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update a [color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/)\nin a layer's renderer. It is the responsibility of the app developer to set up event listeners on this slider that update the color variable of the appropriate renderer.\n\n```js\n// when the user slides the handle(s), update the renderer\n// with the updated color stops\ncolorSlider.updateFromRendererResult(rendererResult, histogramResult);\n\nconst updateRendererFromSlider = () => {\n  const renderer = featureLayer.renderer?.clone();\n  if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n    return;\n  }\n\n  const colorVariable = renderer.visualVariables[0].clone();\n  colorVariable.stops = colorSlider.stops;\n\n  renderer.visualVariables = [colorVariable];\n  featureLayer.renderer = renderer;\n};\n\ncolorSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\ncolorSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\ncolorSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateFromRendererResult(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): void` - A convenience function used to update the properties of a Color Slider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#ContinuousRendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createContinuousRenderer)\nmethod. This method is used to configure an empty Color Slider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","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-slider-color-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"handles-synced-to-primary","description":"Only applicable when three thumbs (i.e. handles) are set on the\nslider (i.e. when [primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#primaryHandleEnabled) is `true`). This property\nindicates whether the position of the outside handles are synced with the middle, or primary,\nhandle. When enabled, if the primary handle is moved then the outside handle positions are updated\nwhile maintaining a fixed distance from the primary handle.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color variable of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color variable of the appropriate renderer.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"name":"primary-handle-enabled","description":"When `true`, the slider will render a third handle between the two handles already provided by default. This is the primary handle.\nThree or five [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#stops) must be defined for the primary handle to render.\nThe primary handle represents the middle stop.\n\nWhen [handlesSyncedToPrimary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#handlesSyncedToPrimary) is `true`, then this handle will control the position of the others when moved.\n\nThis is typically used in diverging, or `above-and-below` renderer configurations.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/"},{"name":"Slider Color (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-color-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-color-size-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Color Size Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [ColorVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) and\na [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/). Both visual variables should be used\nto visualize the same data variable.\n\nThis slider and visualization style is designed specifically for\n3D thematic visualizations where both size and color are used to visualize the same data variable in order\nto minimize confusion because of distortion in perception. For example, a visualization of extruded points\nmay be difficult to understand if two features of similar sizes (and therefore data values) are located\nfar apart from one another; the feature furthest from the [Camera](https://developers.arcgis.com/javascript/latest/references/core/Camera/) will appear smaller than\nthe feature closer to the camera. The color variable can help the user understand that both features have similar values.\n\n![Slider Color Size with perspective](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/colorsizeslider-perspective.avif \"Slider Color Size with perspective\")\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Slider Color Size with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/colorsizeslider-labels.avif \"Slider Color Size with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#min), [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/) configuration,\n[color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) configuration, and the slider's histogram after the\nrenderer has been created from the result of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer) method.\n\n```js\nconst colorAndSizeRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/univariateColorSize.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst colorSizeSlider = document.querySelector(\"arcgis-slider-color-size-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  field: \"B17020_calc_pctPovE\",\n  view: viewElement.view,\n};\n\nconst rendererResult = await colorAndSizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nawait colorSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update the corresponding [color](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/)\nand [size](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/) visual variables in a layer's renderer. It is the responsibility of the app developer\nto set up event listeners on this slider that update these variables in the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = () => {\n  const renderer = featureLayer?.renderer?.clone();\n  if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n    return;\n  }\n  renderer.visualVariables = colorSizeSlider.updateVisualVariables(\n    renderer.visualVariables as VisualVariable[],\n  );\n  featureLayer.renderer = renderer;\n};\n\ncolorSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\ncolorSizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\ncolorSizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateFromRendererResult(rendererResult: RendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties of a Slider Color Size component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#RendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\nmethod. Note that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.\n- `updateVisualVariables(variables: VisualVariable[]): VisualVariable[]` - A convenience function used to update the visual variables of a renderer generated with the\n[createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\nmethod with the values obtained from the slider. This method is useful for cases when the app allows the end user to switch data variables\nused to render the data.","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-slider-color-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"handles-synced-to-primary","description":"Only applicable when three thumbs (i.e. handles) are set on the\nslider (i.e. when [primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#primaryHandleEnabled) is `true`). This property\nindicates whether the position of the outside handles are synced with the middle, or primary,\nhandle. When enabled, if the primary handle is moved then the outside handle positions are updated\nwhile maintaining a fixed distance from the primary handle.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color and size variables of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color and size variables of the appropriate renderer.","values":[]},{"name":"persist-size-range-enabled","description":"Only applicable when three thumbs (i.e. handles) are set on the\nslider (i.e. when [primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#primaryHandleEnabled) is `true`).\nThis property is typically used in diverging, or `above-and-below` renderer configurations.\n\nWhen `true`, ensures symbol sizes in the `above` range\nare consistent with symbol sizes in the `below` range for all slider thumb positions.\nIn other words, the size values in the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#stops) will adjust\nproportionally according to the positions of the data values within the\nconstraints of the size range (maxSize - minSize) as the slider thumbs update.\nWhen `false`, size values in the stops will remain the same even when slider thumb values\nchange.\n\nIn most cases, this should be set to `true` to keep sizes in the `above` range consistent with\nsizes in the `below` range to avoid map misinterpretation.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"name":"primary-handle-enabled","description":"When `true`, the slider will render a third handle between the\ntwo handles already provided by default. This is the primary handle.\nThree or five [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#stops) must be defined for the primary handle to render.\nThe primary handle represents the middle stop.\n\nWhen [handlesSyncedToPrimary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#handlesSyncedToPrimary) is `true`, then\nthis handle will control the position of the others when moved.\n\nThis is typically used in diverging, or `above-and-below` renderer configurations.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/"},{"name":"Slider Color Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-color-size-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-heatmap-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Heatmap Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/HeatmapRenderer/).\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Heatmap Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/heatmapslider-labels.avif \"Heatmap Slider with annotations\")\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst heatmapSlider = document.querySelector(\"arcgis-slider-heatmap-legacy\")!;\n\nconst layer = new CSVLayer({\n  url: \"https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_week.csv\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(layer);\n\nconst params = {\n  layer,\n  valueExpression: \"($feature.mag)\",\n  view: viewElement.view,\n};\n\nconst rendererResult = await heatmapRendererCreator.createRenderer(params);\n\nlayer.renderer = rendererResult.renderer;\n\nheatmapSlider.stops = rendererResult.renderer.colorStops;\n```\n\nThis slider should be used to update the [colorStops](https://developers.arcgis.com/javascript/latest/references/core/renderers/HeatmapRenderer/#colorStops)\nproperty in a HeatmapRenderer. It is the responsibility of the app developer\nto set up event listeners on this slider to update the renderer's colorStops based on how the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-heatmap-legacy/#stops) property was recalculated.\n\n```js\nconst updateRendererFromSlider = () => {\n  const renderer = layer.renderer?.clone();\n  if (!renderer || !(\"colorStops\" in renderer)) {\n    return;\n  }\n  renderer.colorStops = heatmapSlider.stops;\n  layer.renderer = renderer;\n};\n\nheatmapSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nheatmapSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nheatmapSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.","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-slider-heatmap-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-heatmap-legacy/"},{"name":"Slider Heatmap (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-heatmap-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-opacity-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Opacity Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with an [OpacityVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![Opacity Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/opacityslider-labels.avif \"Opacity Slider with annotations\")\n\nThe [updateFromVisualVariableResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#updateFromVisualVariableResult) method can be used to intelligently populate slider properties including [max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#min),\nthe [opacity visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/) configuration,\nand the slider's histogram after the renderer has been created from the result of the\n[createVisualVariable()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/#createVisualVariable) method.\n\n```js\nconst opacityVariableCreator = await import(\"@arcgis/core/smartMapping/renderers/opacity.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst opacitySlider = document.querySelector(\"arcgis-slider-opacity-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/ArcGIS/rest/services/USA_Census_2020_DHC_Total_Population/FeatureServer/2\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  view: viewElement.view,\n  field: \"P002_calc_pct0002\",\n};\n\nconst variableResult = await opacityVariableCreator.createVisualVariable(params);\n\nif (featureLayer.renderer && \"visualVariables\" in featureLayer.renderer) {\n  featureLayer.renderer.visualVariables = [variableResult.visualVariable];\n}\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nawait opacitySlider.updateFromVisualVariableResult(variableResult, histogramResult);\n```\n\nThis slider should be used to update an [opacity visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/)\nin a layer's renderer. It is the responsibility of the app developer\nto set up event listeners on this slider to update the opacity variable of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = () => {\n  const renderer = featureLayer.renderer?.clone();\n  if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n    return;\n  }\n\n  const visualVariable = renderer.visualVariables[0];\n  if (visualVariable.type !== \"opacity\") {\n    return;\n  }\n\n  const opacityVariable = visualVariable.clone();\n  opacityVariable.stops = opacitySlider.stops;\n  renderer.visualVariables = [opacityVariable];\n  featureLayer.renderer = renderer;\n};\n\nopacitySlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nopacitySlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nopacitySlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateFromVisualVariableResult(visualVariable: VisualVariableResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties of an OpacitySlider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/#VisualVariableResult) of\nthe [createVisualVariable()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/#createVisualVariable)\nmethod. This method is used to configure an empty OpacitySlider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","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-slider-opacity-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromVisualVariableResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#updateFromVisualVariableResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the opacity variable of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromVisualVariableResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#updateFromVisualVariableResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the opacity variable of the appropriate renderer.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/"},{"name":"Slider Opacity (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-opacity-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-scale-range","description":"The Scale Range Slider component allows the user to set a minimum and maximum scale based on named scale ranges.\nWhen a layer is provided, the component's minScale and maxScale properties will be set to the scale range of the layer.\n--\n\n### Events\n- **arcgisChange** - Fires when the thumb or range is released on the component. Use [@arcgisInput](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#event-arcgisInput) for continuous updates during a drag.\n- **arcgisInput** - Fires continuously while the thumb or range is being dragged. This event can fire frequently; consider debouncing or throttling expensive work.\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 for user interaction.\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.","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-slider-scale-range/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-max-scale-menu","description":"Indicates whether the maximum scale dropdown menu is visible. Default value is `false`.","values":[]},{"name":"hide-min-scale-menu","description":"Indicates whether the minimum scale dropdown menu is visible. Default value is `false`.","values":[]},{"name":"hide-preview","description":"Indicates whether the preview thumbnail of the scale is visible.\nDefault value is `false`.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"max-scale","description":"The maximum scale of the active scale range.","values":[]},{"name":"max-scale-limit","description":"The lowest possible maximum scale value on the slider, at which [maxScale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#maxScale) may not be set below.","values":[]},{"name":"min-scale","description":"The minimum scale of the active scale range.","values":[]},{"name":"min-scale-limit","description":"The highest possible minimum scale value on the slider, at which [minScale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#minScale) may not be set above.","values":[]},{"name":"mode","description":"The mode of the component, indicating which slider thumbs can be adjusted.","values":[{"name":"max-scale-only"},{"name":"min-scale-only"},{"name":"range"}]},{"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.","values":[]},{"name":"region","description":"The region that the scale thumbnails will focus on.\nEach region comes from the [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).\nBoth lowercase and uppercase region codes are supported.","values":[]},{"name":"show-scale-range-indicator","description":"If an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) is associated with the component and this property\nis set to `true`, the current scale indicator will be represented as a highlighted range of the slider track. The width of the indicator will increase\nas the [camera's tilt](https://developers.arcgis.com/javascript/latest/references/core/Camera/#tilt) approaches 90 degrees. If this property is set to `false`,\na small caret will render under the track indicating the current scale instead.\n\n> [!WARNING]\n> This property is not supported when the component is used in 2D maps.","values":[]},{"name":"show-world-value","description":"Indicates whether the world scale value is shown in the scale menu.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/"},{"name":"Scale Range Slider with Feature Layer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-scale-range--feature-layer-demo&singleStory=true"},{"name":"Scale Range Slider with Tile Layer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-scale-range--tile-layer-demo&singleStory=true"}]},{"name":"arcgis-slider-size-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Size Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/).\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Size Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/sizeslider-labels.avif \"Size Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#min), [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nintervals, and the slider's histogram after the renderer has been created from the result of the\n[createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer) method.\n\n```js\nconst sizeRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/size.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst sizeSlider = document.querySelector(\"arcgis-slider-size-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/USA_Major_Cities_/FeatureServer/0\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  view: viewElement.view,\n  field: \"POPULATION\",\n};\n\nconst rendererResult = await sizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nsizeSlider.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update a [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nin a layer's renderer. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = () => {\n  const renderer = featureLayer.renderer?.clone();\n  if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n    return;\n  }\n\n  const sizeVariable = renderer.visualVariables[0];\n  const updatedSizeVariable = sizeSlider.updateVisualVariable(sizeVariable);\n  if (!updatedSizeVariable) {\n    return;\n  }\n\n  renderer.visualVariables = [updatedSizeVariable];\n  featureLayer.renderer = renderer;\n};\n\nsizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nsizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nsizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateFromRendererResult(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): void` - A convenience function used to update the properties of a SizeSlider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#ContinuousRendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer)\nmethod. This method is used to configure an empty SizeSlider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.\n- `updateVisualVariable(sizeVariable: SizeVariable): null | undefined | SizeVariable` - A convenience function used to update the [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nto match the values of the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#stops) on the slider.\nThe slider stops are automatically updated internally when the user drags a thumb slider.\n\nThis is particularly useful for Size visual variables that have a set\n[minDataValue](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/#minDataValue) and\n[maxDataValue](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/#minDataValue).\nThis method will properly reconstruct the variable to set on the renderer so it matches the stops on the slider.","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-slider-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/"},{"name":"Slider Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-size-legacy--demo&singleStory=true"}]},{"name":"arcgis-snapping-controls","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 for user interaction.\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.","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-snapping-controls/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-enabled-toggle","description":"Controls display of the \"Enable snapping\" toggle.","values":[]},{"name":"hide-feature-enabled-toggle","description":"Controls display of the \"Feature to feature\" toggle. This controls feature snapping.","values":[]},{"name":"hide-grid-controls","description":"Controls display of the [arcgis-grid-controls](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/).","values":[]},{"name":"hide-grid-controls-elements-color-selection","description":"Controls display of the buttons to change the color of the grid.","values":[]},{"name":"hide-grid-controls-elements-dynamic-scale-toggle","description":"Controls display of the toggle that modifies [dynamicScaling](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#dynamicScaling).","values":[]},{"name":"hide-grid-controls-elements-line-interval-input","description":"Controls display of the line interval input. The input sets the interval between major grid lines.","values":[]},{"name":"hide-grid-controls-elements-numeric-inputs","description":"Controls display of the numeric inputs that allow for setting grid spacing and rotation","values":[]},{"name":"hide-grid-controls-elements-out-of-scale-warning","description":"Controls display of the out of scale warning. This warning is displayed when the grid is not shown because it would be too small at the current scale and dynamic scaling is disabled.","values":[]},{"name":"hide-grid-controls-elements-placement-buttons","description":"Controls display of the grid placement buttons. These buttons allow the user to start interactive configuration of the grid.","values":[]},{"name":"hide-grid-controls-elements-rotate-with-map-toggle","description":"Controls display of the \"Rotate grid with map\" toggle. This toggle controls whether the grid rotates with the map.","values":[]},{"name":"hide-layer-list","description":"Controls display of the \"Snapping layers\" dropdown. The list displays the available layers to configure snapping.","values":[]},{"name":"hide-self-enabled-toggle","description":"Controls display of the “Geometry guides” toggle. This toggle controls the self-snapping configuration which handles showing right-angle and parallel line indicators while constructing or modifying geometries.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-grid-controls-elements-grid-enabled-toggle","description":"Controls display of the \"Enable grid\" toggle. This toggle controls whether the grid is displayed.","values":[]},{"name":"show-header","description":"Controls display of the header","values":[]},{"name":"state","description":"The current state of the component.","values":[{"name":"disabled"},{"name":"ready"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-snapping-controls/"},{"name":"Snapping Controls","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-snapping-controls--demo&singleStory=true"}]},{"name":"arcgis-color-select","description":"Labeled swatch which opens a color picker popover to select a color.\n--\n\n### Events\n- **arcgisColorChanged** - Emitted when the color value changes.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"color","description":"The current color value.","values":[]},{"name":"label","description":"The label for the component.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-color-select/"}]},{"name":"arcgis-time-of-day-slider","description":"Component which displays a slider to select a specific time of day or a range of times within a day.\n--\n\n### Events\n- **arcgisTimeChange** - Emitted when the time is changed.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"disabled","description":"Whether the slider is disabled.","values":[]},{"name":"end-time","description":"The end time of the time range in minutes since midnight.","values":[]},{"name":"label","description":"The label for the component.","values":[]},{"name":"mode","description":"The mode of the slider - single time or time range.","values":[{"name":"single"},{"name":"range"}]},{"name":"start-time","description":"The start time of the time range in minutes since midnight.","values":[]},{"name":"steps","description":"If specified, sets an incremental step for the slider.","values":[]},{"name":"visual-scale","description":"The scale of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-of-day-slider/"}]},{"name":"arcgis-time-zone-chip","description":"A compact time-zone selector.\n--\n\n### Events\n- **arcgisInternalTimeZoneChange** - Emitted when the selected time zone changes.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"disabled","values":[]},{"name":"time-zone","values":[]},{"name":"visual-scale","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-zone-chip/"}]},{"name":"arcgis-utility-network-picker","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\nIt allows users to select utility networks from the map.\n--\n\n### Events\n- **arcgisError** - Fires when an error occurs while loading the utility networks from the map.\n- **arcgisPropertyChange**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"error","values":[]},{"name":"heading","values":[]},{"name":"hide-errors","values":[]},{"name":"hide-loader","values":[]},{"name":"state","values":[{"name":"error"},{"name":"loading"},{"name":"ready"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-picker/"}]},{"name":"arcgis-webgl-error","description":"Warning for WebGL errors.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"error-name","description":"The WebGL Error name.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-webgl-error/"}]},{"name":"arcgis-swipe","description":"The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `startLayers` and `endLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisSwipeChange** - Fires when the swipe position changes and the drag handle is released on the component.\n\n**Note:** To constantly listen to changes while dragging, use the `arcgisSwipeInput` event instead.\n- **arcgisSwipeInput** - Fires when the swipe position is updated.\nThis event is fired continuously while dragging the handle.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","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-swipe/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"direction","description":"The direction the Swipe component moves across the view.\nIf `\"horizontal\"`, the component will move left and right and\nif `\"vertical\"`, the component will move up and down.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-divider","description":"When `true`, the divider between the leading and trailing layers will be hidden.","values":[]},{"name":"hide-handle","description":"When `true`, the handle from which you drag the component will be hidden.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"position","description":"The position of the Swipe component. This determines what percentage\nof the view will be taken up by the [startLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-swipe/#startLayers).","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-swipe/"},{"name":"Swipe","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-swipe--demo&singleStory=true"}]},{"name":"arcgis-table-list","description":"The Table List component provides a way to display a list of tables associated with a [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/).\nIt is meant to be used with [feature layer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) tables.\n\nIf a map contains feature layer tables, they will display within the component. Tables can also be added to the Map's\n[tables](https://developers.arcgis.com/javascript/latest/references/core/Map/#tables) collection. Any tables referenced in the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#map)\nproperty will display in the component. If unsure of whether the layer is a table, check the feature layer's\n[isTable](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#isTable) property.\n\nThe [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/ListItem/) API provides access to each table, allows\nthe developer to configure actions related to the table, and allows the developer to add content to the item related to the table.\n\n\n**Known Limitations**\n* The TableList component is not supported with [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\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 for user interaction.\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.","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-table-list/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","values":[]},{"name":"drag-enabled","description":"Indicates whether [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/ListItem/) may be reordered within the list by dragging and dropping.\nDrag won't be enabled until the number of list items is equal to or greater than the value set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#showFilter) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#showFilter) is true.","values":[]},{"name":"heading-level","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-status-indicators","description":"Indicates whether to hide status indicators in the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"min-drag-enabled-items","description":"The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#dragEnabled).","values":[]},{"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-table-list/#showFilter) input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-errors","description":"This property provides the ability to show or hide layer error indicators.","values":[]},{"name":"show-filter","description":"This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]},{"name":"show-temporary-table-indicators","description":"This property provides the ability to show or hide the temporary table indicators for tables 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 table title.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/"},{"name":"Table List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-table-list--demo&singleStory=true"}]},{"name":"arcgis-table-list-next","description":"> [!WARNING]\n> The Table List (next) component is the successor to the Table List component, provided to you early for testing and feedback.\nIn version 6.0, the implementation of [arcgis-table-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/) will be updated under the hood to that of [arcgis-table-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/),\nand this component will be removed. To update at version 6.0, simply remove `-next` from the component name.\n\nThe Table List (next) component provides a way to display a list of tables associated with a map or table collection.\nIt is the direct component migration of the TableList widget and is provided early for testing and feedback.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisFilterChange** - Emitted when the value of the [filterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#filterText) input changes.\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 for user interaction.\n- **arcgisSelectedItemsChange** - Emitted when the collection of [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#selectedItems) changes.\n- **arcgisTableItemsChanged** - Emitted when the collection of [tableItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#tableItems) changes.\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.","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-table-list-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed. When collapsed, only the collapse button and heading are displayed.","values":[]},{"name":"drag-enabled","description":"Indicates whether [items](https://developers.arcgis.com/javascript/latest/references/core/layerList/Item/) may be reordered within the list by dragging and dropping. MapImageLayer [MapImageLayer#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. Drag and drop won't be enabled until the number of list items is equal to or greater than than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input when filtering is enabled.","values":[]},{"name":"filter-text","description":"The value of the filter input text string when filtering is enabled.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-no-filter-results-notice","description":"Indicates whether to hide the notice that appears when no results are found after filtering.","values":[]},{"name":"hide-no-items-notice","description":"Indicates whether to hide the notice that appears when there are no items to display.","values":[]},{"name":"hide-status-indicators","description":"Indicates whether to hide status indicators in the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"list-mode-disabled","description":"Specifies whether to ignore the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property to display all layers. A common use case for `listModeDisabled` is when you want to use the component to manage and configure a layer's `listMode` value.","values":[]},{"name":"min-drag-enabled-items","description":"The minimum number of list items required to enable drag and drop reordering.","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the filter input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode. Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-errors","description":"This property provides the ability to show or hide layer error indicators.","values":[]},{"name":"show-filter","description":"This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]},{"name":"show-temporary-table-indicators","description":"This property provides the ability to show or hide the temporary table indicators for tables 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 table title.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/"},{"name":"Table List Next","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-table-list-next--demo&singleStory=true"}]},{"name":"arcgis-time-bar","description":"The `<arcgis-time-bar>` component provides interactive time selection and playback within a defined temporal extent.\n\n> [!WARNING]\n>\n> By default, the `<arcgis-time-bar>` component will attempt to load persisted _time slider_ settings from a web map or web scene.\n> If this behavior is intended and time slider settings are expected, then it is advisable to refrain from initializing the component's\n> [fullTimeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#fullTimeExtent),\n> [loop](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#loop),\n> [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#mode),\n> [playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#playRate),\n> [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#stops), and\n> [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) properties.\n> The reason being is that these properties will be overwritten when the saved settings are loaded.\n> To disable automatic loading of stored settings, set the `loadPersistedSettingsDisabled` property to `true`.\n\n> [!WARNING]\n>\n> The `time-extent` slot, if used, must contain a single `<arcgis-time-bar-slider>` component. Other elements or components are not supported.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `applyTimeSettings(settings: Pick<ArcgisTimeBar, \"fullTimeExtent\" | \"loop\" | \"mode\" | \"playRate\" | \"stops\" | \"timeExtent\">): Promise<void>` - This method will update multiple `arcgis-time-bar` properties and is intended to be used in conjunction with\n[getTimeSliderSettingsFromWebDocument](https://developers.arcgis.com/javascript/latest/references/core/support/timeUtils/#getTimeSliderSettingsFromWebDocument).\n\n`getTimeSliderSettingsFromWebDocument` is a utility function that extracts `arcgis-time-bar` settings (if any) from a\npublished web map or web scene. This method can be used to apply those settings to the `arcgis-time-bar` component.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): Promise<void>` - Incrementally moves the [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) forward one stop.\n- `play(): Promise<void>` - Initiates playback of the `arcgis-time-bar`, causing the [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) to\nincrementally move forward based on the defined [playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#playRate) and\n[stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#stops).\n\nNote that when [loop](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#loop) is `true`, the `arcgis-time-bar` will restart from the\nbeginning when it reaches the end of the slider while playing.\n- `previous(): Promise<void>` - Incrementally moves the [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) backward one stop.\n- `stop(): Promise<void>` - Stops `arcgis-time-bar` playback.\n- `updateWebDocument(document: WebMap | WebScene): Promise<void>` - Updates the `arcgis-time-bar` definition in the parsed web document.\n\n### Slots\n- **actions-end** - A slot for adding `calcite-action`s that will appear at the end of the component.\n- **settings** - A slot for adding custom content to the settings popover when the `showSettings` property is `true` and settings button is clicked. If no content is provided, the default settings component will be rendered.\n- **time-extent** - A slot for optionally inserting a `arcgis-time-bar-slider`.","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-time-bar/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"floating","description":"Controls the appearance of the `arcgis-time-bar` component.\n\nWhen `floating` is `true`, the component will appear with rounded corners and a dropshadow.\nWhen `floating` is `false`, the default, the component will appear without rounded corners and dropshadow.","values":[]},{"name":"format","description":"This property determines the format of the date displayed in the minimum, maximum, and time extent labels.\nIf `\"date\"` is specified, only the localized day, month, and year components will be displayed, for example, \"6/21/2026\" in the \"en-US\" locale.\nIf `\"date-time\"` is specified, the localized day, month, year, hour, minute, and second components will be displayed, for example, \"6/21/2026, 3:30:00 PM\" in the \"en-US\" locale.","values":[{"name":"date-time"},{"name":"date"}]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"load-persisted-settings-disabled","description":"When `true`, `arcgis-time-bar` will not attempt to load persisted _time slider_ settings from a web map or web scene.","values":[]},{"name":"loop","description":"When `true`, `arcgis-time-bar` will restart from the beginning when it reaches the end of the slider when playing.","values":[]},{"name":"mode","description":"The `arcgis-time-bar` mode. The mode determines how the time extent is calculated based on the position of the thumb(s)\nand the behavior of the component when the thumbs are manipulated.","values":[{"name":"cumulative-from-end"},{"name":"cumulative-from-start"},{"name":"instant"},{"name":"time-window"}]},{"name":"play-rate","description":"When `arcgis-time-bar` is playing, the play rate determines the interval (in milliseconds) between animation steps.\n\n> [!WARNING]\n>\n> When `arcgis-time-bar` is associated with a `arcgis-map` or `argis-scene` component, the actual playback rate may differ.\n> Specifically, the current time extent will only advance after the designated play rate interval and after the view has finished updating.\n> This means that if the view takes longer to update than the specified play rate, the effective play rate will be slower than expected.","values":[]},{"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.","values":[]},{"name":"reverse-animation","description":"When `arcgis-time-bar` is playing, determines whether the animation should play in reverse.","values":[]},{"name":"save-persisted-settings-disabled","description":"When `true`, the `arcgis-time-bar`'s settings will not be included in the parent web document when saved.","values":[]},{"name":"show-next","description":"When `true`, the `arcgis-time-bar` will display a *next* button on the time bar.\nThe *next* button, when clicked will advance the time bar's [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) to the\nnext set of stops in the [effectiveStops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#effectiveStops) array.\nClicking the *next* button is equivalent to calling the [next()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#next) method.","values":[]},{"name":"show-play","description":"When `true`, the `arcgis-time-bar` will display a *play* button on the time bar.\nThe *play* button, when clicked will advance the time bar's [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) every [playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#playRate) milliseconds.\nClicking the *play* button is equivalent to calling the [play()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#play) method.","values":[]},{"name":"show-previous","description":"When `true`, the `arcgis-time-bar` will display a *previous* button on the time bar.\nThe *previous* button, when clicked will advance the time bar's [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) to the\nprevious set of stops in the [effectiveStops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#effectiveStops) array.\nClicking the *previous* button is equivalent to calling the [previous()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#previous) method.","values":[]},{"name":"show-settings","description":"When `true`, the `arcgis-time-bar` will display a *settings* button.\nThe *settings* button, when clicked will display a window that allows the user to configure the time-bar.\nTo customize the content of the settings window, please use the `settings` slot.","values":[]},{"name":"show-time-extent","description":"When `true`, the `arcgis-time-bar` will display the time extent.\nTo customize the display of the time extent, use the `time-extent` slot with the `arcgis-time-bar-slider` component.","values":[]},{"name":"time-zone","description":"The `arcgis-time-bar` component will display dates and times in the time zone specified by this property.\nBy default, the time zone is inherited from an associated `arcgis-map` or `arcgis-scene` component's view.\nIf there is no associated view, the time zone will default to `\"system\"`, the device's time zone.\nWhen the resolved time zone is `\"unknown\"`, the time bar's controls are disabled.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/"},{"name":"Default","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-1&singleStory=true"},{"name":"TimeBar with Label","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-2&singleStory=true"},{"name":"TimeBar with Slider","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-3&singleStory=true"},{"name":"TimeBar with Slider (customized labels)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-4&singleStory=true"},{"name":"TimeBar with Slider (customized ticks)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-8&singleStory=true"},{"name":"TimeBar with Actions","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-5&singleStory=true"},{"name":"TimeBar with Settings","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-6&singleStory=true"},{"name":"TimeBar with Settings (customized)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-7&singleStory=true"}]},{"name":"arcgis-time-bar-slider","description":"The `arcgis-time-bar-slider` component renders a time-based slider intended for use `arcgis-time-bar`'s \"time-extent\" slot.\n--\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.\n\n### Slots\n- **content-end** - A slot that displays ticks at the end of the slider. If not provided, default ticks will be rendered.\n- **max** - A slot that displays a label for the end date of the slider. If not provided, a default label will be rendered.\n- **min** - A slot that displays a label for the start date of the slider. If not provided, a default label will be rendered.\n- **popover** - A slot that displays a popover's content while interacting with the slider's thumb or range. If not provided, a default content will be rendered.","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-time-bar-slider/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"lock-time-window","description":"When `true` and the time bar is in `time-window` mode, users will not be able to adjust individual thumbs. The thumbs will maintain a finite stop separation.\nThis ensures that the time window behaves as a single unit rather than allowing individual thumbs to be moved independently.","values":[]},{"name":"popover-display","description":"Defines how and when popovers are displayed for the slider's thumb or range.\nWhen `none`, popovers are not displayed.\nWhen `auto`, popovers are displayed automatically when interacting with a thumb or the slider's range.\nWhen `always`, popovers are always displayed. If the slider is in `time-window` mode, popovers are displayed for the slider range otherwise the thumb.","values":[{"name":"auto"},{"name":"none"},{"name":"always"}]},{"name":"show-lock-time-window","description":"When `true`, the `arcgis-time-bar-slider` will display a button to toggle the value of the `lockTimeWindow` property.\nThe button will appear depressed when `lockTimeWindow` is `true`.\nThe button will appear disabled when the mode is not `time-window`.","values":[]},{"name":"show-max","description":"When `true`, displays a label for the end date of the slider.\nThe contents of this label can be customized by providing a slotted element in the \"max\" slot.","values":[]},{"name":"show-min","description":"When `true`, displays a label for the start date of the slider.\nThe contents of this label can be customized by providing a slotted element in the \"min\" slot.","values":[]},{"name":"show-ticks","description":"When `true`, displays tick marks and labels beneath the slider.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar-slider/"}]},{"name":"arcgis-time-slider","description":"The Time Slider component simplifies visualization of temporal data in your application.\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 for user interaction.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `applyTimeSliderSettings(settings: TimeSliderSettings): Promise<void>`\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): Promise<void>`\n- `play(): Promise<void>`\n- `previous(): Promise<void>`\n- `stop(): Promise<void>`\n- `updateWebDocument(webmap: WebMap): 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-time-slider/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layout","description":"Determines the layout used by the TimeSlider component.\n\nPossible values are listed below:\n| Value   | Description |\n| ---     | --- |\n| auto    | Automatically uses the \"compact\" layout when the component width is less than 858 pixels. Otherwise the \"wide\" layout it used. |\n| compact | Component elements are oriented vertically. This layout is better suited to narrower widths. |\n| wide    | Component elements are oriented laterally. This thinner design is better suited to wide applications. |","values":[{"name":"auto"},{"name":"compact"},{"name":"wide"}]},{"name":"loop","description":"When `true`, the time slider will play its animation in a loop.","values":[]},{"name":"mode","description":"The time slider mode. This property is used for defining if the temporal data will be displayed\ncumulatively up to a point in time, a single instant in time, or within a time range. See\nthe following table for possible values.\n\nPossible Values       | Description   | Example |\n----------------------|-------------- | ------- |\ninstant               | The slider will show temporal data that falls on a single instance in time. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` and `end` dates to the same date: `{start: sameDate, end: sameDate}` | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/timeslider/mode-instance.avif\"> |\ntime-window           | The slider will show temporal data that falls within a given time range. This is the default. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` and `end` properties to the desired dates. | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/timeslider/mode-time-window.avif\"> |\ncumulative-from-start | Similar to `time-window`, where the start time is always pinned to the start of the slider. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` date to `null` and set `end` date to a desired date: `{start: null, end: date}` | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/timeslider/mode-from-start.avif\"> |\ncumulative-from-end   | Also, similar to the `time-window` with the end time pinned to the end of the slider. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` date to a desired date and set `end` date to `null`: `{start: date, end: null}` | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/timeslider/mode-from-end.avif\"> |","values":[{"name":"cumulative-from-end"},{"name":"cumulative-from-start"},{"name":"instant"},{"name":"time-window"}]},{"name":"play-rate","description":"The time (in milliseconds) between animation steps.\n\n> [!WARNING]\n>\n> When a [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) is associated with a TimeSlider and the TimeSlider is playing, the playback will pause before advancing if the View is still updating.\n> For example, if the `playRate` is set to 1,000 (one second) and the `View` takes 1.5 seconds to render then the TimeSlider thumb(s) will advance every\n> 1.5 seconds rather than every second.","values":[]},{"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.","values":[]},{"name":"time-visible","description":"Shows/hides time in the display.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from the associated [MapView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#timeZone) or [SceneView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#timeZone). When a view is not associated with the component\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\nsystem  | Dates and times will be displayed in the timezone of the device or browser.\nunknown | Dates and times are not adjusted for any timezone. [TimeSlider](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/) will be disabled.\nSpecified IANA timezone | Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-slider/"},{"name":"Time Slider (Associated with View)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-slider--demo&singleStory=true"},{"name":"Time Slider (Independent of View)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-slider--standalone&singleStory=true"}]},{"name":"arcgis-time-zone-label","description":"Time Zone Label is a component for displaying the current [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) of an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/).\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 for user interaction.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"action-icon","description":"An optional leading icon that is displayed within the component.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-zone-label/"},{"name":"Time Zone Label","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-zone-label--demo-1&singleStory=true"},{"name":"Time Zone Label with Expand","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-zone-label--demo-2&singleStory=true"}]},{"name":"arcgis-track","description":"The Track component is a button that when activated continuously animates the Map or Scene\nto the user's location as the user moves.\nThe view rotates based on device heading, and the default heading symbol will display\nwhen speed is greater than zero and the browser provides heading information.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/docs/Web/Security/Defenses/Secure_Contexts), such as HTTPS.\n`localhost` is considered \"potentially secure\" and can be used for testing.\n\n> [!WARNING]\n>\n> **Note**\n>\n> To avoid unexpected navigation, especially when using custom spatial references, configure the view [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#constraints)\n> such as `extent`, `minZoom`, and `maxZoom`.\n> This helps when the geolocated position is inaccurate or causes the map to navigate to a location that is no longer visible because it is outside of\n> a layer's `fullExtent`.\n\n**Known limitations**\n\n- The heading symbol is not currently supported within an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.\n- `start(): Promise<void>` - Start tracking the user's location. Only start the component on a user gesture such as a click event.\n- `stop(): Promise<void>` - Stop tracking the user's location.","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-track/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"go-to-location-disabled","description":"Indicates whether to navigate the view to the position and scale of the geolocated result.","values":[]},{"name":"icon","description":"Icon displayed in the component's button.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"rotation-disabled","description":"Indicates whether the component will automatically rotate to the device heading based on\nthe Geolocation APIs [`GeolocationCoordinates.heading`](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/heading)\nproperty. The map will not rotate if the speed is `0`,\nor if the device is unable to provide heading information.","values":[]},{"name":"scale","description":"Indicates the scale to set on the view when navigating to the position of the geolocated\nresult, after a location is returned.\n\nBy default, the view will navigate to a scale of `2500` for 3D and `4514` for 2D.\nTo override the default in 2D, set the `scale` property and also set [snapToZoom](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#constraints) to `false`.\nFor 2D views the value should be within the [effectiveMinScale](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#constraints)\nand [effectiveMaxScale](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#constraints).","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-track/"},{"name":"Track","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-track--demo&singleStory=true"}]},{"name":"arcgis-utility-network-associations","description":"The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-utility-network-associations/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-refresh-associations-disabled","description":"Indicates whether to show a toggle to automatically show associations every time the map\nextent changes, or an action button to show associations within the current map extent on demand.","values":[]},{"name":"hide-connectivity-associations-settings-color-picker","description":"If true, hides the connectivity association color picker.","values":[]},{"name":"hide-connectivity-associations-settings-style-picker","description":"If true, hides the connectivity association style picker.","values":[]},{"name":"hide-connectivity-associations-settings-width-input","description":"If true, hides the connectivity association width input.","values":[]},{"name":"hide-structural-attachment-associations-settings-color-picker","description":"If true, hides the structural attachment associations color picker.","values":[]},{"name":"hide-structural-attachment-associations-settings-style-picker","description":"If true, hides the structural attachment associations style picker.","values":[]},{"name":"hide-structural-attachment-associations-settings-width-input","description":"If true, hides the structural attachment associations width input.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"include-connectivity-associations-disabled","description":"Indicates whether to query and display connectivity associations.","values":[]},{"name":"include-structural-attachment-associations-disabled","description":"Indicates whether to query and display structural attachment associations.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"max-allowable-associations","description":"The maximum number of associations that can be returned from the server.","values":[]},{"name":"max-allowable-associations-slider-max","description":"The maximum value or upper bound of the Maximum allowable associations slider.\n\nIf the value in the constructor is less than or equal to the value set for\n[maxAllowableAssociationsSliderMin](https://developers.arcgis.com/javascript/latest/references/core/widgets/UtilityNetworkAssociations/#maxAllowableAssociationsSliderMin), the property will be set to a default value (1000).","values":[]},{"name":"max-allowable-associations-slider-min","description":"The minimum value or lower bound of the Maximum allowable associations slider.\n\nIf the value in the constructor is less than 0, the property will be set to a default value (250).\nIf the value in the constructor is greater than or equal to [maxAllowableAssociationsSliderMax](https://developers.arcgis.com/javascript/latest/references/core/widgets/UtilityNetworkAssociations/#maxAllowableAssociationsSliderMax),\nthe property will be set to a default value (250).","values":[]},{"name":"max-allowable-associations-slider-step","description":"Specifies the interval to move the maximum allowable associations slider with the up, or down keys.","values":[]},{"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.","values":[]},{"name":"show-arrows-connectivity","description":"Indicates whether to show arrows for connectivity associations.","values":[]},{"name":"show-arrows-structural-attachment","description":"Indicates whether to show arrows for structural attachment associations.","values":[]},{"name":"show-associations-enabled","description":"When `autoRefreshAssociations` is `true`, indicates whether to automatically show associations\nevery time the current map extent changes.","values":[]},{"name":"show-connectivity-associations-settings-arrows-toggle","description":"If true, shows the connectivity association arrows toggle.","values":[]},{"name":"show-connectivity-associations-settings-cap-select","description":"If true, shows the connectivity association cap select.","values":[]},{"name":"show-max-allowable-associations-slider","description":"If true, hides the max allowable associations slider.","values":[]},{"name":"show-structural-attachment-associations-settings-arrows-toggle","description":"If true, shows the structural attachment associations arrow toggle.","values":[]},{"name":"show-structural-attachment-associations-settings-cap-select","description":"If true, shows the structural attachment associations cap select.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-associations/"}]},{"name":"arcgis-utility-network-trace-analysis","description":"## Overview\n\n> [!WARNING]\n> This component is the successor to the `utility-network-trace-analysis` component.\n> The `utility-network-trace-analysis` component is being substantially refactored to expose public trace sub-components in release 5.2 and 6.0.\n> To avoid destabilizing the public version of `utility-network-trace-analysis`, the refactoring work is being performed in this component.\n> At release, this \"next\" component will replace the original.\n\nThe Utility Network Trace Analysis component allows users to run traces and view trace results in a utility network.\n\n- The component supports selecting a utility network and a named trace configuration in that utility network. Both the utility network and trace configuration must be [stored in the map](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#utilityNetworks).\n- Trace locations (starting points, stopping points, and barriers) are set by selecting features on the view.\n- When a subnetwork-based trace is selected, the component displays the domain, tier, and target tier specified by the selected named trace configuration.\n- If the user selects a subnetwork trace with a specified subnetwork name, the component provides an option to choose a subnetwork name instead of starting location(s) to run the trace with.\n\nSupported trace types are: `connected`, `upstream`, `downstream`, `shortest-path` (deprecated), `path`, `subnetwork`, `subnetwork-controller`, `loops`, and `isolation`.\n\n> [!WARNING]\n>\n> The [shortest path trace type](https://pro.arcgis.com/en/pro-app/latest/help/data/trace-network/discover-the-shortest-path.htm) is deprecated with ArcGIS Pro 3.7 and ArcGIS Enterprise 12.1.\n>\n> While the shortest path trace will continue to function and be an option until the next major release, it is recommended to use the path trace to return the shortest path.\n> The path trace provides the same functionality to return a shortest path result while offering additional capabilities to find paths in your network.\n\nThe component can display the following from a trace result: elements (as [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#traceResultFeatures)), aggregated geometries, and function results.\nIf the trace result includes elements that originate from a [feature layer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/)\nthat is not included in the map, the Results tab displays an `Unknown` layer with a count of those elements.\nThe component's [traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#traceResultFeatures) property also does not include these elements.\n\n> [!WARNING]\n>\n> The Utility Network Trace Analysis component does not support the following:\n>\n> 1. Proxied feature services or feature services that utilize stored credentials.\n> 2. The `circuit` trace type or the `paths` and `circuits` result types.\n> 3. Setting grouping properties `firstUnit` and `lastUnit` for trace locations in a [telecom domain network](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/telecom-domain-networks.htm).\n>    If a [grouped object](https://doc.esri.com/en/arcgis-pro/latest/help/data/utility-network/grouping.html) is used as a trace location, its `firstUnit` and `lastUnit` attributes are not used in the trace.\n\n## Working with nonspatial objects\n\nThe Utility Network Trace Analysis component supports selecting nonspatial objects as trace locations by traversing associations.\n\nWhen selecting a trace location or viewing a trace result feature, information about the feature is displayed according to the\n[PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) of the layer that the feature belongs to.\nIf the feature's layer has no PopupTemplate, a default template is used to display the feature's attributes.\n\nTo select a nonspatial object as a trace location, first select a spatial feature on the map that is associated with the target nonspatial object.\nThe spatial feature's layer must have a PopupTemplate that includes a [UtilityNetworkAssociationsContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/).\nNavigate through the spatial feature's associations to the target nonspatial object, then add the object as a trace location.\n\n## Examples\n\nThis component can be used slotted into an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/):\n\n```html\n<arcgis-map item-id=\"471eb0bf37074b1fbb972b1da70fb310\">\n  <arcgis-utility-network-trace-analysis slot=\"bottom-left\"></arcgis-utility-network-trace-analysis>\n</arcgis-map>\n```\n\nAlternatively, this component can be used outside of a map by providing a [referenceElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#referenceElement):\n\n```html\n<calcite-shell>\n  <calcite-shell-panel slot=\"panel-start\" position=\"start\" width=\"l\">\n    <arcgis-utility-network-trace-analysis reference-element=\"#map-element\"></arcgis-utility-network-trace-analysis>\n  </calcite-shell-panel>\n  <arcgis-map id=\"map-element\" item-id=\"471eb0bf37074b1fbb972b1da70fb310\"></arcgis-map>\n</calcite-shell>\n```\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nEvent payload contains a callback method `cancelSelect` to cancel a selection in progress.\nThe event can also be prevented with `event.preventDefault()` to stop the selection.\n- **arcgisTraceResultClear** - Fires when trace results and errors are cleared from the results tab.\n- **arcgisTraceResultFeaturesReady** - Fires when the trace result features are ready.\nCheck property [traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#traceResultFeatures) for the trace result features.\n- **arcgisTraceResultReady** - Fires when the trace result is ready.\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.\n\n### Slots\n- **results** - Slot for instances of [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/),\nfor displaying the results of one or more traces.","attributes":[{"name":"aggregated-geometry-results-graphics-color","description":"The color used to render graphics for aggregated geometries in trace results, specified as a\n[Color](https://developers.arcgis.com/javascript/latest/references/core/Color/) object.\n\nAggregated geometry is only rendered if the trace configuration specifies aggregated geometry as a result type.\n\nDefault color is #FFFF00.","values":[]},{"name":"aggregated-geometry-results-size","description":"The size in points used to render graphics for aggregated geometries in trace results.\n\nAggregated geometry is only rendered if the trace configuration specifies aggregated geometry as a result type.","values":[]},{"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-utility-network-trace-analysis/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disable-highlight-feature-results","description":"Whether to disable highlighting trace result features on the map.\n\nIf true, the features returned by a trace will not be highlighted on the map.","values":[]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's\n[arcgis-features-next.actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions) when selecting trace locations\nand viewing trace result features.","values":[]},{"name":"hide-clear-results-count","description":"Whether to hide the count of features next to the \"Clear results\" button in the Results tab for trace results\nwhich include [elements](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#elements).","values":[]},{"name":"hide-feature-results","description":"Whether to hide feature results in the results tab.\n\nIf true, when features are returned by a trace, they will not be visible in the results tab.\nA message will be displayed in its place indicating that features were returned by the trace, but are not visible in the results pane.\nThis string can be overridden with the `messageOverrides` property.","values":[]},{"name":"hide-graphics","description":"Whether to hide the aggregated geometry [graphics](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#geometryGraphics)\nfrom the map when the trace result contains aggregated geometry results.","values":[]},{"name":"hide-placeholder","description":"Whether to hide the placeholder string when feature results are hidden in the results tab.\n\nWhen this property and [hideFeatureResults](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#hideFeatureResults) are both set to `true`,\nnothing is rendered for trace result elements. However, features are still queried and are available through\n[traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#traceResultFeatures).","values":[]},{"name":"include-default-actions-disabled","description":"Indicates whether default actions are disabled (hidden) when\nselecting trace locations and viewing trace result features.\nThis property must be set to `true` to disable default actions.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/"},{"name":"Utility Network Trace Analysis","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-utility-network-trace-analysis--demo&singleStory=true"}]},{"name":"arcgis-utility-network-trace-aggregated-geometry-result-item","description":"Trace result item for displaying [aggregated geometry](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#aggregatedGeometry) results from a trace.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisResultReady** - Fires when the component finishes processing the aggregated geometry results.\n\nIf the component has a valid trace result with aggregated geometry results, this fires\nwhen the aggregated geometry graphics have been added to the map.\n\nIf the component does not have a valid map or trace result, this fires when the\ncomponent has finished loading.\n\n### Methods\n- `clearResult(): void` - Removes the aggregated geometry graphics from the\n[graphicsLayer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#graphicsLayer).\nIf the layer was created by the component, it is also removed from the map.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","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-utility-network-trace-aggregated-geometry-result-item/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"graphics-color","description":"The color used for the aggregated geometry graphics.\nDefault value is #FFFF00.","values":[]},{"name":"heading","description":"The heading of the result item.","values":[]},{"name":"hide-graphics","description":"Whether to hide the aggregated geometry [graphics](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#geometryGraphics)\nfrom the map when the trace result contains aggregated geometry results.","values":[]},{"name":"selection-size","description":"The size of the aggregated geometry graphics to render, in points.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/"}]},{"name":"arcgis-utility-network-trace-configuration-picker","description":"Selects a named trace configuration from a list and displays subnetwork fields from the named trace configuration:\nDomain network name, tier name, and target tier name.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"error","values":[]},{"name":"heading","values":[]},{"name":"hide-errors","values":[]},{"name":"hide-subnetwork-info","values":[]},{"name":"state","values":[{"name":"error"},{"name":"loading"},{"name":"ready"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-configuration-picker/"}]},{"name":"arcgis-utility-network-trace-elements-result-item","description":"Trace result item for displaying [element](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#elements) results from a trace.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisResultReady** - Fires when the component finishes querying all features for the trace result elements.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `clearResult(): void` - Cancels any feature queries in progress, removes feature highlights from the map,\nand clears [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#features).\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","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-utility-network-trace-elements-result-item/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disable-highlight","description":"Whether to disable highlighting trace result features on the map.\nIf true, the features returned by a trace will not be highlighted on the map.","values":[]},{"name":"heading","description":"The heading of the result item.","values":[]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's\n[actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#actions)\nwhen selecting trace locations and viewing trace result features.","values":[]},{"name":"hide-feature-results","description":"Whether to hide feature results.\nIf true, the component renders a placeholder string instead of a button to view features.\nWhen true, features are still queried and are available through [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#features).","values":[]},{"name":"hide-placeholder","description":"Whether to hide the placeholder string when feature results are hidden.\n\nWhen this property and [hideFeatureResults](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#hideFeatureResults) are both set to `true`,\nnothing is rendered for trace result elements. However, features are still queried and are available through\n[features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#features).","values":[]},{"name":"include-default-actions-disabled","description":"Indicates whether default actions are disabled (hidden) when viewing trace result features.\nThis property must be set to `true` to disable default actions.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/"}]},{"name":"arcgis-utility-network-trace-functions-result-item","description":"Trace result item for displaying [function](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#globalFunctionResults) results from a trace.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisResultReady** - Fires when the component is finished rendering its results.\n\n### Methods\n- `clearResult(): void` - Clears the result item.\nThis result item has no side effects to clear.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","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-utility-network-trace-functions-result-item/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading","description":"The heading displayed above the result item.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/"}]},{"name":"arcgis-utility-network-trace-inputs","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\nIt allows users to select utility networks, trace configurations, and input features for tracing.\n--\n\n### Events\n- **arcgisPropertyChange**\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nCan be prevented to stop the selection.\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.","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-utility-network-trace-inputs/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's\n[arcgis-features-next.actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions) when selecting trace locations.","values":[]},{"name":"include-default-actions-disabled","description":"Indicates whether default actions are disabled (hidden) when selecting trace locations.\nThis property must be set to `true` to disable default actions.","values":[]},{"name":"mode","values":[{"name":"default"},{"name":"add-spatial-feature"},{"name":"add-spatial-instructions"}]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-inputs/"}]},{"name":"arcgis-utility-network-trace-locations","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\nIt allows users to select locations on the map to use as trace inputs.\n--\n\n### Events\n- **arcgisError**\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nCan be prevented to stop the selection.\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.","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-utility-network-trace-locations/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"error","values":[]},{"name":"heading","values":[]},{"name":"spatial-tolerance","values":[]},{"name":"trace-location-type","values":[{"name":"barrier"},{"name":"starting-point"},{"name":"stopping-point"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-locations/"}]},{"name":"arcgis-utility-network-trace-results","description":"The Utility Network Trace Results component displays the outcome of a single utility network trace, including its\nresults, an empty result, or an error.\n\nThis component displays results for the following trace result types:\n[elements](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#elements),\n[aggregated geometries](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#aggregatedGeometry),\nand [functions](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#globalFunctionResults).\n\nEach result type is displayed by a result item component. By default, this component displays the\nresult items for the result types returned by the trace. To choose which result items are displayed\nor configure their properties individually, add the\n[elements result item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/),\n[aggregated geometry result item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/), or\n[functions result item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/) to this component's default slot.\nWhen the default slot has content, the component displays the slotted content instead of the default result items.\n\n## Use in the trace analysis component's results slot\n\nBy default, the [arcgis-utility-network-trace-analysis](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/) component displays aggregated geometry,\nelements, and functions in its results tab when those result types are returned by the trace.\nYou do not need to slot a results component for this default display configuration. Only slot this component into\nthe trace analysis component's `results` slot when you want to customize the result items in the results tab:\nchoose which items are displayed, configure their properties, or add custom result items.\n\nWhen this component is slotted into the `results` slot of the trace analysis component,\nthe parent trace analysis component sets the\n[trace result](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResult),\n[trace error](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceError),\n[utility network](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#utilityNetwork), and\n[view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#view) properties.\n\nSee the [custom result items example](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#custom-result-items-example).\n\n## Use in a custom app outside the trace analysis component\n\nTo use the component outside of the trace analysis component, slot it into the default slot of\n[arcgis-utility-network-trace-results-pane](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results-pane/). This is useful in custom trace workflow applications\nthat display multiple trace results at once or configure each results component independently. Add one trace results\ncomponent for each trace result and set its properties directly. The pane provides the results container; it does\nnot run traces or synchronize the results components' properties. Your application supplies each component's\n`traceResult`, `traceError`, `utilityNetwork`, and `view` and manages clearing them.\n\nThe [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#view) property is required for elements and aggregated\ngeometry results. The [utilityNetwork](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#utilityNetwork) property is required\nto query features for elements results.\n\nSee the [multiple trace results example](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#multiple-trace-results-example).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisResultsReady** - Fires when all participating result items finish processing the current\n[traceResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResult), including when processing produces no results\nor a result item fails.\n\nCalling [clearResults()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#clearResults) during processing does not emit this\nevent.\n- **arcgisTraceResultClear** - Fires when [clearResults()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#clearResults) is called.\nReplacing or clearing [traceResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResult) directly does not emit\nthis event.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `clearResults(): void` - Clears side effects created by the result items, resets\n[state](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#state) to `\"ready\"`, and emits\n[@arcgisTraceResultClear](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#event-arcgisTraceResultClear).\n\nWhen this component is managed by [arcgis-utility-network-trace-analysis](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/), using the parent\ncomponent's clear results action also clears its synchronized\n[traceResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResult) and\n[traceError](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceError) values. Calling this method directly does not\nchange those properties; set them to `undefined` when using this component independently.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n\n### Slots\n- _default_ - Default slot for adding trace result items or custom content.\nSlotted content replaces the component's default result items.","attributes":[{"name":"aggregated-geometry-results-graphics-color","description":"The color used to render graphics for aggregated geometries in trace results, specified as a\n[Color](https://developers.arcgis.com/javascript/latest/references/core/Color/) object.\n\nAggregated geometry is only rendered if the trace configuration specifies aggregated geometry as a result type.\nThe default is yellow with 0.6 opacity.","values":[]},{"name":"aggregated-geometry-results-size","description":"The size in points used to render graphics for aggregated geometries in trace results.\n\nAggregated geometry is only rendered if the trace configuration specifies aggregated geometry as a result type.\nThe default is `12`.","values":[]},{"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-utility-network-trace-results/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disable-highlight-feature-results","description":"Whether to disable highlighting trace result features on the map.\n\nDisabling highlights does not prevent the component from querying features or affect aggregated geometry graphics.","values":[]},{"name":"expandable","description":"Whether the component can be expanded and collapsed.","values":[]},{"name":"expanded","description":"Whether the component and its contents are expanded when\n[expandable](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#expandable) is `true`.","values":[]},{"name":"heading","description":"The description displayed below the component's localized trace results heading.","values":[]},{"name":"hide-action-bar","description":"Whether to hide the action bar when viewing trace result features.\nThe action bar contains the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions).","values":[]},{"name":"hide-feature-results","description":"Whether to hide the elements result item and its features list.\n\nWhen `true`, the component displays a placeholder instead. Features are still queried and remain available from\n[traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResultFeatures). This property does not disable\nhighlighting; use [disableHighlightFeatureResults](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#disableHighlightFeatureResults) to hide\nfeature highlights.","values":[]},{"name":"hide-graphics","description":"Whether to hide the aggregated geometry [graphics](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#geometryGraphics)\nfrom the map when the trace result contains aggregated geometry results.\n\nHidden graphics remain available from the [arcgis-utility-network-trace-aggregated-geometry-result-item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/) component.","values":[]},{"name":"hide-placeholder","description":"Whether to hide the placeholder shown when feature results are hidden.\n\nWhen this property and [hideFeatureResults](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#hideFeatureResults) are both set to `true`,\nnothing is rendered for trace result elements. However, features are still queried and are available through\n[traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResultFeatures).","values":[]},{"name":"include-default-actions-disabled","description":"Whether to hide the default actions when viewing trace result features.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/"}]},{"name":"arcgis-utility-network-trace-results-pane","description":"Component used for displaying instances of [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/).\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n\n### Slots\n- _default_ - Default slot for trace result pane content.","attributes":[{"name":"hide-warnings","description":"Whether to log console errors about unexpected child elements.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results-pane/"}]},{"name":"arcgis-utility-network-validate-network-topology","description":"## Overview\n\nThe Utility Network Validate Network Topology component validates dirty areas in a utility network after edits have been made.\nIt provides an interface to choose a utility network (if applicable), choose the [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#extentToValidate) to validate, and perform validation.\nIf successful, the result of the validation is available as [result](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#result).\n\n## Validation requirements\n\n- The component only supports a 2D [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/).\n- The utility network must be [stored in the map](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#utilityNetworks) and the network topology must be enabled.\n- The active portal user must have the required user type extension to validate a network topology.\n- Validation fails in cases such as: no dirty areas in the target extent, inability to acquire a version lock, or insufficient permissions on the version.\n\n> [!WARNING]\n>\n> The Utility Network Validate Network Topology component does not support proxied feature services or feature services that utilize stored credentials.\n\n## Examples\n\nThis component can be used slotted into an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/):\n\n```html\n<arcgis-map item-id=\"471eb0bf37074b1fbb972b1da70fb310\">\n  <arcgis-utility-network-validate-network-topology slot=\"top-right\"></arcgis-utility-network-validate-network-topology>\n</arcgis-map>\n```\n\nAlternatively, this component can be used outside of a map by providing a [referenceElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#referenceElement):\n\n```html\n<calcite-shell>\n  <calcite-shell-panel slot=\"panel-start\" position=\"start\" width=\"l\">\n    <arcgis-utility-network-validate-network-topology reference-element=\"#map-element\"></arcgis-utility-network-validate-network-topology>\n  </calcite-shell-panel>\n  <arcgis-map id=\"map-element\" item-id=\"471eb0bf37074b1fbb972b1da70fb310\"></arcgis-map>\n</calcite-shell>\n```\n\n<video src=\"https://developers.arcgis.com/javascript/latest/assets/references/components/utility-network-validate-network-topology/validate-topology-example.webm\" autoplay loop muted playsInline></video>\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisValidateNetworkTopologyEnd** - Fires after a validation workflow ends.\n\nThis event fires after validation succeeds, fails, or is canceled by preventing the\n[@arcgisValidateNetworkTopologyStart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#event-arcgisValidateNetworkTopologyStart) event.\n- **arcgisValidateNetworkTopologyStart** - Fires before the validation request is sent.\n\nThis event can be prevented with `event.preventDefault()` to cancel validation.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"disable-execute-on-default-version","description":"Whether to disable execution on the Default version.\n\nIf true, the execute action button will be disabled.","values":[]},{"name":"extent-to-validate","description":"Specifies the area to validate.\n\nUse `\"current\"` to validate the current view extent. Use `\"entire\"` to validate the utility network's full extent.","values":[{"name":"current"},{"name":"entire"}]},{"name":"hide-utility-network-select","description":"When true, hides the utility network selector.\n\nThe selector is also hidden when the map has one utility network.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/"}]},{"name":"arcgis-version-management","description":"The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.\nThe [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) will update to match the features on the selected version.\nTo learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).\n\n> The Version Management component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisVersioningStateChanged**\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.","attributes":[{"name":"allow-editing-disabled","values":[]},{"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-version-management/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closable","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"page-size","description":"Specifies the number of versions displayed on each page of the Version Management component.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-version-management/"},{"name":"Version Management","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-version-management--demo&singleStory=true"}]},{"name":"arcgis-video","description":"The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid VideoLayer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n--\n\n### Events\n- **arcgisViewReadyChange**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n\n### Slots\n- _default_ - Default slot for adding components to the video. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the view. \n- **--arcgis-table-row-background-color** - _Since 5.1_ Specifies the background color for table rows. \n- **--arcgis-table-row-alt-background-color** - _Since 5.1_ Specifies the background color for alternate table rows. ","attributes":[{"name":"attribution-mode","description":"The display mode used for the attribution. Defaults to null.\n\nSet this property to \"auto\" to automatically synchronize the attribution with the nearest [Calcite mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes). If no Calcite mode is detected, the attribution defaults to light mode. **The \"auto\" mode was added in version 5.2.**\n\nSet this property to \"light\" or \"dark\" to explicitly use that mode without synchronization.","values":[{"name":"dark"},{"name":"light"}]},{"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-video/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"operational-data-visible","description":"Indicates whether map graphics from the reference map element are overlaid on the video player's content.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-video/"}]},{"name":"arcgis-video-player","description":"The Video Player component provides a user interface for interacting with a [VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\n**Known limitations**\n\n* Not supported in 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[![](https://developers.arcgis.com/javascript/latest/assets/references/components/video-player/video-player-video-preview.avif)](https://mediaspace.esri.com/media/1_ctc3psfr)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisVideoReady**\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.","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-video-player/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"following-mode","description":"Determines which telemetry elements to follow when the video layer is playing.","values":[{"name":"none"},{"name":"follow-both"},{"name":"follow-frame"},{"name":"follow-sensor"}]},{"name":"hide-header","description":"Indicates whether to display the video player's header information.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"inline","description":"Indicates whether to render the video player in inline mode.\nIn inline mode, the component uses a compact control layout without a [VideoView](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"operational-data-visible","description":"Indicates whether map graphics from the reference map element are overlaid on the video player's content.","values":[]},{"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.","values":[]},{"name":"show-fullscreen-toggle","description":"Indicates whether to display an action in the header that toggles between inline and the default fullscreen layout.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-video-player/"}]},{"name":"arcgis-view-popover","description":"The View Popover component provides view-aware placement and sizing for popovers anchored to actions inside\na map or scene view. This component is critical to enabling a great user experience with popovers\nwhen the exact placement and content of the popover is highly variable.\n\nThis component was originally added to support arcgis-sketch, which can be placed in all corners\nof the view, in multiple orientations, and with highly configurable settings contents.\n\nBecause layer lists and grid controls are included in the settings popover, it is very common for\nthe popover to overflow the view. It is equally common for the settings popover to be quite compact.\n\nProvide the popover content through the default slot and assign a [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#view),\n[anchorElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#anchorElement), and [actionBarElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#actionBarElement)\nto enable automatic positioning within the view.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"closable","description":"Indicates whether the popover includes a close action in the header.","values":[]},{"name":"heading","description":"The popover heading.","values":[]},{"name":"label","description":"Accessible label for the popover.","values":[]},{"name":"max-content-width","description":"Maximum content width, in pixels, applied to the slotted popover content.","values":[]},{"name":"min-content-width","description":"Minimum content width, in pixels, applied to the slotted popover content.","values":[]},{"name":"open","description":"Indicates whether the popover is open.\n\nListen for [@arcgisPropertyChange](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#event-arcgisPropertyChange) to react to user-driven close actions.","values":[]},{"name":"tail-attachment-appearance","description":"Controls whether the popover appears attached to the action itself or to the containing action bar.","values":[{"name":"action"},{"name":"bar"}]},{"name":"view-edge-margin","description":"Minimum inset, in pixels, between the popover and the edges of the view.\nThe bottom edge will be relative to the attribution bar, if it is visible.","values":[]},{"name":"visual-scale","description":"Visual scale for the popover; this applies only to the header and close button.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/"}]},{"name":"arcgis-volume-measurement","description":"The Volume Measurement component is currently [in preview](https://support.esri.com/en-us/knowledge-base/faq-what-is-preview-000036425).\n\nThe Volume Measurement component can be added to a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) to\ncalculate and visualize the volume of ground surfaces within a defined polygonal area.\n\n![measurement-volume](https://developers.arcgis.com/javascript/latest/assets/references/components/volume-measurement/volume_measurement_poster.avif)\n\nThe Volume Measurement component offers multiple volume measurement modes:\n\n- **Cut & Fill Volume**: Computes cut and fill volumes relative to a flat, horizontal surface defined by the input\npolygon. Ideal for estimating the amount of material to remove or add to level terrain for construction.\n\n- **Stockpile Volume**: Calculates cut and fill volumes against a surface approximated from the polygon's coordinates.\nUseful for estimating the volume of temporary ground features such as piles of material, mounds or depressions.\n\nThe analysis depends on the scene's spatial reference, and the length of the measured perimeter:\n\n- In **Projected Coordinate Systems (PCS)**, apart from Web Mercator used in **local** viewing mode, there is no limit\nto the measurement's perimeter, making it the recommended setup for analysis as accuracy is not compromised.\n\n- In **Web Mercator PCS** used in **local** viewing mode, if the measurement's perimeter exceeds 10 km, the analysis is considered invalid due to potential accuracy issues.\n\n- In **Geographic Coordinate Systems (GCS)** and **Web Mercator** in **global** viewing mode, if the measurement's perimeter exceeds 50 km, the analysis is considered invalid due to potential accuracy issues.\n\n\n**Known Limitations**\n\n-  The Volume Measurement component can only be added to a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n- The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.\n- If the view is too close or too far from the measurement polygon, the results will not be computed due to LOD-induced inaccuracies.\n- The elevation of the target surface in the \"Cut & Fill Volume\" mode is restricted to the range of -11 km and +9 km.\n- This tool operates only on the non-transparent [Map.ground](https://developers.arcgis.com/javascript/latest/references/core/Map/#ground),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/IntegratedMeshLayer/)\nand an [IntegratedMesh3DTilesLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/IntegratedMesh3DTilesLayer/).\n- This tool does not support WGS 1984 spatial reference in a local\n[viewing mode](https://developers.arcgis.com/javascript/latest/references/core/webscene/InitialViewProperties/#viewingMode).\n- The cut-fill elevation tooltip remains enabled independently of\n[ViewOptions.tooltips](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#tooltips).\nIts display and input units can still inherit options on the view.\n\n**Things to consider**\n\n- In \"Cut & Fill Volume\" mode, you can hover over the shift manipulator, press `Tab` to enable tooltip input,\nand enter the target surface elevation.\n- Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n- Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/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- [Volume Measurement Analysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurementAnalysis/)\n- [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurementAnalysisView3D/)\n- [VolumeMeasurementResult](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurement/VolumeMeasurementResult/)\n- [VolumeMeasurementDisplayUnits](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurement/VolumeMeasurementDisplayUnits/)\nand [VolumeMeasurementInputUnits](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurement/VolumeMeasurementInputUnits/)\n- [VolumeMeasurementError](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurement/VolumeMeasurementError/)\n- [Sample - Volume measurement analysis object](https://developers.arcgis.com/javascript/latest/sample-code/analysis-volume-measurement/)\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 for user interaction.\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.","attributes":[{"name":"area-display-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the area. Possible values are listed in\n[areaDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnitOptions).\n\nWhen no area unit is explicitly set on the component or its analysis, this property uses the area unit configured in the view through\n[view.options.displayUnits.area](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [areaDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the area unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"metric"},{"name":"imperial"},{"name":"square-inches"},{"name":"square-feet"},{"name":"square-yards"},{"name":"square-miles"},{"name":"square-nautical-miles"},{"name":"square-us-feet"},{"name":"square-millimeters"},{"name":"square-centimeters"},{"name":"square-decimeters"},{"name":"square-meters"},{"name":"square-kilometers"},{"name":"acres"},{"name":"ares"},{"name":"hectares"}]},{"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-volume-measurement/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"elevation-display-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the cut and fill target elevation. Possible values are listed in\n[elevationDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnitOptions).\n\nWhen no elevation unit is explicitly set on the component or its analysis, this property uses the vertical length unit configured in the view through\n[view.options.displayUnits.verticalLength](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [elevationDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the elevation unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]},{"name":"elevation-input-unit","description":"Unit used for inputting the cut and fill target elevation.\nPossible values are listed in [elevationInputUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationInputUnitOptions).\n\nThis controls which unit is used when entering an elevation value via the tool's UI (for example, using the\nshift manipulator tooltip input in \"Cut & Fill Volume\" mode).\n\nWhen no elevation input unit is explicitly set on the component or its analysis, this property uses the vertical length input unit configured in the view through\n[view.options.inputUnits.verticalLength](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits).\nThe `metric` and `imperial` measurement systems resolve to `meters` and `feet`, respectively.\nIf that option is unset or its resolved unit is unavailable in [elevationInputUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationInputUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the elevation input unit on this component's analysis without changing the units configured in the view.\nChanging this property preserves the target surface elevation.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior while preserving the target surface elevation.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"}]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-area-display-unit-select","description":"If true, the area display unit dropdown will be hidden.","values":[]},{"name":"hide-elevation-display-unit-select","description":"If true, the elevation display unit dropdown will be hidden.","values":[]},{"name":"hide-elevation-input-unit-select","description":"If true, the elevation input unit dropdown will be hidden.","values":[]},{"name":"hide-header","description":"If true, the header will be hidden.","values":[]},{"name":"hide-mode-select","description":"If true, the mode selection dropdown will be hidden.","values":[]},{"name":"hide-perimeter-display-unit-select","description":"If true, the perimeter display unit dropdown will be hidden.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-settings-button","description":"If true, the settings button that opens the settings popover will be hidden.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"hide-volume-display-unit-select","description":"If true, the volume display unit dropdown will be hidden.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"mode","description":"Specifies the analysis' desired measurement type.","values":[{"name":"cut-fill"},{"name":"stockpile"}]},{"name":"perimeter-display-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the perimeter values. Possible values are\nlisted in [perimeterDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnitOptions).\n\nWhen no perimeter unit is explicitly set on the component or its analysis, this property uses the length unit configured in the view through\n[view.options.displayUnits.length](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [perimeterDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the perimeter unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]},{"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.","values":[]},{"name":"volume-display-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the volume values. Possible values are listed in\n[volumeDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnitOptions).\n\nWhen no volume unit is explicitly set on the component or its analysis, this property uses the volume unit configured in the view through\n[view.options.displayUnits.volume](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [volumeDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the volume unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"metric"},{"name":"imperial"},{"name":"cubic-inches"},{"name":"cubic-feet"},{"name":"cubic-yards"},{"name":"cubic-miles"},{"name":"cubic-us-feet"},{"name":"liters"},{"name":"megaliters"},{"name":"gigaliters"},{"name":"cubic-millimeters"},{"name":"cubic-centimeters"},{"name":"cubic-decimeters"},{"name":"cubic-meters"},{"name":"cubic-kilometers"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/"},{"name":"Volume Measurement","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-volume-measurement--demo&singleStory=true"}]},{"name":"arcgis-weather","description":"The Weather component allows easy selection and configuration of weather effects in a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\nThe available weather types are:\n[sunny](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunnyWeather/),\n[cloudy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/CloudyWeather/),\n[rainy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/RainyWeather/),\n[snowy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SnowyWeather/), and\n[foggy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/FoggyWeather/).\n\nTo set the weather programmatically, apply the desired weather type to the\n[arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment) property of the Scene component.\n\n```js\n// Access the Scene component.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// Specify the weather settings.\nviewElement.environment.weather = {\n   type: \"rainy\", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })\n   cloudCover: 0.7,\n   precipitation: 0.3\n};\n```\n\nTo determine if the weather visualization is available, check the boolean value of `viewElement.environment.weatherAvailable`. The weather is only available:\n   * in `global` [arcgis-scene.viewingMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#viewingMode),\n   * when `atmosphereEnabled` property on [arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment) is `true`,\n   * at lower altitudes, near the ground.\n\n**Known limitations**\n\nWeather is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunnyWeather/)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/CloudyWeather/)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/RainyWeather/)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SnowyWeather/)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/FoggyWeather/)\n- [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-weather/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the title of the component. By default, this message is rendered as a level 4\nheading (e.g. `<h4>Time range</h4>`). Depending on the component's placement in your app, you may need to adjust\nthis heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-header","description":"Whether to hide the component's header.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-weather/"},{"name":"Weather","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-weather--demo&singleStory=true"}]},{"name":"arcgis-zoom","description":"The Zoom component allows users to zoom in/out within a map or scene.\n--\n\n### Events\n- **arcgisActionZoom** - Emitted when one of the zoom controls is activated.\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 for user interaction.\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.\n- `zoomIn(): Promise<void>` - Zooms the view in by an LOD factor of 0.5.\n- `zoomOut(): Promise<void>` - Zooms the view out by an LOD factor of 2.","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-zoom/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layout","description":"Determines the layout/orientation of the Zoom component.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"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.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-zoom/"},{"name":"Zoom","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-zoom--demo&singleStory=true"}]}]}
+{"$schema":"https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json","version":1.1,"tags":[{"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 for user interaction.\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.","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.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"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-2d/#unitOptions).\n\nWhen no unit is explicitly set on the component or its analysis, this property uses the area unit configured in the view through\n[view.options.displayUnits.area](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#unitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the area unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"metric"},{"name":"imperial"},{"name":"square-inches"},{"name":"square-feet"},{"name":"square-yards"},{"name":"square-miles"},{"name":"square-nautical-miles"},{"name":"square-us-feet"},{"name":"square-millimeters"},{"name":"square-centimeters"},{"name":"square-decimeters"},{"name":"square-meters"},{"name":"square-kilometers"},{"name":"acres"},{"name":"ares"},{"name":"hectares"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/"},{"name":"Area Measurement 2D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-area-measurement-2d--demo&singleStory=true"}]},{"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[![measurement-area-3d](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/3D_AreaMeasurement_widget.avif)](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![area-measurement-3d-types](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/area-measurement-3d-types.avif)\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 for user interaction.\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.","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.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"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).\n\nWhen no unit is explicitly set on the component or its analysis, this property uses the area unit configured in the view through\n[view.options.displayUnits.area](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#unitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the area unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"metric"},{"name":"imperial"},{"name":"square-inches"},{"name":"square-feet"},{"name":"square-yards"},{"name":"square-miles"},{"name":"square-nautical-miles"},{"name":"square-us-feet"},{"name":"square-millimeters"},{"name":"square-centimeters"},{"name":"square-decimeters"},{"name":"square-meters"},{"name":"square-kilometers"},{"name":"acres"},{"name":"ares"},{"name":"hectares"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/"},{"name":"Area Measurement 3D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-area-measurement-3d--demo&singleStory=true"}]},{"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 for user interaction.\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.","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.","values":[]},{"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 support [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. |","values":[{"name":"list"},{"name":"auto"},{"name":"preview"},{"name":"carousel"}]},{"name":"hide-add-button","description":"Indicates whether to hide the `Add` button which prompts the dialog to add a new attachment.","values":[]},{"name":"hide-add-submit-button","description":"Indicates whether to hide the `add` button after selecting the attachment to add.","values":[]},{"name":"hide-cancel-add-button","description":"Indicates whether to hide the `cancel` button after selecting the attachment to add.","values":[]},{"name":"hide-cancel-update-button","description":"Indicates whether to hide the `cancel` button after selecting an attachment to update an existing attachment.","values":[]},{"name":"hide-delete-button","description":"Indicates whether to hide the `delete` button to delete an existing attachment.","values":[]},{"name":"hide-error-message","description":"Indicates whether to hide an error message if adding or updating an attachment results in errors.","values":[]},{"name":"hide-progress-bar","description":"Indicates whether to hide a progress bar when adding an attachment.","values":[]},{"name":"hide-update-button","description":"Indicates whether to hide an `update` button to allow updating of existing attachments.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachments/"}]},{"name":"arcgis-basemap-gallery","description":"The Basemap Gallery component displays a collection of 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 for user interaction.\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.","attributes":[{"name":"active-basemap","description":"The map's current [basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap).","values":[]},{"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.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"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).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/"},{"name":"Basemap Gallery","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-basemap-gallery--demo&singleStory=true"}]},{"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> [!WARNING]\n> In version 6.0, the implementation of [arcgis-basemap-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/) will be updated under the hood to that of [arcgis-basemap-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/), and the way events for [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#catalogLayerList) are handled will change. We encourage using the [arcgis-basemap-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/) component and providing feedback.\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 for user interaction.\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.","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.","values":[]},{"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.","values":[]},{"name":"basemap-title","description":"The current basemap's title.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","values":[]},{"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.","values":[]},{"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.","values":[]},{"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.","values":[]},{"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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-base-layers","description":"Indicates whether the base layers will be displayed.","values":[]},{"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).","values":[]},{"name":"hide-reference-layers","description":"Indicates whether to the reference layers will be displayed.","values":[]},{"name":"hide-status-indicators","description":"Indicates whether the status indicators will be displayed.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"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.","values":[]},{"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.","values":[]},{"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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"Indicates whether to display a close button in the header.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to display a collapse button in the header.","values":[]},{"name":"show-edit-title-button","description":"Indicates whether to display a button in the header to edit the basemap title.","values":[]},{"name":"show-errors","description":"Indicates whether to display layers with load errors.","values":[]},{"name":"show-filter","description":"Indicates whether to display a filter input box when the 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.","values":[]},{"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.","values":[]},{"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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-checkbox.avif) |","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/"},{"name":"Basemap Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-basemap-layer-list--demo&singleStory=true"}]},{"name":"arcgis-basemap-layer-list-next","description":"> [!WARNING]\n> The Basemap Layer List (next) component is the successor to the Basemap Layer List component, provided to you early for testing and feedback.\nIn version 6.0, the implementation of [arcgis-basemap-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/) will be updated under the hood to that of [arcgis-basemap-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/),\nand this component will be removed. There is a breaking change in the name of the events for [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#catalogLayerList) compared to the [arcgis-basemap-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/).\nTo update at version 6.0, simply remove `-next` from the component name.\n\nThe Basemap Layer List (next) 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.\n[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.\n--\n\n### Events\n- **arcgisBaseFilterChange** - Emitted when the value of the [baseFilterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#baseFilterText) changes.\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisOpenedLayersChange** - Emitted when the collection of [openedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#openedLayers) changes.\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 for user interaction.\n- **arcgisReferenceFilterChange** - Emitted when the value of the [referenceFilterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#referenceFilterText) changes.\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.","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-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"base-filter-text","description":"The value of the [base layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#baseLayers)\nfilter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#showFilter) is true.","values":[]},{"name":"basemap-title","description":"The current basemap's title.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed. When collapsed, only the collapse button and heading are displayed.","values":[]},{"name":"drag-enabled","description":"Indicates whether [items](https://developers.arcgis.com/javascript/latest/references/core/layerList/Item/) may be reordered within the list by dragging and dropping. MapImageLayer [MapImageLayer#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.","values":[]},{"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.","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input when filtering is enabled.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-base-layers","description":"This property provides the ability to show or hide the\n[base layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#baseLayers).","values":[]},{"name":"hide-catalog-layer-list","description":"Indicates whether to hide the catalog layer list in the component.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's heading.","values":[]},{"name":"hide-no-filter-results-notice","description":"Indicates whether to hide the notice that appears when no results are found after filtering.","values":[]},{"name":"hide-no-items-notice","description":"Indicates whether to hide the notice that appears when there are no items to display.","values":[]},{"name":"hide-reference-layers","description":"This property provides the ability to show or hide the\n[reference layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#referenceLayers).","values":[]},{"name":"hide-status-indicators","description":"Indicates whether to hide status indicators in the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"list-mode-disabled","description":"Specifies whether to ignore the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property to display all layers. A common use case for `listModeDisabled` is when you want to use the component to manage and configure a layer's `listMode` value.","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the filter input box.","values":[]},{"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.","values":[]},{"name":"reference-filter-text","description":"The value of the [reference layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#referenceLayers)\nfilter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#showFilter) is true.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode. Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-edit-title-button","description":"This property provides the ability to show or hide the edit title button in the header.","values":[]},{"name":"show-errors","description":"This property provides the ability to show or hide layer error indicators.","values":[]},{"name":"show-filter","description":"This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-temporary-layer-indicators","description":"This property provides the ability to show or hide the temporary layer indicators 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.","values":[]},{"name":"visibility-appearance","description":"Determines the icons used to indicate visibility.\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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/basemap-layer-list/visibilityAppearance-checkbox.avif) |\n","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list-next/"},{"name":"Basemap Layer List Next","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-basemap-layer-list-next--demo&singleStory=true"}]},{"name":"arcgis-basemap-toggle","description":"The Basemap Toggle component allows an end-user to switch between two basemaps.\n\nThe basemaps can have different spatial references.\n\nStarting at 5.2, when the `activeBasemap` changes, the selected basemap is announced to assistive technologies.\nVisit the [Accessibility guide](https://developers.arcgis.com/javascript/latest/accessibility/#assistive-technologies) to learn more about live announcements supporting more audiences.\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 for user interaction.\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.\n- `toggle(): Promise<any>` - Toggles to the [nextBasemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/#nextBasemap).","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-toggle/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"next-basemap","description":"The next basemap for toggling.","values":[]},{"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.","values":[]},{"name":"show-title","description":"Indicates if the Basemap title is displayed.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/"},{"name":"Basemap Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-basemap-toggle--demo&singleStory=true"}]},{"name":"arcgis-bookmarks","description":"The Bookmarks component allows end users to quickly navigate to a particular area of interest.\nIt displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/),\nwhich are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks).\n\nEach bookmark may contain the following properties: `name`, `thumbnail`, `viewpoint` (defines rotation, scale, and target geometry), and `timeExtent`.\nWhen a bookmark with a timeExtent is selected, the [arcgis-map.timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeExtent) of the Map will be set to the timeExtent of the selected bookmark.\nTo disable time capability in the Bookmarks component, set [timeDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#timeDisabled) to `true`.\n\nStarting with version `5.1`, on [@arcgisBookmarkSelect](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#event-arcgisBookmarkSelect) the selected bookmark's name is announced to assistive technologies. Visit the [Accessibility guide](https://developers.arcgis.com/javascript/latest/accessibility/#assistive-technologies) to learn more\nabout live announcements supporting more audiences.\n\nThe Bookmarks component can be used to create, edit, reorder, and delete bookmarks.\nTo enable these features, set the following properties to `true`:\n[showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showAddBookmarkButton), [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showEditBookmarkButton), and [dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#dragEnabled).\n\n**Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) only if they come from a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks) or are provided manually from [bookmarks](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#bookmarks). [Presentation](https://developers.arcgis.com/javascript/latest/references/core/webscene/Presentation/) provides a similar experience for [WebScenes](https://developers.arcgis.com/javascript/latest/references/core/webscene/Presentation/).\n--\n\n### Events\n- **arcgisBookmarkEdit** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/) is edited.\n- **arcgisBookmarkSelect** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/) is selected.\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 for user interaction.\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.\n- `goTo(bookmark: Bookmark): Promise<void>` - Zoom to a specific bookmark.","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-bookmarks/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"bookmarks","description":"A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/)s. These are typically defined inside of a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks), but can also be defined manually, as shown in the code snippet below.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"drag-enabled","description":"Indicates if a Bookmark is able to be dragged in order to update its position in the list.","values":[]},{"name":"filter-placeholder","description":"Defines the text used as a placeholder when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showFilter) is set to `true`.","values":[]},{"name":"filter-text","description":"Defines the text used to filter the bookmarks when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showFilter) is set to `true`.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the message \"No bookmarks\" when no bookmarks\nare available. By default, this message is rendered\nas a level 2 heading (e.g. `<h2>No bookmarks</h2>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-thumbnail","description":"Indicates whether the thumbnail associated with the bookmark is hidden.","values":[]},{"name":"hide-time","description":"Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-add-bookmark-button","description":"Indicates whether to display the button to add a new bookmark.","values":[]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-edit-bookmark-button","description":"Indicates whether to display the button to edit a bookmark.","values":[]},{"name":"show-filter","description":"Indicates whether to display the bookmark filter.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]},{"name":"time-disabled","description":"Indicates whether to disable the time capability of the Bookmarks component.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/"},{"name":"Bookmarks","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-bookmarks--demo&singleStory=true"}]},{"name":"arcgis-building-explorer","description":"The Building Explorer component is used to filter and explore the various building elements of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of building elements grouped in sublayers. Using the Building Explorer component, buildings can be filtered by [level](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#level), [phase](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#phase) or by disciplines and categories.\nThe visibility of these elements can be configured using the component's [hideLevels](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hideLevels), [hidePhases](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hidePhases) and [hideDisciplines](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hideDisciplines) properties.\n\n[![building-explorer](https://developers.arcgis.com/javascript/latest/assets/references/components/building-explorer/building-explorer.avif)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-filter/)\n\nThe [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) to be explored have to be set on the [layers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#layers) property of the component. When setting multiple layers, the filters set by the Building Explorer component will be applied on all layers. The component doesn't allow the user to select between multiple layers present in a scene.\n\nOften, [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) contain an _Overview_ [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingComponentSublayer/) that serves as an exterior shell and views the building model as a single feature. When a layer is added to the Building Explorer component, the visibility of the _Overview_ layer is turned off, so that the user can directly interact with the individual features in the _Full Model_ [BuildingGroupSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingGroupSublayer/).\n\nThe Level element of the Building Explorer component allows users to select a single level in one or several buildings. When selecting a level, the levels above it are hidden and the levels below it become semi-transparent for added visual context.\n\nSome [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) include information indicating the phase in which building elements, such as doors or pipes, were created and, optionally, when they were demolished. If a layer has multiple construction phases, these will be displayed in the Construction phases element. When selecting a construction phase, all the building elements created during or before the phase are selected. Demolished building elements aren't displayed.\n\nDiscipline layers are [group layers](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingGroupSublayer/) that organize the [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) content into architectural, structural, mechanical, or electrical groups. These layers contain a number of Category layers such as walls, windows, furniture, and lighting fixtures. These layers can be turned on and off in the Disciplines and Categories list.\n\nThe Building Explorer component can only display filters set by the component itself. Filters set by other applications will be ignored.\n\n**Known limitations**\n\nBuilding Explorer is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [Sample - Filter BuildingSceneLayer with Building Explorer](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-filter/)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)\n--\n\n### Events\n- **arcgisBuildingLevelChange** - Emitted when the user changes the selected building level, or when a new filter instance is loaded.\n- **arcgisBuildingPhaseChange** - Emitted when the user changes the selected construction phase, or when a new filter instance is loaded.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-building-explorer/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-disciplines","description":"If true, the disciplines tree will be hidden.","values":[]},{"name":"hide-level-heading","description":"If true, the Level heading will be hidden without hiding the levels filter.\nTo hide the entire filter, use [hideLevels](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hideLevels).","values":[]},{"name":"hide-levels","description":"If true, the levels filter will be hidden.\nThe filter is also hidden when fewer than two levels are available.","values":[]},{"name":"hide-phases","description":"If true, the phases filter will be hidden.\nThe filter is also hidden when fewer than two phases are available.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"level","description":"The currently selected value for the building level filter.","values":[]},{"name":"phase","description":"The currently selected value for the construction phase filter.\nConstruction phases are used to track site development for a [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/). Setting a construction phase in the Building Explorer selects everything in the layer which is already constructed at that phase (created phase <= selected phase) but not yet demolished (demolished phase > selected phase). The goal is to display what the building or construction site looks like at that selected phase.","values":[]},{"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.","values":[]},{"name":"toggle-siblings-visibility","description":"If true, Ctrl-clicking or Command-clicking a discipline or category checkbox\nalso toggles its siblings, matching the BuildingExplorer widget.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/"},{"name":"Building Explorer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-building-explorer--demo&singleStory=true"}]},{"name":"arcgis-catalog-layer-list","description":"The Catalog Layer List provides a way to display and interact with [CatalogLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/).\nThe component displays a list of layers in the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer)\nand allows you to toggle their visibility.\n\nThe [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.\n\n> [!WARNING]\n> In version 6.0, the implementation of [arcgis-catalog-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/) will be updated under the hood to that of [arcgis-catalog-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/). We encourage using the [arcgis-catalog-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/) component and providing feedback.\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 for user interaction.\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.","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-catalog-layer-list/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and the heading are displayed.","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter) is true.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component.\nBy default, the heading is rendered as a level 2 heading (e.g., `<h2>Catalog Layer List</h2>`).\nDepending on the component's placement in your app, you may need to adjust this heading for proper semantics.\nThis is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-status-indicators","description":"Indicates whether the status indicators will be displayed.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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-catalog-layer-list/#showFilter) input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"Indicates whether to display a close button in the header.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to display a collapse button in the header.","values":[]},{"name":"show-errors","description":"Indicates whether to display layers with load errors.","values":[]},{"name":"show-filter","description":"Indicates whether to display a filter input box when the number of list items is equal to or greater than the value set in [CatalogLayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"Indicates whether to display the component's heading. The heading text is \"Layer List\". The heading level can be set with the [CatalogLayerList#headingLevel](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#headingLevel).","values":[]},{"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.","values":[]},{"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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-checkbox.avif) |","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/"},{"name":"Catalog Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-catalog-layer-list--demo&singleStory=true"}]},{"name":"arcgis-catalog-layer-list-next","description":"> [!WARNING]\n> The Catalog Layer List (next) component is the successor to the Catalog Layer List component, provided to you early for testing and feedback.\nIn version 6.0, the implementation of [arcgis-catalog-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/) will be updated under the hood to that of [arcgis-catalog-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/),\nand this component will be removed. To update at version 6.0, simply remove `-next` from the component name.\n\nThe Catalog Layer List provides a way to display and interact with [CatalogLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/).\nThe component displays a list of layers in the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer)\nand allows you to toggle their visibility.\n\nThe [Item](https://developers.arcgis.com/javascript/latest/references/core/layerList/Item/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.\n--\n\n### Events\n- **arcgisCatalogItemsChange** - Emitted when the [catalogItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#catalogItems) changes.\n- **arcgisFilterChange** - Emitted when the value of the [filterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#filterText) input changes.\n- **arcgisOpenedLayersChange** - Emitted when the collection of [openedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#openedLayers) changes.\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 for user interaction.\n- **arcgisSelectedItemsChange** - Emitted when the collection of [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#selectedItems) changes.\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.","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-catalog-layer-list-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed. When collapsed, only the collapse button and heading are displayed.","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input when filtering is enabled.","values":[]},{"name":"filter-text","description":"The value of the filter input text string when filtering is enabled.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-catalog-layer-list","description":"Indicates whether to hide the catalog layer list in the component.","values":[]},{"name":"hide-no-filter-results-notice","description":"Indicates whether to hide the notice that appears when no results are found after filtering.","values":[]},{"name":"hide-no-items-notice","description":"Indicates whether to hide the notice that appears when there are no items to display.","values":[]},{"name":"hide-status-indicators","description":"Indicates whether to hide status indicators in the component.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"list-mode-disabled","description":"Specifies whether to ignore the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property to display all layers. A common use case for `listModeDisabled` is when you want to use the component to manage and configure a layer's `listMode` value.","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the filter input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode. Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#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. |","values":[{"name":"multiple"},{"name":"none"},{"name":"single-persist"},{"name":"single"}]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-errors","description":"This property provides the ability to show or hide layer error indicators.","values":[]},{"name":"show-filter","description":"This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]},{"name":"show-temporary-layer-indicators","description":"This property provides the ability to show or hide the temporary layer indicators 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.","values":[]},{"name":"top-layer-disabled","values":[]},{"name":"visibility-appearance","description":"Determines the icons used to indicate visibility.\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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-checkbox.avif) |\n","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list-next/"},{"name":"Catalog Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-catalog-layer-list-next--demo&singleStory=true"}]},{"name":"arcgis-compass","description":"The Compass component indicates where north is in relation to the current view [rotation](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/references/core/Camera/#heading).\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 for user interaction.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>`\n- `reset(): 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-compass/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon displayed in the component's button.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-compass/"},{"name":"Compass","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-compass--demo&singleStory=true"}]},{"name":"arcgis-coordinate-conversion","description":"> [!NOTE]\n> In version 6.0, the implementation of [arcgis-coordinate-conversion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/) will be updated under the hood to that of [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/) , and deprecated properties on this component will be removed. We encourage using the [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/) component and providing feedback.\n\nThe Coordinate Conversion component provides a way to display user cursor position either as map coordinates or\nas any of several popular coordinate notations.  Additionally, the component provides a way to convert\nuser input coordinates into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).\n\n\nSeveral common formats are included by default:\n* XY - Longitude, Latitude (WGS84)\n* MGRS - [Military Grid Reference System](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#mgrs)\n* UTM - [Universal Transverse Mercator](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#utm)\n* DD - Decimal Degrees\n* DDM - Degrees Decimal Minutes\n* DMS - Degrees Minutes Seconds\n* Basemap - X, Y in the coordinate system used by the current basemap in the units used by the basemap.\nWeb Mercator is the standard for Esri-provided basemaps.\n\nAdditional formats can be created by a developer and made available\nthrough the component\n--\n\n### Events\n- **arcgisConversionChange** - Emitted when a conversion is added or removed, or when the order of conversions changes.\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 for user interaction.\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.\n- `reverseConvert(coordinate: string, format: Format): Promise<Point | null | undefined>` - Attempt to convert a string into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).  The format of the\nstring must be specified.  A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of available formats can be\nobtained from the [formats](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/#formats) property.","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-coordinate-conversion/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the coordinate input and coordinate settings headings. By default,\nthese headings are rendered as level 4 headings (e.g. `<h4>Input coordinate</h4>`). Depending on the coordinate conversion component's\nplacement in your app, you may need to adjust this heading for proper semantics. This is important for meeting\naccessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"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).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.","values":[]},{"name":"ignore-coordinate-precision","description":"If false, the component will estimate coordinate precision based on the current state of the\nview. As the view is zoomed farther out, fewer decimal places will be shown. Only affects `DD`,\n`DDM`, `DMS`, and `XY` formats.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"mode","description":"Describes the current mode of the component.\n\n* While in `live` mode, the component will update as the cursor moves.\n* While in `capture` mode, the component will update on mouse click and display a graphic\nmarking the current location.","values":[{"name":"capture"},{"name":"live"},{"name":"idle"}]},{"name":"multiple-conversions-disabled","description":"If this property is set to `true`, multiple conversions will be disabled, and only a single conversion will be displayed. Otherwise, multiple conversions will be shown.","values":[]},{"name":"orientation","description":"Determines whether the component should expand up or down.  If set to `auto`,\nthe component will be oriented based on its position in the view.","values":[{"name":"auto"},{"name":"expand-down"},{"name":"expand-up"}]},{"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.","values":[]},{"name":"remove-leading-zeros","description":"Determines whether leading zeros will be shown in `DD`, `DDM`, and `DMS` formats.\nWhen false: 01.37°N, 008.71°E\nWhen true: 1.37°N, 8.71°E","values":[]},{"name":"storage-disabled","description":"If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/references/core/widgets/CoordinateConversion/#storageType))\nwill not be used to hydrate and persist the component's state.","values":[]},{"name":"storage-type","description":"This property determines whether sessionStorage or localStorage will be used to store component's state.","values":[{"name":"local"},{"name":"session"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/"},{"name":"Coordinate Conversion","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-coordinate-conversion--demo&singleStory=true"}]},{"name":"arcgis-coordinate-conversion-next","description":"> [!WARNING]\n> The Coordinate Conversion (next) component is the successor to the [arcgis-coordinate-conversion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/) component, provided to you for early testing and feedback.\n> It provides a more consistent design and improved user experience.\n> In version 6.0, the implementation of [arcgis-coordinate-conversion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/) will be updated under the hood to that of [arcgis-coordinate-conversion-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/) and this component will be removed.\n> To update at version 6.0, simply remove `-next` from the component name.\n\nThe Coordinate Conversion component provides a way to display user cursor position either as map coordinates or\nas any of several popular coordinate notations.  Additionally, the component provides a way to convert\nuser input coordinates into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).\n\n\nSeveral common formats are included by default:\n* XY - Longitude, Latitude (WGS84)\n* MGRS - [Military Grid Reference System](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#mgrs)\n* UTM - [Universal Transverse Mercator](https://earth-info.nga.mil/index.php?dir=coordsys&action=coordsys#utm)\n* DD - Decimal Degrees\n* DDM - Degrees Decimal Minutes\n* DMS - Degrees Minutes Seconds\n* Basemap - X, Y in the coordinate system used by the current basemap in the units used by the basemap.\nWeb Mercator is the standard for Esri-provided basemaps.\n\nAdditional formats can be created by a developer and made available\nthrough the component\n--\n\n### Events\n- **arcgisConversionChange** - Emitted when a conversion is added or removed, or when the order of conversions changes.\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 for user interaction.\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.\n- `reverseConvert(coordinate: string, format: Format): Promise<Point | null | undefined>` - Attempt to convert a string into a [point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).  The format of the\nstring must be specified.  A [collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of available formats can be\nobtained from the [arcgis-coordinate-conversion.formats](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion/#formats) property.","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-coordinate-conversion-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the coordinate input and coordinate settings headings. By default,\nthese headings are rendered as level 4 headings (e.g. `<h4>Input coordinate</h4>`). Depending on the coordinate conversion component's\nplacement in your app, you may need to adjust this heading for proper semantics. This is important for meeting\naccessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-capture-section","description":"Determines whether the capture section will be shown in the component. If `true`, the capture section will be hidden.","values":[]},{"name":"hide-input-section","description":"Determines whether the input section will be shown in the component. If `true`, the input section will be hidden.","values":[]},{"name":"hide-settings-button","description":"Determines whether the settings button will be shown in the component. If `true`, the settings button will be hidden.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.","values":[]},{"name":"ignore-coordinate-precision","description":"If false, the component will estimate coordinate precision based on the current state of the\nview. As the view is zoomed farther out, fewer decimal places will be shown. Only affects `DD`,\n`DDM`, `DMS`, and `XY` formats.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"mode","description":"Describes the current mode of the component.\n\n* While in `live` mode, the component will update as the cursor moves.\n* While in `capture` mode, the component will update on mouse click and display a graphic\nmarking the current location.\n* While in `idle` mode, the component will not update based on cursor movement or mouse clicks.\nThis mode can be used to \"pause\" the component without losing the current location.","values":[{"name":"capture"},{"name":"live"},{"name":"idle"}]},{"name":"multiple-conversions-disabled","description":"If this property is set to `true`, multiple conversions will be disabled, and only a single conversion will be displayed. Otherwise, multiple conversions will be shown.","values":[]},{"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.","values":[]},{"name":"remove-leading-zeros","description":"Determines whether leading zeros will be shown in `DD`, `DDM`, and `DMS` formats.\nWhen false: 01.37°N, 008.71°E\nWhen true: 1.37°N, 8.71°E","values":[]},{"name":"show-elevation","description":"Determines whether the elevation of the current location will be shown. Only applicable when the view is a SceneView.","values":[]},{"name":"storage-disabled","description":"If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/references/core/widgets/CoordinateConversion/#storageType))\nwill not be used to hydrate and persist the component's state.","values":[]},{"name":"storage-type","description":"This property determines whether sessionStorage or localStorage will be used to store component's state.","values":[{"name":"local"},{"name":"session"}]},{"name":"vertical-unit","description":"Indicates the vertical unit to use when displaying elevation.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"}]},{"name":"visual-scale","description":"Determines the component's scale. Options are small (\"s\"), medium (\"m\"), and large (\"l\").","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-coordinate-conversion-next/"},{"name":"Coordinate Conversion Next","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-coordinate-conversion-next--main-demo&singleStory=true"},{"name":"Single conversion only","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-coordinate-conversion-next--single-conversion-demo&singleStory=true"},{"name":"Minimal configuration","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-coordinate-conversion-next--minimal-demo&singleStory=true"}]},{"name":"arcgis-daylight","description":"The Daylight component can be used to manipulate the lighting conditions of an\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\nTo achieve this, the component modifies the `lighting` property of the\n[arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment) of the Scene component.\n\nTo illuminate the scene, one can either use a configuration of date and time to position the\n[sun](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/) or switch to the\n[virtual](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/VirtualLighting/) mode,\nwhere the light source is relative to the camera.\n\nWhen illuminating the scene with **[sunlight](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/)**\nand adjusting the time and date, the positions of the sun and stars are updated accordingly. This also updates the\n[date](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/#date) property of\n[arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment).\n\n**How date, time, and timezone work**\n\nIn sunlight mode, `SunLighting.date` is the source of truth for the scene lighting instant. The daylight component's\n`utcOffset` controls how that instant is displayed (date and slider time) and how user-entered local values are\nconverted back to UTC.\n\nThis means changing only [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#utcOffset) updates the displayed local date/time but\npreserves the same lighting instant. Changing [localDate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#localDate) and/or\n[timeSliderPosition](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#timeSliderPosition) writes a new `SunLighting.date` instant.\n\n> [!IMPORTANT]\n>\n> Daylight does not use [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone). Changing the scene's time zone does not update the\n> date and time shown in Daylight or change the lighting instant. Support for using the scene's time zone is planned\n> for a future release.\n\n[![daylight-default](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-default.avif)](https://developers.arcgis.com/javascript/latest/sample-code/daylight/)\n\nThe component has an option to select the timezone. When the user makes any adjustments here, a new time\nin the chosen timezone is calculated and displayed in the slider. The timezone selector can be disabled\nby using the [hideTimezone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#hideTimezone) property.\n\nBy default, a calendar is displayed to select the day, month, and year.\nWith the [dateOrSeason](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#dateOrSeason) property, the calendar can be replaced with\na dropdown menu where a season can be selected instead:\n\n![daylight-seasons](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-seasons.avif)\n\nThere are two play buttons: one corresponds to the time-of-day slider and animates the lighting\nover the course of a day, while the other corresponds to the date picker\nand animates the lighting over the course of a year (month by month). The speed of the time-of-day animation can\nbe set using the [playSpeedMultiplier](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#playSpeedMultiplier) property.\n\n<video src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-animation.webm\" autoplay loop muted playsinline></video>\n\nExcept for the daytime slider, all the elements in the Daylight component can be hidden:\n\n![daylight-no-elements](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-no-elements.avif)\n\nWhenever the sun position option is unchecked, the scene applies the\n**[virtual light](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/VirtualLighting/)** source relative to the camera.\nWith this, the component's time slider, timezone, and date picker get automatically disabled:\n\n![daylight-virtual](https://developers.arcgis.com/javascript/latest/assets/references/core/components/daylight/daylight-virtual.avif)\n\n**Things to consider**\n\n* Daylight is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n* The Daylight component uses a numeric UTC offset and does not track an IANA time zone. It does not account for daylight saving time transitions in different countries and regions.\n* When using the [virtual light](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/VirtualLighting/),\nsetting the time and date programmatically does not have an influence on the lighting conditions of the scene.\n* When using the [sunlight](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/),\nthe time slider and time zone automatically react to the changes of the camera (e.g., position, rotation, pan, zoom) because the position of the simulated sun\nis updated to maintain a consistent solar time of day based on the camera's current longitude. This can be adjusted using the\n[cameraTrackingEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunLighting/#cameraTrackingEnabled)\nproperty on [arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment). This camera-based timezone behavior is an approximation based on longitude.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisUserDateTimeChange** - Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons.\n\nThis event is user-action only. It does not fire for internal synchronization (for example, initial state sync\nwhen the view becomes ready).\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.","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-daylight/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"current-season","description":"Sets the season that is used when the component displays the season picker.\nEach season uses a fixed date corresponding to the seasonal equinoxes and solstices.","values":[{"name":"fall"},{"name":"spring"},{"name":"summer"},{"name":"winter"}]},{"name":"date-or-season","description":"Controls whether the component displays a date or a season picker. When the date picker is set, the user selects the date from a calendar. The season picker allows the user to choose a season from a drop-down list. Each season uses a fixed month and day corresponding to the equinoxes and solstices in the current local date's year.","values":[{"name":"date"},{"name":"season"}]},{"name":"day-playing","description":"Starts or pauses the daytime animation cycling through the minutes of the day.\nSet the property to `true` to start the animation and to `false` to pause it.\n\n`dayPlaying` and [yearPlaying](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#yearPlaying) are mutually exclusive.\nWhen virtual lighting is active, playback is stopped.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-date-picker","values":[]},{"name":"hide-header","values":[]},{"name":"hide-play-buttons","values":[]},{"name":"hide-shadows-toggle","values":[]},{"name":"hide-sun-lighting-toggle","values":[]},{"name":"hide-timezone","values":[]},{"name":"icon","description":"Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"local-date","description":"The calendar date in the timezone given by [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#utcOffset).\n\nDate-only ISO strings in `YYYY-MM-DD` format are preserved as-is to avoid day shifts in negative local\ntimezones. Other valid `Date`, `number`, and `string` values are normalized to canonical `YYYY-MM-DD`.","values":[]},{"name":"play-speed-multiplier","description":"Controls the daytime animation speed.","values":[]},{"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.","values":[]},{"name":"time-slider-position","description":"Slider position for the time of day in the timezone\ngiven by [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#utcOffset). The position represents the time\nof the day in minutes. Values are normalized to a single day (0-1439).","values":[]},{"name":"time-slider-steps","description":"Sets the interval, in minutes, with which the time slider increments or decrements as it is dragged or changed via the keyboard.","values":[]},{"name":"time-zone-mode","description":"Time zone mode. Not supported after the component has loaded.","values":[{"name":"offset"},{"name":"region"}]},{"name":"utc-offset","description":"The difference in hours between UTC time and the time displayed in the component.\n\nIn sunlight mode, changing only this property preserves the current `SunLighting.date` instant and recomputes\ndisplayed local date/time in the new offset. When this property changes together with\n[localDate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#localDate) and/or [timeSliderPosition](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#timeSliderPosition),\nthe date/time values are applied as one local selection and a new lighting instant is written.\nThis property is separate from [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone). Changing one does not update the other.","values":[]},{"name":"year-playing","description":"Starts or pauses the date animation cycling through the months of the year.\nSet the property to `true` to start the animation and to `false` to pause it.\n\n`yearPlaying` and [dayPlaying](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/#dayPlaying) are mutually exclusive.\nWhen virtual lighting is active, playback is stopped.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/"},{"name":"Daylight","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-daylight--demo&singleStory=true"}]},{"name":"arcgis-directional-pad","description":"A directional pad (D-Pad) component can be used to control the position and\nrotation of the map. The D-Pad provides eight directions of movement, a small\ncompass which indicates the current orientation of the map and a slider for\nrotating the map.\n\nIt is also possible to disable the map's rotation controls or change the size\nof the component.\n\nThe Directional Pad component is not supported in 3D.\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 for user interaction.\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.","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-directional-pad/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-directional-buttons","description":"Whether to hide directional pad buttons.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-rotation-reset-button","description":"Whether to display the button to reset the rotation angle. This only takes\neffect if showRotationSlider is true.","values":[]},{"name":"show-rotation-slider","description":"Whether to display the map rotation slider.","values":[]},{"name":"visual-scale","description":"Determines the size of directional pad buttons and the slider.\n\nIn addition to this parameter, you can set the width on the component\ncontainer to dictate directional pad size.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directional-pad/"},{"name":"Directional Pad","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-directional-pad--demo&singleStory=true"}]},{"name":"arcgis-directions","description":"The Directions component provides a way to calculate directions, between two or more input locations with a [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/), using ArcGIS Online and custom Network Analysis Route services.\nThis component generates a route finding a least-cost path between multiple points using the routing service associated with the assigned RouteLayer. The route is calculated based on the stops and barriers added to the RouteLayer. The component provides a user interface for adding, removing, and reordering stops and barriers. Once the route is solved, the component displays the route on the map and provides turn-by-turn directions in a list format.\n\nDirections uses the [Search component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/) to locate each stop, either by selecting a point on the map, or by entering a search term into the textbox.\nSearch uses settings defined in the `Search properties`. This includes the `locationType`, which defines the type of geocoding result that is returned, and defaults to \"street\".\n\nDirections requires a RouteLayer to be associated with the `layer` property or using the `useDefaultRouteLayer` property. A RouteLayer can be programmatically created or derived from an external source like a portal item or webmap.\nPlease note that in order to view or interact with routing inputs and results, the RouteLayer must be added to the map. Routing service and symbology are configured in the layer, specifically the `url` and `defaultSymbols` properties respectively.\n\nThe ArcGIS Online routing service requires authentication. If an API key is specified at the app level (see [Config#apiKey](https://developers.arcgis.com/javascript/latest/references/core/config/#Config-apiKey)) or component level (see [apiKey](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#apiKey)) then this key will accompany requests to both the routing service and geocoder/reverse-geocoder.\nPlease refer to the Search component for more information on geocoding.\n\nLocations on the map can be reverse geocoded and used as stops in the route. Click the button with a crosshairs icon to associate a location with a new or existing stop.  After clicking the button, click the map once. To cancel this process, press the `escape` key.\nThe resulting driving directions are automatically collapsed and can be optionally saved to a new or existing portal item. This can be achieved programmatically with `save` and `saveAs`. The `Clear` button calls the `reset()` method, which removes all stops, directions, and the solved route.\n\nSelecting the `Edit route` button allows you to add/move/remove stops, add/move/remove/reshape polyline barriers, and add/move/remove waypoints. To add a new waypoint, first hover the cursor over the route and select the desired point. Then select and drag the point to move and place the waypoint. By default the route will be automatically resolved at the completion of any editing operation. For more complex routes, it may be advantageous to disable auto-solving and solve as and when needed with the dedicated solve button. Currently, this is only supported in 2D MapViews.\n\n**Note:** Printing in Directions is in beta and considered experimental. The print preview dialog, in some scenarios, may not display as anticipated.\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 for user interaction.\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.\n- `getDirections(): Promise<RouteLayerSolveResult>` - Computes a route and directions. If successfully computed, results will be assigned to the [lastRoute](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#lastRoute) property.\n- `save(): Promise<PortalItem>` - Saves the currently assigned [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/)\n(see [layer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#layer)) to an existing portal item.\n- `saveAs(portalItem: PortalItem, options: { folder: PortalFolder; }): Promise<PortalItem>` - Saves the currently assigned [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/)\n(see [layer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/#layer)) to a new portal item.\n- `startEditing(): Promise<void>` - Starts an edit session for interactive addition, modification, and deletion of stops, barriers, and waypoints.\n- `stopEditing(): Promise<void>` - Ends an interactive edit session.\n- `zoomToRoute(): Promise<void>` - Zoom so that the entire route is displayed within the current map extent.","attributes":[{"name":"api-key","description":"An authorization string used to access a resource or service.\n[API keys](https://developers.arcgis.com/documentation/security-and-authentication/api-key-authentication/) are generated\nand managed in the portal. An API key is tied\nexplicitly to an ArcGIS account; it is also used to monitor service usage.\nSetting a fine-grained API key on a specific class overrides the [global API key](https://developers.arcgis.com/javascript/latest/references/core/config/#ConfigWithApiKey).\n\nBy default, the following URLs will be used (unless overwritten in the app, or if using different defaults from a portal):\n\nGeocoding URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`\n\nRouting URL: `https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World`","values":[]},{"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-directions/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-solve-on-edit-active","description":"When `true`, the route will re-solve continuously as an interactive operation is ongoing (e.g., while dragging a stop or waypoint).","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the origin and destination addresses (i.e. \"380 New York Street\").\nBy default, this is rendered\nas a level 2 heading (e.g. `<h2>380 New York Street</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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-layer-details","description":"Indicates whether to a link to the route layer portal-item (if any) will be displayed","values":[]},{"name":"hide-print-button","description":"Indicates whether to the Print button will be displayed","values":[]},{"name":"hide-save-as-button","description":"Indicates whether to the Save As button will be displayed","values":[]},{"name":"hide-save-button","description":"Indicates whether to the Save button will be displayed","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"map-layer-id","description":"The layer ID of a route layer in the associated map.\nWhen set, the component will attempt to find and use the layer with the provided ID from the map.\n\n> [!WARNING]\n> Use `layer`, `mapLayerId`, and `routeLayerItemId` independently; only one should be set at a time.","values":[]},{"name":"max-stops","description":"The maximum number of stops allowed for routing.","values":[]},{"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.","values":[]},{"name":"route-layer-item-id","values":[]},{"name":"unit","description":"Unit system (imperial, metric) or specific unit used for displaying the distance values.\nIf not set, the component will attempt to pick \"imperial\" or \"metric\" based on the user's portal settings.\n\nThis property will affect the summary distance as well as distance for each turn-by-turn maneuver.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]},{"name":"use-default-route-layer","description":"If `true`, a new [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer/) will be created, added to the map and assigned to the `layer` property.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-directions/"},{"name":"Directions","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-directions--demo&singleStory=true"}]},{"name":"arcgis-direct-line-measurement-3d","description":"The Direct Line 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 vertical, horizontal, and direct distances between two points.\n\n[![measurement-line-3d](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/3D_DirectLineMeasurement_widget.avif)](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow distances are computed depends on the scene's spatial reference.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- Direct distance is computed in a Euclidean manner, in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets);\n- Horizontal distance is computed geodetically, taking into consideration the curvature of the planet;\n- Vertical distance is computed as an elevation difference.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, all three distances (direct, horizontal, and vertical)\n are computed in a Euclidean manner (in their respective PCS).\n\nDirect Line Measurement 3D component visualizes and labels the direct, horizontal, and vertical distances and displays the same values\nin the UI panel. When the distance between the points is greater than 100 kilometers,\nthe measurement visualization is simplified, and only the horizontal and vertical distances are calculated.\nThe direct distance option becomes unavailable.\n\n![measurement-line-3d](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/direct-line-measurement-3d.avif)\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\nA second laser line shows the intersection of the scene with the vertical plane that passes through the checkered line.\n\n**Things to consider**\n\n* Direct Line Measurement 3D is designed to work in the Scene component. For measurements in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent, use [arcgis-distance-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/).\n* Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/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- [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/DirectLineMeasurementAnalysis/)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n- [Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-direct-line-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"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-direct-line-measurement-3d/#unitOptions).\n\nWhen no unit is explicitly set on the component or its analysis, this property uses the length unit configured in the view through\n[view.options.displayUnits.length](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-direct-line-measurement-3d/#unitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the distance unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-direct-line-measurement-3d/"},{"name":"Direct Line Measurement 3D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-direct-line-measurement-3d--demo&singleStory=true"}]},{"name":"arcgis-distance-measurement-2d","description":"The Distance 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 length of a polyline.\n\nHow distances are computed depends on the map's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, lengths are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, lengths 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 for user interaction.\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.","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-distance-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"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-distance-measurement-2d/#unitOptions).\n\nWhen no unit is explicitly set on the component or its analysis, this property uses the length unit configured in the view through\n[view.options.displayUnits.length](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/#unitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the distance unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/"},{"name":"Distance Measurement 2D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-distance-measurement-2d--demo&singleStory=true"}]},{"name":"arcgis-editor","description":"The Editor component provides an out-of-the-box editing experience to help streamline editing within a web application.\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 for user interaction.\n- **arcgisSketchCreate** - Fires when a user starts drawing a feature, is actively drawing a feature, and completes drawing a feature.\n- **arcgisSketchUpdate** - Fires when a user starts updating a feature's geometry, is actively updating a feature's geometry, and completes updating a feature's geometry.\n\n### Methods\n- `activateSelectionTool(toolName: SelectionToolName): Promise<SelectionOperation | undefined>` - Activates a selection tool specified by name. Additionally, cancels the previously active selection operation.\n- `cancelSelectionTool(): void` - Cancels any active selection operation.\n- `cancelWorkflow(options?: CancelWorkflowOptions): Promise<void>` - Cancels any active workflow.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `deleteFeatureFromWorkflow(): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `startCreateFeaturesWorkflowAtFeatureCreation(info: CreateFeaturesCreationInfo): Promise<void>`\n- `startCreateFeaturesWorkflowAtFeatureEdit(params: EditorStartCreateFeaturesWorkflowAtFeatureEditParameters): Promise<void>` - Initiates a CreateFeaturesWorkflow by displaying the form panel with the provided feature.\n- `startCreateFeaturesWorkflowAtFeatureTypeSelection(params?: EditorStartCreateFeaturesWorkflowAtFeatureTypeSelectionParameters): Promise<void>` - Initiates a CreateFeaturesWorkflow by displaying the FeatureTemplates panel.\n- `startMergeFeaturesWorkflow(features: FeatureInfo | Graphic[], options: EditorStartMergeFeaturesWorkflowOptions): Promise<void>` - Starts a [MergeFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/MergeFeaturesWorkflow/) using\nthe provided features. All features must belong to the same layer.\n- `startSplitFeatureWorkflow(feature: Graphic, options: EditorStartSplitFeatureWorkflowOptions): Promise<void>` - Starts a [SplitFeatureWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/SplitFeatureWorkflow/) using the provided feature.\n- `startUpdateFeaturesWorkflow(features: FeatureInfo | Graphic[]): Promise<void>` - Starts an [UpdateFeaturesWorkflow](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/UpdateFeaturesWorkflow/) using\nthe provided features.\n- `startUpdateWorkflowAtFeatureEdit(feature: Graphic): Promise<void>`\n- `startUpdateWorkflowAtFeatureSelection(): Promise<void>`\n- `startUpdateWorkflowAtMultipleFeatureSelection(candidates: Graphic[]): 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-editor/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for title of the component. By default, the title (i.e. \"Editor\") is rendered\nas a level 4 heading (e.g. `<h4>Editor</h4>`). 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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-create-features-section","description":"Indicates whether to hide the \"create features\" section of the component in the default view.","values":[]},{"name":"hide-edit-features-section","description":"Indicates whether to hide the \"edit features\" section of the component in the default view.","values":[]},{"name":"hide-labels-toggle","description":"Indicates whether to hide the sketch labels toggle.","values":[]},{"name":"hide-merge-button","description":"Indicates whether to hide the \"Merge features\" button in contexts where that command is available. Default value is `true`.","values":[]},{"name":"hide-selection-toolbar","description":"Controls whether to use the fully featured selection experience. This includes the\nselection toolbar — which provides multiple selection tools — and the\nselection list, which allows modifying selections and starting\nmulti-feature editing workflows, like bulk updates and merges.\n\nIf set to `true`, the component will use a simplified selection experience,\nconsisting of a single \"Select\" button.","values":[]},{"name":"hide-settings-menu","description":"Indicates whether to hide the Settings menu. This menu contains snapping and tooltip options.","values":[]},{"name":"hide-sketch","description":"Determines whether the component should display an embedded Sketch component to provide graphical controls for choosing drawing tools.","values":[]},{"name":"hide-snapping-controls-elements-enabled-toggle","description":"Indicates whether to hide the `enabledToggle` (Enable snapping). This toggles\nthe [SnappingOptions#enabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#enabled) property.\n> [!WARNING]\n>\n> **Note**\n>\n> It is recommended to set `SnappingControls.snappingOptions.enabled = true` if `enabledToggle` is set to `false`.\n> This is because `selfEnabledToggle` and `featureEnabledToggle` require snapping globally to be enabled in order to be interactive. Otherwise, these toggles will not be responsive.","values":[]},{"name":"hide-snapping-controls-elements-feature-enabled-toggle","description":"Indicates whether to hide the `featureEnabledToggle` (Feature to feature). This toggles\nthe [SnappingOptions#featureEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#featureEnabled) property.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls","description":"Indicates whether to hide the `gridControls` (configuration of the snapping grid).","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-color-selection","description":"Indicates whether to hide the `colorSelection` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-dynamic-scale-toggle","description":"Indicates whether to hide the `dynamicScaleToggle` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-line-interval-input","description":"Indicates whether to hide the `lineIntervalInput` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-numeric-inputs","description":"Indicates whether to hide the `numericInputs` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-out-of-scale-warning","description":"Indicates whether to hide the `outOfScaleWarning` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-placement-buttons","description":"Indicates whether to hide the `placementButtons` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-rotate-with-map-toggle","description":"Indicates whether to hide the `rotateWithMapToggle` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-enabled-toggle","description":"Indicates whether to hide the `gridEnabledToggle` (snap-to-grid).","values":[]},{"name":"hide-snapping-controls-elements-layer-list","description":"Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/FeatureSnappingLayerSource/) layerList. The layerlist provides the available layer sources supported for snapping.","values":[]},{"name":"hide-snapping-controls-elements-self-enabled-toggle","description":"Indicates whether to hide the `selfEnabledToggle` (Geometry guides). This toggles\nthe [SnappingOptions#selfEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#selfEnabled) property.","values":[]},{"name":"hide-split-button","description":"Indicates whether to hide the \"Split\" button in contexts where that command is available. Default value is `true`.","values":[]},{"name":"hide-tooltips-toggle","description":"Indicates whether to hide the tooltips toggle. Default value is `true`.","values":[]},{"name":"hide-undo-redo-buttons","description":"Indicates whether to hide undo/redo buttons in the embedded Sketch toolbar. Default value is `true`.","values":[]},{"name":"hide-zoom-to-button","description":"Indicates whether to hide the \"Zoom to\" button when creating and editing features. Default value is `true`.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-snapping-controls-elements-header","description":"Indicates whether to display the header. Default is `false`.","values":[]},{"name":"sync-view-selection","description":"Controls whether the editor should sync with the view's selection manager.\nThis does not include selection sources, which must be configured independently\non the view's selection manager.","values":[]},{"name":"use-view-options","description":"If true, the component uses snapping, tooltips, display units, and input units from [ViewOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/).\n\nWhen this property is `true`:\n\n- Snapping and tooltip options are inherited from the view. The component's [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#snappingOptions) and [tooltipOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#tooltipOptions) are preserved but ignored.\n- Snapping controls and the tooltip toggle are hidden from the component's Settings menu.\n\nWhen `false`, the component uses its own snapping, tooltip, and unit options instead.\n\nLabel [options](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/#labelOptions) and [direction mode](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ValueOptions/#directionMode) are not inherited from the view.\n\nChanges to this property apply when the next create or update operation starts, not to an operation already in progress.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-editor/"},{"name":"Editor","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-editor--demo&singleStory=true"}]},{"name":"arcgis-elevation-profile","description":"The Elevation Profile component manages an [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/) and displays its elevation profiles.\n\n[![elevation profile poster](https://developers.arcgis.com/javascript/latest/assets/references/components/elevation-profile/elevation_profile_poster.avif)](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n\nThe component can visualize multiple profile lines, depending on whether it is used in an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) component or an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component and on the available elevation source data:\n\n* [**ElevationProfileLineGround**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineGround/): represents a profile line that uses elevation from [arcgis-map.ground](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#ground) of the connected Map or Scene component. The profile recomputes automatically when ground layers are added, removed, or their visibility changes.\n* [**ElevationProfileLineInput**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineInput/): represents a profile line that reads elevation from the analysis geometry itself; typically used for polylines with z values. If the line lacks z values but is displayed with a non-draped elevation mode, a profile is still computed. If `elevationInfo` is set to `on-the-ground`, elevation comes from the Ground (when ground layers are present). An elevation offset can be applied. In a Map this requires client-side graphics that already contain z values.\n* [**ElevationProfileLineQuery**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineQuery/): represents a profile line that samples elevation from the elevation source set in the [source](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineQuery/#source) property. The elevation source can be an [ElevationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/) or an object with a method called `queryElevation` that has the same signature as [queryElevation()](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/#queryElevation).\n* [**ElevationProfileLineScene**](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineScene/): represents a profile line that derives elevation from the `Scene` and all its volumetric objects (e.g. SceneLayer, IntegratedMeshLayer).\n\nYou can choose to display one or several profile lines in the chart, by setting them in the [profiles](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#profiles) property.\n\nHovering over the chart shows an overlaid tooltip with elevation values of all profiles, and displays colored dot markers at the matching positions.\n\nCheckboxes in the legend allow hiding individual profiles. Chart units can be set via the settings menu to metric, imperial or a specific unit.\n\nScrolling the chart zooms in to a specific part of the profile chart. When zoomed in, click the minus button to reset the zoom. On touch devices, pinch to zoom in and out.\n\nHow distance values are computed depends on the map's spatial reference:\n\n* In geographic coordinate systems (GCS) and in Web Mercator, distances are computed geodetically.\n* In projected coordinate systems (PCS), apart from Web Mercator, distances are computed in a Euclidean manner (in their respective PCS).\n\n**Known limitations**\n\n- [ElevationProfileLineInput](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineInput/) in 2D is only valid when the analysis [geometry](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#geometry) has z values, `hasZ===true` and no [elevationInfo](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/#elevationInfo) is set.\n- [ElevationProfileLineScene](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfile/ElevationProfileLineScene/) is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ElevationProfileAnalysis/)\n- [Sample - Elevation Profile component](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\n- [Sample - Elevation Profile analysis](https://developers.arcgis.com/javascript/latest/sample-code/analysis-elevation-profile/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current elevation profile. If an interactive operation is in progress, it will also be stopped.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `select(): Promise<void>` - Start an interactive operation to pick an existing polyline feature in the view to use as the input for the\nelevation profile. The operation ends when the user presses the <kbd>Escape</kbd> key.\nTo programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#stop) method.\n- `start(): Promise<void>` - Start an interactive operation that lets the user sketch a new path in the view along which the elevation profile\nwill be generated. The operation completes when the user double-clicks, presses the <kbd>Escape</kbd> key or clicks\nthe Done button in the UI.\nTo programmatically cancel the operation, call the [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#stop) method.\n- `stop(): Promise<void>` - Stop any ongoing interactive operation (for example, selecting or sketching a profile line). This can be used to\nprogrammatically cancel operations started by [start()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#start) or\n[select()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#select).\n\n### Slots\n- **settings-start** - Slot for adding custom UI before the built-in settings controls.\n- **settings-end** - Slot for adding custom UI after the built-in settings controls.","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-elevation-profile/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"distance-unit","description":"The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display distance values\nin the chart, results and legend.\n\nWhen no distance unit is explicitly set on the component or its analysis, this property uses the length unit configured in the view through\n[view.options.displayUnits.length](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [distanceUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#distanceUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the distance unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]},{"name":"elevation-unit","description":"The measurement system (imperial, metric) or specific unit (e.g. feet, kilometers) used to display elevation values\nin the chart, results and legend.\n\nWhen no elevation unit is explicitly set on the component or its analysis, this property uses the vertical length unit configured in the view through\n[view.options.displayUnits.verticalLength](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [elevationUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/#elevationUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the elevation unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]},{"name":"hide-chart","description":"If true, the elevation profile chart will be hidden.","values":[]},{"name":"hide-chart-axis-labels","description":"If true, the elevation profile chart axis labels will be hidden.","values":[]},{"name":"hide-chart-grid-lines","description":"If true, the elevation profile chart grid lines will be hidden.","values":[]},{"name":"hide-clear-button","description":"If true, the clear button will be hidden.","values":[]},{"name":"hide-distance-display-unit-select","description":"If true, the distance display unit dropdown will be hidden in the settings popover.","values":[]},{"name":"hide-elevation-display-unit-select","description":"If true, the elevation display unit dropdown will be hidden in the settings popover.","values":[]},{"name":"hide-legend","description":"If true, the legend will be hidden.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-select-button","description":"If true, the button to select features in the view will be hidden.","values":[]},{"name":"hide-settings-button","description":"If true, the button which opens the settings popover will be hidden.","values":[]},{"name":"hide-start-button","description":"If true, the button to start sketching a new profile line will be hidden.","values":[]},{"name":"hide-uniform-chart-scaling-toggle","description":"If true, the uniform chart scaling toggle will be hidden in the settings popover.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"highlight-disabled","description":"If true, the component will not highlight features selected in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"uniform-chart-scaling","description":"Whether the chart should use a uniform scale for the X and Y axes.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/"},{"name":"Elevation Profile","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-elevation-profile--demo&singleStory=true"}]},{"name":"arcgis-expand","description":"Expand acts as a clickable button for displaying interactive content, most commonly other components.\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 for user interaction.\n\n### Methods\n- `collapse(): Promise<void>` - Collapse the component.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `expand(): Promise<void>` - Expand the component.","attributes":[{"name":"auto-collapse","description":"Automatically collapses the Expand component when the\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/core/views/View/#viewpoint) updates.","values":[]},{"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-expand/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"close-on-esc-disabled","description":"When `true`, the Expand component will not close itself if the Escape key is pressed while its content has keyboard focus.\nThis property can also be set to a function that returns a boolean, allowing for more customization for when to allow the\nExpand component to be closed via the Escape key.","values":[]},{"name":"collapse-icon","description":"Calcite icon used to style the Expand when it can be collapsed.","values":[]},{"name":"collapse-tooltip","description":"Tooltip to display to indicate the Expand can be collapsed.","values":[]},{"name":"expanded","description":"Indicates whether the component is currently expanded or not.","values":[]},{"name":"expand-icon","description":"Calcite icon used to style the Expand when it can be expanded.\nThe component will automatically use the icon of the component placed within the Expand if it has one.","values":[]},{"name":"expand-tooltip","description":"Tooltip to display to indicate Expand can be expanded.","values":[]},{"name":"focus-trap-disabled","description":"Whether the user's keyboard focus should be trapped in the expanded panel state. If `true`, tabbing\nforward or backward will cycle through elements only within the panel content.","values":[]},{"name":"group","description":"This value associates two or more Expand components with each other, allowing one\ncomponent to auto collapse when another in the same group is expanded. For auto collapsing\nto take effect, all components in the group must be included in the same Map, Scene, or Link Chart component.\n\nFor example, if you place multiple Expand components in the `top-left` slot of the Map, you can assign them to a\ngroup called `top-left`. If one Expand component is expanded and the user clicks on a different component in the\n`top-left` group, then the first component is collapsed, allowing the content of the second component to be\nfully visible.","values":[]},{"name":"icon-number","description":"A number to display at the corner of the component to indicate the number of, for example, open issues or unread notices.\n\n![expand component icon number](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/expand-with-iconnumber.avif)","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"modal-disabled","description":"When true, disables the modal behavior of the [Calcite Sheet](https://developers.arcgis.com/calcite-design-system/components/sheet/) when the Expand component is in \"drawer\" [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-expand/#mode).\nThis property is in beta and its behavior will change at 6.0.","values":[]},{"name":"mode","description":"The mode in which the component displays. These modes are listed below:\n\n- `auto`: This is the default mode. It is responsive to browser size changes and will update based on whether the component is viewed in a desktop or mobile application.\n- `floating`: Use this mode if you wish to always display the component as floating in a [Calcite Popover component](https://developers.arcgis.com/calcite-design-system/components/popover/) regardless of browser size.\n- `drawer`: Use this mode if you wish to always display the component in a [Calcite Sheet component](https://developers.arcgis.com/calcite-design-system/components/sheet/) regardless of browser size.","values":[{"name":"auto"},{"name":"drawer"},{"name":"floating"}]},{"name":"placement","description":"The placement used by the [Calcite Popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the component is expanded.\nThis property has no effect when the component is in `drawer` mode.","values":[{"name":"top-start"},{"name":"top-end"},{"name":"bottom-start"},{"name":"bottom-end"},{"name":"bottom"},{"name":"left"},{"name":"right"},{"name":"top"},{"name":"auto"},{"name":"auto-start"},{"name":"auto-end"},{"name":"right-start"},{"name":"right-end"},{"name":"left-start"},{"name":"left-end"},{"name":"leading-start"},{"name":"leading"},{"name":"leading-end"},{"name":"trailing-end"},{"name":"trailing"},{"name":"trailing-start"}]},{"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.","values":[]},{"name":"top-layer-disabled","description":"When true, disables rendering in the top layer (above overlays and modals).\nThis can be useful for controlling stacking context in complex UI layouts.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-expand/"},{"name":"Expand with Custom Content\nThe Expand component with custom content.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-expand--custom-content&singleStory=true"},{"name":"Expand with Component Content\nThe Expand component with the [Basemap Gallery](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/) component.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-expand--component-content&singleStory=true"}]},{"name":"arcgis-exploratory-analysis","description":"The Exploratory Analysis component provides a container for measurement and analysis components and displays one active analysis at a time.\nAdd one or more supported components as child elements.\n\nSupported components include:\n\n- [arcgis-area-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/)\n- [arcgis-area-measurement-3d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/)\n- [arcgis-direct-line-measurement-3d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-direct-line-measurement-3d/)\n- [arcgis-distance-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-distance-measurement-2d/)\n- [arcgis-elevation-profile](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-elevation-profile/)\n- [arcgis-volume-measurement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/)\n\nWhen multiple measurement components are provided, their `icon` and `label` properties are used to create a toolbar for switching between them.\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 for user interaction.\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.","attributes":[{"name":"active-analysis","description":"The active child component. Set using the child component's tag name (i.e. `arcgis-distance-measurement-2d`).\nWhen set, this will display the specified analysis tool as the active component.","values":[{"name":"arcgis-area-measurement-2d"},{"name":"arcgis-area-measurement-3d"},{"name":"arcgis-direct-line-measurement-3d"},{"name":"arcgis-distance-measurement-2d"},{"name":"arcgis-elevation-profile"},{"name":"arcgis-volume-measurement"}]},{"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-exploratory-analysis/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-start-disabled","description":"Specifies whether selecting an analysis tool from the action bar waits for the user to start a new analysis via the button.\nBy default, a new analysis is started once you click on the icon in the toolbar.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"preserve-analysis-on-change","description":"Specifies whether analysis results are preserved when the active analysis component changes.\nBy default, the current analysis is cleared before another analysis component becomes active.","values":[]},{"name":"require-active-analysis","description":"Specifies whether an analysis tool must remain active after it is selected.\nWhen enabled, selecting the active tool again does not collapse the component.","values":[]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-exploratory-analysis/"},{"name":"Exploratory Analysis","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-exploratory-analysis--exploratory-analysis&singleStory=true"}]},{"name":"arcgis-feature","description":"The Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\nThis component is useful in instances where you want to display information about a feature but without\nthe use of an [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/).\n\nIf wanting to show a feature's content with [actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), [related](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/), or [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate), etc., then use the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) component.\n\nWhen Arcade expressions that use `$map` or [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) are defined in any popup template content or as expression elements,\nthe [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#map) and [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#spatialReference) properties need to be defined in the Feature component.\n\n> [!WARNING]\n> In version 6.0, the implementation of [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) will be updated under the hood to that of [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/), and deprecated properties on this component will be removed. We encourage using the [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/) component and providing feedback.\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 for user interaction.\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.\n- `nextMedia(contentElementIndex: number): Promise<void>` - Paginates to the next [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.\n- `previousMedia(contentElementIndex: number): Promise<void>` - Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>` - Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info object. For example,\nyou may have [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) content which contains\nmultiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos`\nyou wish to display.\n- `updateGeometry(): Promise<void>` - Updates the geometry of the graphic.","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-feature/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"chart-animation-disabled","description":"Disables chart animation within the component.","values":[]},{"name":"default-popup-template-enabled","description":"Enables automatic creation of a popup template for layers that have popups enabled but no\npopupTemplate defined. Automatic popup templates are supported for layers that\nsupport the `createPopupTemplate()` method. (Supported for\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OGCFeatureLayer/)\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/PointCloudLayer/),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/StreamLayer/), and\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer/)).\n\n**Note:**\nStarting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat)\nrather than `long-month-day-year` in the default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#heading) of the component.\nBy default, the title is rendered\nas a level 2 heading (e.g. `<h2>Title of content</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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-attachments-content","description":"This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","values":[]},{"name":"hide-content","description":"This property provides the ability to hide or show content within the component.","values":[]},{"name":"hide-custom-content","description":"This property provides the ability to hide or show [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","values":[]},{"name":"hide-expression-content","description":"This property provides the ability to hide or show [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","values":[]},{"name":"hide-fields-content","description":"This property provides the ability to hide or show [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","values":[]},{"name":"hide-heading","description":"This property provides the ability to hide or show the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/#heading).","values":[]},{"name":"hide-last-edited-info","description":"This property provides the ability to hide or show the last edited info within the component.","values":[]},{"name":"hide-media-content","description":"This property provides the ability to hide or show [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","values":[]},{"name":"hide-text-content","description":"This property provides the ability to hide or show [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-relationship-content","description":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","values":[]},{"name":"show-utility-network-content","description":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from the associated [MapView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#timeZone) or [SceneView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#timeZone). When a view is not associated with the component,\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and times are not adjusted for any timezone.\n- Specified IANA timezone: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/"},{"name":"Feature\nThe Feature component displays on hover.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-feature--hover&singleStory=true"}]},{"name":"arcgis-feature-form","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 for user interaction.\n- **arcgisSubmit** - Fires when the [submit()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-form/#submit) method is called.\n- **arcgisValueChange** - Fires when a field value is updated.\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.\n- `getValues(): Promise<any>` - Returns all of the field values, regardless of update status.\n- `submit(): Promise<void>` - Fires the submit event.","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-feature-form/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"edit-type","description":"The edit type for the form, which determines the editing context and behavior.\n\nThis property is used in two primary ways:\n\n1. **Arcade Expressions Context**: When evaluating [Arcade expressions](https://developers.arcgis.com/javascript/latest/arcade/#form-calculation),\nthe value of this property is assigned to the `$editContext.editType` variable.\n   This allows Arcade expressions to adapt their behavior based on the type of edit\n   being performed (e.g., \"INSERT\", \"UPDATE\", \"DELETE\", or \"NA\").\n\n2. **Layer Editing Capabilities**: This property is also used to determine whether\n   the layer allows the specified type of edit. For example:\n   - If `editType` is set to `\"INSERT\"` but the layer has `supportsAdd: false`,\n     all inputs in the form will be read-only.\n   - If `editType` is set to `\"UPDATE\"` but the layer has `supportsUpdate: false`,\n     all inputs will also be read-only.\n\nThis behavior applies regardless of whether a form template or Arcade expressions\nare present. For instance:\n- If a layer has `{ supportsAdd: true, supportsUpdate: false }` and no form template,\n  setting `editType` to `\"INSERT\"` will allow the user to modify all fields, while\n  setting it to `\"UPDATE\"` will make all fields read-only.\n- If a form template is present with field elements that include `editableExpression`\n  or `valueExpression`, the `editType` still determines whether the layer permits\n  editing in the given context.","values":[{"name":"INSERT"},{"name":"UPDATE"},{"name":"DELETE"},{"name":"NA"}]},{"name":"group-display","description":"String indicating the\n[groupDisplay](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureForm/#groupDisplay) and how they will be displayed to the end user. This only applies if using [grouped field elements](https://developers.arcgis.com/javascript/latest/references/core/form/elements/GroupElement/) configured in the Editor's [layer infos](https://developers.arcgis.com/javascript/latest/references/core/widgets/Editor/types/#LayerInfo).\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\nall | All groups will be expanded.\nsequential | A single group will be expanded at a time.","values":[{"name":"all"},{"name":"sequential"}]},{"name":"heading-level","description":"Indicates the heading level to use for the [FormTemplate#title](https://developers.arcgis.com/javascript/latest/references/core/form/FormTemplate/#title) of the form.\nBy default, the title is rendered as a level 2 heading (e.g. `<h2>Form title</h2>`).\nIn addition, group element labels default to a level 3 heading (e.g. `<h3>Group element label</h3>`).\nDepending 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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-read-only-notice","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the form use this time zone. By default, the time zone is inherited from the associated [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) or [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone). When no view is associated, the time zone defaults to `system`.\n\nIf `unknown`, the form uses the layer's [FeatureLayer#preferredTimeZone](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#preferredTimeZone). If the layer does not define a preferred time zone, the form uses UTC.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-form/"},{"name":"Feature Form","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-feature-form--demo&singleStory=true"}]},{"name":"arcgis-add-attachment-view","description":"Displays the attachment add/replace page. Composes a file-picker,\nvalidation notices, and information about the file to be replaced,\nif any.\n--\n\n### Events\n- **arcgisFilesSelect**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"form-disabled","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-add-attachment-view/"}]},{"name":"arcgis-attachment-preview","description":"Displays a preview of an attachment.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `pause(): void`","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachment-preview/"}]},{"name":"arcgis-attachment-thumbnail","description":"Displays a thumbnail of an attachment. If possible, an image preview\nis shown, otherwise falls back to a generic calcite icon appropriate\nfor the attachment type.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"icon-only","description":"Optionally skip any attempt to load a preview. Used to support situations where the thumbnail is a fallback for a failed-to-load preview image.","values":[]},{"name":"skip-filename-alt","description":"Indicates that the alt for the img element should be cleared. This should only be\nset if the thumbnail is shown in a context where filename is already visible.\n\nhttps://www.w3.org/WAI/tutorials/images/decorative/","values":[]},{"name":"visual-scale","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachment-thumbnail/"}]},{"name":"arcgis-attachment-validation-view","description":"Displays validation criteria for an attachment input.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"include-count-criteria","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachment-validation-view/"}]},{"name":"arcgis-file-picker","description":"Provides file browsing and drag/drop interactions, principally for attachments.\n--\n\n### Events\n- **arcgisFilesSelect** - This component does not enforce attachment count or file type limits.\nDo not rely on these events having only payloads consistent with\nthe configured multipleEnabled/fileTypeCategories properties.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `open(): Promise<void>`","attributes":[{"name":"disabled","values":[]},{"name":"heading","values":[]},{"name":"icon","values":[]},{"name":"multiple-enabled","description":"Controls whether the native input is configured to enable multiple file selection.\n\nThis does not enforce the limit, particularly if the user pastes or drags and drops attachments;\nthe event can include multiple files even when this property is false.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-file-picker/"}]},{"name":"arcgis-feature-form-field","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `setFocus(): Promise<void>`","attributes":[{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"read-only","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-form-field/"}]},{"name":"arcgis-feature-form-field-number","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `setFocus(): Promise<void>`","attributes":[{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"read-only","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-form-field-number/"}]},{"name":"arcgis-feature-next","description":"> [!WARNING]\n> The Feature (next) component is the successor to the Feature component, provided to you early for testing and feedback. In version 6.0, the implementation of [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) will be updated under the hood to that of [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/), and this component will be removed. To update at version 6.0, simply remove `-next` from the component name.\n\nThe Feature (next) component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/).\nThis component is useful in instances where you want to display information about a graphic but without\nthe use of an [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/).\n\nTo show a graphic's content with [actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), [related records](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/), aggregate feature browser ([clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate) or [binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/#popupTemplate)), etc., then use the [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/) component.\n\nWhen Arcade expressions that use `$map` or [geometry functions](https://developers.arcgis.com/arcade/function-reference/geometry_functions/) are defined in any popup template content or as expression elements,\nthe [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#map) and [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#spatialReference) properties need to be defined in the Feature (next) component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.\n- `nextMedia(contentElementIndex: number): void` - Paginates to the next [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.\n- `previousMedia(contentElementIndex: number): void` - Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info.\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): void` - Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) info object. For example,\nyou may have [media](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) content which contains\nmultiple `mediaInfos`. This method allows you to specify the index of the `mediaInfos`\nyou wish to display.\n- `updateGeometry(): Promise<void>` - Updates the geometry of the graphic.","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-feature-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"chart-animation-disabled","description":"Indicates whether to disable chart animation in the component.","values":[]},{"name":"default-popup-template-enabled","description":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","values":[]},{"name":"focus-trap-enabled","description":"When `true`, the component will trap focus when opened.\nThis ensures that keyboard navigation is contained within the component when it opens.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-attachments-content","description":"Indicates whether to hide [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","values":[]},{"name":"hide-content","description":"Indicates whether to hide the component's content.","values":[]},{"name":"hide-custom-content","description":"Indicates whether to hide [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","values":[]},{"name":"hide-empty-relationship-content","description":"Indicates whether to hide relationship content when there are no relationship items to display.","values":[]},{"name":"hide-expression-content","description":"Indicates whether to hide [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","values":[]},{"name":"hide-fields-content","description":"Indicates whether to hide [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#heading).","values":[]},{"name":"hide-last-edited-info","description":"Indicates whether to hide the last edited info in the component.","values":[]},{"name":"hide-media-content","description":"Indicates whether to hide [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","values":[]},{"name":"hide-text-content","description":"Indicates whether to hide [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-relationship-content","description":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","values":[]},{"name":"show-utility-network-content","description":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from the associated [MapView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#timeZone) or [SceneView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#timeZone). When a view is not associated with the component,\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and times are not adjusted for any timezone.\n- Specified IANA timezone: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/"},{"name":"Feature (Next)\nThe Feature (next) component displays on hover.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-feature-next--hover&singleStory=true"}]},{"name":"arcgis-feature-table","description":"The Feature Table component provides an interactive tabular view of each feature's attributes in a feature layer.\n--\n\n### Events\n- **arcgisCellClick** - Fires when a cell within the table is clicked.\n- **arcgisCellDblClick** - Fires when a cell within the table is double-clicked.\n- **arcgisCellKeydown** - Fires when a key is pressed down within a cell within the table.\n- **arcgisCellPointerout** - Fires when the mouse pointer is moved out of a cell within the table. This event is useful for scenarios highlighting for things like highlighting a feature in the view, while hovering, without requiring manual interaction to select a row. Another example: these events can also be used to show information about the cell in a tooltip attached to the mouse.\n- **arcgisCellPointerover** - Fires when the mouse pointer is moved over a cell within the table.\n- **arcgisColumnReorder** - Fires when a column is reordered via drag-and-drop.\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 for user interaction.\n- **arcgisSelectionChange** - Fires when a row selection is added or removed.\n\n### Methods\n- `addPendingEdits(edits: FeatureStoreEdits[]): void` - Creates a pending edit with the specified parameters.\nA pending edit is not immediately saved to the layer.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `deleteSelection(showWarningPrompt?: boolean): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `discardPendingEdits(edits?: DiscardPendingEditsParameters[] | null, showWarningPrompt?: boolean): Promise<boolean>` - Cancels any pending edits. This might be edits for a specific field or column, or\nall pending edits for a specific feature. If no parameters are supplied, all pending edits\nfor all features are discarded. Additionally, if showWarningPrompt is 'true', the value returned\nfrom this method will reflect whether or not the user chose to discard the pending edits.\n- `exportSelectionToCSV(includeGeometry?: boolean): Promise<void>`\n- `findColumn(fieldName: string): Promise<ActionColumn | AttachmentsColumn | Column | GroupColumn | RelationshipColumn | null | undefined>`\n- `getCachedFeaturesByPageIndex(pageIndex: number): Promise<FeatureStoreItem[] | undefined>` - Returns cached features for a specific page index.\n- `getFeatureStoreItemByObjectId(objectId: number | string): Promise<FeatureStoreItem | null | undefined>` - Returns information about the feature with the provided object ID from the internal store.\n- `goToPage(index: number): Promise<void>`\n- `hideColumn(fieldName: string): Promise<void>`\n- `nextPage(): Promise<void>`\n- `previousPage(): Promise<void>`\n- `refresh(): Promise<void>`\n- `refreshCellContent(): Promise<void>`\n- `savePendingEdits(): Promise<void>` - Attempts to save any pending edits. If any edits are invalid, the save will be rejected until the edits are in a valid state.\n- `scrollToBottom(): Promise<void>`\n- `scrollToIndex(index: number): Promise<void>`\n- `scrollToLeft(): Promise<void>`\n- `scrollToRow(objectId: number | string): Promise<void>`\n- `scrollToTop(): Promise<void>`\n- `showAllColumns(): Promise<void>`\n- `showColumn(fieldName: string): Promise<void>`\n- `sortColumn(path: string, direction: \"asc\" | \"desc\"): Promise<void>`\n- `toggleColumnVisibility(fieldName: string): Promise<void>`\n- `zoomToSelection(): Promise<void>`","attributes":[{"name":"attachments-enabled","description":"Indicates whether to display the `Attachments` field in the table. It displays the count of attachments per feature and is only applicable if the feature layer [supports attachments](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities).\n\n![featuretable attachmentsEnabled](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/featuretable/attachments-enabled.avif)","values":[]},{"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-feature-table/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-refresh-disabled","description":"Indicates whether the table should automatically refresh when the underlying data changes.","values":[]},{"name":"auto-save-disabled","description":"Indicates whether the table should automatically save when the underlying data changes.","values":[]},{"name":"closed","description":"Indicates whether the primary panel is closed. Once the panel is closed, the panel must be re-opened programmatically.","values":[]},{"name":"collapsed","description":"Indicates whether the primary panel is collapsed. This only applies if the 'showCollapse' property has also been set to true.","values":[]},{"name":"column-performance-mode-disabled","description":"Indicates whether to enable the table's column performance mode.\nThis mode is designed to improve the performance of the table when working with a large number of columns.","values":[]},{"name":"column-reordering-disabled","description":"Indicates whether the table should allow reordering of columns.","values":[]},{"name":"definition-expression","description":"The SQL where clause used to filter features visible in the table. Only the features that satisfy the definition\nexpression are displayed in the table. This value takes priority over any definition expression set on the\nassociated layer.","values":[]},{"name":"description","description":"Text displayed in the table header, under the title. This can be a basic string or custom function that returns a string. This is useful in situations where additional context is needed for the table.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"editing-enabled","description":"Indicates whether [editing](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTable/#editing-in-featuretable) is enabled on the data within the feature table. Double-clicking in a cell will enable editing for that value. In order to edit a feature, the layer must be editable and the user must have the appropriate permissions. In addition, the layer must contain an object ID field.","values":[]},{"name":"filter-by-layer-scale-range","description":"Indicates whether the table respects layer view scale visibility. If no view is provided, this property is ignored.\nThe table is empty when no layer view is available or when the layer view is not visible at the current scale.","values":[]},{"name":"filter-by-selection-enabled","description":"Indicates whether the table only displays rows that are considered selected. Row selection can be modified by adding or removing associated object IDs from `highlightIds`. This will cause the store to fetch fresh features to ensure the expected sort order is honored.","values":[]},{"name":"filter-by-view-extent","description":"Indicates that the table should only display rows for features that are currently in the view's extent.\nThis property has no effect if the table has not been provided a view. If this property is true, the view's extent\nwill overwrite the current value of [filterGeometry](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#filterGeometry).","values":[]},{"name":"hide-column-descriptions","description":"Indicates whether to display descriptions in the header cells of individual columns.","values":[]},{"name":"hide-column-menu-items-sort-ascending","description":"Indicates whether to display the 'Sort Ascending' menu item in column menus.","values":[]},{"name":"hide-column-menu-items-sort-descending","description":"Indicates whether to display the 'Sort Descending' menu item in column menus.","values":[]},{"name":"hide-column-menus","description":"Indicates whether to display the menu items within the individual columns.","values":[]},{"name":"hide-column-visibility-menu","description":"Indicates whether to display the column visibility menu in the table header.","values":[]},{"name":"hide-column-visibility-menu-items-filter","description":"Indicates whether to display the filter in column visibility menu.","values":[]},{"name":"hide-column-visibility-menu-items-header","description":"Indicates whether to display the header in column visibility menu.","values":[]},{"name":"hide-column-visibility-menu-items-toggle-all","description":"Indicates whether to display the 'toggle all' button in column visibility menu.","values":[]},{"name":"hide-header","description":"Indicates whether to display the feature table's header.","values":[]},{"name":"hide-layer-dropdown-icons","description":"Indicates whether to display layer-specific icons in the layer drop down menu.","values":[]},{"name":"hide-menu","description":"Indicates whether to display the feature table's menu.","values":[]},{"name":"hide-menu-items-clear-selection","description":"Indicates whether to display the 'Clear selection' menu item.","values":[]},{"name":"hide-menu-items-delete-selection","description":"Indicates whether to display the' Delete Selection' menu item.","values":[]},{"name":"hide-menu-items-export-selection-to-csv","description":"Indicates whether to display the 'Export selection to CSV' menu item.","values":[]},{"name":"hide-menu-items-refresh-data","description":"Indicates whether to display the 'Refresh data' menu item.","values":[]},{"name":"hide-menu-items-selected-records-show-all-toggle","description":"Indicates whether to toggle between showing only selected records in the table to showing all of the records.","values":[]},{"name":"hide-menu-items-selected-records-show-selected-toggle","description":"Indicates whether to display the 'Show selected records' menu item.","values":[]},{"name":"hide-menu-items-zoom-to-selection","description":"Indicates whether to display the 'Zoom to selection' menu item.","values":[]},{"name":"hide-progress","description":"Indicates whether to display the progress indicator when the table is querying or syncing data.","values":[]},{"name":"hide-selection-column","description":"Indicates whether to display the selection column in the table.\nEach row has a checkbox that selects its corresponding feature.","values":[]},{"name":"hide-tooltips","description":"Indicates whether to display the tooltip for the Show/hide columns button.","values":[]},{"name":"highlight-disabled","description":"Indicates whether to highlight the associated feature when a row is selected by checking the corresponding checkbox. This property is only applicable when working with a map and the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#view) property is set.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"initial-size","description":"The user-provided number of total features accessed from the data source. This is used for initial load of the data store as opposed to querying a specified layer. Additionally, the table will query data counts to verify the data's integrity, or when requested via [refresh()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#refresh).","values":[]},{"name":"label","description":"The components label.","values":[]},{"name":"layer-id","description":"The layer ID of a layer in the service.\nUse with [layerItemId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#layerItemId) when the service contains multiple layers and you want to specify which layer to use.","values":[]},{"name":"layer-item-id","description":"The portal item ID of a layer.\n\n\n> [!WARNING]\n> * Use `layer`, `layerUrl`, `mapLayerId`, and `layerItemId` independently; only one should be set at a time.\n> * If referencing an item containing multiple layers, use [layerId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#layerId) or [tableId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#tableId) to specify which layer or standalone table to use.","values":[]},{"name":"layer-url","description":"The URL to a layer's REST endpoint.\n\n> [!WARNING]\n> Use `layer`, `layerUrl`, `mapLayerId`, and `layerItemId` independently; only one should be set at a time.","values":[]},{"name":"map-layer-id","description":"The layer ID of a layer in the associated map.\nWhen set, the component will attempt to find and use the layer with the provided ID from the map.\n\n> [!WARNING]\n> Use `layer`, `layerUrl`, `mapLayerId`, and `layerItemId` independently; only one should be set at a time.","values":[]},{"name":"max-size","description":"This property is applicable when working with layers that contain a large number of features, as it provides the ability to limit the displayed total feature count. If [paginationEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#paginationEnabled) is `true`, and `maxSize` is greater than the current value of [pageSize](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#pageSize), multiple pages usually display. If `maxSize` is less than [pageSize](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#pageSize), a single page shows the total number of features limited to `maxSize`.","values":[]},{"name":"multiple-selection-disabled","description":"Controls whether the table allows multiple selected rows.","values":[]},{"name":"multiple-sort-enabled","description":"Indicates whether sorting multiple columns is supported within the table.","values":[]},{"name":"multiple-sort-priority","description":"This property can be used to determine how newly-sorted columns are prioritized. By default, newly sorted columns are\ngiven the highest sort priority.","values":[{"name":"append"},{"name":"prepend"}]},{"name":"navigation-scale","description":"This property controls the scale of all components in the navigation bar displayed when\nviewing attachments or related records.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]},{"name":"no-data-message","description":"This property can be used to override the text displayed when the table is fully loaded but no rows are available.","values":[]},{"name":"page-index","description":"Represents the index of the page of the feature currently being displayed. The number of features per page can be adjusted by modifying the [pageSize](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#pageSize). [Pagination](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#paginationEnabled) must be enabled or the value of this property may not be reliable due to virtualization of visible pages.","values":[]},{"name":"page-size","description":"The default page size used when displaying features within the table. By default, the page loads the first 50 features returned by the service. It can be used with [paginationEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#paginationEnabled) to display a subset of features.\n\n> [!WARNING]\n>\n> It is not possible to overwrite the maximum page size on the server, ie. `maxRecordCount`, as this property only applies to set values less than the maximum page size, i.e. `maxRecordCount`, set on the service.","values":[]},{"name":"pagination-enabled","description":"Controls whether the table should only display a single page of features at any time. Current page can be determined via the [pageIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#pageIndex) property. The current page can be modified by calling the [goToPage()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#goToPage) method and passing in the desired [page index](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#pageIndex).","values":[]},{"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.","values":[]},{"name":"related-records-enabled","description":"Indicates whether to display any related records associated with rows within the table. Take note that related layers must be provided via the [layers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#layers) property when there is no associated [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#view).","values":[]},{"name":"return-geometry-enabled","description":"Indicates whether to fetch geometries for the corresponding features displayed in the table.\n\n> [!WARNING]\n>\n> Setting this to `true` can potentially impact the component's performance.","values":[]},{"name":"return-m-enabled","description":"Indicates whether geometries fetched for the corresponding features contain M values, if supported.\nThe [returnGeometryEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#returnGeometryEnabled) property must also be true.\n\n> [!WARNING]\n>\n> Setting this to `true` can potentially impact the component's performance.","values":[]},{"name":"return-z-enabled","description":"Indicates whether the fetched features' geometries contain Z values. This is only applicable if Z-values are supported.\nThe [returnGeometryEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#returnGeometryEnabled) property must also be true.\n\n> [!WARNING]\n>\n> Setting this to `true` can potentially impact the component's performance.","values":[]},{"name":"show-close","description":"Indicates whether to display a close button in the table panel header.","values":[]},{"name":"show-collapse","description":"Indicates whether to display a collapse button in the table panel header.","values":[]},{"name":"show-layer-dropdown","description":"Indicates whether to display the feature table's layer switch drop down menu.","values":[]},{"name":"sync-template-on-changes-disabled","description":"Indicates whether the table should synchronize the current attributeTableTemplate\nbeing used based on changes made to the table's UI.","values":[]},{"name":"sync-view-selection","description":"Controls whether the table should sync with the view's selection manager.\nThis does not include selection sources, which must be configured independently\non the view's selection manager.","values":[]},{"name":"table-id","description":"The table ID of a layer in the service.\nUse with [layerItemId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#layerItemId) when the service contains multiple layers and tables, and you want to specify which table to use.","values":[]},{"name":"table-title","description":"Replacement title for the table. This can be a basic string or custom function that returns a string. This is useful in situations where it may be necessary to dynamically update titles based on the current state of the table.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be in terms of this time zone. If not supplied, the view's time zone is used (if available). Depending on the field type, individual columns may have their own unique time zone behavior when the time zone itself is `unknown`.\n\n> [!WARNING]\n>\n> The following considerations apply when working with date, time, and big integer field types:\n>\n> By default, the FeatureTable displays time zones for `date` and `timestamp-offset` field [types](https://developers.arcgis.com/javascript/latest/references/core/layers/support/Field/#type) using the associated view's time zone. This time zone can be overridden by setting the table's [timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#timeZone) property.\n> If the table's [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#view) isn't set, and, (if applicable), a [Feature.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/#timeZone) isn't set, the table defaults to `system` time. The only instance where this is not the case is when there is a [FeatureLayer#preferredTimeZone](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#preferredTimeZone) set on the table's layer. If the latter is true, the preferred time zone is used as opposed to `system`.","values":[]},{"name":"view-time-enabled","description":"Controls [time extent](https://developers.arcgis.com/javascript/latest/references/core/time/TimeExtent/) filtering behavior for the table. When `true`, the [table's time extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#timeExtent) will\nbe derived from the intersection of the [view](https://developers.arcgis.com/javascript/latest/references/core/views/View/#timeExtent)\nand [layer's](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#timeExtent) `timeExtent`.\nWhen `false`, only the [layer's `timeExtent`](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#timeExtent)\nwill be considered.\nWhen [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/#timeExtent) is defined on the\ntable, only that [time extent](https://developers.arcgis.com/javascript/latest/references/core/time/TimeExtent/) will be used and this property will\nbe ignored.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/"},{"name":"Feature Table","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-feature-table--demo&singleStory=true"}]},{"name":"arcgis-feature-templates","description":"The FeatureTemplates component is part of an editing workflow. Its main purpose is to display [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) templates from one or more feature layers.\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 for user interaction.\n- **arcgisSelectTemplate** - The user has selected a template\n- **arcgisTemplatesChanged** - The source of templates has changed.\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","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-feature-templates/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"disable-templates-mode","description":"Decide if templates should be disabled when the layer is not visible, or not visible at the current scale.","values":[{"name":"never"},{"name":"scale"},{"name":"visible"}]},{"name":"display","description":"Determine if templates should be shown grouped, or in a single flat list","values":[{"name":"flat"},{"name":"grouped"}]},{"name":"exclude-tables","description":"Determines if feature templates for tables should be shown","values":[]},{"name":"favorites-enabled","description":"Include a favorites used tab","values":[]},{"name":"favorites-filter-text","description":"The text the user has entered to filter the list on the favorites tab","values":[]},{"name":"filter-text","description":"The text the user has entered to filter the list","values":[]},{"name":"group-by","description":"When templates are grouped, determine the group by policy. Note: if the component has been supplied with applicationTemplates, the templates will keep the supplied groupings.","values":[{"name":"geometry"},{"name":"layer"}]},{"name":"hide-template-description","description":"Determine if the template description should be displayed","values":[]},{"name":"hide-templates-mode","description":"Decide if templates should be hidden when the layer is not visible, or not visible at the current scale.","values":[{"name":"never"},{"name":"scale"},{"name":"visible"}]},{"name":"min-required-filter-count","description":"Automatically hide the filter if below a certain number of templates.","values":[]},{"name":"recent-filter-text","description":"The text the user has entered to filter the list on the recent tab","values":[]},{"name":"recently-used-enabled","description":"Include a recently used tab","values":[]},{"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.","values":[]},{"name":"section-sort-by","description":"When templates are grouped, determine how the groups are sorted. If the component has been supplied with a sectionSortByFunction then this will be used instead.","values":[{"name":"alphabetical"},{"name":"system"}]},{"name":"selected-template-id","description":"Currently selected template id","values":[]},{"name":"shared-templates-disabled","description":"Fetch shared templates, if the layer's in the view have shared Templates.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to display the collapse button.","values":[]},{"name":"show-filter","description":"Indicates whether to show the templates filter","values":[]},{"name":"template-sort-by","description":"Determines how templates are ordered. This will either be in alphabetical order\nor the order they are defined in the layer schema.","values":[{"name":"alphabetical"},{"name":"system"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-templates/"}]},{"name":"arcgis-template-image","description":"The Template Image component generates a feature swatch representing a\nFeature Template.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-template-image/"}]},{"name":"arcgis-feature-templates-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe FeatureTemplates component is part of an editing workflow. Its main purpose is to display [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) templates from one or more feature layers.\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 for user interaction.\n- **arcgisSelect**\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.\n- `select(item: null | undefined | TemplateItem): void` - Selects the template item to use.","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-feature-templates-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"enable-list-scroll","description":"Indicates whether the list of available feature [template items](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/) should scroll within its containing element.","values":[]},{"name":"filter-text","description":"Text used to filter items.","values":[]},{"name":"group-by","description":"It is possible to group [template items](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/TemplateItem/). This can aid\nin managing various template items and how they display within the component. The values are discussed below.\n\nType | Description | Example\n----- | ----------- | -------\nlayer | This is the *default* grouping. Groups template items by layers. | ![featureTemplatesGroupByLayer](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupByLayers.avif)\ngeometry | Groups template items by geometry type. | ![FeatureTemplatesGroupByGeometry](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupByGeometry.avif)\nnone | The component displays everything in one list with no grouping. | ![featureTemplatesGroupByLayer](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupByNone.avif)\n[GroupByFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureTemplates/types/#GroupByFunction) | Custom function that takes an object containing a [FeatureTemplate](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureTemplate/) and [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/). | ![FeatureTemplatesGroupByCustomGroupFunction](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/groupCustomGroup.avif)","values":[{"name":"layer"},{"name":"none"},{"name":"geometry"}]},{"name":"heading-level","description":"Indicates the heading level to use for the labels of grouped feature templates.\nBy default, the group label is rendered\nas a level 4 heading (e.g. `<h4>Group label</h4>`). 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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-filter","description":"Indicates whether the templates filter displays.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection behavior of list items. The `\"single\"` selection mode keeps the clicked list item selected. Whereas, `\"none\"` does not preserve the selection after clicking the list item.","values":[{"name":"none"},{"name":"single"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-templates-legacy/"}]},{"name":"arcgis-features","description":"The Features component allows users to view a feature's popupTemplate content such as attributes,\nactions, related records, etc., without having to be tied to an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\nThis component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component,\nhowever unlike Popup, the Features component can be placed outside of the map or scene component.\nFor example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/),\nthe [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opens within the map whether it is docked\nor anchored to the selected feature.\nWith the Features component, the same information that Popup provides is shown in a separate container from the map, such as\na HTML div within a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\nIf multiple features are passed into the Features component, the component provides buttons to page though the features and a feature menu that allows the\nlist of features to be displayed so the user can choose which feature content to display in the component. The component also respects\nfeature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate).\n\nThe Features component should be used if needing to use the Popup functionality outside of the map or scene component. To show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [arcgis-feature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature/) component.\n\n> [!WARNING]\n> In version 6.0, the implementation of [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) will be updated under the hood to that of [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/), and deprecated properties on this component will be removed. We encourage using the [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/) component and providing feedback.\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 for user interaction.\n- **arcgisTriggerAction** - Fires after the user clicks on an action in the component.\nThis event may be used to define a custom function to execute when particular actions are clicked.\n\n### Methods\n- `clear(): Promise<void>` - Removes [promises](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#promises), [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#content), and\n[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading) from the Features component.\n- `close(): Promise<void>` - A convenience method to close the component.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): Promise<FeaturesViewModel>` - Selects the feature at the next index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature).\n\n> [!WARNING]\n> The return type of `FeaturesViewModel` on the `next()` method is deprecated. At 6.0, this method will return void. See [arcgis-features-next.next()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#next) for the updated usage.\n- `previous(): Promise<FeaturesViewModel>` - Selects the feature at the previous index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature).\n\n> [!WARNING]\n> The return type of `FeaturesViewModel` on the `previous()` method is deprecated. At 6.0, this method will return void. See [arcgis-features-next.previous()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#previous) for the updated usage.\n- `setFocus(): Promise<void>` - Use this method to give focus to the Component if the component is able to be focused.","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-features/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"chart-animation-disabled","description":"Disables chart animation within the component.","values":[]},{"name":"collapsed","description":"Indicates whether the component displays its content. If `true`, only the header displays.\nThis property is only honored if [showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#showCollapseButton) is `true`.","values":[]},{"name":"collapse-direction","description":"Controls the direction the content collapses when the collapse button is used.\nWhen unset, the component chooses a direction based on the [feature navigation placement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#featureNavigationTop).","values":[{"name":"down"},{"name":"up"}]},{"name":"content","description":"The content of the component. When set directly on the component, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content).","values":[]},{"name":"default-popup-template-enabled","description":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","values":[]},{"name":"feature-count","description":"The number of [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) available in the component.","values":[]},{"name":"feature-menu-open","description":"This property enables multiple features in the component to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features. This value will only be honored if [initialDisplayMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#initialDisplayMode) is set to \"feature\".","values":[]},{"name":"feature-menu-title","description":"Sets the title to display on the component while viewing the feature menu.","values":[]},{"name":"feature-navigation-top","description":"Indicates whether the feature navigation arrows are displayed at the top of the component.\nBy default, the navigation arrows are displayed at the bottom of the component.\nThis property also controls the collapse button's icon direction when the [collapseDirection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#collapseDirection) property is not set. When `featureNavigationTop` is `true`, the collapse button icon defaults to collapsing \"up\" and when `false` it defaults to collapsing \"down\".","values":[]},{"name":"features-per-page","description":"The number of features to fetch at one time.","values":[]},{"name":"heading","description":"The title of the Features component. This can be set to any string value no\nmatter the features that are selected. If the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/), then the title set in the\ncorresponding template is used here.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading) of the component.\nBy default, the heading is rendered\nas a level 2 heading (e.g. `<h2>Popup title</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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#actions).","values":[]},{"name":"hide-attachments-content","description":"This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","values":[]},{"name":"hide-close-button","description":"Indicates whether to hide the close button in the component.","values":[]},{"name":"hide-content","description":"This property provides the ability to hide or show content within the component.","values":[]},{"name":"hide-custom-content","description":"This property provides the ability to hide or show [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","values":[]},{"name":"hide-expression-content","description":"This property provides the ability to hide or show [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","values":[]},{"name":"hide-feature-list-layer-title","description":"Indicates whether to hide the group heading for a list of multiple features.","values":[]},{"name":"hide-feature-menu-heading","description":"Indicates whether to hide the feature menu heading and description in the component's feature menu list.","values":[]},{"name":"hide-feature-navigation","description":"Indicates whether to hide the feature navigation in the component. This allows the user to scroll through various [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) using pagination arrows.","values":[]},{"name":"hide-fields-content","description":"This property provides the ability to hide or show [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#heading).","values":[]},{"name":"hide-last-edited-info","description":"This property provides the ability to hide or show the last edited info within the component.","values":[]},{"name":"hide-media-content","description":"This property provides the ability to hide or show [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","values":[]},{"name":"hide-relationship-content","description":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","values":[]},{"name":"hide-select-feature","description":"Indicates whether to hide the *select feature* action when viewing associated and related features.","values":[]},{"name":"hide-spinner","description":"Indicates whether to hide the spinner in the component.","values":[]},{"name":"hide-text-content","description":"This property provides the ability to hide or show [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","values":[]},{"name":"hide-utility-network-content","description":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","values":[]},{"name":"highlight-disabled","description":"Indicates whether to highlight the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature) in the associated\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"include-default-actions-disabled","description":"Indicates whether to include the default actions in the component.\nIn order to disable any default actions, it is necessary to set `includeDefaultActionsDisabled` to `true`.","values":[]},{"name":"initial-display-mode","description":"Indicates whether to initially display a list of features, or the content for one feature.","values":[{"name":"list"},{"name":"feature"}]},{"name":"label","description":"The component's default label.","values":[]},{"name":"open","description":"Indicates whether the component is visible. This property is `true` when the component is querying for results, even if it is not open. Use this property to check if the component is visible.","values":[]},{"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.","values":[]},{"name":"selected-feature-index","description":"Index of the feature that is [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#features) are set,\nthe first index is automatically selected.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to show the collapse button in the component.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from the associated [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) or [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone) if the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#view) property is set. When a view is not associated with the component\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and times are not adjusted for any timezone.\n- `Specified IANA timezone`: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","values":[]},{"name":"update-location-enabled","description":"Indicates whether to update the component's location when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/#selectedFeatureIndex) changes.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/"},{"name":"Features\nThe Features component displays in a Calcite shell panel on click.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-features--demo&singleStory=true"},{"name":"Hide heading\nDisplays Features with a heading value while hideHeading is enabled.\nThe title area should not render the heading text.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-features--hide-heading&singleStory=true"}]},{"name":"arcgis-features-next","description":"> [!WARNING]\n> The Features (next) component is the successor to the Features component, provided to you early for testing and feedback. In version 6.0, the implementation of [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) will be updated under the hood to that of [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/), and this component will be removed. To update at version 6.0, simply remove `-next` from the component name.\n\nThe Features (next) component allows users to view a feature's popupTemplate content such as attributes,\nactions, related records, etc., without living inside a view component.\nThis component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component,\nhowever unlike Popup, the Features (next) component can be placed outside of a view component.\nFor example, when features are selected in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/),\nthe [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opens within the map whether it is docked\nor anchored to the selected feature.\nWith the Features (next) component, the same information that Popup provides is shown in a separate container from the map, such as a Calcite Design System\n[Shell Panel](https://developers.arcgis.com/calcite-design-system/components/shell-panel/).\n\nIf multiple features are passed into the Features (next) component, the component provides buttons to page though the features and a feature menu that allows the\nlist of features to be displayed so the user can choose which feature content to display in the component. The component also respects\nfeature reduction PopupTemplates for [binning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionCluster/#popupTemplate).\n\nThe Features (next) component should be used if needing to use the Popup functionality outside of the map or scene component. To show a single feature's content without\nactions, related records, clustering configuration, etc., then use the [arcgis-feature-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-next/) component.\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 for user interaction.\n- **arcgisTriggerAction** - Fires after the user clicks on an action in the component.\nThis event may be used to define a custom function to execute when particular actions are clicked.\n\n### Methods\n- `clear(): void` - Removes [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#content), and\n[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading) from the component.\n- `close(): void` - A convenience method to close the component.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): void` - Selects the feature at the next index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature).\n- `previous(): void` - Selects the feature at the previous index in relation to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature).\n- `setFocus(): Promise<void>` - Use this method to give focus to the Component if the component is able to be focused.\n\n### Slots\n- **actions-start** - _Since 5.2._ Slot for adding Calcite [actions](https://developers.arcgis.com/calcite-design-system/components/action/) or [action groups](https://developers.arcgis.com/calcite-design-system/components/action-group/) to the start of the action bar. Multiple actions or action groups can be placed in this slot. Slotted actions remain at the start of the action bar and are not automatically grouped if they exceed the available width. To group actions, place them in a Calcite action group. Actions in this slot remain separate from other actions, including default actions (such as \"Zoom to\" and \"Browse features\"), [PopupTemplate actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), and [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions).\n\nTo display text on the action, use the `text-enabled` attribute of the Calcite [action](https://developers.arcgis.com/calcite-design-system/components/action/#api-reference-properties-textEnabled).\n- **actions-end** - _Since 5.2._ Slot for adding Calcite [actions](https://developers.arcgis.com/calcite-design-system/components/action/) or [action groups](https://developers.arcgis.com/calcite-design-system/components/action-group/) to the end of the action bar. Multiple actions or action groups can be placed in this slot. Slotted actions remain at the end of the action bar and are not automatically grouped if they exceed the available width. To group actions, place them in a Calcite action group. Actions in this slot remain separate from other actions, including default actions (such as \"Zoom to\" and \"Browse features\"), [PopupTemplate actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), and [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions).\n\nTo display text on the action, use the `text-enabled` attribute of the Calcite [action](https://developers.arcgis.com/calcite-design-system/components/action/#api-reference-properties-textEnabled).","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-features-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"chart-animation-disabled","description":"Indicates whether to disable chart animation in the component.","values":[]},{"name":"collapsed","description":"Indicates whether the component displays its content. If `true`, only the header displays.\nThis property is only honored if [showCollapseButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#showCollapseButton) is `true`.","values":[]},{"name":"collapse-direction","description":"Controls the direction the content collapses when the collapse button is used.\nWhen unset, the component chooses a direction based on the [feature navigation placement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#featureNavigationTop).","values":[{"name":"down"},{"name":"up"}]},{"name":"content","description":"The content of the component. When set directly on the component, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content).","values":[]},{"name":"default-popup-template-enabled","description":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","values":[]},{"name":"feature-count","description":"The number of [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) available in the component.","values":[]},{"name":"feature-menu-open","description":"This property enables multiple features in the component to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features. This value will only be honored if [initialDisplayMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#initialDisplayMode) is set to \"feature\".","values":[]},{"name":"feature-menu-title","description":"Sets the title to display on the component while viewing the feature menu.","values":[]},{"name":"feature-navigation-top","description":"Indicates whether the feature navigation arrows are displayed at the top of the component.\nBy default, the navigation arrows are displayed at the bottom of the component.\nThis property also controls the collapse button's icon direction when the [collapseDirection](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#collapseDirection) property is not set. When `featureNavigationTop` is `true`, the collapse button icon defaults to collapsing \"up\" and when `false` it defaults to collapsing \"down\".","values":[]},{"name":"features-per-page","description":"The number of features to fetch at one time.","values":[]},{"name":"focus-trap-enabled","description":"When `true`, the component will trap focus when opened.\nThis ensures that keyboard navigation is contained within the component when it opens.","values":[]},{"name":"heading","description":"The title of the Features component. This can be set to any string value no\nmatter the features that are selected. If the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/), then the title set in the corresponding template is used here.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions).","values":[]},{"name":"hide-attachments-content","description":"Indicates whether to hide [attachments content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/AttachmentsContent/) within the component.","values":[]},{"name":"hide-close-button","description":"Indicates whether to hide the close button in the component.","values":[]},{"name":"hide-content","description":"Indicates whether to hide the component's content.","values":[]},{"name":"hide-custom-content","description":"Indicates whether to hide [custom content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/CustomContent/) within the component.","values":[]},{"name":"hide-empty-relationship-content","description":"Indicates whether to hide relationship content when there are no relationship items to display.","values":[]},{"name":"hide-expression-content","description":"Indicates whether to hide [expression content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/ExpressionContent/) within the component.","values":[]},{"name":"hide-feature-list-layer-title","description":"Indicates whether to hide the group heading for a list of multiple features.","values":[]},{"name":"hide-feature-menu-heading","description":"Indicates whether to hide the feature menu heading and description in the component's feature menu list.","values":[]},{"name":"hide-feature-navigation","description":"Indicates whether to hide the feature navigation in the component. This allows the user to scroll through various [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) using pagination arrows.","values":[]},{"name":"hide-fields-content","description":"Indicates whether to hide [fields content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/FieldsContent/) within the component.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#heading).","values":[]},{"name":"hide-last-edited-info","description":"Indicates whether to hide the last edited info in the component.","values":[]},{"name":"hide-media-content","description":"Indicates whether to hide [media content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/MediaContent/) within the component.","values":[]},{"name":"hide-relationship-content","description":"This property provides the ability to hide or show [relationship content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/RelationshipContent/) within the component.","values":[]},{"name":"hide-select-feature","description":"Indicates whether to hide the *select feature* action when viewing associated and related features.","values":[]},{"name":"hide-spinner","description":"Indicates whether to hide the spinner in the component.","values":[]},{"name":"hide-text-content","description":"Indicates whether to hide [text content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/TextContent/) within the component.","values":[]},{"name":"hide-utility-network-content","description":"This property provides the ability to hide or show [utility network content](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/) within the component.","values":[]},{"name":"highlight-disabled","description":"Indicates whether to highlight the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature) in the associated\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"include-default-actions-disabled","description":"Indicates whether to include the default actions in the component.\nIn order to disable any default actions, it is necessary to set `includeDefaultActionsDisabled` to `true`.","values":[]},{"name":"initial-display-mode","description":"Indicates whether to initially display a list of features, or the content for one feature.\nBy default, a list is displayed when the associated view has `focusRegionVisible` enabled; otherwise, the content for one feature is displayed.","values":[{"name":"list"},{"name":"feature"}]},{"name":"label","description":"The component's default label.","values":[]},{"name":"open","description":"Indicates whether the component is visible. This property is `true` when the component is querying for results, even if it is not open. Use this property to check if the component is visible.","values":[]},{"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.","values":[]},{"name":"selected-feature-index","description":"Index of the feature that is [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#features) are set,\nthe first index is automatically selected.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to show the collapse button in the component.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from the associated [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) or [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone) if the [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#view) property is set. When a view is not associated with the component\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n- `system`: Dates and times will be displayed in the timezone of the device or browser.\n- `unknown`: Dates and times are not adjusted for any timezone.\n- `Specified IANA timezone`: Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","values":[]},{"name":"update-location-enabled","description":"Indicates whether to update the feature location when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#selectedFeatureIndex) changes.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/"},{"name":"Features (Next)\nThe Features (Next) component displays in a Calcite shell panel on click.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-features-next--demo&singleStory=true"}]},{"name":"arcgis-filter-builder","description":"The Filter Builder component can be used to create and manage filter conditions for a specific layer.\nIt provides a user interface for defining filter criteria, allowing users to build complex queries based on\nthe attributes of the selected layer.\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 for user interaction.\n\n### Methods\n- `addCondition(params?: AddConditionParameters, index?: number): Promise<void>` - Adds a new filter condition to the filter builder. The new condition can be configured with an optional field name, operator, and value.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>`\n- `duplicateConditionByIndex(index: number): Promise<void>` - Duplicates the filter condition at the specified index. The duplicated condition will be inserted immediately after the original condition.\n- `removeConditionByIndex(index: number): Promise<void>` - Removes the filter condition at the specified index from the filter builder.\n- `reset(): Promise<void>` - Resets the filter builder by removing all existing conditions and clearing the generated WHERE clause.\nThis method effectively returns the filter builder to its initial state.","attributes":[{"name":"auto-destroy-disabled","values":[]},{"name":"condition-operator","description":"The logical operator used to combine multiple filter conditions.","values":[{"name":"AND"},{"name":"OR"}]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-fab","description":"Controls visibility of the floating action button used to add new conditions. If true, the button will be hidden.","values":[]},{"name":"hide-header","description":"Controls visibility of the header section of the filter builder. If true, the header will be hidden.","values":[]},{"name":"hide-menu","description":"Controls visibility of the menu used to delete or duplicate conditions. If true, the menu will be hidden.","values":[]},{"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.","values":[]},{"name":"visual-scale","description":"Controls the visual scale of the filter builder component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-filter-builder/"},{"name":"Filter Builder","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-filter-builder--demo&singleStory=true"}]},{"name":"arcgis-floor-filter","description":"The Floor Filter component simplifies visualization of GIS data for a specific floor of a\nbuilding in your application. It allows you to filter down the floor plan data displayed in your\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) to a [site](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#site), a [facility](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#facility) in the site,\nor a [level](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#level) in the facility.\n\nTo visualize your data based on [site](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#site), [facility](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#facility), or [level](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/#level), your map must contain the related\nfloor plan layers, with features linked together in a floor plan hierarchy.\nOnce you define your map as floor-aware in the map properties, the interactive, on-screen\nFloor Filter component appears and can be used to explore the floor-aware data based on the\nconfigured site, facility, and levels layers.\nThe Floor Filter component currently supports\n[FeatureLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),\n[SceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/) and\n[MapImageLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/) (map services).\n\nThe component can also be used alongside other filtering functionalities, such as definition queries,\nselection, range, and time, to further control visualization.\nFor example, you may want to visualize all of the features on a specific level in a facility,\nor all the office units within a range of levels in a facility.\n\n**Note**\n\nIf a default site, facility, or level is selected in the floor filter when sharing a floor-aware web map from ArcGIS Pro,\nit will also be the default selection within the Floor Filter component.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.\n- `updateWebDocument(webMap: WebMap | WebScene): 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-floor-filter/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"facility","description":"The currently selected facility.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the headings separating floors in buildings.\nBy default, the building name is rendered\nas a level 2 heading (e.g. `<h2>Building name</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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"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).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"level","description":"The currently selected floor level.","values":[]},{"name":"long-names","description":"Determines if the component is expanded or collapsed.\nIf the value is `true`, the component is expanded and the long names appear.\nOtherwise, short names are used and icons appear alone on buttons.","values":[]},{"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.","values":[]},{"name":"site","description":"The currently selected site.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-floor-filter/"},{"name":"Floor Filter","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-floor-filter--demo&singleStory=true"}]},{"name":"arcgis-fullscreen","description":"The Fullscreen component allows users to toggle the map or scene to fullscreen mode.\nUse the escape key (`esc`) to exit fullscreen mode.\n\n**Known limitations**\n\n* Fullscreen only works with browsers that implement the [Fullscreen](https://developer.mozilla.org/docs/Web/API/Fullscreen_API) API.\n  Thus, iOS Safari is not supported.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"element","description":"The [HTMLElement](https://developer.mozilla.org/docs/Web/API/HTMLElement) to present in fullscreen mode.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"state","values":[{"name":"active"},{"name":"disabled"},{"name":"ready"},{"name":"unsupported"}]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-fullscreen/"},{"name":"Fullscreen","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-fullscreen--demo&singleStory=true"}]},{"name":"arcgis-grid-controls","description":"The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.\nThe grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.\nWith support for snapping, the grid lines can be used as a reference when drawing features.\nNote: grid controls are embedded in snapping controls for Sketch and Editor by default.\n\n**Known limitations**\n\n- Grid Controls is only supported in a 2D Map component.\n- The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.\n- The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.\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 for user interaction.\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.\n- `trySetDisplayEnabled(enabled: boolean): void` - Call this to turn the grid on/off.","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-grid-controls/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"custom-color","description":"The custom color used for drawing the grid, if any.","values":[]},{"name":"dynamic-scaling","description":"Returns `true` if the grid is set to scale dynamically. When dynamic scaling is enabled,\ngrid cells are added or removed to ensure that grid cells are a reasonable size on screen as the user zooms.\nThe way additional grid lines are shown is controlled by the [majorLineInterval](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#majorLineInterval) property.","values":[]},{"name":"effective-spacing-after-dynamic-scaling","description":"Returns the actual spacing of grid lines after dynamic scaling has been applied at the current scale.","values":[]},{"name":"grid-color","description":"Controls the color of the major grid lines. Minor grid lines are a slightly transparent version of this color.","values":[]},{"name":"grid-out-of-scale","description":"True if the grid is currently not displayed (and therefore also not a valid snap target),\nbecause [dynamicScaling](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#dynamicScaling) is off and the grid cells are too small\nto render at the current scale.","values":[]},{"name":"hide-color-selection","description":"Controls display of the color and theme selection options.","values":[]},{"name":"hide-dynamic-scale-toggle","description":"Controls display of the dynamic scaling toggle. Dynamic scaling adjusts the size of the grid to work\nwell regardless of view scale.","values":[]},{"name":"hide-grid-enabled-toggle","description":"Controls display of the grid enabled toggle. This toggle controls whether the grid is displayed.","values":[]},{"name":"hide-grid-snap-enabled-toggle","description":"Controls display of the grid snapping enabled toggle. This toggle controls whether snapping is enabled.","values":[]},{"name":"hide-line-interval-input","description":"Controls display of the line interval input field for setting the interval between major grid lines.","values":[]},{"name":"hide-numeric-inputs","description":"Controls display of the numeric input fields for setting grid spacing and rotation.","values":[]},{"name":"hide-out-of-scale-warning","description":"Controls display of the out of scale warning. This warning is displayed when the grid is not shown\nbecause it would be too small at the current scale and dynamic scaling is disabled.","values":[]},{"name":"hide-placement-buttons","description":"Controls display of the grid placement buttons. These buttons allow the user to start interactive\nconfiguration of the grid.","values":[]},{"name":"hide-rotate-with-map-toggle","description":"Controls display of the rotate with map toggle. This toggle controls whether the grid rotates with the map.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interactive-placement-state","description":"Sets the interactive placement state, either starting or ending a draw operation that implicitly adjusts the grid.\nInteractive placement allows the user to define the center of the grid, then the scale and rotation of the grid by\ndrawing a second point. Setting this to \"place\" allows the user to move the grid center only. Setting this to \"rotate\"\nkeeps the scale and center of the grid constant while rotating the grid by defining a second point.","values":[{"name":"rotate"},{"name":"place"},{"name":"interactive"}]},{"name":"label","description":"The component's default label.","values":[]},{"name":"major-line-interval","description":"Controls the number of grid cells shown between major grid lines. Can be anything between 1 and 15.\nNo minor grid lines are shown when this is set to 1.","values":[]},{"name":"placement-disabled","description":"Use this property to disable the interactive grid placement buttons as needed.\nAn example use case might be to block interaction while another interactive operation\n(e.g. sketching) is in progress.","values":[]},{"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.","values":[]},{"name":"rotate-with-map","description":"Controls whether the grid rotates with the map, or stays fixed to the screen.","values":[]},{"name":"rotation","description":"Rotation of the grid in radians. NOTE: UI controls convert to and from degrees automatically.","values":[]},{"name":"snapping-enabled","description":"Controls snapping behavior if [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#snappingOptions) has been defined.\nIf [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#snappingOptions) have been defined, disabling or enabling grid snapping will\nalso disable or enable grid display.","values":[]},{"name":"spacing","description":"Length of a grid cell. Grid cells are always square. Defined in [unit](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#unit).","values":[]},{"name":"theme","description":"The color scheme used to display the grid. This will be light, dark, or custom. When theme is set to custom,\nthe [customColor](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#customColor) is shown, otherwise a default light or dark theme color is used.","values":[{"name":"dark"},{"name":"light"},{"name":"custom"}]},{"name":"unit","description":"Unit of measure (foot, meter, etc) used when defining the [spacing](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#spacing) grid cell.\nNote that units are defined relatively to the map's spatial reference length unit,\nwhich will not correspond to geographic distance unless using a special-purpose basemap\nwithin a supported target area.\n\nWhen using Web Mercator, the projection defines the length of a meter in projection system units;\nthis length is equal to a geographic meter only at the equator. On screen, the size of the grid cells is constant\nfrom the equator to the poles, but the real-world size of the grid cell is much larger further from the equator.\n\nThe length of the grid cells can usefully correspond to a geographic length when the Grid is used with an\nappropriate spatial reference (for example a local system or a State Plane system) within the reference's area of interest.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/"},{"name":"Grid Controls","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-grid-controls--demo&singleStory=true"}]},{"name":"arcgis-histogram-range-slider","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 for user interaction.\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.\n- `generateWhereClause(field: string): Promise<string | null | undefined>` - Generates a SQL where clause based on a given field and the slider's\nrangeType","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-histogram-range-slider/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"average","description":"The statistical average of the data in the histogram. You would typically\nget this value from the `avg` property of\n[SummaryStatisticsResult](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/types/#SummaryStatisticsResult),\nwhich is the result of the\n[summaryStatistics](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/summaryStatistics/) function.\n\nWhen set, this value will render on the histogram with a line and an average symbol.","values":[]},{"name":"excluded-bar-color","description":"Sets the color of the histogram bars that are excluded based on the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType). For example, when a rangeType of `between` is used,\nall bars **not** between the slider thumbs will be rendered with the color set here.\n\nTo change the style of histogram bars representing included data based on the\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType), use the [includedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#includedBarColor) property.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"included-bar-color","description":"Sets the color of the histogram bars that are included in the specified\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType). For example, when a rangeType of `between` is used,\nall bars between the slider thumbs will be rendered with the color set here.\n\nTo change the style of histogram bars representing excluded data based on the\n[rangeType](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#rangeType), use the [excludedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#excludedBarColor) property.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. If the largest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) _in the constructor_ is greater than the `maxValue` set in\nthis property, then the `maxValue` will update to match the largest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values).","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. If the smallest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) _in the constructor_ is greater than the `minValue` set in\nthis property, then the `minValue` will update to match the smallest\nslider [value](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values).","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb values should round to when they have been moved.\n\nThis value also indicates the precision of thumb [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/HistogramRangeSliderViewModel/#labels) when the data range\n([max](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#max) - [min](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#min)) is less than `10`.\n\nWhen the data range is larger than `10`, [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/HistogramRangeSliderViewModel/#labels) display with a precision of\nno more than two decimal places, though actual slider thumb values will maintain the\nprecision specified in this property.\n\nFor example, given the default precision of `4`, and the following slider configuration,\nThe label of the thumb will display two decimal places, but the precision of the actual\nthumb value will not be lost even when the user slides or moves the thumb.\n\n```js\nconst slider = new HistogramRangeSliderViewModel({\n  min: 20,\n  max: 100,  // data range of 80\n  values: [50.4331],\n  // thumb label will display 50.43\n  // thumb value will maintain precision, so\n  // value will remain at 50.4331\n});\n```\n\nIf the user manually enters a value that has a higher precision than what's indicated by\nthis property, the precision of that thumb value will be maintained until the thumb\nis moved by the user. At that point, the value will be rounded according to the indicated precision.\n\nKeep in mind this property rounds thumb [values](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) and shouldn't be used exclusively\nfor formatting purposes. To format thumb `labels`, use the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#labelFormatFunction)\nproperty.","values":[]},{"name":"range-type","description":"Indicates how the histogram bins should be rendered as the user slides the thumbs. By default,\nblue bars indicate data bins included in the range. Gray bars indicate data bins excluded from\nthe range. These colors can be customized with the [includedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#includedBarColor) and\n[excludedBarColor](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#includedBarColor) properties.\n\nThis property also determines the SQL where clause generated in [generateWhereClause()](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#generateWhereClause)\nfor filtering purposes. The value set here determines the number of [values](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values)\nallowed on the slider.\n\nSee the table below for a description and requirements of all possible values. `value1` refers to\nthe value of the first thumb position. `value2` refers to the value of the final thumb position, if applicable.\n\nPossible Value | Number of [values](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#values) | [Where clause](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#generateWhereClause)\n---------------|----------------------------|----------------------\nequal | 1 | `${field} = ${value1}`\nnot-equal | 1 | `${field} <> ${value1}`\nless-than | 1 | `${field} < ${value1}`\ngreater-than | 1 | `${field} > ${value1}`\nat-most | 1 | `${field} <= ${value1}`\nat-least | 1 | `${field} >= ${value1}`\nbetween | 2 | `${field} BETWEEN ${value1} AND ${value2}`\nnot-between | 2 | `${field} NOT BETWEEN ${value1} AND ${value2}`","values":[{"name":"equal"},{"name":"between"},{"name":"not-between"},{"name":"not-equal"},{"name":"less-than"},{"name":"greater-than"},{"name":"at-most"},{"name":"at-least"}]},{"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.","values":[]},{"name":"standard-deviation","description":"Indicates the standard deviation of the dataset.\nWhen set, computed [dataLines](https://developers.arcgis.com/javascript/latest/references/core/widgets/HistogramRangeSlider/#dataLines) will render on the histogram\nat the location of the given standard deviation\nabove and below the `average`.","values":[]},{"name":"standard-deviation-count","description":"Indicates the number of standard deviation lines to render on the histogram\nfrom the [average].","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-histogram-range-slider/"}]},{"name":"arcgis-home","description":"The Home component is a button that navigates back to the\ninitial [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/)\nor a previously defined `viewpoint`.\n--\n\n### Events\n- **arcgisGo** - Fires when the go() method is called.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `cancelGo(): Promise<void>` - This function provides the ability to interrupt and cancel the process\nof navigating back to the initial extent.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `go(): Promise<void>` - Animates the map or scene to its initial Viewpoint or the\nvalue of `viewpoint`.","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-home/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon displayed in the component's button.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-home/"},{"name":"Home","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-home--demo&singleStory=true"}]},{"name":"arcgis-layer-list","description":"The Layer List provides a way to display a list of layers and switch on/off their visibility.\nThe [listItemCreatedFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#listItemCreatedFunction) and the [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.\n\n> **Notes**\n>\n> - The Layer List does not emit an event when the visibility of a layer changes. To respond to layer visibility changes, watch the [visible](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#visible) property of layers in the [allLayers](https://developers.arcgis.com/javascript/latest/references/core/Map/#allLayers) property with [reactiveUtils](https://developers.arcgis.com/javascript/latest/references/core/core/reactiveUtils/).\n> - To hide layers in the map from the Layer List, you must set the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property on the desired layers to `hide`.\n> - When a [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/) is present in the map, the Layer List will display the [tables](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/#tables) as a [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#tableList) ListItem.\n> - When a [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) is present in the map, the Layer List will display the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer) in a [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#catalogLayerList) ListItem.\n\n> **Keyboard Navigation**\n>\n> - The Layer List supports keyboard navigation using the [Treegrid Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/treegrid/) for improved accessibility. Refer to the Calcite List component documentation for detailed keyboard interaction guidelines: [Calcite List Keyboard Navigation](https://developers.arcgis.com/calcite-design-system/components/list/#keyboard-navigation).\n\n> [!WARNING]\n> In version 6.0, the implementation of [arcgis-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/) will be updated under the hood to that of [arcgis-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/), and the way events for [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#catalogLayerList) and [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/#tableList) are handled will change. We encourage using the [arcgis-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/) component and providing feedback.\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 for user interaction.\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.\n- `triggerAction(action: ActionButton | ActionToggle, item: ListItem): 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-layer-list/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","values":[]},{"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 [MapImageLayer#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.\nDrag won't be enabled until the number of list items is equal to or greater than the value set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#visibleElements) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#visibleElements) is true.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component.\nBy default, the heading is rendered as a level 2 heading (e.g., `<h2>Layer List</h2>`).\nDepending on the component's placement in your app, you may need to adjust this heading for proper semantics.\nThis is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-catalog-layer-list","description":"Indicates whether to display the [LayerList#catalogLayerList](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#catalogLayerList).","values":[]},{"name":"hide-status-indicators","description":"Indicates whether the status indicators will be displayed.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"min-drag-enabled-items","description":"The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#dragEnabled).","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the [visibleElements.filter](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/LayerListVisibleElements/) input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"Indicates whether to display a close button in the header.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to display a collapse button in the header.","values":[]},{"name":"show-errors","description":"Indicates whether to display layers with load errors.","values":[]},{"name":"show-filter","description":"Indicates whether to display a filter input box when the number of list items is equal to or greater than the value set in [LayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"Indicates whether to display the layer list heading. The heading text is \"Layer List\". The heading level can be set with the [LayerList#headingLevel](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/#headingLevel).","values":[]},{"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.","values":[]},{"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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-checkbox.avif) |","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/"},{"name":"Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-layer-list--demo&singleStory=true"}]},{"name":"arcgis-layer-list-next","description":"> [!WARNING]\n> The Layer List (next) component is the successor to the Layer List component, provided to you early for testing and feedback.\nIn version 6.0, the implementation of [arcgis-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/) will be updated under the hood to that of [arcgis-layer-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/),\nand this component will be removed. There is a breaking change in the name of the events for [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#catalogLayerList) and\n[tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#tableList) compared to [arcgis-layer-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list/). To update at version 6.0, simply remove `-next` from the component name.\n\nThe Layer List (next) provides a way to display a list of layers and switch on/off their visibility.\nThe [listItemCreatedFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#listItemCreatedFunction) and the [Item](https://developers.arcgis.com/javascript/latest/references/core/layerList/Item/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.\nTrack info items can also be configured with custom panel content. Legend panel content is not supported for individual track info parts.\n\n> **Notes**\n>\n> - The Layer List does not emit an event when the visibility of a layer changes. To respond to layer visibility changes, watch the [visible](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#visible) property of layers in the [allLayers](https://developers.arcgis.com/javascript/latest/references/core/Map/#allLayers) property with [reactiveUtils](https://developers.arcgis.com/javascript/latest/references/core/core/reactiveUtils/).\n> - To hide layers in the map from the Layer List, you must set the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property on the desired layers to `hide`.\n> - When a [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/) is present in the map, the Layer List will display the [tables](https://developers.arcgis.com/javascript/latest/references/core/layers/KnowledgeGraphLayer/#tables) as a [tableList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#tableList) ListItem.\n> - When a [CatalogLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/) is present in the map, the Layer List will display the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer) in a [catalogLayerList](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#catalogLayerList) ListItem.\n\n> **Keyboard Navigation**\n>\n> - The Layer List supports keyboard navigation using the [Treegrid Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/treegrid/) for improved accessibility. Refer to the Calcite List component documentation for detailed keyboard interaction guidelines: [Calcite List Keyboard Navigation](https://developers.arcgis.com/calcite-design-system/components/list/#keyboard-navigation).\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisFilterChange** - Emitted when the value of the [filterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#filterText) input changes.\n- **arcgisOpenedLayersChange** - Emitted when the collection of [openedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#openedLayers) changes.\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 for user interaction.\n- **arcgisSelectedItemsChange** - Emitted when the collection of [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#selectedItems) changes.\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.","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-layer-list-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed. When collapsed, only the collapse button and heading are displayed.","values":[]},{"name":"drag-enabled","description":"Indicates whether [items](https://developers.arcgis.com/javascript/latest/references/core/layerList/Item/) may be reordered within the list by dragging and dropping. MapImageLayer [MapImageLayer#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. Drag and drop won't be enabled until the number of list items is equal to or greater than than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input when filtering is enabled.","values":[]},{"name":"filter-text","description":"The value of the filter input text string when filtering is enabled.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-catalog-layer-list","description":"Indicates whether to hide the catalog layer list in the component.","values":[]},{"name":"hide-no-filter-results-notice","description":"Indicates whether to hide the notice that appears when no results are found after filtering.","values":[]},{"name":"hide-no-items-notice","description":"Indicates whether to hide the notice that appears when there are no items to display.","values":[]},{"name":"hide-status-indicators","description":"Indicates whether to hide status indicators in the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"list-mode-disabled","description":"Specifies whether to ignore the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property to display all layers. A common use case for `listModeDisabled` is when you want to use the component to manage and configure a layer's `listMode` value.","values":[]},{"name":"min-drag-enabled-items","description":"The minimum number of list items required to enable drag and drop reordering.","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the filter input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode. Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-errors","description":"This property provides the ability to show or hide layer error indicators.","values":[]},{"name":"show-filter","description":"This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]},{"name":"show-temporary-layer-indicators","description":"This property provides the ability to show or hide the temporary layer indicators 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.","values":[]},{"name":"visibility-appearance","description":"Determines the icons used to indicate visibility.\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. | ![visibilityAppearance-default](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-default.avif) |\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. | ![visibilityAppearance-checkbox](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/layer-list/visibilityAppearance-checkbox.avif) |\n","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-layer-list-next/"},{"name":"Layer List Next","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-layer-list-next--demo&singleStory=true"}]},{"name":"arcgis-legend","description":"The Legend component displays the symbols and labels used to represent layers in an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\nOnly layers and sublayers visible in the view are shown, unless [ignoreLayerVisibility](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#ignoreLayerVisibility) is set to `true`.\n\nThe legend automatically updates when:\n - the visibility of a layer or sublayer changes\n - a layer is added or removed from the map\n - a layer's `renderer`, `opacity`, or `title` is changed\n - the `legendEnabled` property is changed (set to `true` or `false` on the layer)\n\n## Known Limitations\n\n* Currently, the legend component does not support the following layer types:\n[ElevationLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ElevationLayer/),\n[GeospatialPDFLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeospatialPDFLayer/),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/IntegratedMeshLayer/),\n[KMLLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KMLLayer/),\n[MapNotesLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MapNotesLayer/),\n[OpenStreetMapLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OpenStreetMapLayer/),\n[SketchLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SketchLayer/),\n[VectorTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/), and\n[WebTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WebTileLayer/).\n* [Symbol3D](https://developers.arcgis.com/javascript/latest/references/core/symbols/Symbol3D/) with more than one\n[symbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/Symbol3DLayer/) are not supported.\n* [DictionaryRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/DictionaryRenderer/) is not supported.\n* [TrackInfo](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TrackInfo/) is not supported.\n* CIM Symbol [primitiveOverride](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/#PrimitiveOverride) is not supported.\n* RasterStretchRenderer [dynamicRangeAdjustment](https://developers.arcgis.com/javascript/latest/references/core/renderers/RasterStretchRenderer/#dynamicRangeAdjustment) is not supported.\n\n## Various examples of legends based on renderer type.\n\n### Unique values\n\n[![Unique values](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-unique-values.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-location-types/)\n\n### Continuous color\n\n[![Continuous color](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-color-vv.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-vv-color/)\n\n### Classed color\n\n[![Classed color](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-class-breaks.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-classbreaks/)\n\n### Continuous size\n\n[![Continuous size](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-size.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-size/)\n\n### Size - above and below\n\n[![Size - above and below](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-size-themes.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-size-themes/)\n\n### Dot density\n\n[![Dot density](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-dot-density.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-dot-density/)\n\n### Predominance\n\n[![Predominance](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-predominance.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-arcade/)\n\n### Relationship\n\n[![Relationship](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/legend/legend-relationship.avif)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-relationship/)\n\n\n## Legend labels\n\nLegend text is directly controlled through the [layer](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/) and [renderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/Renderer/) properties. For example, `layer.title` is directly used by the legend to present a layer's symbology to the end user. To override this text, you can directly update `layer.title`.\n\nFurthermore, you can control date and number formatting in Legend by using the [FieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FieldConfiguration/) formatting options on the layer. As an alternative to this, you can override Legend text via the renderer's properties. For example, the renderer may have a [legendOptions](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#legendOptions) property (or a label property in the case of visual variable stops or UniqueValueInfos) that can be used to override default legend text describing the renderer element in question. The [Update legend text sample](https://developers.arcgis.com/javascript/latest/sample-code/legend-update/) provides an example of overriding legend text via the renderer.\n\nNote that when you override legend text, all formatting and localization that would otherwise be dynamically applied to labels will no longer apply.\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 for user interaction.\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.","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-legend/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"basemap-legend-visible","description":"Indicates whether to show the [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/) layers in the Legend. If you set this property to\n`true` and specify [layerInfos](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#layerInfos) that include the basemap layers, the basemap will be displayed in the legend.\n\n> **Known limitation:**\n>\n> [VectorTileLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer/) in the basemap are not currently supported in the legend.\n> This includes most Esri basemaps such as \"Streets\", \"Topographic\", \"Navigation\", and others that use vector tiles.","values":[]},{"name":"card-style-layout","description":"Indicates the layout of the legend when the [legendStyle](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/#legendStyle) is set to the string value of `\"card\"`.\nThe layout determines how the legend's content is arranged.\n\n[![card-style-layout](https://developers.arcgis.com/javascript/latest/assets/references/components/legend/card-style-layout.avif)](https://developers.arcgis.com/javascript/latest/sample-code/legend-card/)","values":[{"name":"auto"},{"name":"side-by-side"},{"name":"stack"}]},{"name":"heading-level","description":"Indicates the heading level to use for the legend title. By default, legend titles are rendered as level 3 headings (e.g. `<h3>Legend title</h3>`). Depending on the legend placement\nin your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-layers-not-in-current-view","description":"When `true`, layers will only be shown in the legend if they are visible in the view's extent. When data from a layer\nis not visible in the view, the layer's legend information will be hidden. Only layers that implement the `createQuery()`\nand `queryFeatureCount()` methods are supported by `hideLayersNotInCurrentView`.\n\nTo hide layers completely from the legend, you should set the `legendEnabled` property of the layer to `false`.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"ignore-layer-visibility","description":"Determines whether to respect the properties of the layers in the map that control the legend's visibility (`minScale`, `maxScale`, `legendEnabled`).\nBy default, a layer's legend elements **will not render** in the legend given the following conditions:\n\n- The layer's [legendEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#legendEnabled) property\nis set to `false`.\n- If the view's scale is outside the visibility range\ndefined by the layer's [minScale](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#minScale) and\n[maxScale](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#maxScale) properties.\n\nWhen the `ignoreLayerVisibility` property of the legend is set to `true`, the legend elements for each\nlayer in the map will always display, thus disregarding the `minScale`, `maxScale`,\nand `legendEnabled` properties for each layer in the map.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"legend-style","description":"Indicates the style of the legend. The style determines the legend's layout and behavior.\nYou can either specify a string or an object to indicate the style. The known string values are the same values listed in\nthe table within the `type` property.\n\n[![legend-style](https://developers.arcgis.com/javascript/latest/assets/references/components/legend/legend-style.avif)](https://developers.arcgis.com/javascript/latest/sample-code/legend-card/)","values":[{"name":"card"},{"name":"classic"}]},{"name":"loading","description":"Indicates whether the legend is currently loading.","values":[]},{"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.","values":[]},{"name":"respect-layer-definition-expression","description":"If a layer uses a unique value renderer, only features that satisfy the layer's\n[definition](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#definitionExpression)\nwill be displayed in the legend when set to true.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-legend/"},{"name":"Legend","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-legend--demo&singleStory=true"}]},{"name":"arcgis-line-of-sight","description":"The Line Of Sight component is a 3D analysis tool that allows you to perform\n[line of sight visibility analysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysis/)\nin an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/). Visibility between a given observer and multiple target points is calculated against the currently\ndisplayed content in the view, including the ground, integrated meshes, and 3D objects such as buildings or trees.\n\n![line-of-sight](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/line-of-sight.avif)\n\nThe analysis results are displayed as colored lines, where areas visible to the observer are\nshown green and occluded parts are marked in red. Also, the color of the target points indicates their visibility.\nWhen the line of sight cannot be calculated, it will be displayed with a gray color. This may happen if either\nthe target or the observer is not in the view.\n\nWhen creating a new line of sight analysis, the first click in the Scene creates the\n[observer](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysisObserver/)\nand subsequent clicks place the [targets](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysisTarget/).\nBoth the observer and target points can be moved by dragging. Additionally, the target points can be removed with a right click.\n\n**Things to consider**\n\n* Line Of Sight is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n* The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.\n* Snapping, tooltips, display units, and input units are inherited from\n[ViewOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/).\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- [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/LineOfSightAnalysis/)\n- [Sample - Line of sight component](https://developers.arcgis.com/javascript/latest/sample-code/line-of-sight/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current observer and any targets. After calling this method, the user can set a new observer and targets.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `continue(): Promise<void>` - After [stop()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-line-of-sight/#stop) was called, this method allows to continue the line of sight analysis and add more targets.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start a new line of sight analysis.\n- `stop(): Promise<void>` - Stops the current placing of line of sight analysis. Any lines added so far are kept in the view.\nUsers can still interact with existing targets and the observer, but they cannot place new target points.","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-line-of-sight/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-continue-button","description":"If true, the button that allows the user to continue placing more targets will be hidden.","values":[]},{"name":"hide-done-button","description":"If true, the button that ends the current placement will be hidden.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new analysis will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-line-of-sight/"},{"name":"Line of Sight","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-line-of-sight--demo&singleStory=true"}]},{"name":"arcgis-link-chart","description":"Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/references/core/WebLinkChart/) from an [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/).\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisLoadError** - Fires when an arcgis-link-chart fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\n- **arcgisViewAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/#event-analysis-view-create)\n- **arcgisViewAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes: zoom, scale, center, rotation, extent, camera, viewpoint.\nThis event will also emit if stationary toggles from true to false.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDoubleTapDrag** - Fires while the pointer is dragged following a double-tap gesture on the view.\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewFocusRegionSelect** - Fires when the focus region is selected using the `Enter` or `Space` key. Use this event to react to the selection of the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegion) via keyboard input and perform any necessary actions based on that selection, such as performing a `hitTest()` on the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegion) and passing the returned graphics to the [selectionManager](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#selectionManager).\n\nCall `event.detail.preventDefault()` to suppress the default behavior of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opening with the features in the focus region.\n- **arcgisViewHold** - Fires during a pointer drag on the view.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is pressed.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the link chart has a corresponding LayerView created and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the link chart.\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and will be emitted when the view is ready.\nThis event will also emit if the `map` property is changed.\n- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\n- **arcgisViewVerticalTwoFingerDrag** - Fires while the two pointers are dragged vertically on the view.\n\n### Methods\n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `fetchPopupFeatures(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise<AsyncGenerator<Graphic>>` - Use this method to query for features at a given screen location. These features come from origins (layers and sublayers) configured with a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [FeatureLayer.popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled) set. One example could be a custom side panel that displays feature-specific information based on an end user's click location. This method allows a developer to control how the input location is handled, and then subsequently, what to do with the results.\n> [!WARNING]\n> Using [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) as the hit target is considered **[beta](https://developers.arcgis.com/javascript/latest/faq/#what-does-the-beta-tag-mean)** functionality.\n- `goTo(target: GoToTarget2D, options?: GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `openPopup(options?: ViewPopupOpenOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `toMap(screenPoint: MouseEvent | ScreenPoint): Point`\n- `toScreen(point: Point, options?: ToScreenOptions2D): ScreenPoint | null | undefined`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView(analysis: Analysis): Promise<AnalysisView2DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/#whenAnalysisView)\n- `whenLayerView(layer: Layer): Promise<LayerView>` - Gets the LayerView created on the view for the given layer.\n- `zoomIn(): Promise<void>` - Zooms in the view component by a factor of 2.\n- `zoomOut(): Promise<void>` - Zooms out the view component by a factor of 2.\n\n### Slots\n- _default_ - Default slot for adding components to the link chart. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n- **popup** - Slot for the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot.\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the view. \n- **--arcgis-table-row-background-color** - _Since 5.1_ Specifies the background color for table rows. \n- **--arcgis-table-row-alt-background-color** - _Since 5.1_ Specifies the background color for alternate table rows. \n- **--arcgis-focus-region-outer-border-color** - _Since 5.2_ Specifies the outer border color of the focus region. \n- **--arcgis-focus-region-inner-border-color** - _Since 5.2_ Specifies the inner border color of the focus region. \n- **--arcgis-focus-region-border-width** - _Since 5.2_ Specifies the border width of the focus region. ","attributes":[{"name":"animations-disabled","description":"Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/PictureMarkerSymbol/)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/FlowRenderer/)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/references/core/views/LinkChartView/#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The display mode used for the attribution. Defaults to null.\n\nSet this property to \"auto\" to automatically synchronize the attribution with the nearest [Calcite mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes). If no Calcite mode is detected, the attribution defaults to light mode. **The \"auto\" mode was added in version 5.2.**\n\nSet this property to \"light\" or \"dark\" to explicitly use that mode without synchronization.","values":[{"name":"dark"},{"name":"light"},{"name":"auto"}]},{"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-link-chart/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"base-cypher-query","description":"A Knowledge Open Cypher Query that will be used to generate the link chart.  The serviceUrl property must also be set\n\nPlease note that this query only runs once and is used to initialize the link chart.  Once link charts are generated, their membership is \"locked\" unless modified by the WebLinkChart API.  Refresh events on the link chart canvas do not re-run the query for new data","values":[]},{"name":"basemap","description":"Specifies a basemap for the link chart. The basemap is only visible when the link\nchart is set to a geographic layout. See\n[documentation on layouts](https://enterprise.arcgis.com/en/knowledge/latest/knowledge-studio/change-the-layout-applied-to-a-link-chart.htm)\nfor more detail. The basemap is a set of layers that give\ngeographic context to the LinkChartView and the other operational layers\nin the link chart.","values":[]},{"name":"center","description":"Represents the position of the view's center. The property can be set with\na [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) or a string representing\na longitude/latitude pair (`\"-100.4593, 36.9014\"`).\nSetting the center immediately changes the current view.\nFor animating the view, see this component's goTo() method.","values":[]},{"name":"display-filter-disabled","description":"Indicates whether a layer's displayFilter is honored when rendering layers in the view.\nIf `true`, display filters are ignored and all features are rendered.","values":[]},{"name":"focus-region-shortcut-enabled","description":"Enables the `Shift` + `Alt`/`Option` + `O` keyboard shortcut for showing the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegion). When `undefined`, the shortcut is enabled only when a [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component is slotted into the ArcgisLinkChart component, or when [popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupComponentEnabled) is set, and when the [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupDisabled) property is `false`. Set to `true` to handle focus-region selection in a custom application, or `false` to disable the shortcut. When `false`, the shortcut does not change the [focusRegionVisible](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegionVisible) property.","values":[]},{"name":"focus-region-visible","description":"Indicates whether the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegion) is visible. Set this property to `true` to show the centered focus region, or `false` to hide it.\nThe focus region can also be shown or hidden by focusing on the ArcgisLinkChart component and pressing the `Shift` + `Alt`/`Option` + `O` keyboard shortcut. By default, this shortcut is available only when a popup component is available and [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupDisabled) is `false`. Use [focusRegionShortcutEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#focusRegionShortcutEnabled) to explicitly enable or disable it.\n\n**Note:** When the focus region is enabled, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) or slotted [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) will be docked with the dock button hidden by default to prevent it from overlapping the focus region.","values":[]},{"name":"hide-attribution","description":"Indicates whether the attribution is hidden in the view.\n\nEsri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content.\nFor detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation.\nFor information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/).","values":[]},{"name":"item-id","description":"The ID of a WebLinkChart from an ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/references/core/config/#portalUrl) before the Link Chart component loads.","values":[]},{"name":"popup-component-enabled","description":"Indicates whether the [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) (beta) is enabled  as the default popup. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) property (representing the component) will be used for popups instead of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popup) property (representing the widget).\n\n**Note:** This is a beta feature and may change in future releases. At version 6.0, the Popup component will be used by default instead of the Popup widget and the `popup-component-enabled` attribute will no longer be necessary.","values":[]},{"name":"popup-disabled","description":"Controls whether the default popup opens automatically when users click on the view. This controls both the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupElement) and [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popup) properties. When set to `true`, the popup will not open on click or when triggered programmatically.","values":[]},{"name":"resize-align","description":"Defines which anchor stays still while resizing the browser window. The default, `center`,\nensures the view's center point remains constantly visible as the window size changes. The other\noptions allow  the respective portion of the view to remain visible when the window's size is changed.","values":[{"name":"top-left"},{"name":"top-right"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"center"},{"name":"bottom"},{"name":"left"},{"name":"right"},{"name":"top"}]},{"name":"rotation","description":"The clockwise rotation of due north in relation to the top of the view in degrees.\nThe view may be rotated by directly setting\nthe rotation or by using the following mouse event: `Right-click + Drag`.\nWebLinkChart rotation may be disabled by setting the `rotationEnabled` property\nin [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#constraints) to `false`.","values":[]},{"name":"scale","description":"Represents the link chart scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's goTo() method.","values":[]},{"name":"service-url","description":"The URL of the Knowledge Graph Service to load the link chart from.\n\nIf no Base Cypher Query is defined, then the entire dataset will be used to generate the link chart.","values":[]},{"name":"suspended","description":"Indicates if the view is visible on the page.","values":[]},{"name":"time-zone","description":"Defines the time zone of the view.\nThe time zone property determines how dates and times are represented to the user,\nbut the underlying data is unchanged.","values":[]},{"name":"zoom","description":"Represents the level of detail (LOD) at the center of the view.\nA zoom level (or scale) is a number that defines how large or small the contents of a link chart appear in a link chart view.\nZoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.\nA value of -1 means the view has no LODs.\nWhen setting the zoom value, the LinkChartView converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\nLinkChartView can display link charts with different projections at a full range of scales, and so use the scale property on this component rather than zoom level.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's goTo() method.\nSetting this property in conjunction with `center` is a convenient way to set the initial extent of the view.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/"},{"name":"Link Chart","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-link-chart--demo&singleStory=true"}]},{"name":"arcgis-link-chart-layout-switcher","description":"A component for use in link charts that allows users to switch between different layouts. See [documentation on layouts](https://enterprise.arcgis.com/en/knowledge/latest/knowledge-studio/change-the-layout-applied-to-a-link-chart.htm) for more details.\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\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 for user interaction.\n- **arcgisSwitchLayout** - Fires when the component has completed the layout switch.\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.\n- `switchLayout(newLayout: \"basic-grid\" | \"chronological-mono-timeline\" | \"chronological-multi-timeline\" | \"geographic-organic-standard\" | \"hierarchical-bottom-to-top\" | \"organic-community\" | \"organic-standard\" | \"radial-root-centric\" | \"tree-left-to-right\"): Promise<void>` - Switches the layout of the link chart to the value provided.","attributes":[{"name":"appearance","description":"The appearance of the layout switcher. `dropdown` displays a button that is clicked to reveal a dropdown menu, while `menu-bar` displays a menu bar.","values":[{"name":"dropdown"},{"name":"menu-bar"}]},{"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-link-chart-layout-switcher/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"close-on-select-disabled","description":"When `true`, the layout menu will not close when a layout is selected. Only applicable when `appearance` is `dropdown`.","values":[]},{"name":"icon","description":"Icon displayed in the component's button, when `appearance` is `dropdown`.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"prevent-extent-update","description":"Prevents extent from updating on changes to the layout.","values":[]},{"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.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart-layout-switcher/"},{"name":"Link Chart Layout Switcher","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-link-chart-layout-switcher--demo&singleStory=true"}]},{"name":"arcgis-link-chart-nonspatial-visibility-toggle","description":"The <link-chart-nonspatial-visibility-toggle> component is used in conjunction with link chart. The component toggles visibility of nonspatial data.\n\nNote: Use the following credentials to sign in to the demo:\n  - Username: `viewer01`\n  - Password: `I68VGU^nMurF`\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 for user interaction.\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.\n- `switchNonspatialVisibility(nonspatialVisibilitySetting: NonspatialMode): Promise<void>` - Switches the nonspatial visibility setting","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-link-chart-nonspatial-visibility-toggle/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"reference-element","description":"By assigning the `id` attribute of the LinkChart component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the LinkChart.\n\nSee also:\n- [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart-nonspatial-visibility-toggle/"},{"name":"Link Chart Nonspatial Visibility Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-link-chart-nonspatial-visibility-toggle--demo&singleStory=true"}]},{"name":"arcgis-locate","description":"The Locate component animates the Map or Scene to the user's current location.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/docs/Web/Security/Defenses/Secure_Contexts), such as HTTPS.\n`localhost` is considered \"potentially secure\" and can be used for testing.\n\n> [!WARNING]\n>\n> **Note**\n>\n> To avoid unexpected navigation, especially when using custom spatial references, configure the view [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#constraints)\n> such as `extent`, `minZoom`, and `maxZoom`.\n> This helps when the geolocated position is inaccurate or causes the map to navigate\n> to a location that is no longer visible because it is outside of\n> a layer's `fullExtent`.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisSuccess**\n\n### Methods\n- `cancelLocate(): Promise<void>` - This function provides the ability to interrupt and cancel the process of\nprogrammatically obtaining the location of the user's device.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `locate(): Promise<GeolocationPosition | null>`","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-locate/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"go-to-location-disabled","description":"Indicates whether navigation to the position and scale of the geolocated result is disabled.","values":[]},{"name":"icon","description":"Icon displayed in the component's button.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"popup-disabled","values":[]},{"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.","values":[]},{"name":"scale","description":"Indicates the scale to set on the view when navigating to the position of the geolocated\nresult, after a location is returned from the [@arcgisSuccess](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-locate/#event-arcgisSuccess) event.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-locate/"},{"name":"Locate","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-locate--demo&singleStory=true"}]},{"name":"arcgis-map","description":"The ArcGIS Map component is used to add 2D maps to web applications. For 3D maps, use the\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\n\n#### Initializing the Map component\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/)\nand can be initialized in one of three ways:\n\n##### 1. Using a WebMap\nLoad a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/) from [ArcGIS Online](https://www.arcgis.com/home/index.html)\nor an [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html) by specifying the [itemId](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#itemId) attribute.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\"></arcgis-map>\n```\n\n##### 2. Setting Map component attributes directly\nDefine the Map component using attributes like [basemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#basemap), [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#center), and [zoom](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#zoom) directly.\n\n```html\n<arcgis-map basemap=\"satellite\" center=\"-154.88, 19.46\" zoom=\"15\"></arcgis-map>\n```\n\n##### 3. Providing a Map instance\nAlternatively, you can provide your own [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/) instance to the component.\nThis allows full control over map configuration, including [basemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#basemap), operational [layers](https://developers.arcgis.com/javascript/latest/references/core/Map/#layers)\nand [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReference). See the [Select features by rectangle sample](https://developers.arcgis.com/javascript/latest/sample-code/highlight-features-by-geometry/)\nfor an example of this approach in action.\n\n```html\n<arcgis-map></arcgis-map>\n<script type=\"module\">\n  const viewElement = document.querySelector(\"arcgis-map\");\n\n  // set the basemap of the map to states feature layer\n  // add national parks feature layer and a polygon graphics layer\n  viewElement.map = new Map({\n    basemap: new Basemap({ baseLayers: [states] }),\n    layers: [nationalParksLayer, polygonGraphicsLayer]\n  });\n\n  // set the spatial reference of the map to NAD 1983 Albers contiguous USA\n  viewElement.spatialReference = { wkid: 102003 };\n</script>\n```\n#### Adding components and customizing the Map\n\nOther components can be added and connected to the Map component.\n\n```html\n<arcgis-map item-id=\"05e015c5f0314db9a487a9b46cb37eca\">\n  <arcgis-zoom slot=\"top-left\"></arcgis-zoom>\n  <arcgis-legend slot=\"bottom-left\"></arcgis-legend>\n</arcgis-map>\n```\n\nThe Map component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/references/core/) of the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\");\nviewElement.addEventListener(\"arcgisViewReadyChange\", () => {\n  const layer = new GraphicsLayer({ title: \"My Layer\" });\n  viewElement.map.add(layer);\n});\n```\n\nSee also:\n- [SDK sample apps using the Map component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-map)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisLoadError** - Fires when an arcgis-map fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\n- **arcgisViewAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-create)\n- **arcgisViewAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is triggered when view-related properties change, such as [zoom](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#zoom), [scale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#scale), [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#center), [rotation](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#rotation), [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#extent),\n[viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#viewpoint), or [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#stationary).\nIt reflects user interactions (e.g. panning or zooming) or programmatic updates to the view.\n\n> The `arcgisViewChange` event may be emitted before the view is fully ready.\n> This means the event can fire before the component's `stationary` property is `true` or before the view has completed its initial setup.\n> For actions that require the view to be ready and stationary, combine this event with checks on the component's `stationary` and `ready` properties.\n- **arcgisViewClick** - Fires after a user clicks on the view. This event emits slightly slower than an [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick)\nevent to make sure that an [@arcgisViewDoubleClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewDoubleClick) event isn't triggered instead. The `arcgisViewImmediateClick`\nevent can be used for responding to an `arcgisViewClick` event without delay.\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n- **arcgisViewDoubleTapDrag** - Fires while the pointer is dragged following a double-tap gesture on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-double-tap-drag)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n- **arcgisViewFocusRegionSelect** - Fires when the focus region is selected using the `Enter` or `Space` key. Use this event to react to the selection of the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegion) via keyboard input and perform any necessary actions based on that selection, such as performing a `hitTest()` on the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegion) and passing the returned graphics to the [selectionManager](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#selectionManager).\n\nCall `event.detail.preventDefault()` to suppress the default behavior of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opening with the features in the focus region.\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view. In contrast to the [@arcgisViewClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewClick) event, the `arcgisViewImmediateClick`\nis emitted as soon as the user clicks on the view, and is not inhibited by a [@arcgisViewDoubleClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewDoubleClick) event.\nThis event is useful for interactive experiences that require feedback without delay.\n- **arcgisViewImmediateDoubleClick** - Fires after two consecutive [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick) events. In contrast to [@arcgisViewDoubleClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewDoubleClick),\nan `arcgisViewImmediateDoubleClick` cannot be prevented by use of `stopPropagation()` on the [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick)\nevent and can therefore be used to react to double-clicking independently of usage of the [@arcgisViewImmediateClick](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#event-arcgisViewImmediateClick) event.\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding\n[LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)\ncreated and rendered in the view.\n- **arcgisViewLayerviewCreateError** - Fires when an error occurs during the creation of a [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)\nafter a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a [LayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/LayerView/)\nis destroyed and is no longer rendered in the view.\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n- **arcgisViewReadyChange** - This event is for the `ready` property and is emitted when the view is ready.\nFires also when the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#map) is updated.\n- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\n- **arcgisViewVerticalTwoFingerDrag** - Fires while the two pointers are dragged vertically on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#event-vertical-two-finger-drag)\n\n### Methods\n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `fetchPopupFeatures(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise<AsyncGenerator<Graphic>>` - Use this method to query for features at a given screen location. These features come from origins (layers and sublayers) configured with a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [FeatureLayer.popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled) set. One example could be a custom side panel that displays feature-specific information based on an end user's click location. This method allows a developer to control how the input location is handled, and then subsequently, what to do with the results.\n> [!WARNING]\n> Using [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) as the hit target is considered **[beta](https://developers.arcgis.com/javascript/latest/faq/#what-does-the-beta-tag-mean)** functionality.\n- `goTo(target: GoToTarget2D, options?: GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `hitTest(hitTarget: MouseEvent | ScreenPoint | ScreenPolygon | ScreenRect, options?: HitTestOptions): Promise<ViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/references/core/views/types/#ViewHitTestResult) from each layer that intersects the specified hit target.\nThe returned object contains an array of different [result types](https://developers.arcgis.com/javascript/latest/references/core/views/types/#ViewHit)\nsuch as graphics, raster pixels, media elements, or routes.\n\n**2D hitTest() behavior by layer type**\n| Layer type | Hit test behavior |\n| :--- | :--- |\n| [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer), [CatalogFootprintLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/catalog/CatalogFootprintLayer), [CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer), [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer), [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OGCFeatureLayer), [OrientedImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/OrientedImageryLayer), [ParquetLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ParquetLayer), [StreamLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/StreamLayer), [SubtypeGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SubtypeGroupLayer), [WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer) | Returns all [features](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) that intersect the hit target. |\n| [GeoRSSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoRSSLayer), [GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer), [KMLLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/KMLLayer), [SketchLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SketchLayer) | Returns all [features](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) that intersect the hit target. |\n| [ImageryLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryLayer),  [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/ImageryTileLayer)| Returns a [result](https://developers.arcgis.com/javascript/latest/references/core/views/types/#RasterHit) containing raster pixel value used in rendering and bandId info on intersecting pixels. Support was added in version 5.1. For a `ScreenRect` hit target, the hit result is returned for the center of the specified shape. |\n| [VectorTileLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VectorTileLayer) | Returns a result for all intersecting [features](https://developers.arcgis.com/javascript/latest/references/core/views/types/#GraphicHit) containing attributes of style layers (as of version 4.29; in prior releases, only the topmost style layer result was returned). In addition, the graphic's [origin](https://developers.arcgis.com/javascript/latest/references/core/Graphic#origin) contains the style layer's [id](https://maplibre.org/maplibre-style-spec/layers/#id) and layer index within the [vector tile style](https://doc.arcgis.com/en/arcgis-online/reference/tile-layers.htm#ESRI_SECTION1_8F68399EB47B48FF9EF46719FCC96978). Spatial information about the actual feature represented in the style layer is returned only if the style layer is a [symbol layer](https://maplibre.org/maplibre-style-spec/layers/#symbol). Otherwise, the graphic's geometry is `null`. |\n| [MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer) | Returns a [result](https://developers.arcgis.com/javascript/latest/references/core/views/types/#MediaHit) for each media element that intersects the hit target. |\n| [RouteLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/RouteLayer) | Returns a [result](https://developers.arcgis.com/javascript/latest/references/core/views/types/#RouteHit) for each route element that intersects the hit target. |\n\n**Note:** If the [Polygon](https://developers.arcgis.com/javascript/latest/references/core/geometry/Polygon) feature's symbol [SimpleFillSymbol.style](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol#style) is set to \"none\", the hitTest method will not\nreturn results when the fill is clicked. However, it will return results when the outline is clicked. To get results when clicking the fill, set the\n[SimpleFillSymbol.color](https://developers.arcgis.com/javascript/latest/references/core/symbols/SimpleFillSymbol#color) to a transparent color instead.\n\nRelease-specific changes:\n* At version 5.2, support for [ScreenPolygon](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenPolygon) hit targets was added.\n* At version 5.1, support for [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) hit targets was added.\n- `openPopup(options?: ViewPopupOpenOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with content or driven\nfrom the PopupTemplate of input features.\n- `takeScreenshot(options?: UserSettings): Promise<Screenshot>` - Create a screenshot of the current view.\n- `toMap(screenPoint: MouseEvent | ScreenPoint): Point`\n- `toScreen(point: Point, options?: ToScreenOptions2D): ScreenPoint | null | undefined`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView(analysis: Analysis): Promise<AnalysisView2DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#whenAnalysisView)\n- `whenLayerView<TLayer extends Layer>(layer: TLayer): Promise<LayerView2DFor<TLayer>>` - Gets the LayerView created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#whenLayerView)\n- `zoomIn(): Promise<void>` - Zooms in the view component by a factor of 2.\n- `zoomOut(): Promise<void>` - Zooms out the view component by a factor of 2.\n\n### Slots\n- _default_ - Default slot for adding components to the map. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n- **popup** - Slot for the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot.\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the view. \n- **--arcgis-table-row-background-color** - _Since 5.1_ Specifies the background color for table rows. \n- **--arcgis-table-row-alt-background-color** - _Since 5.1_ Specifies the background color for alternate table rows. \n- **--arcgis-focus-region-outer-border-color** - _Since 5.2_ Specifies the outer border color of the focus region. \n- **--arcgis-focus-region-inner-border-color** - _Since 5.2_ Specifies the inner border color of the focus region. \n- **--arcgis-focus-region-border-width** - _Since 5.2_ Specifies the border width of the focus region. ","attributes":[{"name":"animations-disabled","description":"Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/PictureMarkerSymbol/)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/FlowRenderer/)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The display mode used for the attribution. Defaults to null.\n\nSet this property to \"auto\" to automatically synchronize the attribution with the nearest [Calcite mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes). If no Calcite mode is detected, the attribution defaults to light mode. **The \"auto\" mode was added in version 5.2.**\n\nSet this property to \"light\" or \"dark\" to explicitly use that mode without synchronization.","values":[{"name":"dark"},{"name":"light"},{"name":"auto"}]},{"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-map/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"basemap","description":"Specifies a basemap for the map. The basemap is a set of layers that give\ngeographic context to the view and the other operational layers\nin the map.\n\nThe basemap can be set from a basemap ID string from the [basemap styles service](https://developers.arcgis.com/javascript/latest/references/core/support/BasemapStyle/), such as `arcgis/navigation`, or from the [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/) class.\n\n> [!NOTE]\n> Accessing the basemap styles service requires authentication, see [Authentication and access tokens](https://developers.arcgis.com/javascript/latest/authentication/access-tokens/) for more information.","values":[]},{"name":"center","description":"Represents the view's center point; when setting the center, you may pass a\n[Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) instance, numbers representing\na longitude/latitude pair (`[-100.4593, 36.9014]`), or a string attribute representing a longitude/latitude pair (\"-100.4593, 36.9014\").\nSetting the `center` immediately changes the current view. For animating the view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) method.\n\nThe returned [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) object is always\nin the spatial reference of the view and may be modified internally.\nTo persist the returned object, create a clone using [clone()](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/#clone) method.\n\n**Notes**\n\n* If the spatial reference of `center` set in the constructor does not match the [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReference) of the view, then the\n[projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/) will be loaded dynamically.\n* At runtime, the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/) must be\n[loaded](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#load) when\nsetting the `center` to a spatial reference that doesn't match the view spatial reference. You can check if the projectOperator is\nloaded prior to setting the center by calling [isLoaded()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#isLoaded)\nmethod. If it is not yet loaded, you can call [load()](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/#load) method.","values":[]},{"name":"display-filter-disabled","description":"Indicates whether a layer's `displayFilterInfo` is honored when rendering layers in the view.\nIf `true`, display filters are ignored and all features are rendered.","values":[]},{"name":"focus-region-shortcut-enabled","description":"Enables the `Shift` + `Alt`/`Option` + `O` keyboard shortcut for showing the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegion). When `undefined`, the shortcut is enabled only when a [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component is slotted into the ArcgisMap component, or when [popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupComponentEnabled) is set, and when the [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupDisabled) property is `false`. Set to `true` to handle focus-region selection in a custom application, or `false` to disable the shortcut. When `false`, the shortcut does not change the [focusRegionVisible](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegionVisible) property.","values":[]},{"name":"focus-region-visible","description":"Indicates whether the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegion) is visible. Set this property to `true` to show the centered focus region, or `false` to hide it.\nThe focus region can also be shown or hidden by focusing on the ArcgisMap component and pressing the `Shift` + `Alt`/`Option` + `O` keyboard shortcut. By default, this shortcut is available only when a popup component is available and [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupDisabled) is `false`. Use [focusRegionShortcutEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#focusRegionShortcutEnabled) to explicitly enable or disable it.\n\n**Note:** When the focus region is enabled, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) or slotted [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) will be docked with the dock button hidden by default to prevent it from overlapping the focus region.","values":[]},{"name":"ground","description":"Specifies the surface properties for the map.","values":[]},{"name":"hide-attribution","description":"Indicates whether the attribution is hidden in the view.\n\nEsri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content.\nFor detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation.\nFor information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/).","values":[]},{"name":"item-id","description":"The ID of a WebMap from ArcGIS Online or ArcGIS Enterprise portal.\n\nTo configure the portal url you must set the [`portalUrl` property on `config`](https://developers.arcgis.com/javascript/latest/references/core/config/#portalUrl) before the Map component loads.","values":[]},{"name":"popup-component-enabled","description":"Indicates whether the [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) (beta) is enabled  as the default popup. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) property (representing the component) will be used for popups instead of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popup) property (representing the widget).\n\n**Note:** This is a beta feature and may change in future releases. At version 6.0, the Popup component will be used by default instead of the Popup widget and the `popup-component-enabled` attribute will no longer be necessary.","values":[]},{"name":"popup-disabled","description":"Controls whether the default popup opens automatically when users click on the view. This controls both the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupElement) and [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popup) properties. When set to `true`, the popup will not open on click or when triggered programmatically.","values":[]},{"name":"resize-align","description":"Defines which anchor stays still while resizing the browser window. The default, `center`,\nensures the view's center point remains constantly visible as the window size changes. The other\noptions allow  the respective portion of the view to remain visible when the window's size is changed.","values":[{"name":"top-left"},{"name":"top-right"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"center"},{"name":"bottom"},{"name":"left"},{"name":"right"},{"name":"top"}]},{"name":"rotation","description":"The clockwise rotation of due north in relation to the top of the view in degrees.\nThe view may be rotated by directly setting\nthe rotation or by using the following mouse event: `Right-click + Drag`.\nMap rotation may be disabled by setting the `rotationEnabled` property\nin [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#constraints) to `false`. See the code snippet below for\nan example of this.","values":[]},{"name":"scale","description":"Represents the map scale at the center of the view. Setting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) method.","values":[]},{"name":"spatial-reference-locked","description":"Indicates if the map's [spatialReference](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#spatialReference) can be changed after it is ready.\nThe default is `false`, indicating the map's spatialReference can be changed at runtime.\nWhen true, basemaps with spatial references that do not match the map's spatial reference\nwill be disabled in [arcgis-basemap-gallery](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/) components and the map's spatialReference cannot be changed at runtime.","values":[]},{"name":"suspended","description":"Indicates if the view is visible on the page.","values":[]},{"name":"time-zone","description":"Defines the time zone of the view.\nThe time zone property determines how dates and times are represented to the user,\nbut the underlying data is unchanged.","values":[]},{"name":"zoom","description":"Represents the level of detail (LOD) at the center of the map.\nA zoom level (or scale) is a number that defines how large or small the contents of a map appear in a Map component.\nZoom level is a number usually between 0 (global view) and 23 (very detailed view) and is used as a shorthand for predetermined scale values.\nA value of -1 means the map has no LODs.\nWhen setting the zoom value, the component converts it to the corresponding scale, or interpolates it if the zoom is a fractional number.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#goTo) method.\nSetting this property in conjunction with `center` is a convenient way to set the initial extent of the view.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/"},{"name":"Map","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-map--demo&singleStory=true"}]},{"name":"arcgis-navigation-toggle","description":"The Navigation Toggle component can be used to control the navigation mode of a Scene component.\n\nWhen the navigation mode is set to \"pan\" (default), the mouse drag gesture pans the view and right-click + drag allows the user\nto rotate the view. When the navigation mode is set to \"rotate\", the mouse drag gesture rotates the view and\nright-click + drag pans the view.\n\n**Known limitations**\n\nNavigation Toggle is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n @since 4.28\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 for user interaction.\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.\n- `toggle(): 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-navigation-toggle/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layout","description":"The layout direction of the component.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"name":"navigation-mode","description":"The navigation mode of the view. The possible values:\n\n* `pan` - The mouse drag gesture pans the view. Right-click + drag allows the user to perform a 3D rotate around the center of the view.\n* `rotate` - The mouse drag gesture performs a 3D rotate around the center of the view and the right-click + drag gesture pans the view.","values":[{"name":"pan"},{"name":"rotate"}]},{"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.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-navigation-toggle/"},{"name":"Navigation Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-navigation-toggle--demo&singleStory=true"}]},{"name":"arcgis-oriented-imagery-viewer","description":"The Oriented Imagery Viewer component allows the user to explore and use their oriented images.\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 for user interaction.\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.\n- `loadBestImage(mapPoint: Point, options?: AbortOptions): Promise<void>` - Loads the best available image for a given map point and displays it in the viewer. The method takes a `Point` object as an argument, which represents the location on the map for which the best image should be loaded. The viewer will analyze the available images for that location and select the one that best matches the given location.\n- `reset(): void` - /**\nResets the viewer to its initial state.\nThis method clears the currently displayed image or video from the viewer and removes all associated graphics from the map.\n- `showImageByObjectId(objectId: ObjectId, options?: ShowImageByObjectIdOptions): Promise<void>` - Displays the image corresponding to the specified object ID.","attributes":[{"name":"action-bar-position","description":"Specifies the position of the action bar within the oriented imagery viewer.\n| Position | Description |\n|----------|-------------|\n| bottom   | Action bar is positioned at the bottom of the viewer. |\n| end      | Action bar is positioned at the end of the viewer. |\n| start    | Action bar is positioned at the start of the viewer. |\n| top      | Action bar is positioned at the top of the viewer. |","values":[{"name":"bottom"},{"name":"end"},{"name":"start"},{"name":"top"}]},{"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-oriented-imagery-viewer/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"current-coverage-visible","description":"Toggles the visibility of the current footprint polygon associated with the selected image loaded in the viewer.\nCurrent footprint coverage allows you to better understand how the images in the oriented imagery layer relate to the map.\nThe footprint of the image is symbolized with red fill on the map. If you zoom or pan in the oriented imagery viewer,\nthe footprint coverage graphic will update on the map to highlight the area on the map that is visible in the image.","values":[]},{"name":"data-capture-enabled","description":"Indicates whether the data capture tools are enabled in the oriented imagery viewer for digitization.\nWhen set to `true`, the data capture (edit) option will be visible on the digitizable overlayed feature layers available in the image overlays tab.\nOn clicking the data capture option, the digitization tools will appear at the bottom of the viewer once the overlay tab is closed.","values":[]},{"name":"disabled","description":"When `false`, the view click interaction is enabled for the oriented imagery viewer component. This allows users to pick a location on the map and display the best image to the viewer.\nWhen `true`, the view click interaction will be defaulted to map navigation.","values":[]},{"name":"gallery-opened","description":"Indicates if the image gallery functionality is available in the component.\nTo visualize additional images of the same location, select the image gallery from the oriented imagery viewer.\nThe gallery is a carousel of low-resolution thumbnails of all images that depict the selected map location. Click a thumbnail to view the full-resolution image in the oriented imagery viewer.","values":[]},{"name":"hide-additional-camera-locations-toggle","description":"Indicates whether to hide the action button that toggles visibility of camera locations\nfor additional images, meaning images other than the currently displayed image.","values":[]},{"name":"hide-additional-footprints-toggle","description":"Indicates whether to hide the action button that toggles visibility of footprints\nfor additional images, meaning images other than the currently displayed image.","values":[]},{"name":"hide-current-footprint-toggle","description":"Indicates whether to hide the action button that toggles visibility of the footprint\nfor the currently displayed image.","values":[]},{"name":"hide-directional-navigation-toggle","description":"Indicates whether to hide the action button that toggles directional navigation mode.","values":[]},{"name":"hide-display-image-toggle","description":"Indicates whether to hide the action button that displays imagery for the clicked feature.\nUnlike explore-images mode, this action uses the feature returned from the click location\ninstead of performing a spatial query for the best image.","values":[]},{"name":"hide-enhancement-tool-toggle","description":"Indicates whether to hide the action button that opens the image enhancement controls.","values":[]},{"name":"hide-explore-images3d-toggle","description":"Indicates whether to hide the action button that toggles 3D explore-images mode.","values":[]},{"name":"hide-explore-images-toggle","description":"Indicates whether to hide the action button that toggles explore-images mode,\nallowing the user to click the map and load imagery for that location.","values":[]},{"name":"hide-header","description":"Indicates whether to hide the header of the widget.","values":[]},{"name":"hide-image-gallery-toggle","description":"Indicates whether to hide the action button that opens the image gallery.","values":[]},{"name":"hide-image-measurement-tools-group","description":"Indicates whether to hide the top-level action bar group for measurement tools.","values":[]},{"name":"hide-image-navigation-group","description":"Indicates whether to hide the top-level action bar group for image navigation tools.","values":[]},{"name":"hide-image-overlays-toggle","description":"Indicates whether to hide the action button that opens the image overlays UI.","values":[]},{"name":"hide-map-image-location-tool-toggle","description":"Indicates whether to hide the action button that toggles the map-image conversion tool.","values":[]},{"name":"hide-menu","description":"Indicates whether to hide the action bar of the widget.","values":[]},{"name":"hide-navigation-tool-toggle","description":"Indicates whether to hide the action button that toggles the navigation tool.","values":[]},{"name":"hide-overlays-group","description":"Indicates whether to hide the top-level action bar group for overlay controls.","values":[]},{"name":"hide-popups-action","description":"Indicates whether to hide the action button that shows image popups and attributes.","values":[]},{"name":"hide-search-group","description":"Indicates whether to hide the top-level action bar group for search and image discovery tools.","values":[]},{"name":"hide-sequential-navigation-toggle","description":"Indicates whether to hide the action button that toggles sequential navigation mode.","values":[]},{"name":"hide-superimpose-view-toggle","description":"Indicates whether to hide the action button that toggles superimposition of the current image\nin a 3D scene when the required camera properties and metadata are available.","values":[]},{"name":"hide-utilities-group","description":"Indicates whether to hide the top-level action bar group for utility tools.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"image-enhancement-tool-active","description":"Indicates if the image enhancement tool is active. When `true`, the component displays the functionalities to adjust the brightness, contrast, and sharpness of the\nimage in the oriented imagery viewer using interactive sliders.\nSettings will be preserved for subsequent images loaded in the oriented imagery viewer.","values":[]},{"name":"image-overlays-opened","description":"Indicates whether the image overlays tab in the oriented imagery viewer is open.\nWhen set to `true`, the overlays tab appears at the bottom of the viewer. It includes two toggle options: overlay camera locations and overlay map features.\nThese options enable users to visualize and overlay map features that intersect with the image’s footprint within the viewer.","values":[]},{"name":"is-additional-coverage-visible","description":"Indicates if the additional footprint polygons are visible for the selected image loaded in the viewer.\nThe footprint graphics (appearing in blue) show the coverage footprints of all the additional images in the\nlayer that depict the location selected by the user.","values":[]},{"name":"is-additional-point-sources-visible","description":"Indicates if the additional camera locations are visible for the selected image loaded in the viewer.\nThe point location graphics (appearing in blue) show the camera locations for additional images that depict the location the user selects.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"map-image-conversion-tool-state","description":"Indicates if the map-image location tool is available in the component.\nWhen `true`, the user can select a point on the map and the corresponding location in pixel space will be displayed in the image, and vice versa.","values":[]},{"name":"map-layer-id","description":"The layer ID of an Oriented Imagery Layer in the associated map.\nWhen set, the component will attempt to find and use the layer with the provided ID from the map.\n\n> [!WARNING]\n> Use `layer`, `mapLayerId`, and `orientedImageryLayerItemId` independently; only one should be set at a time.","values":[]},{"name":"navigation-tool-active","description":"When `true`, the navigation tool is available in the component.\nThe navigation tool can be used to explore the images that contain the selected location on the map using a compass.\nTo view a different image of the selected map location, click the camera locations (blue dots), or click a segment to view\nthe best image from that segment (segments with images are shown in white; segments without images are gray).","values":[]},{"name":"oriented-imagery-layer-item-id","description":"The portal item ID of an Oriented Imagery Layer to load and use in the component.\n\n> [!WARNING]\n> Use `layer`, `mapLayerId`, and `orientedImageryLayerItemId` independently; only one should be set at a time.","values":[]},{"name":"preload-media","description":"When true, loading an image via directional or sequential navigation caches all neighboring images associated with that image.\nNavigating to adjacent images then uses the cached assets, reducing load times and improving viewer performance.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-oriented-imagery-viewer/"},{"name":"Oriented Imagery Viewer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-oriented-imagery-viewer--demo&singleStory=true"}]},{"name":"arcgis-oriented-imagery-viewer-non-panoramic-viewer","description":"### Methods\n- `addGraphic(graphic: Graphic): void`\n- `addGraphics(graphics: Graphic[]): void`\n- `clearGraphics(): void`\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `mediaOnLoad(): Promise<NonPanoramicMedia | undefined>`\n- `removeGraphic(graphic: Graphic): void`\n- `removeGraphics(graphics: Graphic[]): void`","attributes":[{"name":"hide-header","values":[]},{"name":"hide-loader","values":[]},{"name":"hide-video-controls","values":[]},{"name":"hide-zoom-controls","values":[]},{"name":"rotation","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-oriented-imagery-viewer-non-panoramic-viewer/"}]},{"name":"arcgis-oriented-imagery-viewer-panoramic-viewer","description":"### Methods\n- `addGraphic(graphic: Graphic): void`\n- `addGraphics(graphics: Graphic[]): void`\n- `clearGraphics(): void`\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `mediaOnLoad(): Promise<PanoramicMedia | undefined>`\n- `removeGraphic(graphic: Graphic): void`\n- `removeGraphics(graphics: Graphic[]): void`\n- `zoomIn(): void`\n- `zoomOut(): void`","attributes":[{"name":"hide-loader","values":[]},{"name":"hide-title","values":[]},{"name":"hide-video-controls","values":[]},{"name":"hide-zoom-controls","values":[]},{"name":"pitch","values":[]},{"name":"yaw","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-oriented-imagery-viewer-panoramic-viewer/"}]},{"name":"arcgis-oriented-imagery-viewer-panoramic-viewer-zoom","description":"### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.\n- `zoomFOV(fov: number): void`\n- `zoomIn(): void`\n- `zoomOut(): 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-oriented-imagery-viewer-panoramic-viewer-zoom/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layout","description":"Determines the layout/orientation of the Zoom component.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"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.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-oriented-imagery-viewer-panoramic-viewer-zoom/"}]},{"name":"arcgis-oriented-imagery-viewer-video-controls","description":"### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-oriented-imagery-viewer-video-controls/"}]},{"name":"arcgis-paste","description":"The Paste component provides a UX for working with a Clipboard and\ncopy and pasting features and/or geometries.\n--\n\n### Events\n- **arcgisApplyPasteCommand** - The user has initiated a paste command.\n- **arcgisApplyPasteError** - An error occurred performing a paste command\n- **arcgisBeforeClipboardMove** - The clipboard move interactive operation is about to start\n- **arcgisClipboardMoveStateChanged** - The clipboard move interactive operation has changed state.\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 for user interaction.\n\n### Methods\n- `cancelMoveClipboard(): Promise<void>` - Cancels any running Clipboard Move Interaction\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component\n- `executePasteCommand(id: SupportedPasteCommand, options?: {\n    silent?: boolean;\n    showFeatureForm?: boolean;\n}): Promise<PasteExecuteResult>` - Execute a paste command without opening the panel.\n\nparam id - The paste commands identifier\nparam options.silent - Determines if the command is being run without UX, or if it is running with the panel open\n- `registerPasteCommand(pasteCommand: CustomPasteCommand): Promise<void>` - Registers a custom Paste Command\n- `reset(): Promise<void>` - Resets the Paste panel to its home page\n- `showClipboardItems(visible: boolean): Promise<void>` - Method to show the clipboard items on the map\n- `startMoveClipboard(continuous: boolean): Promise<void>` - Start an interactive clipboard move operation\n- `writeChanges(applySet: ApplySet): Promise<(ApplySetLayerEditResult | ApplySetServiceEditResult)[]>` - Method to write the paste edits to the geodatabase(s).\n\n### Slots\n- **home-header-actions-start** - Slot for adding actions to the start of the header on the entry page.\n- **header-actions-end** - Slot for adding actions to the end of the header.\n- **gallery-page-message** - Slot for adding content to the template gallery page.\n- **commands-page-message** - Slot for adding content to commands page.\n\n### CSS Properties\n- **--arcgis-paste-height** - Specifies the height of the component. \n- **--arcgis-paste-width** - Specifies the width of the component. \n- **--arcgis-paste-blocks-padding** - Specifies the padding for elements within the component. ","attributes":[{"name":"always-show-feature-form","description":"Determines if the attributes panel should be shown for newly created paste features. If not set\nthe panel will only be shown if there are mandatory fields that have not been provided.","values":[]},{"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-paste/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When true, the component will be hidden.","values":[]},{"name":"close-on-apply","description":"Determines if the panel will automatically close after it has applied a Paste.","values":[]},{"name":"disable-templates-mode","description":"Decide if templates should be disabled when the layer is not visible, or not visible at the current scale.","values":[{"name":"scale"},{"name":"never"},{"name":"visible"}]},{"name":"hide-error-notice","description":"Determines if the component should show error notices","values":[]},{"name":"hide-footer","description":"Determines if the footer should be hidden.","values":[]},{"name":"hide-footer-cancel-button","description":"Determines if the attributes panel should have a Cancel button in the Footer, or rely on the close header action","values":[]},{"name":"hide-header-close-button","description":"Determines if the component should have a close button. A close button can be added by using the header-actions-end slot.","values":[]},{"name":"hide-tooltips","description":"Indicates whether to display the tooltip for clipboard and other actions.","values":[]},{"name":"hide-view-clipboard","description":"Determines if the view clipboard action is available","values":[]},{"name":"highlight-group","description":"The highlight group to use when highlighting features when they are being created.","values":[]},{"name":"maximum-feature-count","description":"The maximum number of features that can be created by a paste operation.","values":[]},{"name":"maximum-feature-count-with-complex-forms","description":"The maximum number of features that can be created by a paste operation.\nwhen there are complex Arcade expressions that must be executed.","values":[]},{"name":"paste-with-multiple-features-enabled","description":"Determines whether pasting multiple features is supported","values":[]},{"name":"paste-with-multiple-layers-enabled","description":"Determines whether pasting new features into multiple layers is allowed","values":[]},{"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.","values":[]},{"name":"supported-commands","description":"The list of supported paste operations. New types of operations can be registered using the 'registerPasteOperation'","values":[{"name":"paste"},{"name":"paste-append"},{"name":"paste-as"},{"name":"paste-merge"},{"name":"paste-subtract"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-paste/"}]},{"name":"arcgis-clipboard","description":"The Feature Clipboard displays the current contents of the clipboard.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"hide-tooltips","description":"Indicates whether to display tooltips on clipboard items.","values":[]},{"name":"max-show-count","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-clipboard/"}]},{"name":"arcgis-feature-image","description":"The Feature Image component generates a feature swatch representing a\nFeature.\nThe component can be configured to only generate a swatch, when the element\nis within the visible scope of the page.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"height-in-pixels","description":"The generated thumbnail height","values":[]},{"name":"min-width","values":[]},{"name":"use-true-shape","description":"Specifies whether to use the shape of the feature. If set to false, then a simple symbol swatch will be used.","values":[]},{"name":"width-in-pixels","description":"The generated thumbnail width","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-image/"}]},{"name":"arcgis-feature-title","description":"The Feature Title component generates a feature title for a graphic\nThe component can be configured to only generate a title, when the element\nis within the visible scope of the page.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"is-new-feature","description":"Flag to indicate that the graphic is a new feature and may not have an OID field","values":[]},{"name":"no-title-label","description":"Label to show if the feature does not have a","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-title/"}]},{"name":"arcgis-multi-feature-form","description":"The Multi Feature Form component provides a Feature Form which works with\nlayer FeatureForm templates. It allows for multiple features to be edited at once.\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 for user interaction.\n- **arcgisSubmit** - Fires when the [submit()](https://developers.arcgis.com/javascript/latest/references/core/widgets/BatchAttributeForm/#submit) method is called.\n- **arcgisValueChange** - Fires when a field value is updated.\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.\n- `getValues(graphic: Graphic): Record<string, unknown>`\n- `goToFirstError(): void`\n- `userChangesHaveMadeFeatureInvalid(feature: Graphic): boolean`","attributes":[{"name":"active-feature-index","values":[]},{"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-multi-feature-form/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","values":[]},{"name":"edit-type","values":[{"name":"INSERT"},{"name":"UPDATE"},{"name":"DELETE"},{"name":"NA"}]},{"name":"group-display","values":[{"name":"all"},{"name":"sequential"}]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"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).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"maximum-feature-count","values":[]},{"name":"maximum-feature-count-with-complex-forms","values":[]},{"name":"read-only","values":[]},{"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.","values":[]},{"name":"submit-has-been-attempted","values":[]},{"name":"time-zone","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-multi-feature-form/"}]},{"name":"arcgis-popup","description":"## Overview\nThe Popup component allows users to view content from feature attributes. Popups enhance web applications\nby providing users with a simple way to interact with and view attributes in a layer.\nThey play an important role in relaying information to the user, which improves the storytelling capabilities of the application.\n\nThe popup component can be added to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) using the `popup` slot.\nWhen added to a view component, the popup is automatically populated with content from the selected feature in the view and displays when clicking on features in the view.\nThe content of the popup is determined based on the [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) assigned to the selected feature.\n\n```html\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\">\n  <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n```\n\nThe Popup component can also be opened manually at a specific location using the [open](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#open) property.\nTo prevent the popup from opening automatically when clicking on features within view components, set the `popup-disabled` attribute to `true` and add the Popup component to the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) using the `popup` slot.\nBefore setting the `open` property to `true`, you must set the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) property to specify where the popup should open.\n\nExample of opening the popup at a clicked location with custom content:\n\n```html\n<!-- Set popup-disabled and popup-component-enabled attributes -->\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\" popup-disabled>\n  <!-- Add the popup component to the popup slot. -->\n  <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n<script>\nconst viewElement = document.querySelector(\"arcgis-map\");\nconst popupComponent = document.querySelector(\"arcgis-popup\");\n// Listen for clicks on the view and open the popup at the clicked location with custom content.\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n  const { mapPoint } = event.detail;\n  popupComponent.location = mapPoint;\n  popupComponent.heading = \"You clicked here\";\n  popupComponent.content = \"Latitude: \" + mapPoint.latitude.toFixed(3) + \", Longitude: \" + mapPoint.longitude.toFixed(3);\n  popupComponent.open = true;\n});\n</script>\n```\n\nAlternatively, you can call the [arcgis-map.fetchPopupFeatures()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#fetchPopupFeatures) method within the view element's click event listener to open the popup with features at the clicked location.\n```html\n<!-- Set popup-disabled and popup-component-enabled attributes -->\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\" popup-disabled>\n  <!-- Add the popup component to the popup slot. -->\n  <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n<script>\nconst viewElement = document.querySelector(\"arcgis-map\");\nconst popupComponent = document.querySelector(\"arcgis-popup\");\n// Listen for clicks on the view and populate the popup with features at that location.\nviewElement.addEventListener(\"arcgisViewClick\", async (event) => {\n const generator = await viewElement.fetchPopupFeatures(event.detail.screenPoint, {\n   pointerType: event.detail.pointerType,\n });\n\n const features = await Array.fromAsync(generator);\n popupComponent.features = features;\n});\n// Open the popup when the features property changes.\nreactiveUtils.watch(\n() => popupComponent.features,\n() => {\n  popupComponent.open = popupComponent.features ? true : false;\n});\n</script>\n```\n\nThe popup component can be used with the view components by default. Set the `popup-component-enabled` attribute to `true` using [arcgis-map.popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupComponentEnabled), [arcgis-scene.popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupComponentEnabled), or [arcgis-link-chart.popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/#popupComponentEnabled) to open the popup component automatically when clicking on features.\n\n```html\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\" popup-component-enabled></arcgis-map>\n```\n> At version 6.0, the Popup component will be used by default and setting the `popup-component-enabled` attribute will no longer be necessary.\n\n## Popup UI\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) components contain a default popup.\nThis popup can display generic content, which is set in its [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading)\nand [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content) properties.\nWhen  content is set directly on the Popup instance it is not tied to a specific feature or layer.\n\n![popup-basic-example](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/popup/popup-basic.avif)\n\nIn the image above, the text \"Marriage in Nassau County Census Tract 5177.01\" is the popup's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading).\nThe remaining text is the popup's [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content).\nA dock button is displayed in the top right corner of the popup allowing the user to dock the popup to one of the sides or corners of the view.\nThe options for docking may be set in the [dockOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#dockOptions) property.\nThe popup may also be collapsed by clicking the collapse button (the down arrow icon) in the top right corner of the popup.\nWhen collapsed, only the heading of the popup displays.\nThe popup may be closed by clicking the close button (the \"x\" icon) in the top right corner of the popup.\n\nPopups can also contain [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions) which execute a function defined by the developer when clicked.\nBy default, every popup has a \"Zoom to\" action (as shown in the image above with the magnifying glass) that allows users to zoom to the selected feature.\nSee the [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions) property for information about adding custom actions to a popup.\n\nThe Popup component is tied to an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/) component, whether it's docked or anchored to the selected feature.\nIf wanting to utilize the Popup functionality outside of [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-link-chart/), the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features/) component can be used to display the same content\nin its own container.\n\n## Popup and PopupTemplate\n[PopupTemplates](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) are closely related to Popup, but are more specific to [layers](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/)\nand [graphics](https://developers.arcgis.com/javascript/latest/references/core/Graphic/). Popup templates allow you to define custom titles and content templates based on the source of the\n[selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature). When a layer or a graphic has a defined\npopup template, the popup will display the content defined in the popup template when the feature is clicked.\nThe content may contain field values from the attributes of the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature).\n\nCustom PopupTemplates may also be assigned directly to a popup by setting [graphics](https://developers.arcgis.com/javascript/latest/references/core/Graphic/) on the\n[features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) property.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange**\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisTriggerAction** - Fires after the user clicks on an action in the Popup component.\nThis event may be used to define a custom function to execute when particular actions are clicked.\n\n### Methods\n- `clear(): Promise<void>` - Removes all [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features), [content](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#content),\n[heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading), and [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) from the Popup.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): Promise<void>` - Selects the feature at the next index in relation to the selected feature.\n- `openFeatureStream(options: OpenFeatureStreamOptions): Promise<void>` - Opens the popup with a location and a feature stream. Promise batches are converted to a feature stream internally. While waiting, the popup remains at its current location and becomes active when the first feature is available.\nIf both `featureStream` and `promises` are provided, `featureStream` is used.\nIf the location is `null` or `undefined`, the first feature's geometry determines the popup location. If no features become available, the popup closes without changing its location.\n- `previous(): Promise<void>` - Selects the feature at the previous index in relation to the selected feature.\n- `setFocus(): Promise<void>` - Use this method to give focus to the component if the component is able to be focused.\n\n### Slots\n- **actions-start** - _Since 5.2._ Slot for adding Calcite [actions](https://developers.arcgis.com/calcite-design-system/components/action/) or [action groups](https://developers.arcgis.com/calcite-design-system/components/action-group/) to the start of the action bar. Multiple actions or action groups can be placed in this slot. Slotted actions remain at the start of the action bar and are not automatically grouped if they exceed the available width. To group actions, place them in a Calcite action group. Actions in this slot remain separate from other actions, including default actions (such as \"Zoom to\" and \"Browse features\"), [PopupTemplate actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), and [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions).\n\nSince the popup component is tied to the view, the actions in this slot will be responsive to the view's size and show/hide the action's text accordingly.\n- **actions-end** - _Since 5.2._ Slot for adding Calcite [actions](https://developers.arcgis.com/calcite-design-system/components/action/) or [action groups](https://developers.arcgis.com/calcite-design-system/components/action-group/) to the end of the action bar. Multiple actions or action groups can be placed in this slot. Slotted actions remain at the end of the action bar and are not automatically grouped if they exceed the available width. To group actions, place them in a Calcite action group. Actions in this slot remain separate from other actions, including default actions (such as \"Zoom to\" and \"Browse features\"), [PopupTemplate actions](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#actions), and [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions).\n\nSince the popup component is tied to the view, the actions in this slot will be responsive to the view's size and show/hide the action's text accordingly.","attributes":[{"name":"alignment","description":"Position of the popup in relation to the selected feature. The default behavior\nis to display above the feature and adjust if not enough room. If needing\nto explicitly control where the popup displays in relation to the feature, choose\nan option besides `auto`.","values":[{"name":"top-center"},{"name":"top-left"},{"name":"top-right"},{"name":"bottom-center"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-start"},{"name":"top-end"},{"name":"bottom-start"},{"name":"bottom-end"},{"name":"auto"}]},{"name":"auto-close-enabled","description":"This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/references/core/Viewpoint/) changes.","values":[]},{"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-popup/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"collapsed","description":"Indicates whether the popup displays its content. If `true`, only the header displays.","values":[]},{"name":"content","description":"The content of the component. When set directly on the component, this content is static and cannot use fields to set content templates. To set a template for the content based on field or attribute names, see [PopupTemplate.content](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/#content).","values":[]},{"name":"default-popup-template-enabled","description":"Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the `createPopupTemplate` method.\n\n**Note:** Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/references/core/popup/support/FieldInfoFormat/#dateFormat) rather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) created by setting the `defaultPopupTemplateEnabled` property to `true`.\nFor example, previously a date that may have appeared as `\"December 30, 1997\"` will now appear as `\"12/30/1997 6:00 PM\"`.","values":[]},{"name":"dock-enabled","description":"Indicates whether the placement of the popup is docked to the side of the view.\n\nDocking the popup allows for a better user experience, particularly when opening\npopups in apps on mobile devices. When a popup is \"dockEnabled\" it means the popup no\nlonger points to the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature) or the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location)\nassigned to it. Rather it is attached to a side, the top, or the bottom of the view.\n\nSee [dockOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#dockOptions) to override default options related to docking the popup.","values":[]},{"name":"feature-menu-open","description":"This property enables multiple features in the component to display in a list rather than displaying the first selected feature. Setting this to `true` allows the user to scroll through the list of features. This value will only be honored if [initialDisplayMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#initialDisplayMode) is set to \"feature\".","values":[]},{"name":"feature-menu-title","description":"Sets the title to display on the component while viewing the feature menu.","values":[]},{"name":"focus-trap-disabled","description":"When `true`, this prevents the popup from trapping focus when opened.\nPreventing focus trapping can be used in scenarios where interactions are expected within the user interface, such as when the popup resides in a panel.","values":[]},{"name":"heading","description":"The title of the popup. This can be set generically on the popup no\nmatter the features that are selected. If the [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/), then the title set in the\ncorresponding template is used here.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading) of the popup.\nBy default, the heading is rendered\nas a level 2 heading (e.g. `<h2>Popup title</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.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#actions).","values":[]},{"name":"hide-close-button","description":"Indicates whether to hide the close button in the component.","values":[]},{"name":"hide-collapse-button","description":"Indicates whether to hide the collapse button in the component.","values":[]},{"name":"hide-empty-relationship-content","description":"Indicates whether to hide relationship content when there are no relationship items to display.","values":[]},{"name":"hide-feature-list-layer-title","description":"Indicates whether to hide the group heading for a list of multiple features.","values":[]},{"name":"hide-feature-menu-heading","description":"Indicates whether to hide the feature menu heading and description in the component's feature menu list.","values":[]},{"name":"hide-feature-navigation","description":"Indicates whether to hide the feature navigation in the component. This allows the user to scroll through various [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) using pagination arrows.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's [heading](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#heading).","values":[]},{"name":"hide-spinner","description":"Indicates whether to hide the spinner in the component.","values":[]},{"name":"highlight-disabled","description":"Indicates if the selected feature will be highlighted.\nThis is done using the [arcgis-map.highlights](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#highlights) or the [arcgis-scene.highlights](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#highlights).","values":[]},{"name":"include-default-actions-disabled","description":"Indicates whether to include the default actions in the component.\nIn order to disable any default actions, it is necessary to set `includeDefaultActionsDisabled` to `true`.","values":[]},{"name":"initial-display-mode","description":"Indicates whether to initially display a list of features, or the content for one feature.\nBy default, a list is displayed when the associated view has `focusRegionVisible` enabled; otherwise, the content for one feature is displayed.","values":[{"name":"list"},{"name":"feature"}]},{"name":"label","description":"The component's default label.","values":[]},{"name":"open","description":"Indicates whether the component is visible. This property is `true` when the component is querying for results, even if it is not open. Use this property to check if the component is visible.","values":[]},{"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.","values":[]},{"name":"selected-feature-index","description":"Index of the feature that is [selectedFeature](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeature). When [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#features) are set,\nthe first index is automatically selected.","values":[]},{"name":"top-layer-disabled","description":"When true, disables rendering in the top layer (above overlays and modals).\nThis can be useful for controlling stacking context in complex UI layouts.","values":[]},{"name":"update-location-enabled","description":"Indicates whether to update the [location](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#location) when the [selectedFeatureIndex](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/#selectedFeatureIndex) changes.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/"},{"name":"Popup\nThe Popup component opens on view element click.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-popup--demo&singleStory=true"},{"name":"Custom Popup\nThe Popup component opens manually within a click event.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-popup--custom-popup&singleStory=true"},{"name":"Small Map","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-popup--small-map&singleStory=true"}]},{"name":"arcgis-presentation","description":"The Presentation component allows to present slides of a web scene in a presentation mode\nand supports navigating between the slides of a web scene.\n--\n\n### Events\n- **arcgisPopupFeatureNotFound** - Fires after a slide with a popup reference element has been applied, but the component was unable to retrieve the popup feature.\nThis event may be used to show a custom error message for such cases.\n- **arcgisPopupFeaturesRetrieved** - Fires after the popup feature(s) of a slide have been retrieved from the service or from the view.\nThis event may be used to show the popup graphic not in a popup, but in another component, e.g. ArcgisFeature.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisSlideApplyCancel** - Fires after applying a slide to the Scene View has been canceled.\nIt only fires if the slide cancelled is in the list of slides of the webscene presentation.\n- **arcgisSlideApplyComplete** - Fires after applying a slide to the Scene View has been completed.\nIt only fires if the slide canceled is in the list of slides of the webscene presentation.\n- **arcgisSlideApplyStart** - Fires after a slide has been applied to the Scene View.\nIt only fires if the slide applied is in the list of slides of the webscene presentation.\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","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-presentation/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"keyboard-navigation-enabled","description":"Enable navigation with the keyboard\nby using the arrow keys or page up/page down keys","values":[]},{"name":"navigation-hidden","description":"Hide the presentation navigation in the UI.\nSlide elements will still be shown when a slide is applied to the view.","values":[]},{"name":"slice-analysis-interactive","description":"Show the slice analysis of a slide interactive so manipulators will be displayed, allowing users to click and drag to edit the analysis.\nPer default interactive is set to false.","values":[]},{"name":"slide-captions-disabled","description":"Disable display of captions when slide is applied.\nPer default the display of captions is enabled.","values":[]},{"name":"slide-id","description":"The id of the slide applied to the view","values":[]},{"name":"slide-legend-disabled","description":"Disable display of slide legend when slide is applied.\nPer default the display of legend is enabled.\nDisabling the legend after creation of the component will hide the legend if it is displayed from a slide previously applied.","values":[]},{"name":"slide-popup-disabled","description":"Disable display of slide popup when slide with popup is applied.\nPer default the display of popup is enabled.\nThe events arcgisPopupFeaturesRetrieved and arcgisPopupFeatureNotFound will be emitted also when popups are disabled.","values":[]},{"name":"visual-scale","description":"specifies the size of the component","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-presentation/"}]},{"name":"arcgis-print","description":"The Print component connects your application with a [printing service](https://doc.esri.com/en/arcgis-enterprise/latest/administer/configure-the-portal-to-print-maps.html) to allow the map to be printed.\nIt takes advantage of server-side, high-quality, full cartographic print functionality using the ExportWebMap service of ArcGIS,\nwhich can be configured with custom layout templates. One is provided that shows the map only, while another provides a layout with legend, etc.\nThe Print component works with the [print](https://developers.arcgis.com/javascript/latest/references/core/rest/print/) module, which generates a printer-ready version of the map.\n\nThe Print component uses the ArcGIS Online print service by default, but it can be configured to use a custom print service with the [printServiceUrl](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#printServiceUrl) property.\nThe component can preserve map scale or map extent in the printout. By default, the map extent is preserved. Use\n[TemplateOptions.scaleEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/Print/TemplateOptions/#scaleEnabled) to preserve scale instead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/references/core/rest/support/PrintTemplate/#layout)\nexcept `map-only`. If using a custom print service, then `customTextElements` are supported for each print\ntemplate. Values found there will be populated in the Print component under `Advanced options`. These values can\nbe overwritten in the Print component UI, or programmatically using the\n[templateCustomTextElements](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/references/core/rest/support/PrintTemplate/#exportOptions).\n\n**Known limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/references/core/rest/print/) for a detailed list of known limitations.\n\n```html\n<arcgis-map item-id=\"45725ba7d9fb47a0925398919b13d1fa\">\n <arcgis-print slot=\"top-right\"></arcgis-print>\n</arcgis-map>\n```\n\n```js\n// get a reference to the component\nconst components = document.querySelectorAll(\"arcgis-print\");\n\nconst portal = new Portal({\n url: \"https://user.maps.arcgis.com/sharing\",\n authMode: \"immediate\",\n authorizedCrossOriginDomains: [\"https://user.maps.arcgis.com\"],\n});\n\ncomponents.forEach((component) => {\n component.portal = portal;\n});\n```\n--\n\n### Events\n- **arcgisBrowseTemplatesChange** - Emitted when the collection of browse templates changes.\n- **arcgisComplete** - Emitted when the component is complete.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisSaveAs** - Emitted when the user saves an exported map printout.\n- **arcgisSubmit** - Emitted when the component is submitted.\n\n### Methods\n- `addPortalTemplate(portalItem: PortalItem): Promise<void>` - Adds a portal item to a collection of browse templates available in the Print component UI.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","attributes":[{"name":"allowed-formats","description":"Specify the print output file format(s) that the user can select based on the options available from the print service.\nThis property can take a string value or an array of string values.\n\nWhen this value is \"all\" (default value), all the print service formats are available to be used.\nWhen an array of string values is used, only those values that match the options available from the print service will be used.\nIf none of the input string values match those available from the print service, `allowedFormats` will fallback to default behavior.","values":[{"name":"all"}]},{"name":"allowed-formats-for-saving","description":"Specifies the print output file format(s) that the user can select when saving the exported map printout.\nThis property can take a string value or an array of string values.","values":[{"name":"all"}]},{"name":"allowed-layouts","description":"Specify the print output layout(s) that the user can select based on the options available from the print service.\nThis property can take a string value or an array of string values.\n\nWhen this value is \"all\" (default value), all the print service layouts are available to be used.\nWhen an array of string values is used, only those values that match the options available from the print service will be used.\nIf none of the input string values match those available from the print service, `allowedLayouts` will fallback to default behavior.","values":[{"name":"all"}]},{"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-print/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-populate-author","description":"Indicates whether to automatically populate the author field in the print layout advanced options\nwith the username of the current portal user.\n\nThis only takes effect if there is a portal with a signed-in user assigned to the [portal](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#portal) property.","values":[]},{"name":"exclude-default-templates","description":"Indicates whether or not to include [defaultTemplates](https://developers.arcgis.com/javascript/latest/references/core/widgets/Print/PrintViewModel/#defaultTemplates).","values":[]},{"name":"exclude-organization-templates","description":"Indicates whether or not to include templates from an organization's portal.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the \"Exported files\" text where users can\naccess the exported map printout. By default, this text is rendered\nas a level 3 heading (e.g. `<h3>Exported files</h3>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-advanced-options","description":"Indicates whether the advanced options section in the Print component UI is hidden.","values":[]},{"name":"hide-feature-attributes","values":[]},{"name":"hide-header","description":"Indicates whether the component's header is hidden.","values":[]},{"name":"hide-include-tables","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"print-service-url","description":"The URL of the REST endpoint of the Export Web Map Task.\nDefaults to the ArcGIS Online print service if this property is not specified.\nIf the [portal](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/#portal) property is set, this property will use the portal's print service URL.","values":[]},{"name":"reference-element","description":"By passing the `id` of the Map or Scene component into this property, you can position components from the `@arcgis/map-components`\npackage anywhere in the DOM while still maintaining a connection to the Map or Scene.\n\nSee [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component).","values":[]},{"name":"show-print-area-enabled","description":"The initial state of the print area toggle in the Print component UI.\nWhen set to `true`, the print area toggle is enabled by default.\nWhen set to `false`, the print area toggle is disabled by default.","values":[]},{"name":"show-save-as","description":"Indicates whether to show the \"Save As\" option in the Print component UI.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-print/"},{"name":"Print","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-print--demo&singleStory=true"}]},{"name":"arcgis-reverse-geocode-list","description":"The Reverse Geocode List component displays a list of addresses obtained by reverse geocoding a given location.\nThis is the component behind the What's Here functionality in Map Viewer. This class was created for MV for 5.0,\nbut is internal for 5.0, and will be wider released at 5.1 or later.\n--\n\n### Events\n- **arcgisReverseGeocodeCopy**\n- **arcgisReverseGeocodeResultsChange**\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.","attributes":[{"name":"auto-destroy-disabled","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-coordinates","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-reverse-geocode-list/"},{"name":"Reverse Geocode List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-reverse-geocode-list--demo&singleStory=true"}]},{"name":"arcgis-scale-bar","description":"The Scale Bar component displays a scale bar representing the scale of the map.\nIt respects various coordinate systems and displays units in metric or imperial values.\nMetric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.\nWhen working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.\n\nWhen the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.\nOtherwise, the center of the map is used to calculate the scale.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-scale-bar/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"bar-style","description":"The style for the scale bar.\nWhen `unit` is set to `dual`, the style will always be `line`.","values":[{"name":"line"},{"name":"ruler"}]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"unit","description":"Units to use for the scale bar.\nWhen using `dual`, the scale bar displays both metric and imperial units.\nWhen metric, distances will be shown in either kilometers, meters, centimeters, or millimeters depending on the scale. Similarly, imperial\nunits will be shown in either miles, feet, or inches.","values":[{"name":"metric"},{"name":"imperial"},{"name":"dual"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scale-bar/"},{"name":"Scale Bar","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-scale-bar--demo&singleStory=true"}]},{"name":"arcgis-scene","description":"The ArcGIS Scene component is used to add 3D maps to web applications. For 2D maps, use the\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/references/core/WebScene/) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n  basemap=\"satellite\"\n  ground=\"world-elevation\"\n  camera-position=\"12.3808, 46.3959, 4400\"\n  camera-tilt=\"75\"\n  camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n   <arcgis-layer-list slot=\"bottom-right\"></arcgis-layer-list>\n</arcgis-scene>\n```\n\nThe Scene component can be customized further using any of the [core API functionalities](https://developers.arcgis.com/javascript/latest/references/core/)\nof the ArcGIS Maps SDK for JavaScript.\n\n```js\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// The view is now ready to be used.\nconst layer = new GraphicsLayer({ title: \"My layer\"});\nviewElement.map.add(layer);\n```\n\n**See also**\n\n- [SDK sample apps using the Scene component](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=arcgis-scene)\n- [Get started](https://developers.arcgis.com/javascript/latest/get-started/)\n- [Programming patterns](https://developers.arcgis.com/javascript/latest/programming-patterns/)\n--\n\n### Events\n- **arcgisLoadError** - Fires when an arcgis-scene fails to load or if one of its dependencies fails to load (e.g., basemap, ground, layers).\n- **arcgisViewAnalysisViewCreate** - Fires when the view for an analysis is created.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-analysis-view-create)\n- **arcgisViewAnalysisViewCreateError** - Fires when an error occurs during the creation of an analysis view after an analysis is added to the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes: [zoom](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#zoom), [scale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#scale), [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#center), [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#extent),\n[camera](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#camera), [viewpoint](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#viewpoint). This event will also emit if [stationary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#stationary) toggles from `true` to `false`.\n\n> The `arcgisViewChange` event may be emitted before the view is fully ready.\n> This means the event can fire before the component's `stationary` property is `true` or before the view has completed its initial setup.\n> For actions that require the view to be ready and stationary, combine this event with checks on the component's `stationary` and `ready` properties.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n   viewElement.hitTest(event.detail).then((response) => {\n      const result = response.results[0];\n      // ....\n   });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-double-click)\n- **arcgisViewDoubleTapDrag** - Fires while the pointer is dragged following a double-tap gesture on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-double-tap-drag)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-drag)\n- **arcgisViewFocusRegionSelect** - Fires when the focus region is selected using the `Enter` or `Space` key. Use this event to react to the selection of the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegion) via keyboard input and perform any necessary actions based on that selection, such as performing a `hitTest()` on the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegion) and passing the returned graphics to the [selectionManager](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#selectionManager).\n\nCall `event.detail.preventDefault()` to suppress the default behavior of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) opening with the features in the focus region.\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map) property is changed.\n- **arcgisViewReadyError** - Fires if the view encounters a content or rendering error.\n- **arcgisViewVerticalTwoFingerDrag** - Fires while the two pointers are dragged vertically on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#event-vertical-two-finger-drag)\n\n### Methods\n- `closePopup(): Promise<void>` - Closes the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup).\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map), [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup),\nand removes components or other UI DOM elements added to it.\n- `fetchPopupFeatures(hitTarget: ScreenPoint | ScreenRect, options?: FetchPopupFeaturesOptions): Promise<AsyncGenerator<Graphic>>` - Use this method to query for features at a given screen location. These features come from origins (layers and sublayers) configured with a [PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) and have its [FeatureLayer.popupEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#popupEnabled) set. One example could be a custom side panel that displays feature-specific information based on an end user's click location. This method allows a developer to control how the input location is handled, and then subsequently, what to do with the results.\n> [!WARNING]\n> Using [ScreenRect](https://developers.arcgis.com/javascript/latest/references/core/core/types/#ScreenRect) as the hit target is considered **[beta](https://developers.arcgis.com/javascript/latest/faq/#what-does-the-beta-tag-mean)** functionality.\n- `goTo(target: GoToTarget3D, options?: GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#goTo)\n- `hitTest(hitTarget: MouseEvent | ScreenPoint | ScreenPolygon | ScreenRect, options?: HitTestOptions3D): Promise<SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n   viewElement.hitTest(event.detail).then((response) => {\n      const result = response.results[0];\n      if (result?.type === \"graphic\") {\n         const { longitude, latitude } = result.mapPoint;\n         console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n      } else {\n         console.log(\"Did not hit any graphic\");\n      }\n   });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#hitTest)\n- `openPopup(options?: ViewPopupOpenOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#openPopup)\n- `takeScreenshot(options?: UserSettings): Promise<Screenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#takeScreenshot)\n- `toMap(screenPoint: MouseEvent | ScreenPoint, options?: HitTestOptions3D): Point | null | undefined` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/).\n- `toScreen(point: Point): ScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView<AnalysisType extends Analysis>(analysis: AnalysisType): Promise<AnalysisView3DFor<AnalysisType>>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#whenAnalysisView)\n- `whenLayerView<TLayer extends Layer>(layer: TLayer): Promise<Layer extends TLayer ? LayerView : LayerView3DFor<TLayer>>` - Gets the layer view created on the view for the given layer.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#whenLayerView)\n- `zoomIn(): Promise<void>` - Zooms in the view component by a factor of 2.\n- `zoomOut(): Promise<void>` - Zooms out the view component by a factor of 2.\n\n### Slots\n- _default_ - Default slot for adding components to the scene. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n- **popup** - Slot for the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component to open automatically on click. Only the Popup component can be placed in this slot.\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the view. \n- **--arcgis-table-row-background-color** - _Since 5.1_ Specifies the background color for table rows. \n- **--arcgis-table-row-alt-background-color** - _Since 5.1_ Specifies the background color for alternate table rows. \n- **--arcgis-focus-region-outer-border-color** - _Since 5.2_ Specifies the outer border color of the focus region. \n- **--arcgis-focus-region-inner-border-color** - _Since 5.2_ Specifies the inner border color of the focus region. \n- **--arcgis-focus-region-border-width** - _Since 5.2_ Specifies the border width of the focus region. ","attributes":[{"name":"alpha-compositing-enabled","description":"Allows the view to be partially or fully transparent when composited with the webpage elements behind it.\n\nThis property can only be set once at construction time. When alpha compositing is enabled, web scenes are less\nperformant. It is important to set this property to `true` only when you need to apply transparency on the view.","values":[]},{"name":"animations-disabled","description":"Indicates whether animations are disabled in the view. This includes animated symbols (animated\n[CIMSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/CIMSymbol/),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/references/core/symbols/PictureMarkerSymbol/)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/FlowRenderer/)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/MediaLayer/),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The display mode used for the attribution. Defaults to null.\n\nSet this property to \"auto\" to automatically synchronize the attribution with the nearest [Calcite mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes). If no Calcite mode is detected, the attribution defaults to light mode. **The \"auto\" mode was added in version 5.2.**\n\nSet this property to \"light\" or \"dark\" to explicitly use that mode without synchronization.","values":[{"name":"dark"},{"name":"light"},{"name":"auto"}]},{"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-scene/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"basemap","description":"Specifies a basemap for the map. The basemap is a set of layers that give\ngeographic context to the view and the other operational layers\nin the map.\nIt can either be set using a basemap ID string ([see values](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap)),\n[Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/)\nor [BasemapStyle](https://developers.arcgis.com/javascript/latest/references/core/support/BasemapStyle/).\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap)","values":[]},{"name":"camera-fov","description":"The diagonal field of view (fov) angle for the camera. The range of angles must be between 1 and 170 degrees.\n\nSetting the camera fov immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#fov)","values":[]},{"name":"camera-heading","description":"The compass heading of the camera in degrees.\n\nSetting the camera heading immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#heading)","values":[]},{"name":"camera-position","description":"The position of the camera defined by a map point. It can either be set with a\n[Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#position)","values":[]},{"name":"camera-tilt","description":"The tilt of the camera in degrees with respect to the surface as projected down from the camera position.\n\nSetting the camera tilt immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Camera/#tilt)","values":[]},{"name":"center","description":"Represents the center point of the view. It can be a string with the format `\"<longitude>, <latitude>\"`\nor a [Point](https://developers.arcgis.com/javascript/latest/references/core/geometry/Point/) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#center)","values":[]},{"name":"display-filter-disabled","description":"Indicates whether a layer's `displayFilter` is honored when rendering layers in the view.\nIf `true`, the display filters are ignored and all features are rendered.","values":[]},{"name":"focus-region-shortcut-enabled","description":"Enables the `Shift` + `Alt`/`Option` + `O` keyboard shortcut for showing the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegion). When `undefined`, the shortcut is enabled only when a [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) component is slotted into the ArcgisScene component, or when [popupComponentEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupComponentEnabled) is set, and when the [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupDisabled) property is `false`. Set to `true` to handle focus-region selection in a custom application, or `false` to disable the shortcut. When `false`, the shortcut does not change the [focusRegionVisible](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegionVisible) property.","values":[]},{"name":"focus-region-visible","description":"Indicates whether the [focusRegion](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegion) is visible. Set this property to `true` to show the centered focus region, or `false` to hide it.\nThe focus region can also be shown or hidden by focusing on the ArcgisScene component and pressing the `Shift` + `Alt`/`Option` + `O` keyboard shortcut. By default, this shortcut is available only when a popup component is available and [popupDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupDisabled) is `false`. Use [focusRegionShortcutEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#focusRegionShortcutEnabled) to explicitly enable or disable it.\n\n**Note:** When the focus region is enabled, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) or slotted [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) will be docked with the dock button hidden by default to prevent it from overlapping the focus region.","values":[]},{"name":"ground","description":"Specifies the surface properties for the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#map). It can be either a [Ground](https://developers.arcgis.com/javascript/latest/references/core/Ground/)\ninstance or a string with one of the following values:\n   * `\"world-elevation\"`\n   * `\"world-topobathymetry\"`\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/Map/#ground)","values":[]},{"name":"hide-attribution","description":"Indicates whether the attribution is hidden in the view.\n\nEsri requires that when you use an ArcGIS Online basemap in your app, the map must include Esri attribution and you must be licensed to use the content.\nFor detailed guidelines on working with attribution, please visit the official [attribution in your app](https://developers.arcgis.com/terms/attribution/) documentation.\nFor information on terms of use, see the [Terms of Use FAQ](https://developers.arcgis.com/terms/faq/).","values":[]},{"name":"item-id","description":"The ID of a [WebScene](https://developers.arcgis.com/javascript/latest/references/core/WebScene/) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://doc.esri.com/en/arcgis-enterprise/latest/plan/what-is-portal-for-arcgis-.html).\n\nTo configure the portal url you must set the [config.portalUrl](https://developers.arcgis.com/javascript/latest/references/core/config/#portalUrl) property before the Scene component loads.","values":[]},{"name":"popup-component-enabled","description":"Indicates whether the [popup component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) (beta) is enabled  as the default popup. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) property (representing the component) will be used for popups instead of the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup) property (representing the widget).\n\n**Note:** This is a beta feature and may change in future releases. At version 6.0, the Popup component will be used by default instead of the Popup widget and the `popup-component-enabled` attribute will no longer be necessary.","values":[]},{"name":"popup-disabled","description":"Controls whether the default popup opens automatically when users click on the view. This controls both the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popupElement) and [popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#popup) properties. When set to `true`, the popup will not open on click or when triggered programmatically.","values":[]},{"name":"quality-profile","description":"Scenes can be drawn in three different quality modes: `high`, `medium` and `low`.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#qualityProfile)","values":[{"name":"medium"},{"name":"low"},{"name":"high"}]},{"name":"scale","description":"Represents the map scale at the center of the view.\n\nSetting the scale immediately changes the view. For animating\nthe view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#scale)","values":[]},{"name":"suspended","description":"Indicates if the view is visible on the page.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#suspended)","values":[]},{"name":"time-zone","description":"Defines the time zone of the view.\nThe time zone property determines how dates and times are represented to the user,\nbut the underlying data is unchanged.\n\n> [!IMPORTANT]\n>\n> This property does not apply to the [arcgis-daylight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/) or\n> [arcgis-shadow-cast](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/) components. They use their own `utcOffset` properties. Support for using the\n> scene's time zone in these components is planned for a future release.\n\nThe time zone can be set to one of the following values:\n\n**Possible Values**\n\n| Value | Description |\n| ----- | ----------- |\n| system | Dates and times will be displayed in the time zone of the device or browser. |\n| unknown | Dates and times will be displayed based on the time zone that has been defined for the layer. No adjustments are made to the display of date info. The [arcgis-time-bar](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/) component is disabled. |\n| Specified IANA time zone | Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |","values":[]},{"name":"viewing-mode","description":"The viewing mode sets whether the view renders the earth as a sphere (global mode) or on a flat plane (local mode).\n\nNote that the viewing mode must be set before the Scene component loads.\nDepending on the viewing mode different [supported coordinate systems](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#supported-coordinate-systems) are available.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#viewingMode)","values":[{"name":"global"},{"name":"local"}]},{"name":"zoom","description":"Represents the level of detail (LOD) at the center of the view.\n\nSetting the zoom immediately changes the current view. For animating the view, see this component's [goTo()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#goTo) method.\nSetting this property in conjunction with [center](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#zoom)","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/"},{"name":"Scene","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-scene--demo&singleStory=true"}]},{"name":"arcgis-search","description":"The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,\nBuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the\n`findAddressCandidates` operation is used, whereas queries are used on feature layers.\n\nBy default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.\nIf a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey\nis present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property. See the\n[Authentication and access tokens](https://developers.arcgis.com/javascript/latest/authentication/access-tokens/) guide to learn more.\n\nFor popups, we recommend using either [popup-component-enabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#popupComponentEnabled),\nor adding the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-popup/) to your view components as a best practice.\n\nThe Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data\nsources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property\nof the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.\nHowever, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a\nspecified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.\nThis behavior can be changed by using the localSearchDisabled property.\n\nStarting with version `5.1`, on [@arcgisSelectResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#event-arcgisSelectResult) the selected search result is announced to assistive technologies. Visit the [Accessibility guide](https://developers.arcgis.com/javascript/latest/accessibility/#assistive-technologies) to learn more\nabout live announcements supporting more audiences.\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 for user interaction.\n- **arcgisSearchClear** - Fires when a result is cleared from the input box or a new result is selected.\n- **arcgisSearchComplete** - Fires when the [search()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#search) method is called and returns its results.\n- **arcgisSearchStart** - Fires when the [search()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#search) method starts.\n- **arcgisSelectResult** - Fires when a search result is selected.\n- **arcgisSuggestComplete** - Fires when the [suggest()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#suggest) method is called and returns its results.\n- **arcgisSuggestStart** - Fires when the [suggest()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#suggest) method starts.\n\n### Methods\n- `clear(): void` - Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.\nIt also hides any open menus.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `search(searchItem?: Graphic | null | undefined | number[] | Point | SuggestResult | string): Promise<null | undefined | SearchResponse>` - Depending on the sources specified, search() queries the feature layer(s) and/or performs\naddress matching using any specified [locator(s)](https://developers.arcgis.com/javascript/latest/references/core/rest/locator/) and\nreturns any applicable results.\n- `setFocus(): Promise<void>` - Brings focus to the component's text input.\n- `suggest(query?: string): Promise<null | undefined | SuggestResponse>` - Performs a suggest() request on the active Locator. It also uses the current value of\nthe component or one that is passed in.\n\nSuggestions are available if working with a 10.3 or greater geocoding service that has\n[suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e.\n`supportsPagination = true`.","attributes":[{"name":"active-menu","description":"The current active menu of the Search component.","values":[{"name":"source"},{"name":"none"},{"name":"suggestion"}]},{"name":"active-source-index","description":"The selected source's index. This value is `-1` when all sources are selected.","values":[]},{"name":"all-placeholder","description":"String value used as a hint for input text when searching on multiple sources. See\nthe image below to view the location and style of this text in the context of the component.\n\n![search-allPlaceholder](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-allplaceholder.avif)","values":[]},{"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-search/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-navigate-disabled","description":"Indicates whether to automatically navigate to the selected result. If `true`, will not automatically navigate to the selected result.","values":[]},{"name":"auto-select-disabled","description":"By default, the component will automatically select and zoom to the first geocoded result. When `true`, the\n[findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)\noperation will still geocode the input string, but the top result will not be selected. To work with the\ngeocoded results, you can set up a [@arcgisSearchComplete](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#event-arcgisSearchComplete) event handler and get the results\nthrough the event object.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-sources-menu","description":"When `true`, hides the sources menu even when multiple sources are available.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"include-default-sources-disabled","description":"When `true`, will not include [defaultSources](https://developers.arcgis.com/javascript/latest/references/core/widgets/Search/SearchViewModel/#defaultSources) in the Search UI.\nThis can be a boolean value or a function that returns a collection of Search sources.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"location-disabled","description":"When `true`, will disable location services within the component.\n\n![locationDisabled](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-locationEnabled.avif)\n\n**Note:**\nThe use of this property is only supported on secure origins.\nTo use it, switch your application to a secure origin, such as HTTPS.\nNote that localhost is considered \"potentially secure\" and can be used for easy testing in browsers that support\n[Window.isSecureContext](https://developer.mozilla.org/docs/Web/API/isSecureContext#browser_compatibility)\n(currently Chrome and Firefox).","values":[]},{"name":"max-results","description":"The maximum number of results returned by the component if not specified by the source.","values":[]},{"name":"max-suggestions","description":"The maximum number of suggestions returned by the component if not specified by the source.\n\nIf working with the default\n[ArcGIS Online Geocoding service](https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm),\nthe default remains at `5`.","values":[]},{"name":"min-suggest-characters","description":"The minimum number of characters needed for the search if not specified by the source.","values":[]},{"name":"popup-disabled","description":"By default, the graphic can be clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/).\nWhen `true`, disables displaying the [Popup](https://developers.arcgis.com/javascript/latest/references/core/widgets/Popup/) on feature click.","values":[]},{"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.","values":[]},{"name":"result-graphic-disabled","description":"If `true`, the [resultGraphic](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/#resultGraphic) will not display at the\nlocation of the selected feature.","values":[]},{"name":"search-all-disabled","description":"By default, the \"All\" option is displayed by default to search all sources:\n\n![search-searchAllDisabled-true](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-enablesearchingall-true.avif)\n\nWhen `true`, no option to search all sources at once is available:\n\n![search-searchAllDisabled-false](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/search-enablesearchingall-false.avif)","values":[]},{"name":"search-term","description":"The value of the search box input text string.","values":[]},{"name":"suggestions-disabled","description":"If `true`, disables suggestions for the component.\n\nThis is only available if working with a 10.3 or greater geocoding service that has [suggest capability\nloaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.","values":[]},{"name":"top-layer-disabled","description":"When true, disables rendering in the top layer (above overlays and modals).\nThis can be useful for controlling stacking context in complex UI layouts.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search/"},{"name":"Search","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-search--demo&singleStory=true"}]},{"name":"arcgis-search-result-renderer","description":"The Search Result Renderer renders the Search component results and supports selecting alternate matches.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-search-result-renderer/#destroy) method when you are done to\nprevent memory leaks.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-search-result-renderer/"}]},{"name":"arcgis-selection-list","description":"The `Selection List` component displays selected features in a hierarchical list organized by group and layer. It is intended for applications that need to present the current selection and support browsing, filtering, and interaction with selected features.\n\nThe component can be used with the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/) or [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component and reflects selections made through a [selection manager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/), including the [view](https://developers.arcgis.com/javascript/latest/references/core/views/View/#selectionManager), the [Selection Toolbar](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/), or the [selection manager API](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/).\n--\n\n### Events\n- **arcgisClear** - Fires when the active selection is cleared via the close button on the selection count chip.\nThis event does not fire when the selection is cleared programmatically, or when the selection is\ncleared by a different component. For more information about selection changes, use the\n[selection-change](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/#event-selection-change) event emitted by the associated [selection manager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/).\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 for user interaction.\n\n### Methods\n- `clear(): Promise<void>` - Clears all active selections for all groups, layers and features.\n- `collapseAll(): Promise<void>` - Utility method for collapsing all parent list items.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `deselectItem(item: ListItem): Promise<void>` - Utility method to deselect any group, layer or feature item.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `expandAll(): Promise<void>` - Utility method for expanding all parent list items.\n- `findLayerItem(layer: SelectableLayer): Promise<LayerItem | null | undefined>` - Utility method for finding the corresponding LayerItem for a given layer.\n- `findParentItem(layer: SelectableLayer): Promise<null | undefined | ParentItem>` - Utility method for finding the corresponding parent item for a given layer.\n- `goToItem(item: ListItem): Promise<void>` - Repositions the view to center based on the chosen item.\n- `removeFromSelection(params: {\n    layer: SelectableLayer;\n    selection: SelectionIdentifier[];\n}): Promise<void>` - Removes specific features from the selection, based on the provided layer and object IDs.\n- `replace(params: {\n    layer: SelectableLayer;\n    selection: SelectionIdentifier[];\n}): Promise<void>` - Replaces an active selection, based on the provided layer and object IDs.\n- `selectItem(item: ListItem): Promise<void>` - Selects all features contextual to a given item. Deselects all other features.","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-selection-list/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"display-mode","description":"Controls how the list is displayed. If this value is set to `\"group\"`, the list displays [feature](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) and [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) items nested under\ntheir associated [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) and [group](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/GroupLayerItem/) items. If this value is set to `\"layer\"`, the list displays [feature](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) items nested under\ntheir associated [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) item, while excluding [group](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/GroupLayerItem/) items. If this value is set to `\"feature\"` the list only displays\n[feature](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) items, while excluding [group](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/GroupLayerItem/) and [layer](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/LayerItem/) items.","values":[{"name":"feature"},{"name":"group"},{"name":"layer"}]},{"name":"filter-text","description":"Current value of the list's text filter.","values":[]},{"name":"hide-chip","description":"Indicates whether the selection count chip should be hidden. The chip shows the total\ncount of selected features and a `close` button for clearing the selection.","values":[]},{"name":"hide-chip-close-button","description":"Indicates whether the 'close' button on the selection count chip should be hidden.\nThe 'close' button allows users to clear the current selection.","values":[]},{"name":"hide-filter","description":"Indicates that the filter should be hidden.","values":[]},{"name":"hide-filter-notice","description":"Indicates that the filter notice should be hidden.","values":[]},{"name":"hide-header","description":"Indicates that the header should be hidden.","values":[]},{"name":"hide-item-close-actions","description":"Indicates that the close actions for individual list items should be hidden.","values":[]},{"name":"hide-item-count","description":"Indicates that the count for individual list items should be hidden.","values":[]},{"name":"hide-item-icons","description":"Indicates that the icons for individual list items should be hidden.","values":[]},{"name":"hide-item-menus","description":"Indicates that the menus for individual list items should be hidden.","values":[]},{"name":"hide-layer-filter","description":"Indicates that the layer filter should be hidden.","values":[]},{"name":"hide-menu","description":"Indicates that the primary menu should be hidden.","values":[]},{"name":"hide-zoom-to-button","description":"Indicates that the 'zoom to' button should be hidden.","values":[]},{"name":"highlight-on-hover-disabled","description":"Property controlling whether corresponding features on the view should be highlighted when\nhovering over the associated list item. Only applies to list items representing individual features.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"max-visible-feature-count-per-layer","description":"Maximum number of selected [feature items](https://developers.arcgis.com/javascript/latest/references/core/widgets/support/SelectionList/FeatureItem/) displayed per layer.\nDoes not limit or restrict the selection itself.","values":[]},{"name":"menu-scale","description":"Default scale of all menus.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]},{"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.","values":[]},{"name":"visual-scale","description":"Controls the visual scale of any rendered Calcite elements.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-list/"},{"name":"Selection List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-selection-list--demo&singleStory=true"}]},{"name":"arcgis-selection-toolbar","description":"The selection toolbar component can be used to modify selected features on a provided [MapView](/references/core/views/MapView/) or [SceneView](/references/core/views/SceneView/). It provides an interface for performing [selection operations](/references/core/views/selection/SelectionOperation/) such as adding, removing, or replacing selected features.\nThis component can be used in conjunction with other components. Examples such as [arcgis-selection-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-list/) and [arcgis-feature-table](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-feature-table/).\n--\n\n### Events\n- **arcgisBeforeActivate** - Fires before any [selection operation](/references/core/views/selection/SelectionOperation/) is activated.\n- **arcgisClear** - Fires when the active selection is cleared via the close button on the selection count chip.\nThis event does not fire when the selection is cleared programmatically, or when the selection is\ncleared by a different component. For more information about selection changes, use the\n'selection-change' event emitted by the associated [selection manager](/references/core/views/SelectionManager/).\n- **arcgisComplete** - Fires when the [selection operation](/references/core/views/selection/SelectionOperation/) is complete\nor canceled and results have been processed.\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 for user interaction.\n- **arcgisSelectionChange** - Fires when the potential selection set changes while drawing. This event will not fire unless\nthe [syncWhileDrawing](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/#syncWhileDrawing) property is set to `true`. For the final selection set, use the [complete ](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/#event-arcgisComplete) event\nor refer to the associated [selection manager](/references/core/views/SelectionManager/).\n\n### Methods\n- `activate(options?: SelectionOperationProperties): Promise<SelectionOperation | undefined>` - Activates the specified tool using the provided options and cancels any active [selection operation](/references/core/views/selection/SelectionOperation/). This method has no effect when the toolbar is disabled.\n- `activateTool(toolName: SelectionToolName): Promise<SelectionOperation | undefined>` - Activates the specified tool by name and cancels any [selection operation](/references/core/views/selection/SelectionOperation/). This method has no effect when the toolbar is disabled.\n- `cancel(): Promise<void>` - Cancels any active operation and, when applicable, emits a [complete](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/#event-arcgisComplete) event. The event includes an [aborted](/references/core/views/selection/types/#SelectionCompleteEventInfo-aborted) property that indicates whether the operation was canceled.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `syncSources(): Promise<void>` - Synchronizes the effective [selection manager](/references/core/views/SelectionManager/)\nwith the current layers and tables in the view.\n\nCall this method after adding or removing layers or tables from the view,\nespecially when using a custom [selection manager](/references/core/views/SelectionManager/). Newly added [sources](/references/core/views/SelectionManager/#sources)\nare otherwise excluded from selection results.\n\nThis method has no effect if the effective [selection manager](/references/core/views/SelectionManager/)\ndoes not have an assigned view.\n- `toggleTool(toolName: SelectionToolName): Promise<SelectionOperation | undefined>` - Toggles the active state of the specified tool. If\nthe tool is currently active, it is canceled.\nOtherwise, the tool is activated after canceling\nany active [selection operation](/references/core/views/selection/SelectionOperation/).","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-selection-toolbar/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"continuous-selection-enabled","description":"Determines if the selection toolbar should automatically reactivate a new [selection operation](/references/core/views/selection/SelectionOperation/) after the completion of an active [selection operation](/references/core/views/selection/SelectionOperation/), using options from the previous operation.\nThis only applies if the previous [selection operation](/references/core/views/selection/SelectionOperation/) was completed, and not canceled.","values":[]},{"name":"default-operation-type","description":"The default [selection operation type](/references/core/views/selection/types/#SelectionOperationType) to use when starting a new [selection operation](/references/core/views/selection/SelectionOperation/).\nThis value can be changed via the [selection operation type](/references/core/views/selection/types/#SelectionOperationType) dropdown.","values":[{"name":"remove"},{"name":"replace"},{"name":"add"}]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-chip","description":"Indicates whether the selection count chip should be hidden. The chip shows the total\ncount of selected features and a `close` button for clearing the selection.","values":[]},{"name":"hide-chip-close-button","description":"Indicates whether the 'close' button on the selection count chip should be hidden.\nThe 'close' button allows users to clear the current selection.","values":[]},{"name":"hide-lasso-tool","description":"Indicates whether the lasso tool should be hidden. The lasso tool allows for freehand selection of features.","values":[]},{"name":"hide-operation-type-controls","description":"Indicates whether the [selection operation type](/references/core/views/selection/types/#SelectionOperationType) controls should be hidden. The operation type controls\nallow for changing the selection operation type (e.g., `replace`, `add`, `remove`).","values":[]},{"name":"hide-pan-tool","description":"Indicates whether the pan tool is hidden. The pan tool allows users\nto navigate the view without initiating a [selection operation](/references/core/views/selection/SelectionOperation/) and\nis active by default when no [selection operation](/references/core/views/selection/SelectionOperation/) is in progress.","values":[]},{"name":"hide-point-tool","description":"Indicates whether the point tool should be hidden. The point tool allows for selecting features by clicking on them.\nThe point tool will include all features that intersect the selected point, rather than only the top-most feature.","values":[]},{"name":"hide-polygon-tool","description":"Indicates whether the polygon tool should be hidden. The polygon tool allows for selecting features\nby drawing a polygon.","values":[]},{"name":"hide-progress","description":"Indicates whether the progress indicator should be hidden.\n\nThe progress indicator shows when a [selection operation](/references/core/views/selection/SelectionOperation/) is processing results. The processing time can vary depending on the potential number of selected\nfeatures, or whether the [selection operation](/references/core/views/selection/SelectionOperation/) is querying source layers or [layer views](/references/core/views/layers/LayerView/) for results.","values":[]},{"name":"hide-rectangle-tool","description":"Indicates whether the rectangle selection tool is hidden. The\nrectangle tool allows users to select features by drawing a\nrectangular area.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layer-preference-enabled","description":"Indicates whether [selection operations](/references/core/views/selection/SelectionOperation/) should always query source layers rather than their associated [layer views](/references/core/views/layers/LayerView/) when determining selection results. Querying the source layer may be necessary when the most up-to-date feature data is required. Changing this property while a [selection operation](/references/core/views/selection/SelectionOperation/) is in progress will not affect the active operation. The change will apply only to subsequent operations.","values":[]},{"name":"layout","description":"Controls the orientation of the component.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"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.","values":[]},{"name":"return-feature-title-fields","description":"Determines whether selected features include the fields required to\ndisplay feature titles as defined by the [web map](/references/core/WebMap/).\n\nWhen enabled, these fields are available on features returned by selection\nevents. They are not stored in the [selection manager](/references/core/views/SelectionManager/),\nwhich stores only selected feature Object IDs.\n\nEnabling this property may require additional queries and can affect\nselection performance.","values":[]},{"name":"return-geometry-disabled","description":"Indicates whether to omit feature geometries from features returned by\nselection events. Disable this property when selected feature geometries\nare needed by an application.\n\nGeometries are not stored in the [selection manager](/references/core/views/SelectionManager/), which stores only selected feature Object IDs.\n\nDisabling geometry results may improve selection performance when geometries are not needed.","values":[]},{"name":"show-text-labels","description":"Indicates text labels should be displayed next to each tool.","values":[]},{"name":"sync-results-disabled","description":"Indicates whether results from new [selection operations](/references/core/views/selection/SelectionOperation/) are automatically synchronized with the associated [selection manager](/references/core/views/SelectionManager/). When set to `false`, events emitted by the selection-toolbar will still include the updated selection results, but the associated [selection manager](/references/core/views/SelectionManager/) will not be updated when the [selection operation](/references/core/views/selection/SelectionOperation/) completes.","values":[]},{"name":"sync-while-drawing","description":"Indicates whether the [selection operation](/references/core/views/selection/SelectionOperation/) continuously evaluates the potential\nselection while the associated draw tool is active and emits updates through events.\nWhen set to `false`, the selection is evaluated only once after drawing is complete.\n\nPotential selection results are not stored or reflected by the associated [selection manager](/references/core/views/SelectionManager/). Set this property to `true` to receive continuous updates to the working\nselection set, such as for highlighting potential features while drawing. This\nproperty does not control whether the final selection results are stored by the\n[selection manager](/references/core/views/SelectionManager/); use [syncResultsDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/#syncResultsDisabled) for that\nbehavior.","values":[]},{"name":"visual-scale","description":"Controls the scale of any rendered [Calcite](https://developers.arcgis.com/calcite-design-system/components) elements.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-selection-toolbar/"},{"name":"Selection Toolbar","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-selection-toolbar--demo&singleStory=true"}]},{"name":"arcgis-shadow-cast","description":"The Shadow Cast component visualizes shadows cast by 3D features or sunlight exposure in an\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/). This is helpful in urban development, where projects may need to satisfy shadow or\nsunlight exposure requirements for a selected day and time range.\n\n[![shadow cast component](https://developers.arcgis.com/javascript/latest/assets/references/core/analysis/shadow-cast-analysis-duration.avif)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\nBy default, the component visualizes shadows. When [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true`,\nit visualizes sunlight exposure instead.\n\nThe component provides controls for the date, time range, timezone, visualization mode, colors, intervals, and whether\nto visualize shadows or sunlight.\n\nThe [date](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#date), [startTimeOfDay](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#startTimeOfDay),\n[endTimeOfDay](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#endTimeOfDay), and [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#utcOffset) properties\ndefine the date, time range, and UTC offset used to compute the analysis overlay. They do not change the lighting in\nthe scene. To control scene lighting, use the [arcgis-daylight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-daylight/) component.\n\nThe [utcOffset](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#utcOffset) property determines the time zone used to interpret the selected\ndate and time range.\n\n> [!IMPORTANT]\n>\n> Shadow Cast does not use [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone). Changing the scene's time zone does not affect\n> the analysis. Support for using the scene's time zone is planned for a future release.\n\nThe [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) property controls how shadow or sunlight exposure is visualized:\n\n| Mode | Use for | Details |\n| --- | --- | --- |\n| `min-duration` | Highlighting areas that meet or exceed a minimum shadow or sunlight duration. | The threshold is defined by [minDuration](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDuration). |\n| `total-duration` | Showing cumulative shadow or sunlight duration across the analysis area. | Supports continuous visualization or 1-hour intervals. Areas with no duration remain transparent, intermediate values are interpolated, and the highest duration uses the opacity from [totalDurationColor](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#totalDurationColor). |\n| `discrete` | Displaying individual shadow or sunlight samples at regular intervals. | The interval is defined by [discreteInterval](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#discreteInterval). For example, a one-hour range with a 30-minute interval displays samples at the start, middle, and end of the range. |\n\nHovering over the scene displays a tooltip showing the shadow or sunlight duration at that location, rounded to\n15-minute intervals. To disable this tooltip, set\n[hideShadowDurationTooltip](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#hideShadowDurationTooltip) to `true`.\n\n**Known limitations**\n\n* Shadow Cast is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n* Terrain does not cast shadows in this analysis.\n* As a result, shadow duration may be underestimated and sunlight duration may be overestimated in areas where terrain\nwould normally block sunlight. To avoid incorrect visualization, `startTimeOfDay` should be set after local sunrise\nand `endTimeOfDay` before local sunset.\n* The analysis does not take daylight savings into account. Use the timezone picker to adjust the offset from the\nCoordinated Universal Time (UTC) and account for daylight saving time.\n* The timezone is automatically detected by the component based on the camera location. In some situations, this might\nnot be accurate. In case of an inaccurate timezone, users can set it manually using the timezone picker.\n\n**See also**\n\n- [Sample - Shadow Cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n- [ShadowCastAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/)\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 for user interaction.\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.\n- `getDurationAtScreen(point: ScreenPoint): Promise<number>` - Returns the duration (in milliseconds) for a certain point on the screen based on the current analysis settings.\nBy default, this method returns the time spent in shadow. When\n[visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true`, this method returns the time spent in sunlight.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ShadowCastAnalysisView3D/#getDurationAtScreen)","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-shadow-cast/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"date","description":"The calendar date used to calculate the shadow or sunlight visualization. This date excludes the time. If a date with a time is set, the time value will be set to midnight (`00:00:00`) of that date in local system time.\nIf no date is set, then it defaults to the current date in local system time.\n\n_See also_\n\n* [Date](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)","values":[]},{"name":"discrete-interval","description":"Individual shadow or sunlight samples are displayed at this time interval in `\"discrete\"`\n[mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode), starting with the start time of day. The interval is expressed in\nmilliseconds. If set to 0, the analysis uses the smallest possible interval, up to a maximum of 255 samples.","values":[]},{"name":"end-time-of-day","description":"Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#date)) when the shadow or sunlight computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#endTimeOfDay)","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-date-picker","description":"If true, the date picker will be hidden.","values":[]},{"name":"hide-discrete-color-picker","description":"If true, the color picker will be hidden in the discrete mode options.","values":[]},{"name":"hide-discrete-interval","description":"If true, the interval selector will be hidden in the discrete mode options.","values":[]},{"name":"hide-discrete-options","description":"If true, the visualization options will be hidden in discrete mode.","values":[]},{"name":"hide-min-duration-color-picker","description":"If true, the color picker will be hidden in the minimum duration mode options.","values":[]},{"name":"hide-min-duration-context-color-picker","description":"If true, the color picker will be hidden in the context options in minimum duration mode.","values":[]},{"name":"hide-min-duration-context-interval","description":"If true, the interval selector will be hidden in the context options in minimum duration mode.","values":[]},{"name":"hide-min-duration-context-options","description":"If true, the context options will be hidden in the minimum duration mode options.","values":[]},{"name":"hide-min-duration-context-toggle","description":"If true, the toggle used to show or hide the context options will be hidden.","values":[]},{"name":"hide-min-duration-options","description":"If true, the visualization options will be hidden in minimum duration mode.","values":[]},{"name":"hide-min-duration-slider","description":"If true, the minimum duration slider will be hidden in the minimum duration mode options.","values":[]},{"name":"hide-shadow-duration-tooltip","description":"If true, the tooltip which displays the shadow or sunlight duration at a certain location will be hidden.","values":[]},{"name":"hide-time-range-slider","description":"If true, the time range slider will be hidden.","values":[]},{"name":"hide-timezone","description":"If true, the timezone picker will be hidden.","values":[]},{"name":"hide-total-duration-color-picker","description":"If true, the color picker will be hidden in the total duration mode options.","values":[]},{"name":"hide-total-duration-mode-select","description":"If true, the mode selector will be hidden in the total duration mode options.","values":[]},{"name":"hide-total-duration-options","description":"If true, the visualization options will be hidden in the total duration mode.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"hide-visualization-options","description":"If true, the visualization options will be hidden.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"max-min-duration","description":"Maximum allowed value for the [minDuration](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDuration) property, in milliseconds.","values":[]},{"name":"min-duration","description":"The minimum duration (in milliseconds) used in `\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) to\ndetermine which shadowed or sunlit areas are displayed.","values":[]},{"name":"min-duration-context-enabled","description":"Whether to enable additional context showing discrete shadows at the same time as displaying shadows above a\nminimum duration when in `\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode). The [minDurationContextColor](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextColor)\nand [minDurationContextInterval](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextInterval) properties are used to configure the visualization of the\ndiscrete shadows when context is enabled. This context is hidden when\n[visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true` because the equivalent sunlight context would show\nbroad areas not in shadow at each sample and can obscure the threshold result.","values":[]},{"name":"min-duration-context-interval","description":"The interval in milliseconds used when showing additional context in `\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) when\n[minDurationContextEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDurationContextEnabled) is true. This context applies to shadow\nvisualization and is not used when [visualizeSunlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#visualizeSunlight) is `true`.","values":[]},{"name":"min-min-duration","description":"Minimum allowed value for the [minDuration](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#minDuration) property, in milliseconds.","values":[]},{"name":"mode","description":"Mode of analysis to use when computing and displaying shadows or sunlight.\n\n- `\"discrete\"`: Displays individual shadow or sunlight snapshots at regular time intervals within the selected time range.\n- `\"min-duration\"`: Displays areas where accumulated shadow or sunlight exceeds a user-defined minimum duration within the selected time range. When visualizing shadows, optional discrete shadow overlays can provide additional context.\n- `\"total-duration\"`: Displays total shadow or sunlight accumulation within the selected time range. Supports continuous or 1-hour aggregated modes.","values":[{"name":"discrete"},{"name":"min-duration"},{"name":"total-duration"}]},{"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.","values":[]},{"name":"start-time-of-day","description":"Time (in milliseconds from midnight of the [date](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#date)) when the shadow or sunlight computation should start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#startTimeOfDay)","values":[]},{"name":"time-zone-mode","description":"Controls whether the component uses its legacy UTC-offset model or the scene's regional time zone.","values":[{"name":"offset"},{"name":"region"}]},{"name":"total-duration-mode","description":"Mode in which the cumulative shadow or sunlight duration should be displayed in `\"total-duration\"`\n[mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode): as a continuous surface or as an hourly aggregation of values.","values":[{"name":"continuous"},{"name":"hourly"}]},{"name":"utc-offset","description":"The UTC offset in hours used to interpret the selected date and time range for the analysis. If not specified, the\ncomponent automatically determines an approximate UTC offset based on the camera location.\nThis property is separate from [arcgis-scene.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#timeZone). Changing one does not update the other.","values":[]},{"name":"visualize-sunlight","description":"When `true`, the component visualizes sunlight duration instead of shadow duration. This applies to all modes,\ntheir respective options, and the duration returned by\n[getDurationAtScreen()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#getDurationAtScreen). In sunlight mode, the discrete context controls in the\n`\"min-duration\"` [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/#mode) are hidden because the equivalent sunlight context\nwould show broad areas not in shadow at each sample and can obscure the threshold result.\n\n[Read more](https://developers.arcgis.com/javascript/latest/references/core/analysis/ShadowCastAnalysis/#visualizeSunlight)","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-shadow-cast/"},{"name":"Shadow Cast","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-shadow-cast--demo&singleStory=true"},{"name":"Sunlight","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-shadow-cast--sunlight&singleStory=true"}]},{"name":"arcgis-sketch","description":"The Sketch component provides a simple UI for creating and updating graphics on a [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/) or a [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).\n--\n\n### Events\n- **arcgisCreate** - Fires when a user starts sketching a graphic, is actively sketching a graphic and completes sketching a graphic.\n- **arcgisDelete** - Fires when a user deletes selected graphics by clicking the Delete feature button on the Sketch widget or when the `delete()` method is called.\n- **arcgisDuplicate** - Fires when the user duplicates selected graphics.\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 for user interaction.\n- **arcgisRedo** - Fires in response to redo action during creation of a new graphic or updating existing graphics. The undo/redo stack is for an individual sketch operation, meaning you can undo/redo actions while creating or updating a graphic.\n- **arcgisUndo** - Fires in response to undo action during creation of a new graphic or updating existing graphics. The undo/redo stack is for an individual sketch operation, meaning you can undo/redo actions while creating or updating a graphic.\n- **arcgisUpdate** - Fires when the user starts updating graphics, is actively updating graphics, and completes updating graphics.\n\n### Methods\n- `cancel(): Promise<void>`\n- `complete(): Promise<void>`\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `create(tool: CreateTool, createOptions?: CreateOptions): Promise<void>`\n- `delete(): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `dismissFloatingElements(): Promise<void>`\n- `duplicate(): Promise<void>`\n- `redo(): Promise<void>`\n- `setContextualToolLocation(location: \"inline-end\" | \"inline\" | \"separate\"): Promise<void>`\n- `setCustomTools(createToolOptions?: CustomToolOptions[] | null, customActionOptions?: CustomActionProperties[] | null): Promise<void>`\n- `setGroupCollapsePriorities(priorities: Map<SketchGroupName, number> | null): Promise<void>` - Note: `setGroupAllowCollapseOptions` has been removed in favor of a single priority setting.\nSet the group's priority to `LayoutPriorities.NeverCollapse` (1000) or `LayoutPriorities.ForceCollapse` (0)\nto control collapse behavior.\n- `triggerUpdate(graphic: Parameters<SketchViewModel[\"update\"]>[0], updateOptions?: Parameters<SketchViewModel[\"update\"]>[1]): Promise<void>`\n- `undo(): 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-sketch/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"cancel-update-on-click-away-disabled","description":"Indicates whether clicking away from an update graphic should not end the current update operation.","values":[]},{"name":"creation-mode","description":"Defines the default behavior once the [create()](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#create) operation is completed. By default, the user will be\nable to continuously create graphics with same geometry types.\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\ncontinuous | This is the default. Users can continue creating graphics with same geometry types.\nsingle | User can create a single graphic with the specified geometry type. User must choose an operation once the graphic is created.\nupdate | The graphic will be selected for an [update()](https://developers.arcgis.com/javascript/latest/references/core/widgets/Sketch/#update) operation once the `create` operation is completed.","values":[{"name":"update"},{"name":"single"},{"name":"continuous"}]},{"name":"default-graphics-layer-disabled","description":"By default, sketch will create and manage a graphics layer.\n\nSet this prop to true to disable this behavior. Disabling the default\ngraphics layer is recommended if supplying your own layer.","values":[]},{"name":"hide-create-tools-circle","description":"Indicates whether to hide the circle sketch tool.","values":[]},{"name":"hide-create-tools-multipoint","description":"Indicates whether to hide the multipoint tool. Regardless of setting, multipoint is not available when working with a scene view.\n\nThe multipoint tool is excluded from `availableCreateTools` by default. Even if this property is false,\nmultipoint will not be available until it is added to `availableCreateTools`.","values":[]},{"name":"hide-create-tools-point","description":"Indicates whether to hide the point sketch tool.","values":[]},{"name":"hide-create-tools-polygon","description":"Indicates whether to hide the polygon sketch tool.","values":[]},{"name":"hide-create-tools-polyline","description":"Indicates whether to hide the polyline sketch tool.","values":[]},{"name":"hide-create-tools-rectangle","description":"Indicates whether to hide the rectangle sketch tool.","values":[]},{"name":"hide-delete-button","description":"Indicates whether to hide the 'delete' button while a graphic is selected. Do not hide this button without giving users on touch devices another way to delete selected geometries.","values":[]},{"name":"hide-duplicate-button","description":"Indicates whether to hide the 'duplicate' button while a graphic is selected.","values":[]},{"name":"hide-geometry-simplification-activity-indicator","description":"Indicates whether to hide display of the geometry simplification progress indicator while geometry simplification is in progress.\n\nWhen set to `false`, the progress indicator is not shown","values":[]},{"name":"hide-labels-toggle","description":"Indicates whether to hide the sketch labels toggle`.","values":[]},{"name":"hide-selection-count-label","description":"Indicates whether to hide a label indicating the length of the currently selected feature set.","values":[]},{"name":"hide-selection-tools-lasso-selection","description":"Indicates whether to hide the 'lasso' (freehand polygon) selection tool.","values":[]},{"name":"hide-selection-tools-rectangle-selection","description":"Indicates whether to hide the rectangle selection tool.","values":[]},{"name":"hide-settings-menu","description":"Indicates whether to hide the settings menu. The settings menu includes controls for tooltips, segment labels,\ngrid display, and snapping.","values":[]},{"name":"hide-single-plugin-back-button","description":"Indicates whether to hide the back button on the segment drawing toolbar when only one create tool is available.","values":[]},{"name":"hide-snapping-controls","description":"Indicates whether to hide the snapping controls portion of the settings menu.","values":[]},{"name":"hide-snapping-controls-elements-enabled-toggle","description":"Indicates whether to hide the `enabledToggle` (Enable snapping). This toggles\nthe [SnappingOptions#enabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#enabled) property.\n> [!WARNING]\n>\n> **Note**\n>\n> It is recommended to set `SnappingControls.snappingOptions.enabled = true` if `enabledToggle` is set to `false`.\n> This is because `selfEnabledToggle` and `featureEnabledToggle` require snapping globally to be enabled in order to be interactive. Otherwise, these toggles will not be responsive.","values":[]},{"name":"hide-snapping-controls-elements-feature-enabled-toggle","description":"Indicates whether to hide the `featureEnabledToggle` (Feature to feature). This toggles\nthe [SnappingOptions#featureEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#featureEnabled) property.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls","description":"Indicates whether to hide the `gridControls` (configuration of the snapping grid).","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-color-selection","description":"Indicates whether to hide the `colorSelection` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-dynamic-scale-toggle","description":"Indicates whether to hide the `dynamicScaleToggle` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-line-interval-input","description":"Indicates whether to hide the `lineIntervalInput` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-numeric-inputs","description":"Indicates whether to hide the `numericInputs` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-out-of-scale-warning","description":"Indicates whether to hide the `outOfScaleWarning` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-placement-buttons","description":"Indicates whether to hide the `placementButtons` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-controls-elements-rotate-with-map-toggle","description":"Indicates whether to hide the `rotateWithMapToggle` within the snapping grid controls.","values":[]},{"name":"hide-snapping-controls-elements-grid-enabled-toggle","description":"Indicates whether to hide the `gridEnabledToggle` (snap-to-grid).","values":[]},{"name":"hide-snapping-controls-elements-layer-list","description":"Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/snapping/FeatureSnappingLayerSource/) layerList. The layerlist provides the available layer sources supported for snapping.","values":[]},{"name":"hide-snapping-controls-elements-self-enabled-toggle","description":"Indicates whether to hide the `selfEnabledToggle` (Geometry guides). This toggles\nthe [SnappingOptions#selfEnabled](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/SnappingOptions/#selfEnabled) property.","values":[]},{"name":"hide-tooltips-toggle","description":"Indicates whether to hide the tooltips toggle`.","values":[]},{"name":"hide-undo-redo-menu","description":"Indicates whether to hide the undo/redo menu within the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layout","description":"Determines the layout/orientation of the Sketch component.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"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.","values":[]},{"name":"relative-position","description":"Relative position is used to control the appearance of elements rendered by `arcgis-sketch`. If used within\nthe slots of an `arcgis-map` or `arcgis-scene` component, you do not need to manually set this value.\n\nExamples of elements that depend on relative position include the split button chevrons (in vertical layout), the settings\npopover, and tooltips.","values":[{"name":"top-left"},{"name":"top-right"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-start"},{"name":"top-end"},{"name":"bottom-start"},{"name":"bottom-end"}]},{"name":"show-create-tools-freehand-polygon","description":"Indicates whether to display the freehandPolygon tool.","values":[]},{"name":"show-create-tools-freehand-polyline","description":"Indicates whether to display the freehandPolyline tool.","values":[]},{"name":"show-create-tools-text","description":"Indicates whether to display the text tool.","values":[]},{"name":"show-snapping-controls-elements-header","description":"Indicates whether to display the header.","values":[]},{"name":"toolbar-kind","description":"Controls the appearance of the sketch component, allowing the toolbar to adapt its appearance appropriately based on context.\n\nSet this to `docked` for use within the Expand component, or any other situation\nwhere Sketch is not floating within a large canvas.","values":[{"name":"docked"},{"name":"floating"}]},{"name":"update-on-graphic-click-disabled","description":"Controls whether the user can click a graphic in the layer to start updating it.","values":[]},{"name":"use-view-options","description":"If true, the component uses snapping, tooltips, display units, and input units from [ViewOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/).\n\nWhen this property is `true`:\n\n- Snapping and tooltip options are inherited from the view. The component's [snappingOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#snappingOptions) and [tooltipOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#tooltipOptions) are preserved but ignored.\n- Snapping controls and the tooltip toggle are hidden from the component's Settings menu.\n- Units set through [valueOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#valueOptions) override the corresponding units on the view, such as length or area, without changing the view's options. Setting a unit to `null` or `undefined` restores inheritance for that measurement type.\n\nWhen `false`, the component uses its own snapping, tooltip, and unit options instead.\n\nLabel [options](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/#labelOptions) and [direction mode](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ValueOptions/#directionMode) are not inherited from the view.\n\nChanges to this property apply when the next create or update operation starts, not to an operation already in progress.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch/"},{"name":"Sketch","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-sketch--demo&singleStory=true"}]},{"name":"arcgis-sketch-tooltip-controls","description":"The sketch-tooltip-controls component provides a user interface to set specific options within Sketch's [SketchTooltipOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchTooltipOptions/), [SketchLabelOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchLabelOptions/), and [SketchValueOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchValueOptions/) classes.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"direction-mode","description":"Indicates whether the direction (deflection) of the segment being drawn\nis measured relative to the previous segment or from the main axis of the map\n(usually north). See [SketchTooltipOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchTooltipOptions/) and [SketchValueOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/sketch/SketchValueOptions/#directionMode).","values":[{"name":"absolute"},{"name":"relative"}]},{"name":"hide-labels-toggle","description":"Controls whether the labels toggle is shown for this component.\n\n> **Note:**  If this component is contained in another component, the parent\ncomponent is responsible for setting this property based on any\nknown limitations, including properties on the view. Specifically,\nas of 5.1, if the view is a 2d video or linkchart instead of a map,\nthe parent component should set this property to `true`.","values":[]},{"name":"hide-tooltips-toggle","description":"Controls whether the tooltips toggle is shown for this component.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"labels-enabled","description":"Indicates whether labels are shown next to each segment of the graphic being sketched.","values":[]},{"name":"show-direction-mode-picker","description":"Controls whether the direction mode picker is shown for this component.","values":[]},{"name":"show-header","description":"Controls whether a header is shown for this component.","values":[]},{"name":"tooltips-enabled","description":"Indicates whether tooltips are shown while sketching and editing.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-sketch-tooltip-controls/"}]},{"name":"arcgis-slice","description":"The Slice component is a 3D analysis tool that can be used to reveal occluded content in a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/). It applies\n[slice analysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/SliceAnalysis/)\nto any layer type, making it possible to see inside buildings or to explore geological surfaces.\n\n<a href=\"https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html\"><video src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/slice.webm\" autoplay loop muted playsinline></video></a>\n\nThe slicing [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape)\nis always a [plane](https://developers.arcgis.com/javascript/latest/references/core/analysis/SlicePlane/).\nBy default, the plane is either horizontal or vertical. To allow a tilt angle for the plane, set\n[tiltEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#tiltEnabled)\nto `true`. The slice hides any content in front of the surface. The handles on the sides of the plane can be used to adjust\nthe size, heading, tilt, and position of the slice plane.\nThe [SlicePlane](https://developers.arcgis.com/javascript/latest/references/core/analysis/SlicePlane/)\ncan be set or retrieved using the [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape) property.\n\nOnce the slice plane is applied, layers can be excluded from the slicing. For example, by excluding the sublayers which include\ncolumns and floor slabs, the inner structure of a building can investigated.\n\n[![slice-exclude](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/slice-exclude.avif)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nHolding the `Shift` key while placing a new slice applies it vertically.\n\n**Known limitation**\n\nSlice is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [SliceAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/SliceAnalysis/)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `clear(): Promise<void>` - Clear the [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape) of the slice, effectively removing it from the view. Other properties like [excludedLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#excludedLayers)\nand [excludeGroundSurface](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#excludeGroundSurface) are not modified.\nCalling this method changes the [state](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#state) to `ready`.\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>` - Start the interactive placement of a new slice, clearing the previous [shape](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#shape).\nCalling this method changes the [state](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/#state) to `slicing`.","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-slice/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"exclude-ground-surface","description":"Indicates whether the [Ground](https://developers.arcgis.com/javascript/latest/references/core/Ground/) and layers that\nare draped on the ground surface are excluded from the slice.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the \"Excluded layers\" heading.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-start-button","description":"If true, the button that starts a new slice will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"tilt-enabled","description":"Enable tilting the slice shape. If set to true, the slice shape will orient itself as best as\npossible to the surface under the cursor when first placing the shape. If set to false, the slice shape is\nrestricted to be either horizontal or vertical.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slice/"},{"name":"Slice","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slice--demo&singleStory=true"}]},{"name":"arcgis-slider-binary-color-size-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained.\nAt that point, development should use the native component.\n\nThe Binary Color Size Slider component is intended for authoring and exploring diverging data-driven visualizations in any\nlayer that can be rendered with an above and below theme for a [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/).\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/BinaryColorSizeSlider/#fromRendererResult)\nmethod can be used to intelligently populate slider properties including [max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#min), [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nconfiguration, and the slider's histogram after the renderer has been created from the result of the\n[createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer) method.\n\n```js\nconst univariateColorSizeRendererCreator = await import(\n  \"@arcgis/core/smartMapping/renderers/univariateColorSize.js\"\n);\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst binaryColorSizeSlider = document.querySelector(\"arcgis-slider-binary-color-size-legacy\");\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  field: \"B17020_calc_pctPovE\",\n  view: viewElement.view,\n  theme: \"above-and-below\",\n};\n\nconst rendererResult = await univariateColorSizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nawait binaryColorSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update an above and below (diverging) visualization in a layer's renderer.\nIt is the responsibility of the app developer to set up event listeners on that update the size variable of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = async () => {\n  const result = await binaryColorSizeSlider.updateRenderer(featureLayer.renderer);\n  featureLayer.renderer = result;\n};\n\nbinaryColorSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nbinaryColorSizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nbinaryColorSizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateFromRendererResult(rendererResult: RendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties of a Binary Color Size Slider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#RendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\nmethod. This method is useful for cases when the app allows the end user to switch data variables used to render the data.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.\n- `updateRenderer(renderer: ClassBreaksRenderer): Promise<ClassBreaksRenderer | null | undefined>` - A convenience function used to update the input renderer based on\nthe values of the slider [stops](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/BinaryColorSizeSlider/#stops).","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-slider-binary-color-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"handles-synced-to-primary","description":"This property indicates whether the position of the outside handles are synced with the middle, or primary,\nhandle. When enabled, if the primary handle is moved then the outside handle positions are updated\nwhile maintaining a fixed distance from the primary handle.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","values":[]},{"name":"persist-size-range-enabled","description":"When `true`, ensures symbol sizes in the `above` range\nare consistent with symbol sizes in the `below` range for all slider thumb positions.\nIn other words, the size values in the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/#stops) will adjust\nproportionally according to the positions of the data values within the\nconstraints of the size range (maxSize - minSize) as the slider thumbs update.\nWhen `false`, size values in the stops will remain the same even when slider thumb values\nchange.\n\nIn most cases, this should be set to `true` to keep sizes in the `above` range consistent with\nsizes in the `below` range to avoid map misinterpretation.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-binary-color-size-legacy/"},{"name":"Slider Binary Color Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-binary-color-size-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-classed-color-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Classed Color Slider component is designed for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with color in a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![Classed Color Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/classedcolorslider-labels.avif \"Classed Color Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/ClassedColorSlider/#fromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos) configuration,\nand the slider's histogram after the renderer has been created from the result of the\n[createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createClassBreaksRenderer) method.\n\n```js\nconst colorRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/color.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst classedColorSlider = document.querySelector(\"arcgis-slider-classed-color-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  field: \"B17020_calc_pctPovE\",\n  view: viewElement.view,\n  numClasses: 4\n};\n\nconst rendererResult = await colorRendererCreator.createClassBreaksRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nawait classedColorSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nin a ClassBreaksRenderer. It is the responsibility of the app developer\nto set up event listeners on this slider that update the breaks of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = async () => {\n  const renderer = featureLayer?.renderer?.clone();\n  if (!renderer || !(\"classBreakInfos\" in renderer) || !renderer.classBreakInfos?.[0]) {\n    return;\n  }\n\n  const updatedClassBreakInfos = await classedColorSlider.updateClassBreakInfos(renderer.classBreakInfos);\n  if (!updatedClassBreakInfos) {\n    return;\n  }\n\n  renderer.classBreakInfos = updatedClassBreakInfos;\n  featureLayer.renderer = renderer;\n};\n\nclassedColorSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nclassedColorSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nclassedColorSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateClassBreakInfos(breakInfos: ClassBreakInfo[]): Promise<ClassBreakInfo[] | null | undefined>` - A convenience function used to update the\n[classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nof a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) associated with this slider.\n\nThe number of breaks from the renderer must match the number of breaks in the slider.\nGenerally, the input breaks for this method should come from the same renderer as one\nused to create the slider with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#updateFromRendererResult) method.\n- `updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties of a ClassedColorSlider from the result\nof the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createClassBreaksRenderer) method.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","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-slider-classed-color-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-color-legacy/"},{"name":"Slider Classed Color (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-classed-color-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-classed-size-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Classed Size Slider component is designed for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with size in a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/).\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Classed Size Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/classedsizeslider-labels.avif \"Classed Size Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos) configuration,\nand the slider's histogram after the renderer has been created from the result of the [createClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer)\nmethod.\n\n```js\nconst sizeRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/size.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst classedSizeSlider = document.querySelector(\"arcgis-slider-classed-size-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Median_Income_by_Race_and_Age_Selp_Emp_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  field: \"B19049_001E\",\n  view: viewElement.view,\n  numClasses: 4,\n};\n\nconst rendererResult = await sizeRendererCreator.createClassBreaksRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nawait classedSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nin a ClassBreaksRenderer. It is the responsibility of the app developer\nto set up event listeners on this slider that update the breaks of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = async () => {\n  const renderer = featureLayer?.renderer?.clone();\n  if (!renderer || !(\"classBreakInfos\" in renderer) || !renderer.classBreakInfos?.[0]) {\n    return;\n  }\n  renderer.classBreakInfos = (await classedSizeSlider.updateClassBreakInfos(renderer.classBreakInfos);\n  featureLayer.renderer = renderer;\n};\n\nclassedSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nclassedSizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nclassedSizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateClassBreakInfos(breakInfos: ClassBreakInfo[]): Promise<ClassBreakInfo[] | null | undefined>` - A convenience function used to update the\n[classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)\nof a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) associated with this slider.\n\nThe number of breaks from the renderer must match the number of breaks in the slider.\nGenerally, the input breaks for this method should come from the same renderer as one\nused to create the slider with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method.\n- `updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties of a ClassedSizeSlider from the result\nof the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer) method.\nThis method is used to configure an empty ClassedSizeSlider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","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-slider-classed-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the breaks of the appropriate renderer.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/"},{"name":"Slider Classed Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-classed-size-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-color-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Color Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [ColorVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![Color Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/colorslider-2-labels.avif \"Color Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#min), the [color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) configuration,\nand the slider's histogram after the renderer has been created from the result of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createContinuousRenderer) method.\n\n```js\nconst colorRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/color.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst colorSlider = document.querySelector(\"arcgis-slider-color-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params: ContinuousRendererParameters = {\n  layer: featureLayer,\n  field: \"B17020_calc_pctPovE\",\n  view: viewElement.view,\n  theme: \"above-and-below\",\n};\n\nconst rendererResult = await colorRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\ncolorSlider.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update a [color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/)\nin a layer's renderer. It is the responsibility of the app developer to set up event listeners on this slider that update the color variable of the appropriate renderer.\n\n```js\n// when the user slides the handle(s), update the renderer\n// with the updated color stops\ncolorSlider.updateFromRendererResult(rendererResult, histogramResult);\n\nconst updateRendererFromSlider = () => {\n  const renderer = featureLayer.renderer?.clone();\n  if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n    return;\n  }\n\n  const colorVariable = renderer.visualVariables[0].clone();\n  colorVariable.stops = colorSlider.stops;\n\n  renderer.visualVariables = [colorVariable];\n  featureLayer.renderer = renderer;\n};\n\ncolorSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\ncolorSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\ncolorSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateFromRendererResult(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): void` - A convenience function used to update the properties of a Color Slider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#ContinuousRendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createContinuousRenderer)\nmethod. This method is used to configure an empty Color Slider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","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-slider-color-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"handles-synced-to-primary","description":"Only applicable when three thumbs (i.e. handles) are set on the\nslider (i.e. when [primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#primaryHandleEnabled) is `true`). This property\nindicates whether the position of the outside handles are synced with the middle, or primary,\nhandle. When enabled, if the primary handle is moved then the outside handle positions are updated\nwhile maintaining a fixed distance from the primary handle.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color variable of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color variable of the appropriate renderer.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"name":"primary-handle-enabled","description":"When `true`, the slider will render a third handle between the two handles already provided by default. This is the primary handle.\nThree or five [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#stops) must be defined for the primary handle to render.\nThe primary handle represents the middle stop.\n\nWhen [handlesSyncedToPrimary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#handlesSyncedToPrimary) is `true`, then this handle will control the position of the others when moved.\n\nThis is typically used in diverging, or `above-and-below` renderer configurations.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/"},{"name":"Slider Color (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-color-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-color-size-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Color Size Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [ColorVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) and\na [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/). Both visual variables should be used\nto visualize the same data variable.\n\nThis slider and visualization style is designed specifically for\n3D thematic visualizations where both size and color are used to visualize the same data variable in order\nto minimize confusion because of distortion in perception. For example, a visualization of extruded points\nmay be difficult to understand if two features of similar sizes (and therefore data values) are located\nfar apart from one another; the feature furthest from the [Camera](https://developers.arcgis.com/javascript/latest/references/core/Camera/) will appear smaller than\nthe feature closer to the camera. The color variable can help the user understand that both features have similar values.\n\n![Slider Color Size with perspective](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/colorsizeslider-perspective.avif \"Slider Color Size with perspective\")\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Slider Color Size with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/colorsizeslider-labels.avif \"Slider Color Size with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#min), [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/) configuration,\n[color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) configuration, and the slider's histogram after the\nrenderer has been created from the result of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer) method.\n\n```js\nconst colorAndSizeRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/univariateColorSize.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst colorSizeSlider = document.querySelector(\"arcgis-slider-color-size-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Poverty_by_Age_Boundaries/FeatureServer/1\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  field: \"B17020_calc_pctPovE\",\n  view: viewElement.view,\n};\n\nconst rendererResult = await colorAndSizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nawait colorSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update the corresponding [color](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/)\nand [size](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/) visual variables in a layer's renderer. It is the responsibility of the app developer\nto set up event listeners on this slider that update these variables in the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = () => {\n  const renderer = featureLayer?.renderer?.clone();\n  if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n    return;\n  }\n  renderer.visualVariables = colorSizeSlider.updateVisualVariables(\n    renderer.visualVariables as VisualVariable[],\n  );\n  featureLayer.renderer = renderer;\n};\n\ncolorSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\ncolorSizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\ncolorSizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateFromRendererResult(rendererResult: RendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties of a Slider Color Size component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#RendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\nmethod. Note that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.\n- `updateVisualVariables(variables: VisualVariable[]): VisualVariable[]` - A convenience function used to update the visual variables of a renderer generated with the\n[createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/univariateColorSize/#createContinuousRenderer)\nmethod with the values obtained from the slider. This method is useful for cases when the app allows the end user to switch data variables\nused to render the data.","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-slider-color-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"handles-synced-to-primary","description":"Only applicable when three thumbs (i.e. handles) are set on the\nslider (i.e. when [primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#primaryHandleEnabled) is `true`). This property\nindicates whether the position of the outside handles are synced with the middle, or primary,\nhandle. When enabled, if the primary handle is moved then the outside handle positions are updated\nwhile maintaining a fixed distance from the primary handle.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color and size variables of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the color and size variables of the appropriate renderer.","values":[]},{"name":"persist-size-range-enabled","description":"Only applicable when three thumbs (i.e. handles) are set on the\nslider (i.e. when [primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#primaryHandleEnabled) is `true`).\nThis property is typically used in diverging, or `above-and-below` renderer configurations.\n\nWhen `true`, ensures symbol sizes in the `above` range\nare consistent with symbol sizes in the `below` range for all slider thumb positions.\nIn other words, the size values in the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#stops) will adjust\nproportionally according to the positions of the data values within the\nconstraints of the size range (maxSize - minSize) as the slider thumbs update.\nWhen `false`, size values in the stops will remain the same even when slider thumb values\nchange.\n\nIn most cases, this should be set to `true` to keep sizes in the `above` range consistent with\nsizes in the `below` range to avoid map misinterpretation.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"name":"primary-handle-enabled","description":"When `true`, the slider will render a third handle between the\ntwo handles already provided by default. This is the primary handle.\nThree or five [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#stops) must be defined for the primary handle to render.\nThe primary handle represents the middle stop.\n\nWhen [handlesSyncedToPrimary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/#handlesSyncedToPrimary) is `true`, then\nthis handle will control the position of the others when moved.\n\nThis is typically used in diverging, or `above-and-below` renderer configurations.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-size-legacy/"},{"name":"Slider Color Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-color-size-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-heatmap-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Heatmap Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/HeatmapRenderer/).\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Heatmap Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/heatmapslider-labels.avif \"Heatmap Slider with annotations\")\n\n```js\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst heatmapSlider = document.querySelector(\"arcgis-slider-heatmap-legacy\")!;\n\nconst layer = new CSVLayer({\n  url: \"https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/2.5_week.csv\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(layer);\n\nconst params = {\n  layer,\n  valueExpression: \"($feature.mag)\",\n  view: viewElement.view,\n};\n\nconst rendererResult = await heatmapRendererCreator.createRenderer(params);\n\nlayer.renderer = rendererResult.renderer;\n\nheatmapSlider.stops = rendererResult.renderer.colorStops;\n```\n\nThis slider should be used to update the [colorStops](https://developers.arcgis.com/javascript/latest/references/core/renderers/HeatmapRenderer/#colorStops)\nproperty in a HeatmapRenderer. It is the responsibility of the app developer\nto set up event listeners on this slider to update the renderer's colorStops based on how the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-heatmap-legacy/#stops) property was recalculated.\n\n```js\nconst updateRendererFromSlider = () => {\n  const renderer = layer.renderer?.clone();\n  if (!renderer || !(\"colorStops\" in renderer)) {\n    return;\n  }\n  renderer.colorStops = heatmapSlider.stops;\n  layer.renderer = renderer;\n};\n\nheatmapSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nheatmapSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nheatmapSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.","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-slider-heatmap-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-heatmap-legacy/"},{"name":"Slider Heatmap (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-heatmap-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-opacity-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Opacity Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with an [OpacityVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![Opacity Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/opacityslider-labels.avif \"Opacity Slider with annotations\")\n\nThe [updateFromVisualVariableResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#updateFromVisualVariableResult) method can be used to intelligently populate slider properties including [max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#min),\nthe [opacity visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/) configuration,\nand the slider's histogram after the renderer has been created from the result of the\n[createVisualVariable()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/#createVisualVariable) method.\n\n```js\nconst opacityVariableCreator = await import(\"@arcgis/core/smartMapping/renderers/opacity.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst opacitySlider = document.querySelector(\"arcgis-slider-opacity-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/ArcGIS/rest/services/USA_Census_2020_DHC_Total_Population/FeatureServer/2\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  view: viewElement.view,\n  field: \"P002_calc_pct0002\",\n};\n\nconst variableResult = await opacityVariableCreator.createVisualVariable(params);\n\nif (featureLayer.renderer && \"visualVariables\" in featureLayer.renderer) {\n  featureLayer.renderer.visualVariables = [variableResult.visualVariable];\n}\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nawait opacitySlider.updateFromVisualVariableResult(variableResult, histogramResult);\n```\n\nThis slider should be used to update an [opacity visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/OpacityVariable/)\nin a layer's renderer. It is the responsibility of the app developer\nto set up event listeners on this slider to update the opacity variable of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = () => {\n  const renderer = featureLayer.renderer?.clone();\n  if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n    return;\n  }\n\n  const visualVariable = renderer.visualVariables[0];\n  if (visualVariable.type !== \"opacity\") {\n    return;\n  }\n\n  const opacityVariable = visualVariable.clone();\n  opacityVariable.stops = opacitySlider.stops;\n  renderer.visualVariables = [opacityVariable];\n  featureLayer.renderer = renderer;\n};\n\nopacitySlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nopacitySlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nopacitySlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateFromVisualVariableResult(visualVariable: VisualVariableResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties of an OpacitySlider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/#VisualVariableResult) of\nthe [createVisualVariable()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/#createVisualVariable)\nmethod. This method is used to configure an empty OpacitySlider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.","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-slider-opacity-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromVisualVariableResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#updateFromVisualVariableResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the opacity variable of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromVisualVariableResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/#updateFromVisualVariableResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the opacity variable of the appropriate renderer.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-opacity-legacy/"},{"name":"Slider Opacity (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-opacity-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-scale-range","description":"The Scale Range Slider component allows the user to set a minimum and maximum scale based on named scale ranges.\nWhen a layer is provided, the component's minScale and maxScale properties will be set to the scale range of the layer.\n--\n\n### Events\n- **arcgisChange** - Fires when the thumb or range is released on the component. Use [@arcgisInput](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#event-arcgisInput) for continuous updates during a drag.\n- **arcgisInput** - Fires continuously while the thumb or range is being dragged. This event can fire frequently; consider debouncing or throttling expensive work.\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 for user interaction.\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.","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-slider-scale-range/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-max-scale-menu","description":"Indicates whether the maximum scale dropdown menu is visible. Default value is `false`.","values":[]},{"name":"hide-min-scale-menu","description":"Indicates whether the minimum scale dropdown menu is visible. Default value is `false`.","values":[]},{"name":"hide-preview","description":"Indicates whether the preview thumbnail of the scale is visible.\nDefault value is `false`.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"max-scale","description":"The maximum scale of the active scale range.","values":[]},{"name":"max-scale-limit","description":"The lowest possible maximum scale value on the slider, at which [maxScale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#maxScale) may not be set below.","values":[]},{"name":"min-scale","description":"The minimum scale of the active scale range.","values":[]},{"name":"min-scale-limit","description":"The highest possible minimum scale value on the slider, at which [minScale](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/#minScale) may not be set above.","values":[]},{"name":"mode","description":"The mode of the component, indicating which slider thumbs can be adjusted.","values":[{"name":"max-scale-only"},{"name":"min-scale-only"},{"name":"range"}]},{"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.","values":[]},{"name":"region","description":"The region that the scale thumbnails will focus on.\nEach region comes from the [ISO 3166-1 alpha-2 code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).\nBoth lowercase and uppercase region codes are supported.","values":[]},{"name":"show-scale-range-indicator","description":"If an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) is associated with the component and this property\nis set to `true`, the current scale indicator will be represented as a highlighted range of the slider track. The width of the indicator will increase\nas the [camera's tilt](https://developers.arcgis.com/javascript/latest/references/core/Camera/#tilt) approaches 90 degrees. If this property is set to `false`,\na small caret will render under the track indicating the current scale instead.\n\n> [!WARNING]\n> This property is not supported when the component is used in 2D maps.","values":[]},{"name":"show-world-value","description":"Indicates whether the world scale value is shown in the scale menu.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-scale-range/"},{"name":"Scale Range Slider with Feature Layer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-scale-range--feature-layer-demo&singleStory=true"},{"name":"Scale Range Slider with Tile Layer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-scale-range--tile-layer-demo&singleStory=true"}]},{"name":"arcgis-slider-size-legacy","description":"> [!WARNING]\n>\n> This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.\n>\n> A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.\n\nThe Size Slider component is intended for authoring and exploring data-driven visualizations in any\nlayer that can be rendered with a [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/).\n\nSee the image below for a summary of the configurable options available on this slider.\n\n![Size Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/sizeslider-labels.avif \"Size Slider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#min), [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nintervals, and the slider's histogram after the renderer has been created from the result of the\n[createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer) method.\n\n```js\nconst sizeRendererCreator = await import(\"@arcgis/core/smartMapping/renderers/size.js\");\nconst viewElement = document.querySelector(\"arcgis-map\")!;\nconst sizeSlider = document.querySelector(\"arcgis-slider-size-legacy\")!;\n\nconst featureLayer = new FeatureLayer({\n  url: \"https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/USA_Major_Cities_/FeatureServer/0\",\n});\n\nawait viewElement.viewOnReady();\nviewElement.map?.add(featureLayer);\n\nconst params = {\n  layer: featureLayer,\n  view: viewElement.view,\n  field: \"POPULATION\",\n};\n\nconst rendererResult = await sizeRendererCreator.createContinuousRenderer(params);\n\nfeatureLayer.renderer = rendererResult.renderer;\n\nconst histogramResult = await histogram({\n  ...params,\n  numBins: 30,\n});\n\nsizeSlider.updateFromRendererResult(rendererResult, histogramResult);\n```\n\nThis slider should be used to update a [size visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nin a layer's renderer. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.\n\n```js\nconst updateRendererFromSlider = () => {\n  const renderer = featureLayer.renderer?.clone();\n  if (!renderer || !(\"visualVariables\" in renderer) || !renderer.visualVariables?.[0]) {\n    return;\n  }\n\n  const sizeVariable = renderer.visualVariables[0];\n  const updatedSizeVariable = sizeSlider.updateVisualVariable(sizeVariable);\n  if (!updatedSizeVariable) {\n    return;\n  }\n\n  renderer.visualVariables = [updatedSizeVariable];\n  featureLayer.renderer = renderer;\n};\n\nsizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nsizeSlider.addEventListener(\"arcgisThumbDrag\", updateRendererFromSlider);\nsizeSlider.addEventListener(\"arcgisPropertyChange\", updateRendererFromSlider);\n```\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 for user interaction.\n- **arcgisThumbChange** - Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.\n- **arcgisThumbDrag** - Fires when a user drags a thumb 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.\n- `updateFromRendererResult(rendererResult: ContinuousRendererResult, histogramResult?: HistogramResult): void` - A convenience function used to update the properties of a SizeSlider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#ContinuousRendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createContinuousRenderer)\nmethod. This method is used to configure an empty SizeSlider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.\nNote that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.\n- `updateVisualVariable(sizeVariable: SizeVariable): null | undefined | SizeVariable` - A convenience function used to update the [SizeVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/)\nto match the values of the [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#stops) on the slider.\nThe slider stops are automatically updated internally when the user drags a thumb slider.\n\nThis is particularly useful for Size visual variables that have a set\n[minDataValue](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/#minDataValue) and\n[maxDataValue](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/SizeVariable/#minDataValue).\nThis method will properly reconstruct the variable to set on the renderer so it matches the stops on the slider.","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-slider-size-legacy/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"max","description":"The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","values":[]},{"name":"min","description":"The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/#updateFromRendererResult) method,\nthe user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer\nto set up event listeners that update the size variable of the appropriate renderer.","values":[]},{"name":"precision","description":"Defines how slider thumb values should be rounded. This number indicates the number\nof decimal places slider thumb _values_ should round to when they have been moved.\n\nKeep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-size-legacy/"},{"name":"Slider Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-slider-size-legacy--demo&singleStory=true"}]},{"name":"arcgis-snapping-controls","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 for user interaction.\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.","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-snapping-controls/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-enabled-toggle","description":"Controls display of the \"Enable snapping\" toggle.","values":[]},{"name":"hide-feature-enabled-toggle","description":"Controls display of the \"Feature to feature\" toggle. This controls feature snapping.","values":[]},{"name":"hide-grid-controls","description":"Controls display of the [arcgis-grid-controls](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/).","values":[]},{"name":"hide-grid-controls-elements-color-selection","description":"Controls display of the buttons to change the color of the grid.","values":[]},{"name":"hide-grid-controls-elements-dynamic-scale-toggle","description":"Controls display of the toggle that modifies [dynamicScaling](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-grid-controls/#dynamicScaling).","values":[]},{"name":"hide-grid-controls-elements-line-interval-input","description":"Controls display of the line interval input. The input sets the interval between major grid lines.","values":[]},{"name":"hide-grid-controls-elements-numeric-inputs","description":"Controls display of the numeric inputs that allow for setting grid spacing and rotation","values":[]},{"name":"hide-grid-controls-elements-out-of-scale-warning","description":"Controls display of the out of scale warning. This warning is displayed when the grid is not shown because it would be too small at the current scale and dynamic scaling is disabled.","values":[]},{"name":"hide-grid-controls-elements-placement-buttons","description":"Controls display of the grid placement buttons. These buttons allow the user to start interactive configuration of the grid.","values":[]},{"name":"hide-grid-controls-elements-rotate-with-map-toggle","description":"Controls display of the \"Rotate grid with map\" toggle. This toggle controls whether the grid rotates with the map.","values":[]},{"name":"hide-layer-list","description":"Controls display of the \"Snapping layers\" dropdown. The list displays the available layers to configure snapping.","values":[]},{"name":"hide-self-enabled-toggle","description":"Controls display of the “Geometry guides” toggle. This toggle controls the self-snapping configuration which handles showing right-angle and parallel line indicators while constructing or modifying geometries.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"show-grid-controls-elements-grid-enabled-toggle","description":"Controls display of the \"Enable grid\" toggle. This toggle controls whether the grid is displayed.","values":[]},{"name":"show-header","description":"Controls display of the header","values":[]},{"name":"state","description":"The current state of the component.","values":[{"name":"disabled"},{"name":"ready"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-snapping-controls/"},{"name":"Snapping Controls","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-snapping-controls--demo&singleStory=true"}]},{"name":"arcgis-color-select","description":"Labeled swatch which opens a color picker popover to select a color.\n--\n\n### Events\n- **arcgisColorChanged** - Emitted when the color value changes.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"color","description":"The current color value.","values":[]},{"name":"label","description":"The label for the component.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-color-select/"}]},{"name":"arcgis-time-of-day-slider","description":"Component which displays a slider to select a specific time of day or a range of times within a day.\n--\n\n### Events\n- **arcgisTimeChange** - Emitted when the time is changed.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"disabled","description":"Whether the slider is disabled.","values":[]},{"name":"end-time","description":"The end time of the time range in minutes since midnight.","values":[]},{"name":"label","description":"The label for the component.","values":[]},{"name":"mode","description":"The mode of the slider - single time or time range.","values":[{"name":"single"},{"name":"range"}]},{"name":"start-time","description":"The start time of the time range in minutes since midnight.","values":[]},{"name":"steps","description":"If specified, sets an incremental step for the slider.","values":[]},{"name":"visual-scale","description":"The scale of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-of-day-slider/"}]},{"name":"arcgis-time-zone-chip","description":"A compact time-zone selector.\n--\n\n### Events\n- **arcgisInternalTimeZoneChange** - Emitted when the selected time zone changes.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"disabled","values":[]},{"name":"time-zone","values":[]},{"name":"visual-scale","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-zone-chip/"}]},{"name":"arcgis-utility-network-picker","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\nIt allows users to select utility networks from the map.\n--\n\n### Events\n- **arcgisError** - Fires when an error occurs while loading the utility networks from the map.\n- **arcgisPropertyChange**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"error","values":[]},{"name":"heading","values":[]},{"name":"hide-errors","values":[]},{"name":"hide-loader","values":[]},{"name":"state","values":[{"name":"error"},{"name":"loading"},{"name":"ready"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-picker/"}]},{"name":"arcgis-webgl-error","description":"Warning for WebGL errors.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"error-name","description":"The WebGL Error name.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-webgl-error/"}]},{"name":"arcgis-swipe","description":"The Swipe component provides a tool to show a portion of a layer or layers\non top of a map. Layers can be swiped vertically or horizontally to easily\ncompare two layers or see what is underneath a layer.\n\nTo use the Swipe component, set the `startLayers` and `endLayers`\nproperties to determine what will be compared on either side of the component. If one of these properties\nis not set, then the Swipe component will overlay the existing map.\n\n**Known limitations**\n\n- This component is not currently supported within a Scene component.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisSwipeChange** - Fires when the swipe position changes and the drag handle is released on the component.\n\n**Note:** To constantly listen to changes while dragging, use the `arcgisSwipeInput` event instead.\n- **arcgisSwipeInput** - Fires when the swipe position is updated.\nThis event is fired continuously while dragging the handle.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","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-swipe/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"direction","description":"The direction the Swipe component moves across the view.\nIf `\"horizontal\"`, the component will move left and right and\nif `\"vertical\"`, the component will move up and down.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"hide-divider","description":"When `true`, the divider between the leading and trailing layers will be hidden.","values":[]},{"name":"hide-handle","description":"When `true`, the handle from which you drag the component will be hidden.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"position","description":"The position of the Swipe component. This determines what percentage\nof the view will be taken up by the [startLayers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-swipe/#startLayers).","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-swipe/"},{"name":"Swipe","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-swipe--demo&singleStory=true"}]},{"name":"arcgis-table-list","description":"The Table List component provides a way to display a list of tables associated with a [Map](https://developers.arcgis.com/javascript/latest/references/core/Map/).\nIt is meant to be used with [feature layer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/) tables.\n\nIf a map contains feature layer tables, they will display within the component. Tables can also be added to the Map's\n[tables](https://developers.arcgis.com/javascript/latest/references/core/Map/#tables) collection. Any tables referenced in the [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#map)\nproperty will display in the component. If unsure of whether the layer is a table, check the feature layer's\n[isTable](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#isTable) property.\n\nThe [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/ListItem/) API provides access to each table, allows\nthe developer to configure actions related to the table, and allows the developer to add content to the item related to the table.\n\n\n**Known Limitations**\n* The TableList component is not supported with [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\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 for user interaction.\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.","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-table-list/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","values":[]},{"name":"drag-enabled","description":"Indicates whether [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/ListItem/) may be reordered within the list by dragging and dropping.\nDrag won't be enabled until the number of list items is equal to or greater than the value set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#showFilter) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#showFilter) is true.","values":[]},{"name":"heading-level","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-status-indicators","description":"Indicates whether to hide status indicators in the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"min-drag-enabled-items","description":"The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#dragEnabled).","values":[]},{"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-table-list/#showFilter) input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/TableList/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-errors","description":"This property provides the ability to show or hide layer error indicators.","values":[]},{"name":"show-filter","description":"This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]},{"name":"show-temporary-table-indicators","description":"This property provides the ability to show or hide the temporary table indicators for tables 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 table title.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/"},{"name":"Table List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-table-list--demo&singleStory=true"}]},{"name":"arcgis-table-list-next","description":"> [!WARNING]\n> The Table List (next) component is the successor to the Table List component, provided to you early for testing and feedback.\nIn version 6.0, the implementation of [arcgis-table-list](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list/) will be updated under the hood to that of [arcgis-table-list-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/),\nand this component will be removed. To update at version 6.0, simply remove `-next` from the component name.\n\nThe Table List (next) component provides a way to display a list of tables associated with a map or table collection.\nIt is the direct component migration of the TableList widget and is provided early for testing and feedback.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisFilterChange** - Emitted when the value of the [filterText](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#filterText) input changes.\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 for user interaction.\n- **arcgisSelectedItemsChange** - Emitted when the collection of [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#selectedItems) changes.\n- **arcgisTableItemsChanged** - Emitted when the collection of [tableItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#tableItems) changes.\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.","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-table-list-next/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed. When collapsed, only the collapse button and heading are displayed.","values":[]},{"name":"drag-enabled","description":"Indicates whether [items](https://developers.arcgis.com/javascript/latest/references/core/layerList/Item/) may be reordered within the list by dragging and dropping. MapImageLayer [MapImageLayer#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. Drag and drop won't be enabled until the number of list items is equal to or greater than than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input when filtering is enabled.","values":[]},{"name":"filter-text","description":"The value of the filter input text string when filtering is enabled.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-no-filter-results-notice","description":"Indicates whether to hide the notice that appears when no results are found after filtering.","values":[]},{"name":"hide-no-items-notice","description":"Indicates whether to hide the notice that appears when there are no items to display.","values":[]},{"name":"hide-status-indicators","description":"Indicates whether to hide status indicators in the component.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"list-mode-disabled","description":"Specifies whether to ignore the [listMode](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#listMode) property to display all layers. A common use case for `listModeDisabled` is when you want to use the component to manage and configure a layer's `listMode` value.","values":[]},{"name":"min-drag-enabled-items","description":"The minimum number of list items required to enable drag and drop reordering.","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the filter input box.","values":[]},{"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.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode. Selected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#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. |","values":[{"name":"none"},{"name":"single-persist"},{"name":"multiple"},{"name":"single"}]},{"name":"show-close-button","description":"This property provides the ability to show or hide the close button. When the close button is shown, the `ESC` key can be used to close the component via keyboard when the focus is within the component.","values":[]},{"name":"show-collapse-button","description":"This property provides the ability to show or hide the collapse button.","values":[]},{"name":"show-errors","description":"This property provides the ability to show or hide layer error indicators.","values":[]},{"name":"show-filter","description":"This property provides the ability to show or hide the filter input box when then number of list items is equal to or greater than the value set in [minFilterItems](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"This property provides the ability to show or hide the heading.","values":[]},{"name":"show-temporary-table-indicators","description":"This property provides the ability to show or hide the temporary table indicators for tables 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 table title.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-table-list-next/"},{"name":"Table List Next","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-table-list-next--demo&singleStory=true"}]},{"name":"arcgis-time-bar","description":"The `<arcgis-time-bar>` component provides interactive time selection and playback within a defined temporal extent.\n\n> [!WARNING]\n>\n> By default, the `<arcgis-time-bar>` component will attempt to load persisted _time slider_ settings from a web map or web scene.\n> If this behavior is intended and time slider settings are expected, then it is advisable to refrain from initializing the component's\n> [fullTimeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#fullTimeExtent),\n> [loop](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#loop),\n> [mode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#mode),\n> [playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#playRate),\n> [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#stops), and\n> [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) properties.\n> The reason being is that these properties will be overwritten when the saved settings are loaded.\n> To disable automatic loading of stored settings, set the `loadPersistedSettingsDisabled` property to `true`.\n\n> [!WARNING]\n>\n> The `time-extent` slot, if used, must contain a single `<arcgis-time-bar-slider>` component. Other elements or components are not supported.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n\n### Methods\n- `applyTimeSettings(settings: Pick<ArcgisTimeBar, \"fullTimeExtent\" | \"loop\" | \"mode\" | \"playRate\" | \"stops\" | \"timeExtent\">): Promise<void>` - This method will update multiple `arcgis-time-bar` properties and is intended to be used in conjunction with\n[getTimeSliderSettingsFromWebDocument](https://developers.arcgis.com/javascript/latest/references/core/support/timeUtils/#getTimeSliderSettingsFromWebDocument).\n\n`getTimeSliderSettingsFromWebDocument` is a utility function that extracts `arcgis-time-bar` settings (if any) from a\npublished web map or web scene. This method can be used to apply those settings to the `arcgis-time-bar` component.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): Promise<void>` - Incrementally moves the [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) forward one stop.\n- `play(): Promise<void>` - Initiates playback of the `arcgis-time-bar`, causing the [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) to\nincrementally move forward based on the defined [playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#playRate) and\n[stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#stops).\n\nNote that when [loop](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#loop) is `true`, the `arcgis-time-bar` will restart from the\nbeginning when it reaches the end of the slider while playing.\n- `previous(): Promise<void>` - Incrementally moves the [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) backward one stop.\n- `stop(): Promise<void>` - Stops `arcgis-time-bar` playback.\n- `updateWebDocument(document: WebMap | WebScene): Promise<void>` - Updates the `arcgis-time-bar` definition in the parsed web document.\n\n### Slots\n- **actions-end** - A slot for adding `calcite-action`s that will appear at the end of the component.\n- **settings** - A slot for adding custom content to the settings popover when the `showSettings` property is `true` and settings button is clicked. If no content is provided, the default settings component will be rendered.\n- **time-extent** - A slot for optionally inserting a `arcgis-time-bar-slider`.","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-time-bar/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"floating","description":"Controls the appearance of the `arcgis-time-bar` component.\n\nWhen `floating` is `true`, the component will appear with rounded corners and a dropshadow.\nWhen `floating` is `false`, the default, the component will appear without rounded corners and dropshadow.","values":[]},{"name":"format","description":"This property determines the format of the date displayed in the minimum, maximum, and time extent labels.\nIf `\"date\"` is specified, only the localized day, month, and year components will be displayed, for example, \"6/21/2026\" in the \"en-US\" locale.\nIf `\"date-time\"` is specified, the localized day, month, year, hour, minute, and second components will be displayed, for example, \"6/21/2026, 3:30:00 PM\" in the \"en-US\" locale.","values":[{"name":"date-time"},{"name":"date"}]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"load-persisted-settings-disabled","description":"When `true`, `arcgis-time-bar` will not attempt to load persisted _time slider_ settings from a web map or web scene.","values":[]},{"name":"loop","description":"When `true`, `arcgis-time-bar` will restart from the beginning when it reaches the end of the slider when playing.","values":[]},{"name":"mode","description":"The `arcgis-time-bar` mode. The mode determines how the time extent is calculated based on the position of the thumb(s)\nand the behavior of the component when the thumbs are manipulated.","values":[{"name":"cumulative-from-end"},{"name":"cumulative-from-start"},{"name":"instant"},{"name":"time-window"}]},{"name":"play-rate","description":"When `arcgis-time-bar` is playing, the play rate determines the interval (in milliseconds) between animation steps.\n\n> [!WARNING]\n>\n> When `arcgis-time-bar` is associated with a `arcgis-map` or `argis-scene` component, the actual playback rate may differ.\n> Specifically, the current time extent will only advance after the designated play rate interval and after the view has finished updating.\n> This means that if the view takes longer to update than the specified play rate, the effective play rate will be slower than expected.","values":[]},{"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.","values":[]},{"name":"reverse-animation","description":"When `arcgis-time-bar` is playing, determines whether the animation should play in reverse.","values":[]},{"name":"save-persisted-settings-disabled","description":"When `true`, the `arcgis-time-bar`'s settings will not be included in the parent web document when saved.","values":[]},{"name":"show-next","description":"When `true`, the `arcgis-time-bar` will display a *next* button on the time bar.\nThe *next* button, when clicked will advance the time bar's [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) to the\nnext set of stops in the [effectiveStops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#effectiveStops) array.\nClicking the *next* button is equivalent to calling the [next()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#next) method.","values":[]},{"name":"show-play","description":"When `true`, the `arcgis-time-bar` will display a *play* button on the time bar.\nThe *play* button, when clicked will advance the time bar's [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) every [playRate](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#playRate) milliseconds.\nClicking the *play* button is equivalent to calling the [play()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#play) method.","values":[]},{"name":"show-previous","description":"When `true`, the `arcgis-time-bar` will display a *previous* button on the time bar.\nThe *previous* button, when clicked will advance the time bar's [timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#timeExtent) to the\nprevious set of stops in the [effectiveStops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#effectiveStops) array.\nClicking the *previous* button is equivalent to calling the [previous()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/#previous) method.","values":[]},{"name":"show-settings","description":"When `true`, the `arcgis-time-bar` will display a *settings* button.\nThe *settings* button, when clicked will display a window that allows the user to configure the time-bar.\nTo customize the content of the settings window, please use the `settings` slot.","values":[]},{"name":"show-time-extent","description":"When `true`, the `arcgis-time-bar` will display the time extent.\nTo customize the display of the time extent, use the `time-extent` slot with the `arcgis-time-bar-slider` component.","values":[]},{"name":"time-zone","description":"The `arcgis-time-bar` component will display dates and times in the time zone specified by this property.\nBy default, the time zone is inherited from an associated `arcgis-map` or `arcgis-scene` component's view.\nIf there is no associated view, the time zone will default to `\"system\"`, the device's time zone.\nWhen the resolved time zone is `\"unknown\"`, the time bar's controls are disabled.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar/"},{"name":"Default","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-1&singleStory=true"},{"name":"TimeBar with Label","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-2&singleStory=true"},{"name":"TimeBar with Slider","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-3&singleStory=true"},{"name":"TimeBar with Slider (customized labels)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-4&singleStory=true"},{"name":"TimeBar with Slider (customized ticks)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-8&singleStory=true"},{"name":"TimeBar with Actions","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-5&singleStory=true"},{"name":"TimeBar with Settings","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-6&singleStory=true"},{"name":"TimeBar with Settings (customized)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-bar--demo-7&singleStory=true"}]},{"name":"arcgis-time-bar-slider","description":"The `arcgis-time-bar-slider` component renders a time-based slider intended for use `arcgis-time-bar`'s \"time-extent\" slot.\n--\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.\n\n### Slots\n- **content-end** - A slot that displays ticks at the end of the slider. If not provided, default ticks will be rendered.\n- **max** - A slot that displays a label for the end date of the slider. If not provided, a default label will be rendered.\n- **min** - A slot that displays a label for the start date of the slider. If not provided, a default label will be rendered.\n- **popover** - A slot that displays a popover's content while interacting with the slider's thumb or range. If not provided, a default content will be rendered.","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-time-bar-slider/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"lock-time-window","description":"When `true` and the time bar is in `time-window` mode, users will not be able to adjust individual thumbs. The thumbs will maintain a finite stop separation.\nThis ensures that the time window behaves as a single unit rather than allowing individual thumbs to be moved independently.","values":[]},{"name":"popover-display","description":"Defines how and when popovers are displayed for the slider's thumb or range.\nWhen `none`, popovers are not displayed.\nWhen `auto`, popovers are displayed automatically when interacting with a thumb or the slider's range.\nWhen `always`, popovers are always displayed. If the slider is in `time-window` mode, popovers are displayed for the slider range otherwise the thumb.","values":[{"name":"auto"},{"name":"none"},{"name":"always"}]},{"name":"show-lock-time-window","description":"When `true`, the `arcgis-time-bar-slider` will display a button to toggle the value of the `lockTimeWindow` property.\nThe button will appear depressed when `lockTimeWindow` is `true`.\nThe button will appear disabled when the mode is not `time-window`.","values":[]},{"name":"show-max","description":"When `true`, displays a label for the end date of the slider.\nThe contents of this label can be customized by providing a slotted element in the \"max\" slot.","values":[]},{"name":"show-min","description":"When `true`, displays a label for the start date of the slider.\nThe contents of this label can be customized by providing a slotted element in the \"min\" slot.","values":[]},{"name":"show-ticks","description":"When `true`, displays tick marks and labels beneath the slider.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-bar-slider/"}]},{"name":"arcgis-time-slider","description":"The Time Slider component simplifies visualization of temporal data in your application.\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 for user interaction.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `applyTimeSliderSettings(settings: TimeSliderSettings): Promise<void>`\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): Promise<void>`\n- `play(): Promise<void>`\n- `previous(): Promise<void>`\n- `stop(): Promise<void>`\n- `updateWebDocument(webmap: WebMap): 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-time-slider/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layout","description":"Determines the layout used by the TimeSlider component.\n\nPossible values are listed below:\n| Value   | Description |\n| ---     | --- |\n| auto    | Automatically uses the \"compact\" layout when the component width is less than 858 pixels. Otherwise the \"wide\" layout it used. |\n| compact | Component elements are oriented vertically. This layout is better suited to narrower widths. |\n| wide    | Component elements are oriented laterally. This thinner design is better suited to wide applications. |","values":[{"name":"auto"},{"name":"compact"},{"name":"wide"}]},{"name":"loop","description":"When `true`, the time slider will play its animation in a loop.","values":[]},{"name":"mode","description":"The time slider mode. This property is used for defining if the temporal data will be displayed\ncumulatively up to a point in time, a single instant in time, or within a time range. See\nthe following table for possible values.\n\nPossible Values       | Description   | Example |\n----------------------|-------------- | ------- |\ninstant               | The slider will show temporal data that falls on a single instance in time. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` and `end` dates to the same date: `{start: sameDate, end: sameDate}` | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/timeslider/mode-instance.avif\"> |\ntime-window           | The slider will show temporal data that falls within a given time range. This is the default. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` and `end` properties to the desired dates. | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/timeslider/mode-time-window.avif\"> |\ncumulative-from-start | Similar to `time-window`, where the start time is always pinned to the start of the slider. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` date to `null` and set `end` date to a desired date: `{start: null, end: date}` | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/timeslider/mode-from-start.avif\"> |\ncumulative-from-end   | Also, similar to the `time-window` with the end time pinned to the end of the slider. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/#timeExtent) property's `start` date to a desired date and set `end` date to `null`: `{start: date, end: null}` | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/timeslider/mode-from-end.avif\"> |","values":[{"name":"cumulative-from-end"},{"name":"cumulative-from-start"},{"name":"instant"},{"name":"time-window"}]},{"name":"play-rate","description":"The time (in milliseconds) between animation steps.\n\n> [!WARNING]\n>\n> When a [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) is associated with a TimeSlider and the TimeSlider is playing, the playback will pause before advancing if the View is still updating.\n> For example, if the `playRate` is set to 1,000 (one second) and the `View` takes 1.5 seconds to render then the TimeSlider thumb(s) will advance every\n> 1.5 seconds rather than every second.","values":[]},{"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.","values":[]},{"name":"time-visible","description":"Shows/hides time in the display.","values":[]},{"name":"time-zone","description":"Dates and times displayed in the component will be displayed in this time zone. By default this time zone is\ninherited from the associated [MapView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#timeZone) or [SceneView.timeZone](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/#timeZone). When a view is not associated with the component\nthen the property will fallback to the `system` time zone.\n\n**Possible Values**\n\nValue | Description |\n----- | ----------- |\nsystem  | Dates and times will be displayed in the timezone of the device or browser.\nunknown | Dates and times are not adjusted for any timezone. [TimeSlider](https://developers.arcgis.com/javascript/latest/references/core/widgets/TimeSlider/) will be disabled.\nSpecified IANA timezone | Dates and times will be displayed in the specified IANA time zone. See [wikipedia - List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-slider/"},{"name":"Time Slider (Associated with View)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-slider--demo&singleStory=true"},{"name":"Time Slider (Independent of View)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-slider--standalone&singleStory=true"}]},{"name":"arcgis-time-zone-label","description":"Time Zone Label is a component for displaying the current [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) of an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/).\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 for user interaction.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"action-icon","description":"An optional leading icon that is displayed within the component.","values":[]},{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-time-zone-label/"},{"name":"Time Zone Label","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-zone-label--demo-1&singleStory=true"},{"name":"Time Zone Label with Expand","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-time-zone-label--demo-2&singleStory=true"}]},{"name":"arcgis-track","description":"The Track component is a button that when activated continuously animates the Map or Scene\nto the user's location as the user moves.\nThe view rotates based on device heading, and the default heading symbol will display\nwhen speed is greater than zero and the browser provides heading information.\n\nThis component uses the browser's [Geolocation API](https://developer.mozilla.org/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/docs/Web/Security/Defenses/Secure_Contexts), such as HTTPS.\n`localhost` is considered \"potentially secure\" and can be used for testing.\n\n> [!WARNING]\n>\n> **Note**\n>\n> To avoid unexpected navigation, especially when using custom spatial references, configure the view [constraints](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#constraints)\n> such as `extent`, `minZoom`, and `maxZoom`.\n> This helps when the geolocated position is inaccurate or causes the map to navigate to a location that is no longer visible because it is outside of\n> a layer's `fullExtent`.\n\n**Known limitations**\n\n- The heading symbol is not currently supported within an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\n--\n\n### Events\n- **arcgisComplete**\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.\n- `start(): Promise<void>` - Start tracking the user's location. Only start the component on a user gesture such as a click event.\n- `stop(): Promise<void>` - Stop tracking the user's location.","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-track/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"go-to-location-disabled","description":"Indicates whether to navigate the view to the position and scale of the geolocated result.","values":[]},{"name":"icon","description":"Icon displayed in the component's button.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]},{"name":"rotation-disabled","description":"Indicates whether the component will automatically rotate to the device heading based on\nthe Geolocation APIs [`GeolocationCoordinates.heading`](https://developer.mozilla.org/docs/Web/API/GeolocationCoordinates/heading)\nproperty. The map will not rotate if the speed is `0`,\nor if the device is unable to provide heading information.","values":[]},{"name":"scale","description":"Indicates the scale to set on the view when navigating to the position of the geolocated\nresult, after a location is returned.\n\nBy default, the view will navigate to a scale of `2500` for 3D and `4514` for 2D.\nTo override the default in 2D, set the `scale` property and also set [snapToZoom](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#constraints) to `false`.\nFor 2D views the value should be within the [effectiveMinScale](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#constraints)\nand [effectiveMaxScale](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/#constraints).","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-track/"},{"name":"Track","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-track--demo&singleStory=true"}]},{"name":"arcgis-utility-network-associations","description":"The Utility Network Associations component offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The Utility Network Associations component does not support proxied feature services or feature services that utilize stored credentials.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-utility-network-associations/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"auto-refresh-associations-disabled","description":"Indicates whether to show a toggle to automatically show associations every time the map\nextent changes, or an action button to show associations within the current map extent on demand.","values":[]},{"name":"hide-connectivity-associations-settings-color-picker","description":"If true, hides the connectivity association color picker.","values":[]},{"name":"hide-connectivity-associations-settings-style-picker","description":"If true, hides the connectivity association style picker.","values":[]},{"name":"hide-connectivity-associations-settings-width-input","description":"If true, hides the connectivity association width input.","values":[]},{"name":"hide-structural-attachment-associations-settings-color-picker","description":"If true, hides the structural attachment associations color picker.","values":[]},{"name":"hide-structural-attachment-associations-settings-style-picker","description":"If true, hides the structural attachment associations style picker.","values":[]},{"name":"hide-structural-attachment-associations-settings-width-input","description":"If true, hides the structural attachment associations width input.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"include-connectivity-associations-disabled","description":"Indicates whether to query and display connectivity associations.","values":[]},{"name":"include-structural-attachment-associations-disabled","description":"Indicates whether to query and display structural attachment associations.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"max-allowable-associations","description":"The maximum number of associations that can be returned from the server.","values":[]},{"name":"max-allowable-associations-slider-max","description":"The maximum value or upper bound of the Maximum allowable associations slider.\n\nIf the value in the constructor is less than or equal to the value set for\n[maxAllowableAssociationsSliderMin](https://developers.arcgis.com/javascript/latest/references/core/widgets/UtilityNetworkAssociations/#maxAllowableAssociationsSliderMin), the property will be set to a default value (1000).","values":[]},{"name":"max-allowable-associations-slider-min","description":"The minimum value or lower bound of the Maximum allowable associations slider.\n\nIf the value in the constructor is less than 0, the property will be set to a default value (250).\nIf the value in the constructor is greater than or equal to [maxAllowableAssociationsSliderMax](https://developers.arcgis.com/javascript/latest/references/core/widgets/UtilityNetworkAssociations/#maxAllowableAssociationsSliderMax),\nthe property will be set to a default value (250).","values":[]},{"name":"max-allowable-associations-slider-step","description":"Specifies the interval to move the maximum allowable associations slider with the up, or down keys.","values":[]},{"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.","values":[]},{"name":"show-arrows-connectivity","description":"Indicates whether to show arrows for connectivity associations.","values":[]},{"name":"show-arrows-structural-attachment","description":"Indicates whether to show arrows for structural attachment associations.","values":[]},{"name":"show-associations-enabled","description":"When `autoRefreshAssociations` is `true`, indicates whether to automatically show associations\nevery time the current map extent changes.","values":[]},{"name":"show-connectivity-associations-settings-arrows-toggle","description":"If true, shows the connectivity association arrows toggle.","values":[]},{"name":"show-connectivity-associations-settings-cap-select","description":"If true, shows the connectivity association cap select.","values":[]},{"name":"show-max-allowable-associations-slider","description":"If true, hides the max allowable associations slider.","values":[]},{"name":"show-structural-attachment-associations-settings-arrows-toggle","description":"If true, shows the structural attachment associations arrow toggle.","values":[]},{"name":"show-structural-attachment-associations-settings-cap-select","description":"If true, shows the structural attachment associations cap select.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-associations/"}]},{"name":"arcgis-utility-network-trace-analysis","description":"## Overview\n\n> [!WARNING]\n> This component is the successor to the `utility-network-trace-analysis` component.\n> The `utility-network-trace-analysis` component is being substantially refactored to expose public trace sub-components in release 5.2 and 6.0.\n> To avoid destabilizing the public version of `utility-network-trace-analysis`, the refactoring work is being performed in this component.\n> At release, this \"next\" component will replace the original.\n\nThe Utility Network Trace Analysis component allows users to run traces and view trace results in a utility network.\n\n- The component supports selecting a utility network and a named trace configuration in that utility network. Both the utility network and trace configuration must be [stored in the map](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#utilityNetworks).\n- Trace locations (starting points, stopping points, and barriers) are set by selecting features on the view.\n- When a subnetwork-based trace is selected, the component displays the domain, tier, and target tier specified by the selected named trace configuration.\n- If the user selects a subnetwork trace with a specified subnetwork name, the component provides an option to choose a subnetwork name instead of starting location(s) to run the trace with.\n\nSupported trace types are: `connected`, `upstream`, `downstream`, `shortest-path` (deprecated), `path`, `subnetwork`, `subnetwork-controller`, `loops`, and `isolation`.\n\n> [!WARNING]\n>\n> The [shortest path trace type](https://pro.arcgis.com/en/pro-app/latest/help/data/trace-network/discover-the-shortest-path.htm) is deprecated with ArcGIS Pro 3.7 and ArcGIS Enterprise 12.1.\n>\n> While the shortest path trace will continue to function and be an option until the next major release, it is recommended to use the path trace to return the shortest path.\n> The path trace provides the same functionality to return a shortest path result while offering additional capabilities to find paths in your network.\n\nThe component can display the following from a trace result: elements (as [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#traceResultFeatures)), aggregated geometries, and function results.\nIf the trace result includes elements that originate from a [feature layer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/)\nthat is not included in the map, the Results tab displays an `Unknown` layer with a count of those elements.\nThe component's [traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#traceResultFeatures) property also does not include these elements.\n\n> [!WARNING]\n>\n> The Utility Network Trace Analysis component does not support the following:\n>\n> 1. Proxied feature services or feature services that utilize stored credentials.\n> 2. The `circuit` trace type or the `paths` and `circuits` result types.\n> 3. Setting grouping properties `firstUnit` and `lastUnit` for trace locations in a [telecom domain network](https://pro.arcgis.com/en/pro-app/latest/help/data/utility-network/telecom-domain-networks.htm).\n>    If a [grouped object](https://doc.esri.com/en/arcgis-pro/latest/help/data/utility-network/grouping.html) is used as a trace location, its `firstUnit` and `lastUnit` attributes are not used in the trace.\n\n## Working with nonspatial objects\n\nThe Utility Network Trace Analysis component supports selecting nonspatial objects as trace locations by traversing associations.\n\nWhen selecting a trace location or viewing a trace result feature, information about the feature is displayed according to the\n[PopupTemplate](https://developers.arcgis.com/javascript/latest/references/core/PopupTemplate/) of the layer that the feature belongs to.\nIf the feature's layer has no PopupTemplate, a default template is used to display the feature's attributes.\n\nTo select a nonspatial object as a trace location, first select a spatial feature on the map that is associated with the target nonspatial object.\nThe spatial feature's layer must have a PopupTemplate that includes a [UtilityNetworkAssociationsContent](https://developers.arcgis.com/javascript/latest/references/core/popup/content/UtilityNetworkAssociationsContent/).\nNavigate through the spatial feature's associations to the target nonspatial object, then add the object as a trace location.\n\n## Examples\n\nThis component can be used slotted into an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/):\n\n```html\n<arcgis-map item-id=\"471eb0bf37074b1fbb972b1da70fb310\">\n  <arcgis-utility-network-trace-analysis slot=\"bottom-left\"></arcgis-utility-network-trace-analysis>\n</arcgis-map>\n```\n\nAlternatively, this component can be used outside of a map by providing a [referenceElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#referenceElement):\n\n```html\n<calcite-shell>\n  <calcite-shell-panel slot=\"panel-start\" position=\"start\" width=\"l\">\n    <arcgis-utility-network-trace-analysis reference-element=\"#map-element\"></arcgis-utility-network-trace-analysis>\n  </calcite-shell-panel>\n  <arcgis-map id=\"map-element\" item-id=\"471eb0bf37074b1fbb972b1da70fb310\"></arcgis-map>\n</calcite-shell>\n```\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nEvent payload contains a callback method `cancelSelect` to cancel a selection in progress.\nThe event can also be prevented with `event.preventDefault()` to stop the selection.\n- **arcgisTraceResultClear** - Fires when trace results and errors are cleared from the results tab.\n- **arcgisTraceResultFeaturesReady** - Fires when the trace result features are ready.\nCheck property [traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#traceResultFeatures) for the trace result features.\n- **arcgisTraceResultReady** - Fires when the trace result is ready.\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.\n\n### Slots\n- **results** - Slot for instances of [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/),\nfor displaying the results of one or more traces.","attributes":[{"name":"aggregated-geometry-results-graphics-color","description":"The color used to render graphics for aggregated geometries in trace results, specified as a\n[Color](https://developers.arcgis.com/javascript/latest/references/core/Color/) object.\n\nAggregated geometry is only rendered if the trace configuration specifies aggregated geometry as a result type.\n\nDefault color is #FFFF00.","values":[]},{"name":"aggregated-geometry-results-size","description":"The size in points used to render graphics for aggregated geometries in trace results.\n\nAggregated geometry is only rendered if the trace configuration specifies aggregated geometry as a result type.","values":[]},{"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-utility-network-trace-analysis/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disable-highlight-feature-results","description":"Whether to disable highlighting trace result features on the map.\n\nIf true, the features returned by a trace will not be highlighted on the map.","values":[]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's\n[arcgis-features-next.actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions) when selecting trace locations\nand viewing trace result features.","values":[]},{"name":"hide-clear-results-count","description":"Whether to hide the count of features next to the \"Clear results\" button in the Results tab for trace results\nwhich include [elements](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#elements).","values":[]},{"name":"hide-feature-results","description":"Whether to hide feature results in the results tab.\n\nIf true, when features are returned by a trace, they will not be visible in the results tab.\nA message will be displayed in its place indicating that features were returned by the trace, but are not visible in the results pane.\nThis string can be overridden with the `messageOverrides` property.","values":[]},{"name":"hide-graphics","description":"Whether to hide the aggregated geometry [graphics](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#geometryGraphics)\nfrom the map when the trace result contains aggregated geometry results.","values":[]},{"name":"hide-placeholder","description":"Whether to hide the placeholder string when feature results are hidden in the results tab.\n\nWhen this property and [hideFeatureResults](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#hideFeatureResults) are both set to `true`,\nnothing is rendered for trace result elements. However, features are still queried and are available through\n[traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/#traceResultFeatures).","values":[]},{"name":"include-default-actions-disabled","description":"Indicates whether default actions are disabled (hidden) when\nselecting trace locations and viewing trace result features.\nThis property must be set to `true` to disable default actions.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/"},{"name":"Utility Network Trace Analysis","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-utility-network-trace-analysis--demo&singleStory=true"}]},{"name":"arcgis-utility-network-trace-aggregated-geometry-result-item","description":"The Utility Network Trace Aggregated Geometry Result Item component displays the\n[aggregated geometry](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#aggregatedGeometry)\nreturned by a utility network trace. It creates graphics for the result's line, multipoint, and polygon geometries\nand displays them in the view. Provides options to show or hide the graphics, change their color and size.\n\nAdd this component directly to the default slot of [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/).\nThe parent supplies the required read-only properties for the\n[trace result](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#traceResult) and\n[MapView](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#view).\n\nBy default, the [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/) component displays the\n[aggregated geometry](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/),\n[elements](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/), and\n[functions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/) result items for the result types\nreturned by the trace. Adding content to its default slot replaces all default result items. Add each result item\nthat the custom configuration should display.\n\nBy default, the component creates and manages a graphics layer. Set\n[graphicsLayer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#graphicsLayer) to render the\naggregated geometry graphics in an existing layer instead.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisResultReady** - Fires when the component finishes processing the current trace result.\n\nFor a result with aggregated geometry, the event fires after the graphics are created and, unless\n[hideGraphics](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#hideGraphics) is `true`, added to\nthe map. The event also fires when processing completes without graphics because the result, aggregated geometry,\nor map view is unavailable.\n\nClearing a result with\n[clearResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#clearResult) does not emit this\nevent.\n\n### Methods\n- `clearResult(): void` - Removes the aggregated geometry graphics from the\n[graphicsLayer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#graphicsLayer).\nIf the layer was created by the component, it is also removed from the map. The method clears\n[geometryGraphics](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#geometryGraphics) and resets\n[state](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#state) to `\"ready\"`.\n\nThis method does not clear the parent-provided\n[traceResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#traceResult) or emit\n[@arcgisResultReady](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#event-arcgisResultReady).\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","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-utility-network-trace-aggregated-geometry-result-item/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"graphics-color","description":"The color of the aggregated geometry graphics.\nThe default is yellow with 0.6 opacity.","values":[]},{"name":"heading","description":"The heading displayed above the aggregated geometry controls.","values":[]},{"name":"hide-graphics","description":"Whether to hide the aggregated geometry graphics from the map.\n\nWhen true, the graphics remain available through\n[geometryGraphics](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#geometryGraphics) but are removed\nfrom the [graphicsLayer](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#graphicsLayer).","values":[]},{"name":"selection-size","description":"The marker size and line or polygon-outline width of the aggregated geometry graphics, in points.\nThe default is 12.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/"}]},{"name":"arcgis-utility-network-trace-configuration-picker","description":"Selects a named trace configuration from a list and displays subnetwork fields from the named trace configuration:\nDomain network name, tier name, and target tier name.\n--\n\n### Events\n- **arcgisError**\n- **arcgisPropertyChange**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"error","values":[]},{"name":"heading","values":[]},{"name":"hide-errors","values":[]},{"name":"hide-subnetwork-info","values":[]},{"name":"state","values":[{"name":"error"},{"name":"loading"},{"name":"ready"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-configuration-picker/"}]},{"name":"arcgis-utility-network-trace-elements-result-item","description":"The Utility Network Trace Elements Result Item component displays features corresponding to the\n[elements](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#elements)\nreturned by a utility network trace. It queries utility network layers for features, highlights trace elements\nin the view, and uses [arcgis-features-next](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/) to display the queried features in a list.\n\nFor traces containing only element results, the features list opens automatically. For traces containing multiple\nresult types, users open the features list by selecting the elements result item in the trace results component.\nSee [isFeaturesListShown](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#isFeaturesListShown) for details.\n\nAdd this component directly to the default slot of [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/).\nThe parent supplies the required read-only properties for the\n[trace result](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#traceResult),\n[utility network](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#utilityNetwork), and\n[MapView](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#view).\nConfigure other settings, such as [layers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#layers),\n[disableHighlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#disableHighlight), and\n[hideFeatureResults](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#hideFeatureResults), on this component.\n\nBy default, the [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/) component displays the\n[aggregated geometry](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/),\n[elements](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/), and\n[functions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/) result items for the result types\nreturned by the trace. Adding content to its default slot replaces all default result items. Add each result item\nthat the custom configuration should display.\n\nUse [layers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#layers) to restrict feature queries to\nspecific utility network layers.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisResultReady** - Fires when processing the current trace result finishes, including when a query fails.\nThe [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#features) property contains the features\nsuccessfully queried.\n\nClearing an in-progress result with\n[clearResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#clearResult) does not emit this event.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `clearResult(): void` - Cancels feature queries in progress, removes trace-element highlights from the map,\nclears [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#features), closes the features list,\nand resets [state](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#state) to `\"ready\"`.\n\nDoes not clear the parent-provided [traceResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#traceResult)\nor emit [@arcgisResultReady](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#event-arcgisResultReady).\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","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-utility-network-trace-elements-result-item/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disable-highlight","description":"Whether to disable highlighting trace result features on the map.\nIf true, the features returned by a trace will not be highlighted on the map.","values":[]},{"name":"heading","description":"The label of the elements result item that opens the features list.\nIf not specified or empty, the component uses its localized default label.","values":[]},{"name":"hide-action-bar","description":"Whether to hide the action bar when viewing trace result features.\nThe action bar contains the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions).","values":[]},{"name":"hide-feature-results","description":"Whether to hide the elements result item and the features list.\nIf true, the component renders a placeholder string instead of the elements result item.\nWhen true, features are still queried and are available through [features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#features).\n\nThis property does not disable highlighting. Use\n[disableHighlight](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#disableHighlight) to hide trace-element highlights.","values":[]},{"name":"hide-placeholder","description":"Whether to hide the placeholder string when the elements result item and the features list are hidden.\n\nWhen this property and [hideFeatureResults](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#hideFeatureResults) are both set to `true`,\nnothing is rendered for trace result elements. However, features are still queried and are available through\n[features](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/#features).","values":[]},{"name":"include-default-actions-disabled","description":"Whether to hide the default actions when viewing trace result features.","values":[]},{"name":"reference-element","description":"The reference element, or its ID, forwarded to the embedded\n[Features component](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#referenceElement).\n\nSetting this property does not remove the requirement to use this component as a child of\n[arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/).","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/"}]},{"name":"arcgis-utility-network-trace-functions-result-item","description":"The Utility Network Trace Functions Result Item component displays the\n[function results](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#globalFunctionResults)\nreturned by a utility network trace. It displays function results in a table with the function\n[name](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/FunctionResult/#functionName)\nand [value](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/FunctionResult/#result).\nIf a function name is unavailable, the component displays the function result's\n[network attribute name](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/FunctionResult/#networkAttributeName)\nand [function type](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/FunctionResult/#functionType).\nFunction results without a network attribute name, function type, or result value are not displayed.\n\nAdd this component directly to the default slot of [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/).\nThe parent supplies the required read-only\n[trace result](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/#traceResult) property.\n\nBy default, the [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/) component displays the\n[aggregated geometry](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/),\n[elements](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/), and\n[functions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/) result items for the result types\nreturned by the trace. Adding content to its default slot replaces all default result items. Add each result item\nthat the custom configuration should display.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisResultReady** - Fires when the component finishes processing the current trace result, including when the result contains no function results.\nCalling [clearResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/#clearResult) does not emit this event.\n\n### Methods\n- `clearResult(): void` - This method has no effect because the component creates no side effects while processing function results.\nDoes not emit [@arcgisResultReady](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/#event-arcgisResultReady).\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","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-utility-network-trace-functions-result-item/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading","description":"The heading displayed above the function results table.\nIf not specified or empty, the component uses its localized default heading.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/"}]},{"name":"arcgis-utility-network-trace-inputs","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\nIt allows users to select utility networks, trace configurations, and input features for tracing.\n--\n\n### Events\n- **arcgisPropertyChange**\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nCan be prevented to stop the selection.\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.","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-utility-network-trace-inputs/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's\n[arcgis-features-next.actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions) when selecting trace locations.","values":[]},{"name":"include-default-actions-disabled","description":"Indicates whether default actions are disabled (hidden) when selecting trace locations.\nThis property must be set to `true` to disable default actions.","values":[]},{"name":"mode","values":[{"name":"default"},{"name":"add-spatial-feature"},{"name":"add-spatial-instructions"}]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-inputs/"}]},{"name":"arcgis-utility-network-trace-locations","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\nIt allows users to select locations on the map to use as trace inputs.\n--\n\n### Events\n- **arcgisError**\n- **arcgisTraceLocationSelectEnd** - Fires when the user completes the selection of a trace location.\n- **arcgisTraceLocationSelectStart** - Fires when the user begins selection of a trace location.\nCan be prevented to stop the selection.\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.","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-utility-network-trace-locations/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"error","values":[]},{"name":"heading","values":[]},{"name":"spatial-tolerance","values":[]},{"name":"trace-location-type","values":[{"name":"barrier"},{"name":"starting-point"},{"name":"stopping-point"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-locations/"}]},{"name":"arcgis-utility-network-trace-results","description":"The Utility Network Trace Results component displays the outcome of a single utility network trace, including its\nresults, an empty result, or an error.\n\nThis component displays results for the following trace result types:\n[elements](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#elements),\n[aggregated geometries](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#aggregatedGeometry),\nand [functions](https://developers.arcgis.com/javascript/latest/references/core/rest/networks/support/TraceResult/#globalFunctionResults).\n\nEach result type is displayed by a result item component. By default, this component displays the\nresult items for the result types returned by the trace. To choose which result items are displayed\nor configure their properties individually, add the\n[elements result item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-elements-result-item/),\n[aggregated geometry result item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/), or\n[functions result item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-functions-result-item/) to this component's default slot.\nWhen the default slot has content, the component displays the slotted content instead of the default result items.\n\n## Use in the trace analysis component's results slot\n\nBy default, the [arcgis-utility-network-trace-analysis](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/) component displays aggregated geometry,\nelements, and functions in its results tab when those result types are returned by the trace.\nYou do not need to slot a results component for this default display configuration. Only slot this component into\nthe trace analysis component's `results` slot when you want to customize the result items in the results tab:\nchoose which items are displayed, configure their properties, or add custom result items.\n\nWhen this component is slotted into the `results` slot of the trace analysis component,\nthe parent trace analysis component sets the\n[trace result](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResult),\n[trace error](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceError),\n[utility network](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#utilityNetwork), and\n[view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#view) properties.\n\nSee the [custom result items example](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#custom-result-items-example).\n\n## Use in a custom app outside the trace analysis component\n\nTo use the component outside of the trace analysis component, slot it into the default slot of\n[arcgis-utility-network-trace-results-pane](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results-pane/). This is useful in custom trace workflow applications\nthat display multiple trace results at once or configure each results component independently. Add one trace results\ncomponent for each trace result and set its properties directly. The pane provides the results container; it does\nnot run traces or synchronize the results components' properties. Your application supplies each component's\n`traceResult`, `traceError`, `utilityNetwork`, and `view` and manages clearing them.\n\nThe [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#view) property is required for elements and aggregated\ngeometry results. The [utilityNetwork](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#utilityNetwork) property is required\nto query features for elements results.\n\nSee the [multiple trace results example](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#multiple-trace-results-example).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisResultsReady** - Fires when all participating result items finish processing the current\n[traceResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResult), including when processing produces no results\nor a result item fails.\n\nCalling [clearResults()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#clearResults) during processing does not emit this\nevent.\n- **arcgisTraceResultClear** - Fires when [clearResults()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#clearResults) is called.\nReplacing or clearing [traceResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResult) directly does not emit\nthis event.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `clearResults(): void` - Clears side effects created by the result items, resets\n[state](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#state) to `\"ready\"`, and emits\n[@arcgisTraceResultClear](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#event-arcgisTraceResultClear).\n\nWhen this component is managed by [arcgis-utility-network-trace-analysis](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-analysis/), using the parent\ncomponent's clear results action also clears its synchronized\n[traceResult](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResult) and\n[traceError](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceError) values. Calling this method directly does not\nchange those properties; set them to `undefined` when using this component independently.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n\n### Slots\n- _default_ - Default slot for adding trace result items or custom content.\nSlotted content replaces the component's default result items.","attributes":[{"name":"aggregated-geometry-results-graphics-color","description":"The color used to render graphics for aggregated geometries in trace results, specified as a\n[Color](https://developers.arcgis.com/javascript/latest/references/core/Color/) object.\n\nAggregated geometry is only rendered if the trace configuration specifies aggregated geometry as a result type.\nThe default is yellow with 0.6 opacity.","values":[]},{"name":"aggregated-geometry-results-size","description":"The size in points used to render graphics for aggregated geometries in trace results.\n\nAggregated geometry is only rendered if the trace configuration specifies aggregated geometry as a result type.\nThe default is `12`.","values":[]},{"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-utility-network-trace-results/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disable-highlight-feature-results","description":"Whether to disable highlighting trace result features on the map.\n\nDisabling highlights does not prevent the component from querying features or affect aggregated geometry graphics.","values":[]},{"name":"expandable","description":"Whether the component can be expanded and collapsed.","values":[]},{"name":"expanded","description":"Whether the component and its contents are expanded when\n[expandable](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#expandable) is `true`.","values":[]},{"name":"heading","description":"The description displayed below the component's localized trace results heading.","values":[]},{"name":"hide-action-bar","description":"Whether to hide the action bar when viewing trace result features.\nThe action bar contains the feature's [actions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-features-next/#actions).","values":[]},{"name":"hide-feature-results","description":"Whether to hide the elements result item and its features list.\n\nWhen `true`, the component displays a placeholder instead. Features are still queried and remain available from\n[traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResultFeatures). This property does not disable\nhighlighting; use [disableHighlightFeatureResults](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#disableHighlightFeatureResults) to hide\nfeature highlights.","values":[]},{"name":"hide-graphics","description":"Whether to hide the aggregated geometry [graphics](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/#geometryGraphics)\nfrom the map when the trace result contains aggregated geometry results.\n\nHidden graphics remain available from the [arcgis-utility-network-trace-aggregated-geometry-result-item](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-aggregated-geometry-result-item/) component.","values":[]},{"name":"hide-placeholder","description":"Whether to hide the placeholder shown when feature results are hidden.\n\nWhen this property and [hideFeatureResults](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#hideFeatureResults) are both set to `true`,\nnothing is rendered for trace result elements. However, features are still queried and are available through\n[traceResultFeatures](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/#traceResultFeatures).","values":[]},{"name":"include-default-actions-disabled","description":"Whether to hide the default actions when viewing trace result features.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/"}]},{"name":"arcgis-utility-network-trace-results-pane","description":"Component used for displaying instances of [arcgis-utility-network-trace-results](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results/).\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n\n### Slots\n- _default_ - Default slot for trace result pane content.","attributes":[{"name":"hide-warnings","description":"Whether to log console errors about unexpected child elements.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-trace-results-pane/"}]},{"name":"arcgis-utility-network-validate-network-topology","description":"## Overview\n\nThe Utility Network Validate Network Topology component validates dirty areas in a utility network after edits have been made.\nIt provides an interface to choose a utility network (if applicable), choose the [extent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#extentToValidate) to validate, and perform validation.\nIf successful, the result of the validation is available as [result](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#result).\n\n## Validation requirements\n\n- The component only supports a 2D [MapView](https://developers.arcgis.com/javascript/latest/references/core/views/MapView/).\n- The utility network must be [stored in the map](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#utilityNetworks) and the network topology must be enabled.\n- The active portal user must have the required user type extension to validate a network topology.\n- Validation fails in cases such as: no dirty areas in the target extent, inability to acquire a version lock, or insufficient permissions on the version.\n\n> [!WARNING]\n>\n> The Utility Network Validate Network Topology component does not support proxied feature services or feature services that utilize stored credentials.\n\n## Examples\n\nThis component can be used slotted into an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/):\n\n```html\n<arcgis-map item-id=\"471eb0bf37074b1fbb972b1da70fb310\">\n  <arcgis-utility-network-validate-network-topology slot=\"top-right\"></arcgis-utility-network-validate-network-topology>\n</arcgis-map>\n```\n\nAlternatively, this component can be used outside of a map by providing a [referenceElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#referenceElement):\n\n```html\n<calcite-shell>\n  <calcite-shell-panel slot=\"panel-start\" position=\"start\" width=\"l\">\n    <arcgis-utility-network-validate-network-topology reference-element=\"#map-element\"></arcgis-utility-network-validate-network-topology>\n  </calcite-shell-panel>\n  <arcgis-map id=\"map-element\" item-id=\"471eb0bf37074b1fbb972b1da70fb310\"></arcgis-map>\n</calcite-shell>\n```\n\n<video src=\"https://developers.arcgis.com/javascript/latest/assets/references/components/utility-network-validate-network-topology/validate-topology-example.webm\" autoplay loop muted playsInline></video>\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisValidateNetworkTopologyEnd** - Fires after a validation workflow ends.\n\nThis event fires after validation succeeds, fails, or is canceled by preventing the\n[@arcgisValidateNetworkTopologyStart](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/#event-arcgisValidateNetworkTopologyStart) event.\n- **arcgisValidateNetworkTopologyStart** - Fires before the validation request is sent.\n\nThis event can be prevented with `event.preventDefault()` to cancel validation.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"disabled","description":"When true, the component is visually de-emphasized and does not accept user interaction.","values":[]},{"name":"disable-execute-on-default-version","description":"Whether to disable execution on the Default version.\n\nIf true, the execute action button will be disabled.","values":[]},{"name":"extent-to-validate","description":"Specifies the area to validate.\n\nUse `\"current\"` to validate the current view extent. Use `\"entire\"` to validate the utility network's full extent.","values":[{"name":"current"},{"name":"entire"}]},{"name":"hide-utility-network-select","description":"When true, hides the utility network selector.\n\nThe selector is also hidden when the map has one utility network.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-utility-network-validate-network-topology/"}]},{"name":"arcgis-version-management","description":"The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.\nThe [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) will update to match the features on the selected version.\nTo learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).\n\n> The Version Management component does not support proxied feature services or feature services that utilize stored credentials.\n\nNote: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisVersioningStateChanged**\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.","attributes":[{"name":"allow-editing-disabled","values":[]},{"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-version-management/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closable","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"page-size","description":"Specifies the number of versions displayed on each page of the Version Management component.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-version-management/"},{"name":"Version Management","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-version-management--demo&singleStory=true"}]},{"name":"arcgis-video","description":"The ArcGIS Video component provides a view for displaying video feeds from a\n[VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/).\nIt is designed to render and interact with video layers.\n\nA Video component must have a valid VideoLayer.\nIt supports various features such as navigating, zooming, and panning, making it suitable for\napplications that require interactive video overlays.\n--\n\n### Events\n- **arcgisViewReadyChange**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n\n### Slots\n- _default_ - Default slot for adding components to the video. User is responsible for positioning the content via CSS.\n- **top-left** - Slot for components positioned in the top-left corner.\n- **top-right** - Slot for components positioned in the top-right corner.\n- **bottom-left** - Slot for components positioned in the bottom-left corner.\n- **bottom-right** - Slot for components positioned in the bottom-right corner.\n- **top-start** - Slot for components positioned at the top-start (top-left in LTR, top-right in RTL).\n- **top-end** - Slot for components positioned at the top-end (top-right in LTR, top-left in RTL).\n- **bottom-start** - Slot for components positioned at the bottom-start (bottom-left in LTR, bottom-right in RTL).\n- **bottom-end** - Slot for components positioned at the bottom-end (bottom-right in LTR, bottom-left in RTL).\n\n### CSS Properties\n- **--arcgis-layout-overlay-space-top** - _Since 4.34_ Specifies the top padding for the layout. \n- **--arcgis-layout-overlay-space-bottom** - _Since 4.34_ Specifies the bottom padding for the layout. \n- **--arcgis-layout-overlay-space-left** - _Since 4.34_ Specifies the left padding for the layout. \n- **--arcgis-layout-overlay-space-right** - _Since 4.34_ Specifies the right padding for the layout. \n- **--arcgis-view-color-focus** - _Since 5.0_ Specifies the focus outline color for the view. \n- **--arcgis-table-row-background-color** - _Since 5.1_ Specifies the background color for table rows. \n- **--arcgis-table-row-alt-background-color** - _Since 5.1_ Specifies the background color for alternate table rows. ","attributes":[{"name":"attribution-mode","description":"The display mode used for the attribution. Defaults to null.\n\nSet this property to \"auto\" to automatically synchronize the attribution with the nearest [Calcite mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes). If no Calcite mode is detected, the attribution defaults to light mode. **The \"auto\" mode was added in version 5.2.**\n\nSet this property to \"light\" or \"dark\" to explicitly use that mode without synchronization.","values":[{"name":"dark"},{"name":"light"}]},{"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-video/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"operational-data-visible","description":"Indicates whether map graphics from the reference map element are overlaid on the video player's content.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-video/"}]},{"name":"arcgis-video-player","description":"The Video Player component provides a user interface for interacting with a [VideoLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/).\nIt displays the original video content and provides controls for playing, pausing, seeking, and changing the video speed and quality.\n\nThe Video Player component provides the following capabilities:\n - Control operations (play, pause, seek)\n - Time and duration display\n - Customizable graphics colors\n - Following options (sensor, frame, video)\n - Adjustable speed and quality\n - Access to frame metadata\n\n**Known limitations**\n\n* Not supported in 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[![](https://developers.arcgis.com/javascript/latest/assets/references/components/video-player/video-player-video-preview.avif)](https://mediaspace.esri.com/media/1_ctc3psfr)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\n- **arcgisVideoReady**\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.","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-video-player/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"following-mode","description":"Determines which telemetry elements to follow when the video layer is playing.","values":[{"name":"none"},{"name":"follow-both"},{"name":"follow-frame"},{"name":"follow-sensor"}]},{"name":"hide-header","description":"Indicates whether to display the video player's header information.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"inline","description":"Indicates whether to render the video player in inline mode.\nIn inline mode, the component uses a compact control layout without a [VideoView](https://developers.arcgis.com/javascript/latest/references/core/views/VideoView/).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"operational-data-visible","description":"Indicates whether map graphics from the reference map element are overlaid on the video player's content.","values":[]},{"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.","values":[]},{"name":"show-fullscreen-toggle","description":"Indicates whether to display an action in the header that toggles between inline and the default fullscreen layout.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-video-player/"}]},{"name":"arcgis-view-popover","description":"The View Popover component provides view-aware placement and sizing for popovers anchored to actions inside\na map or scene view. This component is critical to enabling a great user experience with popovers\nwhen the exact placement and content of the popover is highly variable.\n\nThis component was originally added to support arcgis-sketch, which can be placed in all corners\nof the view, in multiple orientations, and with highly configurable settings contents.\n\nBecause layer lists and grid controls are included in the settings popover, it is very common for\nthe popover to overflow the view. It is equally common for the settings popover to be quite compact.\n\nProvide the popover content through the default slot and assign a [view](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#view),\n[anchorElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#anchorElement), and [actionBarElement](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#actionBarElement)\nto enable automatic positioning within the view.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.","attributes":[{"name":"closable","description":"Indicates whether the popover includes a close action in the header.","values":[]},{"name":"heading","description":"The popover heading.","values":[]},{"name":"label","description":"Accessible label for the popover.","values":[]},{"name":"max-content-width","description":"Maximum content width, in pixels, applied to the slotted popover content.","values":[]},{"name":"min-content-width","description":"Minimum content width, in pixels, applied to the slotted popover content.","values":[]},{"name":"open","description":"Indicates whether the popover is open.\n\nListen for [@arcgisPropertyChange](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/#event-arcgisPropertyChange) to react to user-driven close actions.","values":[]},{"name":"tail-attachment-appearance","description":"Controls whether the popover appears attached to the action itself or to the containing action bar.","values":[{"name":"action"},{"name":"bar"}]},{"name":"view-edge-margin","description":"Minimum inset, in pixels, between the popover and the edges of the view.\nThe bottom edge will be relative to the attribution bar, if it is visible.","values":[]},{"name":"visual-scale","description":"Visual scale for the popover; this applies only to the header and close button.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-view-popover/"}]},{"name":"arcgis-volume-measurement","description":"The Volume Measurement component is currently [in preview](https://support.esri.com/en-us/knowledge-base/faq-what-is-preview-000036425).\n\nThe Volume Measurement component can be added to a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) to\ncalculate and visualize the volume of ground surfaces within a defined polygonal area.\n\n![measurement-volume](https://developers.arcgis.com/javascript/latest/assets/references/components/volume-measurement/volume_measurement_poster.avif)\n\nThe Volume Measurement component offers multiple volume measurement modes:\n\n- **Cut & Fill Volume**: Computes cut and fill volumes relative to a flat, horizontal surface defined by the input\npolygon. Ideal for estimating the amount of material to remove or add to level terrain for construction.\n\n- **Stockpile Volume**: Calculates cut and fill volumes against a surface approximated from the polygon's coordinates.\nUseful for estimating the volume of temporary ground features such as piles of material, mounds or depressions.\n\nThe analysis depends on the scene's spatial reference, and the length of the measured perimeter:\n\n- In **Projected Coordinate Systems (PCS)**, apart from Web Mercator used in **local** viewing mode, there is no limit\nto the measurement's perimeter, making it the recommended setup for analysis as accuracy is not compromised.\n\n- In **Web Mercator PCS** used in **local** viewing mode, if the measurement's perimeter exceeds 10 km, the analysis is considered invalid due to potential accuracy issues.\n\n- In **Geographic Coordinate Systems (GCS)** and **Web Mercator** in **global** viewing mode, if the measurement's perimeter exceeds 50 km, the analysis is considered invalid due to potential accuracy issues.\n\n\n**Known Limitations**\n\n-  The Volume Measurement component can only be added to a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n- The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.\n- If the view is too close or too far from the measurement polygon, the results will not be computed due to LOD-induced inaccuracies.\n- The elevation of the target surface in the \"Cut & Fill Volume\" mode is restricted to the range of -11 km and +9 km.\n- This tool operates only on the non-transparent [Map.ground](https://developers.arcgis.com/javascript/latest/references/core/Map/#ground),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/IntegratedMeshLayer/)\nand an [IntegratedMesh3DTilesLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/IntegratedMesh3DTilesLayer/).\n- This tool does not support WGS 1984 spatial reference in a local\n[viewing mode](https://developers.arcgis.com/javascript/latest/references/core/webscene/InitialViewProperties/#viewingMode).\n- The cut-fill elevation tooltip remains enabled independently of\n[ViewOptions.tooltips](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#tooltips).\nIts display and input units can still inherit options on the view.\n\n**Things to consider**\n\n- In \"Cut & Fill Volume\" mode, you can hover over the shift manipulator, press `Tab` to enable tooltip input,\nand enter the target surface elevation.\n- Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n- Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/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- [Volume Measurement Analysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurementAnalysis/)\n- [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurementAnalysisView3D/)\n- [VolumeMeasurementResult](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurement/VolumeMeasurementResult/)\n- [VolumeMeasurementDisplayUnits](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurement/VolumeMeasurementDisplayUnits/)\nand [VolumeMeasurementInputUnits](https://developers.arcgis.com/javascript/latest/references/core/analysis/VolumeMeasurement/VolumeMeasurementInputUnits/)\n- [VolumeMeasurementError](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/VolumeMeasurement/VolumeMeasurementError/)\n- [Sample - Volume measurement analysis object](https://developers.arcgis.com/javascript/latest/sample-code/analysis-volume-measurement/)\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 for user interaction.\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.","attributes":[{"name":"area-display-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the area. Possible values are listed in\n[areaDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnitOptions).\n\nWhen no area unit is explicitly set on the component or its analysis, this property uses the area unit configured in the view through\n[view.options.displayUnits.area](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [areaDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#areaDisplayUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the area unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"metric"},{"name":"imperial"},{"name":"square-inches"},{"name":"square-feet"},{"name":"square-yards"},{"name":"square-miles"},{"name":"square-nautical-miles"},{"name":"square-us-feet"},{"name":"square-millimeters"},{"name":"square-centimeters"},{"name":"square-decimeters"},{"name":"square-meters"},{"name":"square-kilometers"},{"name":"acres"},{"name":"ares"},{"name":"hectares"}]},{"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-volume-measurement/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"elevation-display-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the cut and fill target elevation. Possible values are listed in\n[elevationDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnitOptions).\n\nWhen no elevation unit is explicitly set on the component or its analysis, this property uses the vertical length unit configured in the view through\n[view.options.displayUnits.verticalLength](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [elevationDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationDisplayUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the elevation unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]},{"name":"elevation-input-unit","description":"Unit used for inputting the cut and fill target elevation.\nPossible values are listed in [elevationInputUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationInputUnitOptions).\n\nThis controls which unit is used when entering an elevation value via the tool's UI (for example, using the\nshift manipulator tooltip input in \"Cut & Fill Volume\" mode).\n\nWhen no elevation input unit is explicitly set on the component or its analysis, this property uses the vertical length input unit configured in the view through\n[view.options.inputUnits.verticalLength](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits).\nThe `metric` and `imperial` measurement systems resolve to `meters` and `feet`, respectively.\nIf that option is unset or its resolved unit is unavailable in [elevationInputUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#elevationInputUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the elevation input unit on this component's analysis without changing the units configured in the view.\nChanging this property preserves the target surface elevation.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior while preserving the target surface elevation.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"}]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component. By default, the heading is rendered as a `<h2>`. Depending on the component's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-area-display-unit-select","description":"If true, the area display unit dropdown will be hidden.","values":[]},{"name":"hide-elevation-display-unit-select","description":"If true, the elevation display unit dropdown will be hidden.","values":[]},{"name":"hide-elevation-input-unit-select","description":"If true, the elevation input unit dropdown will be hidden.","values":[]},{"name":"hide-header","description":"If true, the header will be hidden.","values":[]},{"name":"hide-mode-select","description":"If true, the mode selection dropdown will be hidden.","values":[]},{"name":"hide-perimeter-display-unit-select","description":"If true, the perimeter display unit dropdown will be hidden.","values":[]},{"name":"hide-reset-units-button","description":"If true, hides all unit-reset buttons. Unit-selection dropdowns remain available.\n\nResetting a unit clears the corresponding overrides on the component and its analysis. The component then uses the corresponding value from [ViewOptions.displayUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits), or [ViewOptions.inputUnits](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#inputUnits) for input units, when that option is set and its resolved unit is included in the component's available units. Otherwise, it uses its default unit if available, or the first available unit.","values":[]},{"name":"hide-settings-button","description":"If true, the settings button that opens the settings popover will be hidden.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"hide-volume-display-unit-select","description":"If true, the volume display unit dropdown will be hidden.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"interaction-disabled","description":"Indicates whether interactive creation and editing of the analysis are disabled. When true, users cannot create a new analysis interactively or modify an existing analysis using its editing manipulators. Any interactive operation in progress is canceled. If the analysis is already complete, it and its results remain visible.","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"mode","description":"Specifies the analysis' desired measurement type.","values":[{"name":"cut-fill"},{"name":"stockpile"}]},{"name":"perimeter-display-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the perimeter values. Possible values are\nlisted in [perimeterDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnitOptions).\n\nWhen no perimeter unit is explicitly set on the component or its analysis, this property uses the length unit configured in the view through\n[view.options.displayUnits.length](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [perimeterDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#perimeterDisplayUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the perimeter unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"feet"},{"name":"miles"},{"name":"nautical-miles"},{"name":"meters"},{"name":"kilometers"},{"name":"metric"},{"name":"millimeters"},{"name":"centimeters"},{"name":"us-feet"},{"name":"yards"},{"name":"decimeters"},{"name":"inches"},{"name":"imperial"}]},{"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.","values":[]},{"name":"volume-display-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the volume values. Possible values are listed in\n[volumeDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnitOptions).\n\nWhen no volume unit is explicitly set on the component or its analysis, this property uses the volume unit configured in the view through\n[view.options.displayUnits.volume](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/#displayUnits).\nIf that option is unset or unavailable in [volumeDisplayUnitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/#volumeDisplayUnitOptions),\nthe component uses its default unit if available, or the first available unit.\nThis property overrides the volume unit on this component's analysis without changing the units configured in the view.\nThe reset button clears both overrides and resumes this inheritance and fallback behavior.","values":[{"name":"metric"},{"name":"imperial"},{"name":"cubic-inches"},{"name":"cubic-feet"},{"name":"cubic-yards"},{"name":"cubic-miles"},{"name":"cubic-us-feet"},{"name":"liters"},{"name":"megaliters"},{"name":"gigaliters"},{"name":"cubic-millimeters"},{"name":"cubic-centimeters"},{"name":"cubic-decimeters"},{"name":"cubic-meters"},{"name":"cubic-kilometers"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-volume-measurement/"},{"name":"Volume Measurement","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-volume-measurement--demo&singleStory=true"}]},{"name":"arcgis-weather","description":"The Weather component allows easy selection and configuration of weather effects in a\n[arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\nThe available weather types are:\n[sunny](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunnyWeather/),\n[cloudy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/CloudyWeather/),\n[rainy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/RainyWeather/),\n[snowy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SnowyWeather/), and\n[foggy](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/FoggyWeather/).\n\nTo set the weather programmatically, apply the desired weather type to the\n[arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment) property of the Scene component.\n\n```js\n// Access the Scene component.\nconst viewElement = document.querySelector(\"arcgis-scene\");\nawait viewElement.viewOnReady();\n// Specify the weather settings.\nviewElement.environment.weather = {\n   type: \"rainy\", // autocasts as new RainyWeather({ cloudCover: 0.7, precipitation: 0.3 })\n   cloudCover: 0.7,\n   precipitation: 0.3\n};\n```\n\nTo determine if the weather visualization is available, check the boolean value of `viewElement.environment.weatherAvailable`. The weather is only available:\n   * in `global` [arcgis-scene.viewingMode](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#viewingMode),\n   * when `atmosphereEnabled` property on [arcgis-scene.environment](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/#environment) is `true`,\n   * at lower altitudes, near the ground.\n\n**Known limitations**\n\nWeather is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SunnyWeather/)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/CloudyWeather/)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/RainyWeather/)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/SnowyWeather/)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/references/core/views/3d/environment/FoggyWeather/)\n- [Sample - Weather component](https://developers.arcgis.com/javascript/latest/sample-code/weather/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready for user interaction.\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.","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-weather/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the title of the component. By default, this message is rendered as a level 4\nheading (e.g. `<h4>Time range</h4>`). Depending on the component's placement in your app, you may need to adjust\nthis heading for proper semantics. This is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-header","description":"Whether to hide the component's header.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-weather/"},{"name":"Weather","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-weather--demo&singleStory=true"}]},{"name":"arcgis-zoom","description":"The Zoom component allows users to zoom in/out within a map or scene.\n--\n\n### Events\n- **arcgisActionZoom** - Emitted when one of the zoom controls is activated.\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 for user interaction.\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.\n- `zoomIn(): Promise<void>` - Zooms the view in by an LOD factor of 0.5.\n- `zoomOut(): Promise<void>` - Zooms the view out by an LOD factor of 2.","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-zoom/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"layout","description":"Determines the layout/orientation of the Zoom component.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"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.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-zoom/"},{"name":"Zoom","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-zoom--demo&singleStory=true"}]}]}