@arcgis/map-components 5.0.0-next.140 → 5.0.0-next.142

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 a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent to calculate and display the area and perimeter of a polygon.\n\nHow areas and perimeters are computed depends on the map's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, areas and perimeters are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, areas and perimeters are computed in a Euclidean manner (in their respective PCS).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","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/arcgis-area-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.","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":"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](#unitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"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/arcgis-area-measurement-2d/"},{"name":"Area Measurement 2D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-area-measurement-2d--demo&singleStory=true"}]},{"name":"arcgis-area-measurement-3d","description":"The Area Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-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/img/apiref/widgets/3D_AreaMeasurement_widget.png)](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/img/apiref/widgets/area-measurement-3d-types.png)\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 [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Area Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/).\n* 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/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","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/arcgis-area-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.","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":"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](#unitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"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/arcgis-area-measurement-3d/"},{"name":"Area Measurement 3D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/api-reference/esri-widgets-Attachments.html#displayType) the attachments.\n\n| Value    | Description |\n| ------ | ----------- |\n| auto     | Default value. If a feature layer's capabilities supports [resizing attachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#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":"auto"},{"name":"list"},{"name":"preview"}]},{"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 on 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/arcgis-attachments/"}]},{"name":"arcgis-basemap-gallery","description":"The Basemap Gallery component displays a collection images representing basemaps from [ArcGIS.com](https://www.arcgis.com/index.html) or a user-defined set of map or image services. When a new basemap is selected from the Basemap Gallery, the map's basemap layers are removed and replaced with the basemap layers of the associated basemap selected in the gallery.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/api-reference/esri-Map.html#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/arcgis-basemap-gallery/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When `true`, sets the component to a disabled state so the user cannot interact with it.","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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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/arcgis-basemap-gallery/"},{"name":"Basemap Gallery","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-Basemap.html) layers and switch on/off their visibility. [Base layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and [reference layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) are divided into separate sections. When editing is enabled, layers can be reordered by dragging and dropping between the lists and the title can be edited.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) 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/api-reference/esri-widgets-LayerList-ListItem.html) may be reordered within the list by dragging and dropping.\nMapImageLayer [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the widget 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 widget's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-base-layers","description":"Indicates whether the base layers will be displayed.","values":[]},{"name":"hide-flow","description":"Determines whether the basemap layer list should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The basemap layer list will be displayed within its original flow component if set to `true`. The flow component will be omitted from the basemap layer list if set to `false`. To place the basemap layer list into an existing Calcite flow component, set this property to `false`.","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/api-reference/esri-widgets-BasemapLayerList.html#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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListVisibleElements.html) 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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#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":"multiple"},{"name":"single"},{"name":"single-persist"}]},{"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 then number of list items is equal to or greater than the value set in [BasemapLayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#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/api-reference/esri-layers-Layer.html#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/img/apiref/widgets/basemap-layer-list/visibilityAppearance-default.png) |\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/img/apiref/widgets/basemap-layer-list/visibilityAppearance-checkbox.png) |","values":[{"name":"default"},{"name":"checkbox"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/"},{"name":"Basemap Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-basemap-layer-list--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--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `toggle(): Promise<any>` - Toggles to the [next basemap](#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/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/arcgis-basemap-toggle/"},{"name":"Basemap Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-webmap-Bookmark.html),\nwhich are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#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/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/arcgis-bookmarks/#timeDisabled) to `true`.\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/arcgis-bookmarks/#showAddBookmarkButton), [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton), and [dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#dragEnabled).\n\n**Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) only if they come from a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks) or are [provided manually](#bookmarks). [Presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html) provides a similar experience for [WebScenes](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html).\n--\n\n### Events\n- **arcgisBookmarkEdit** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited.\n- **arcgisBookmarkSelect** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) 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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `goTo(bookmark: __esri.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/arcgis-bookmarks/#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":"disabled","description":"When true, the component is visually withdrawn and cannot be interacted with.","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/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/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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-flow","description":"Determines whether the component should be rendered within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/).","values":[]},{"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":"Indicates whether to display the close button.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to display 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":"Indicates whether to display 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/arcgis-bookmarks/"},{"name":"Bookmarks","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-layers-BuildingSceneLayer.html). 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](#level), [construction phase](#phase) or by disciplines and categories.\nThe visibility of these elements can be configured using the component's [hideLevels](#hidelevels), [hidePhases](#hidephases) and [hideDisciplines](#hidedisciplines) properties.\n\n[![building-explorer](https://developers.arcgis.com/javascript/latest/assets/img/components/building-explorer/building-explorer.png)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-filter/)\n\nThe [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) to be explored have to be set on the [layers](#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/api-reference/esri-layers-BuildingSceneLayer.html) contain an _Overview_ [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html) 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/api-reference/esri-layers-buildingSublayers-BuildingGroupSublayer.html).\n\nThe Level element of the Building Explorer component allows 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/api-reference/esri-layers-BuildingSceneLayer.html) 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/api-reference/esri-layers-buildingSublayers-BuildingGroupSublayer.html) that organize the [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) 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 [Scene](https://developers.arcgis.com/javascript/latest/references/map-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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-disciplines","description":"Hides the disciplines tree from the UI.","values":[]},{"name":"hide-levels","description":"Hides the levels filter from the UI.","values":[]},{"name":"hide-phases","description":"Hides the phases filter from the UI.","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 building level.","values":[]},{"name":"phase","description":"The currently selected construction 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":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/"},{"name":"Building Explorer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-building-explorer--demo&singleStory=true"}]},{"name":"arcgis-building-level-item","description":"### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"active","values":[]},{"name":"base-width","values":[]},{"name":"height","description":"The height of the component.","values":[]},{"name":"hovered","values":[]},{"name":"level","values":[]},{"name":"width","description":"The width of the component.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-level-item/"}]},{"name":"arcgis-catalog-layer-list","description":"The Catalog Layer List component provides a way to display and interact with CatalogLayers.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#visibleElements) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#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>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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-flow","description":"Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The component will be displayed within its original flow component if set to `true`. The flow component will be omitted from the component if set to `false`. To place the component into an existing Calcite flow component, set this property to `false`.","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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList-CatalogLayerListVisibleElements.html) 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/api-reference/esri-widgets-CatalogLayerList.html#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":"multiple"},{"name":"single"},{"name":"single-persist"}]},{"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 then number of list items is equal to or greater than the value set in [CatalogLayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#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/api-reference/esri-widgets-CatalogLayerList.html#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/api-reference/esri-layers-Layer.html#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/img/apiref/widgets/layer-list/visibilityAppearance-default.png) |\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/img/apiref/widgets/layer-list/visibilityAppearance-checkbox.png) |","values":[{"name":"default"},{"name":"checkbox"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-catalog-layer-list/"},{"name":"Catalog Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-catalog-layer-list--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/api-reference/esri-views-MapView.html#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-compass/#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":"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":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-compass/"},{"name":"Compass","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-compass--demo&singleStory=true"}]},{"name":"arcgis-coordinate-conversion","description":"The 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/api-reference/esri-geometry-Point.html).\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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `reverseConvert(coordinate: string, format: Format): Promise<__esri.Point | nullish>` - Attempt to convert a string into a [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).  The format of the\nstring must be specified.  A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of available formats can be\nobtained from the [formats](#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/arcgis-coordinate-conversion/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"expanded","description":"Describes whether the component is expanded or not. If `true`, the component is expanded and all conversions are visible.","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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-capture-button","description":"Determines whether the capture button will be shown in the component. If `true`, the capture button will be hidden.","values":[]},{"name":"hide-expand-button","description":"Determines whether the expand button will be shown in the component. If `true`, the expand button will be hidden.","values":[]},{"name":"hide-input-button","description":"Determines whether the input coordinate button will be shown in the component. If `true`, the input button 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":"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":"live"},{"name":"capture"}]},{"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":"storage-disabled","description":"If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#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/arcgis-coordinate-conversion/"},{"name":"Coordinate Conversion","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-coordinate-conversion--demo&singleStory=true"}]},{"name":"arcgis-daylight","description":"The Daylight component can be used to manipulate the lighting conditions of a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nTo achieve this, the component modifies the `lighting` property of the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-views-3d-environment-SunLighting.html) or switch to the\n[virtual](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html) mode,\nwhere the light source is relative to the camera.\n\nWhen illuminating the scene with **[sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)**\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/api-reference/esri-views-3d-environment-SunLighting.html#date) property of\n[environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\n\n[![daylight-default](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-default.png)](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](#hideTimezone) property.\n\nBy default, a calendar is displayed to select the day, month, and year.\nWith the [dateOrSeason](#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/img/apiref/components/daylight/daylight-seasons.png)\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](#playSpeedMultiplier) property.\n\n![daylight-animation](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-animation.gif)\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/img/apiref/components/daylight/daylight-no-elements.png)\n\nWhenever the sun position option is unchecked, the scene applies the\n**[virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)** 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/img/apiref/components/daylight/daylight-virtual.png)\n\n**Things to consider**\n\n* Daylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* The Daylight component uses UTC time and does not account for the daylight savings times in different countries and regions of the world.\n* When using the [virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html),\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/api-reference/esri-views-3d-environment-SunLighting.html),\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/api-reference/esri-views-3d-environment-SunLighting.html#cameraTrackingEnabled)\nproperty on [environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisUserDateTimeChange** - Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"spring"},{"name":"summer"},{"name":"fall"},{"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 date corresponding to the equinoxes and solstices of 2014.","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.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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](#utcOffset).","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](#utcOffset). The position represents the time\nof the day in minutes. Possible values range between 0 and 1440.","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":"utc-offset","description":"The difference in hours between UTC time and the time displayed in the component.","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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/"},{"name":"Daylight","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-directional-pad/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"Indicates whether interaction is allowed on the component. When `true`,\nthis property sets the component to a disabled state to disable any user\ninteraction.","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":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directional-pad/"},{"name":"Directional Pad","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-layers-RouteLayer.html), using ArcGIS Online and custom Network Analysis Route services.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getDirections(): Promise<__esri.RouteLayerSolveResult>`\n- `save(): Promise<__esri.PortalItem>`\n- `saveAs(portalItem: __esri.PortalItem, options: { folder: __esri.PortalFolder; }): Promise<__esri.PortalItem>`\n- `zoomToRoute(): Promise<void>`","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/api-reference/esri-config.html#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/arcgis-directions/#destroy) method when you are done to\nprevent memory leaks.","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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-layer-details","description":"Indicates whether to a link to the route layer portal-item (if any) 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":"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":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"name":"use-default-route-layer","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directions/"},{"name":"Directions","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-directions--demo&singleStory=true"}]},{"name":"arcgis-direct-line-measurement-3d","description":"The Direct Line Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-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/img/apiref/widgets/3D_DirectLineMeasurement_widget.png)](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/img/apiref/widgets/direct-line-measurement-3d.png)\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 [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Distance Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/).\n* Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n- [Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","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/arcgis-direct-line-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.","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":"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](#unitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/"},{"name":"Direct Line Measurement 3D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent to calculate and display the length of a polyline.\n\nHow distances are computed depends on the scene'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 to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","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/arcgis-distance-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.","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":"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](#unitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/"},{"name":"Distance Measurement 2D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\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- `cancelWorkflow(): Promise<void>`\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `deleteFeatureFromWorkflow(): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `startCreateFeaturesWorkflowAtFeatureCreation(info: __esri.CreateFeaturesCreationInfo): Promise<void>`\n- `startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise<void>`\n- `startUpdateWorkflowAtFeatureEdit(feature: __esri.Graphic): Promise<void>`\n- `startUpdateWorkflowAtFeatureSelection(): Promise<void>`\n- `startUpdateWorkflowAtMultipleFeatureSelection(candidates: __esri.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/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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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-flow","description":"Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The component will be displayed within its original flow component if set to `true`. The flow component will be omitted from the component if set to `false`. To place the component into an existing Calcite flow component, set this property to `false`.","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-settings-menu","description":"Indicates whether to hide the settings menu. This menu contains the snapping and tooltips settings.","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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#featureEnabled) property.","values":[]},{"name":"hide-snapping-controls-elements-layer-list","description":"Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html) 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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#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":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-editor/"},{"name":"Editor","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-analysis-ElevationProfileAnalysis.html) and displays its elevation profiles.\n\n[![elevation profile poster](https://developers.arcgis.com/javascript/latest/assets/img/components/elevation-profile/elevation_profile_poster.png)](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 a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) component or a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component and on the available elevation source data:\n\n* [**ElevationProfileLineGround**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineGround.html): represents a profile line that uses elevation from [Map.ground](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineInput.html): 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/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html): represents a profile line that samples elevation from the elevation source set in the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html#source) property. The elevation source can be an [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) or ant object with a method called `queryElevation` that has the same signature as [queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation).\n* [**ElevationProfileLineScene**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineScene.html): 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](#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\n[![elevation profile chart gif](https://developers.arcgis.com/javascript/latest/assets/img/components/elevation-profile/elevation_profile_chart_gif.gif)](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\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/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineInput.html) in 2D is only valid when the analysis [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#geometry) has z values, `hasZ===true` and no [elevationInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#elevationInfo) is set.\n- [ElevationProfileLineScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineScene.html) is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html)\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 to be interacted with.\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>` - Create a promise that resolves once 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/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/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/arcgis-elevation-profile/#start) or\n[select()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#select).","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/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.","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"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.","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"name":"hide-chart","description":"If true, the elevation profile chart will be hidden.","values":[]},{"name":"hide-clear-button","description":"If true, the clear button will be hidden.","values":[]},{"name":"hide-legend","description":"If true, the legend will be hidden.","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-sketch-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-unit-selector","description":"If true, the unit selector 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":"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/arcgis-elevation-profile/"},{"name":"Elevation Profile","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `collapse(): Promise<void>` - Collapse the component.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/api-reference/esri-views-View.html#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/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.png)","values":[]},{"name":"label","description":"The component's default label.","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":"auto"},{"name":"left"},{"name":"right"},{"name":"top"},{"name":"bottom"},{"name":"top-start"},{"name":"top-end"},{"name":"bottom-start"},{"name":"bottom-end"},{"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":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/"},{"name":"Expand with Custom Content\nThe Expand component with custom content.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/arcgis-basemap-gallery/) component.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--component-content&singleStory=true"}]},{"name":"arcgis-feature","description":"The Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).\nThis component is useful in instances where you want to display information about a feature but without\nthe use of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).\n\nIf wanting to show a feature's content with [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#actions), [related](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html), or [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate), etc., then use the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-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](#map) and [spatialReference](#spatialReference) properties need to be defined in the Feature 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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/api-reference/esri-popup-content-MediaContent.html) info.\n- `previousMedia(contentElementIndex: number): Promise<void>` - Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info.\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>` - Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info object. For example,\nyou may have [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) 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/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/api-reference/esri-layers-FeatureLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html)\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html), and\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html)).\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/api-reference/esri-popup-support-FieldInfoFormat.html#dateFormat)\nrather than `long-month-day-year` in the default [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) 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](#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-attachments-content","description":"This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html) 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/api-reference/esri-popup-content-CustomContent.html) 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/api-reference/esri-popup-content-ExpressionContent.html) 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/api-reference/esri-popup-content-FieldsContent.html) within the component.","values":[]},{"name":"hide-heading","description":"This property provides the ability to hide or show the component's [heading](#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/api-reference/esri-popup-content-MediaContent.html) 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/api-reference/esri-popup-content-TextContent.html) 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/api-reference/esri-popup-content-RelationshipContent.html) 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/api-reference/esri-popup-content-UtilityNetworkAssociationsContent.html) 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 [MapView.timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone). When a MapView 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 time 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/arcgis-feature/"},{"name":"Feature\nThe Feature component displays on hover.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n- **arcgisSubmit** - Fires when the [submit()](#submit) method is called.\n- **arcgisValueChange** - Fires when a field value is updated.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-feature-form/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","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/api-reference/esri-widgets-FeatureForm.html#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/api-reference/esri-form-elements-GroupElement.html) configured in the Editor's [layer infos](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#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/api-reference/esri-form-FormTemplate.html#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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":"The timezone displayed within the form. If `unknown`, it first checks if the  layer has a [FeatureLayer#preferredTimeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#preferredTimeZone). If so, it displays this. If not, it will default to UTC.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-form/"},{"name":"Feature Form","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-feature-form--demo&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**\n- **arcgisCellKeydown**\n- **arcgisCellPointerout**\n- **arcgisCellPointerover**\n- **arcgisColumnReorder**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisSelectionChange**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `deleteSelection(showWarningPrompt?: boolean): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `exportSelectionToCSV(includeGeometry?: boolean): Promise<void>`\n- `findColumn(fieldName: string): Promise<__esri.ActionColumn | __esri.AttachmentsColumn | __esri.Column | __esri.GroupColumn | __esri.RelationshipColumn | nullish>`\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- `scrollToBottom(): Promise<void>`\n- `scrollToIndex(index: number): Promise<void>`\n- `scrollToLeft(): Promise<void>`\n- `scrollToRow(objectId: number): 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- `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/api-reference/esri-layers-FeatureLayer.html#capabilities).\n\n![featuretable attachmentsEnabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featuretable/attachments-enabled.png)","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/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":"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":"Indicates whether the table is disabled. When disabled, the table will not display any data or allow interaction. This is purely a visual override and does not prevent the table from attempting to render data. This property has no effect on the current [state](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#state) property value.","values":[]},{"name":"editing-enabled","description":"Indicates whether [editing](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#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-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":"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.","values":[]},{"name":"hide-column-menu-items-sort-descending","description":"Indicates whether to display the Sort Descending menu item.","values":[]},{"name":"hide-column-menus","description":"Indicates whether to display the menu items within the individual columns","values":[]},{"name":"hide-header","description":"Indicates whether to display the feature table's header information.","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-toggle-columns","description":"Indicates whether to enable toggling column visibility within the menu.","values":[]},{"name":"hide-menu-items-zoom-to-selection","description":"Indicates whether to display the Zoom to selected 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/api-reference/esri-widgets-FeatureTable.html#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/api-reference/esri-widgets-FeatureTable.html#refresh).","values":[]},{"name":"label","description":"The components label.","values":[]},{"name":"layer-item-id","description":"Portal Item Id for a layer to load. You can set, `layer`, `layerUrl`, or `itemId`,\nbut not more than one.","values":[]},{"name":"layer-url","description":"Url for a layer to load. You can set, `layer`, `layerUrl`, or `itemId`,\nbut not more than one.","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/api-reference/esri-widgets-FeatureTable.html#paginationEnabled) is `true`, and `maxSize` is greater than the current value of [pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#pageSize), multiple pages usually display. If `maxSize` is less than [pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#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":"s"},{"name":"m"},{"name":"l"}]},{"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/api-reference/esri-widgets-FeatureTable.html#pageSize). [Pagination](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#paginationEnabled) must be enabled or the value of this property may not be not 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/api-reference/esri-widgets-FeatureTable.html#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/api-reference/esri-widgets-FeatureTable.html#pageIndex) property. The current page can be modified by calling the [goToPage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#goToPage) method and passing in the desired [page index](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#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/api-reference/esri-widgets-FeatureTable.html#layers) property when there is no associated [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#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/api-reference/esri-widgets-FeatureTable.html#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/api-reference/esri-widgets-FeatureTable.html#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-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":"table-disabled","description":"**Deprecated**: since 5.0, use `element.disabled` instead.. ","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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) displays timezones for `date` and `timestamp-offset` field [types](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) reflecting the MapView's timezone. This timezone can be overridden by setting the table's [timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#timeZone) property.\n> If the table's [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#view) isn't set, and the table's [Feature#timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#timeZone) isn't set, the table defaults to `system` time. The only time that this is not the case is when there is a [FeatureLayer#preferredTimeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#preferredTimeZone) set on the table's layer. If the latter is true, the preferred time zone is used as opposed to `system`.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-table/"},{"name":"Feature Table","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-feature-table--demo&singleStory=true"}]},{"name":"arcgis-feature-templates","description":"### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisSelect**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-feature-templates/#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/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) 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/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html). 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/img/apiref/widgets/groupByLayers.png)\ngeometry | Groups template items by geometry type. | ![FeatureTemplatesGroupByGeometry](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/groupByGeometry.png)\nnone | The component displays everything in one list with no grouping. | ![featureTemplatesGroupByLayer](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/groupByNone.png)\n[GroupByFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-types.html#GroupByFunction) | Custom function that takes an object containing a [FeatureTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) and [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). | ![FeatureTemplatesGroupByCustomGroupFunction](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/groupCustomGroup.png)","values":[{"name":"geometry"},{"name":"layer"},{"name":"none"}]},{"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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-filter","description":"Indicates whether the templates filter displays.\n![](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featureTemplatesFilter.png)","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/arcgis-feature-templates/"}]},{"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 a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThis component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-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/arcgis-map/),\nthe [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-layers-support-FeatureReductionBinning.html#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate).\n\nThe Features component should be used if needing to use the Popup functionality outside of the map or scene component. If wanting 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/arcgis-feature/) 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 to be interacted with.\n- **arcgisTriggerAction** - Fires after the user clicks on an action in the Features 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](#promises), [features](#features), [content](#content), and\n[heading](#heading) from the Features component.\n- `close(): Promise<void>` - A convenience method to close the component.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `fetchFeatures(screenPoint: __esri.ScreenPoint, options?: __esri.FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>` - Use this method to return feature(s) at a given screen location.\nThese features are fetched from all of the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nin the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). In order to use this, a layer must already have an\nassociated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). This method allows a developer to\ncontrol how the input location is handled.\n- `next(): Promise<FeaturesViewModel>` - Selects the feature at the next index in relation to the [selected feature](#selectedFeature).\n- `open(options?: __esri.FeaturesViewModelOpenOptions): Promise<void>` - Opens the Features component with content defined either explicitly with `content`\nor driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features.\n- `previous(): Promise<FeaturesViewModel>` - Selects the feature at the previous index in relation to the [selected feature](#selectedFeature).\n- `setFocus(): Promise<void>` - Use this method to give focus to the Component if the component is able to be focused.\n- `triggerAction(action: __esri.ActionButton | __esri.ActionToggle): Promise<void>` - Triggers the [`arcgisTriggerAction`](#arcgisTriggerAction) event and executes the action\nat the specified index in the [actions](#actions) array.","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/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 [`showCollapsed`](#showCollapsed) is `true`.","values":[]},{"name":"content","description":"The content of the Features component. When set directly on the component, this content is\nstatic and cannot use fields to set content templates. To set a template\nfor the content based on field or attribute names, see\n[PopupTemplate.content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content).","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/api-reference/esri-layers-FeatureLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html), and\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html)).","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.\nSetting this to `true` allows the user to scroll through the list of features.\nThis value will only be honored if [`initialDisplayMode`](#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.","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 [selected feature](#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html), 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](#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's [actions](#actions).","values":[]},{"name":"hide-attachments-content","description":"This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html) 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/api-reference/esri-popup-content-CustomContent.html) 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/api-reference/esri-popup-content-ExpressionContent.html) 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 pagination in the component.\nThis allows the user to scroll through various [selected 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/api-reference/esri-popup-content-FieldsContent.html) within the component.","values":[]},{"name":"hide-flow","description":"Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if set to `false`.\nThe flow component will be omitted from the component if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's [heading](#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/api-reference/esri-popup-content-MediaContent.html) 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/api-reference/esri-popup-content-RelationshipContent.html) within the component.","values":[]},{"name":"hide-spinner","description":"Indicates whether to hide the component's loading spinner.","values":[]},{"name":"hide-text-content","description":"This property provides the ability to hide or show [text content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html) 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/api-reference/esri-popup-content-UtilityNetworkAssociationsContent.html) within the component.","values":[]},{"name":"highlight-disabled","description":"Indicates whether to highlight the [selected feature](#selectedFeature) in the associated\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-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":"feature"},{"name":"list"}]},{"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":"selected-feature-index","description":"Index of the feature that is [selected](#selectedFeature). When [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 [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeZone) if the [view](#view) property is set. When a MapView 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 time 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":"visible","description":"Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open in the view.\nUse the property to check if the component is visible.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-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/?path=/story/arcgis-features--demo&singleStory=true"}]},{"name":"arcgis-floor-filter","description":"The Floor Filter component simplifies visualization of GIS data for a specific floor of a building in your application.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `updateWebDocument(webMap: __esri.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/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 widget's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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/arcgis-floor-filter/"},{"name":"Floor Filter","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/en-US/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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"element","description":"The [HTMLElement](https://developer.mozilla.org/en-US/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":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-fullscreen/"},{"name":"Fullscreen","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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](#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](#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](#snappingOptions) has been defined.\nIf [snappingOptions](#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](#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](#customColor) is shown, otherwise a default light or dark theme color is used.","values":[{"name":"custom"},{"name":"light"},{"name":"dark"}]},{"name":"unit","description":"Unit of measure (foot, meter, etc) used when defining the [spacing](#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":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-grid-controls/"},{"name":"Grid Controls","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `generateWhereClause(field: string): Promise<nullish | string>` - 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/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/api-reference/esri-smartMapping-statistics-types.html#SummaryStatisticsResult),\nwhich is the result of the\n[summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) 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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType), use the [includedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType), use the [excludedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#labels) when the data range\n([max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#max) - [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#min)) is less than `10`.\n\nWhen the data range is larger than `10`, [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#values) and shouldn't be used exclusively\nfor formatting purposes. To format thumb `labels`, use the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor) and\n[excludedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor) properties.\n\nThis property also determines the SQL where clause generated in [generateWhereClause()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#generateWhereClause)\nfor filtering purposes. The value set here determines the number of [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#values) | [Where clause](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#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":"not-equal"},{"name":"less-than"},{"name":"greater-than"},{"name":"at-most"},{"name":"at-least"},{"name":"between"},{"name":"not-between"}]},{"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/api-reference/esri-widgets-HistogramRangeSlider.html#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/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/api-reference/esri-Viewpoint.html)\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 to be interacted with.\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>` - Create a promise that resolves once 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/arcgis-home/#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":"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":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-home/"},{"name":"Home","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-home--demo&singleStory=true"}]},{"name":"arcgis-layer-list","description":"The Layer List component provides a way to display a list of layers, and switch on/off their visibility.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `triggerAction(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.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/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/api-reference/esri-widgets-LayerList-ListItem.html) may be reordered within the list by dragging and dropping.\nMapImageLayer [MapImageLayer#sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#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 than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-catalog-layer-list","description":"Indicates whether to display the [LayerList#catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogLayerList).","values":[]},{"name":"hide-flow","description":"Indicates whether the layer list should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The layer list will be displayed within its original flow component if set to `true`. The flow component will be omitted from the layer list if set to `false`. To place the layer list into an existing Calcite flow component, set this property to `false`.","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/api-reference/esri-widgets-LayerList.html#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/api-reference/esri-widgets-LayerList-LayerListVisibleElements.html) 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/api-reference/esri-widgets-LayerList.html#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":"multiple"},{"name":"single"},{"name":"single-persist"}]},{"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 then number of list items is equal to or greater than the value set in [LayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#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/api-reference/esri-widgets-LayerList.html#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/api-reference/esri-layers-Layer.html#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/img/apiref/widgets/layer-list/visibilityAppearance-default.png) |\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/img/apiref/widgets/layer-list/visibilityAppearance-checkbox.png) |","values":[{"name":"default"},{"name":"checkbox"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-layer-list/"},{"name":"Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-layer-list--demo&singleStory=true"}]},{"name":"arcgis-legend","description":"The Legend component displays the symbols and labels used to represent layers in a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nOnly layers and sublayers visible in the view are shown, unless [ignoreLayerVisibility](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-layers-ElevationLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html),\n[KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html),\n[MapNotesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html),\n[OpenStreetMapLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OpenStreetMapLayer.html),\n[VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html), and\n[WebTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html).\n* [Symbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html) with more than one\n[symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) are not supported.\n* [DictionaryRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html) is not supported.\n* [TrackInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TrackInfo.html) is not supported.\n* CIM Symbol [primitiveOverride](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) is not supported.\n* RasterStretchRenderer [dynamicRangeAdjustment](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#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/img/apiref/widgets/legend/legend-unique-values.png)](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/img/apiref/widgets/legend/legend-color-vv.png)](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/img/apiref/widgets/legend/legend-class-breaks.png)](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/img/apiref/widgets/legend/legend-size.png)](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/img/apiref/widgets/legend/legend-size-themes.png)](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/img/apiref/widgets/legend/legend-dot-density.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-dot-density/)\n\n### Predominance\n\n[![Predominance](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/legend/legend-predominance.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-arcade/)\n\n### Relationship\n\n[![Relationship](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/legend/legend-relationship.png)](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/api-reference/esri-layers-Layer.html) and [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) 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/api-reference/esri-layers-support-FieldConfiguration.html) 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/api-reference/esri-renderers-ClassBreaksRenderer.html#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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/api-reference/esri-Basemap.html) layers in the Legend. If you set this property to\n`true` and specify [layerInfos](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/#layerInfos) that include the basemap layers, the basemap will be displayed in the legend.","values":[]},{"name":"card-style-layout","description":"Indicates the layout of the legend when the [legendStyle](https://developers.arcgis.com/javascript/latest/references/map-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/img/components/legend/card-style-layout.png)](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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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/api-reference/esri-layers-FeatureLayer.html#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/api-reference/esri-layers-FeatureLayer.html#minScale) and\n[maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#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/img/components/legend/legend-style.png)](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 render, only features that satisfy the layer's\n[definition](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#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/arcgis-legend/"},{"name":"Legend","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a [Scene](https://developers.arcgis.com/javascript/latest/references/map-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/img/apiref/widgets/line-of-sight.png)\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/api-reference/esri-analysis-LineOfSightAnalysisObserver.html)\nand subsequent clicks place the [targets](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html).\nBoth the observer and target points can be moved by dragging. Additionally, the target points can be removed with a right click.\n\n**Known limitation**\n\nLine Of Sight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\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 to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current analysis results. After calling this method, the user can set a new observer and targets.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `continue(): Promise<void>` - After [stop()](#stop) was called, this method allows to continue the line of sight analysis and add more targets.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start a new line of sight analysis.\n- `stop(): Promise<void>` - Stop the current placing of line of sight analysis. Any lines added this 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/arcgis-line-of-sight/#destroy) method when you are done to\nprevent memory leaks.","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":"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/arcgis-line-of-sight/"},{"name":"Line of Sight","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-line-of-sight--demo&singleStory=true"}]},{"name":"arcgis-link-chart","description":"Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html) from an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html).\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisLoadError** - Fires when a ArcgisLinkChart 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/api-reference/esri-views-MapView.html#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/api-reference/esri-views-MapView.html#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#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- **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- `addLayer(layer: __esri.Layer | Promise<Layer>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): 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: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-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: __esri.Analysis): Promise<__esri.AnalysisView2DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.\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 [Popup](https://developers.arcgis.com/javascript/latest/references/map-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. ","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/api-reference/esri-symbols-CIMSymbol.html),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","values":[{"name":"light"},{"name":"dark"}]},{"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/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 view's center point; when setting the center, you may pass a\nesri/geometry/Point instance 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 layer's displayFilter are honored when rendering layers in the view.\nIf `false`, display filters are ignored and all features are rendered.","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/api-reference/esri-config.html#portalUrl) before the Link Chart component loads.","values":[]},{"name":"popup-disabled","description":"Controls whether the popup opens automatically when users click on the view.","values":[]},{"name":"popup-widget-disabled","description":"Indicates whether the popup widget is disabled. When set to `true`, the Popup component will be used for popups instead of the widget.","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":"center"},{"name":"left"},{"name":"right"},{"name":"top"},{"name":"bottom"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-left"},{"name":"top-right"}]},{"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](#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/arcgis-link-chart/"},{"name":"Link Chart","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n- **arcgisSwitchLayout** - Fires when component has completed the layout switch\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/arcgis-link-chart-layout-switcher/"},{"name":"Link Chart Layout Switcher","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 for use in link charts that allows users to switch whether or not nonspatial data is visible in the view.  Spatial entities are those with a value in a defined geometry property in a traditional map context.  A Spatial relataionship is one where both endpoints are spatial\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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `switchNonspatialVisibility(nonspatialVisibilitySetting: NonspatialMode): Promise<void>` - Switches the nonspatial visility 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/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","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart-nonspatial-visibility-toggle/"},{"name":"Link Chart Nonspatial Visibility Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), 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/en-US/docs/Web/API/isSecureContext#browser_compatibility).\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 to be interacted with.\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>` - Create a promise that resolves once 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/arcgis-locate/#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 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":"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 [track](#event-track) event.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-locate/"},{"name":"Locate","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\n#### Initializing the Map component\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)\nand can be initialized in one of three ways:\n\n##### 1. Using a WebMap\nLoad a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) from [ArcGIS Online](https://www.arcgis.com/home/index.html)\nor an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) by specifying the [item-id](#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](#basemap), [center](#center), and [zoom](#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/api-reference/esri-Map.html) instance to the component.\nThis allows full control over map configuration, including [basemap](#basemap), operational [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers)\nand [spatial reference](#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/api-reference/) 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 a ArcgisMap 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/api-reference/esri-views-MapView.html#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/api-reference/esri-views-MapView.html#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is triggered when view-related properties change, such as [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[viewpoint](#viewpoint), or [stationary](#stationary).\nIt reflects user interactions (e.g. panning or zooming) or programmatic updates to the view.\n- **arcgisViewClick** - Fires after a user clicks on the view. This event emits slightly slower than an [arcgisViewImmediateClick](#arcgisViewImmediateClick)\nevent to make sure that an [arcgisViewDoubleClick](#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/api-reference/esri-views-MapView.html#event-double-tap-drag)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\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](#arcgisViewClick) event, the `arcgisViewImmediateClick`\nis emitted as soon as the user clicks on the view, and is not inhibited by a [arcgisViewDoubleClick](#arcgisViewDoubleClick) event.\nThis event is useful for interactive experiences that require feedback without delay.\n- **arcgisViewImmediateDoubleClick** - Fires after two consecutive [arcgisViewImmediateClick](#arcgisViewImmediateClick) events. In contrast to [arcgisViewDoubleClick](#arcgisViewDoubleClick),\nan `arcgisViewImmediateDoubleClick` cannot be prevented by use of `stopPropagation()` on the [arcgisViewImmediateClick](#arcgisViewImmediateClick)\nevent and can therefore be used to react to double-clicking independently of usage of the [arcgisViewImmediateClick](#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/api-reference/esri-views-layers-LayerView.html)\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/api-reference/esri-views-layers-LayerView.html)\nafter a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\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](#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/api-reference/esri-views-MapView.html#event-vertical-two-finger-drag)\n\n### Methods\n- `addLayer(layer: __esri.Layer | PromiseLike<__esri.Layer>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the map tables collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the map tables collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `hitTest(screenPoint: __esri.MapViewScreenPoint | MouseEvent, options?: __esri.MapViewHitTestOptions): Promise<__esri.HitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates. The results are\norganized as an array of objects containing different [result types](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult).\n\nThe following layer types will return all [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit) if a hit is\nmade on intersecting features: [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[GeoRSSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html),\n[KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html),\n[MapNotesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html),\n[SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html),\n[VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html), and\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html).\n\nThe [ParquetLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ParquetLayer.html) hit result returns only the topmost feature\nwhen the hit occurs on overlapping features in a ParquetLayer.\n\nThe [VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html) hit test result contains an array of objects containing\na [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit).\nThe graphic returns attributes of a style layer. In addition, the graphic's [origin](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#origin)\ncontains 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).\nSpatial 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).\nOtherwise, the graphic's geometry is `null`.\n\nThe [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) hit test result contains all media elements if the hit is made on intersecting elements.\nThe [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) hit test result contains all route elements if the hit is made on intersecting elements.\n\nIf the [polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) feature's symbol\n[style](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#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[color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#color) to a transparent color instead.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): 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?: __esri.MapViewTakeScreenshotOptions): Promise<__esri.Screenshot>` - Create a screenshot of the current view.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-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: __esri.Analysis): Promise<__esri.AnalysisView2DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenAnalysisView)\n- `whenLayerView<TLayer extends __esri.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/api-reference/esri-views-MapView.html#whenLayerView)\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 [Popup](https://developers.arcgis.com/javascript/latest/references/map-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. ","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/api-reference/esri-symbols-CIMSymbol.html),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","values":[{"name":"light"},{"name":"dark"}]},{"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/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.\nIt can either be set using a basemap ID string ([see values](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap)),\n[Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)\nor [BasemapStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap)","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/api-reference/esri-geometry-Point.html) 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()](#goTo) method.\n\nThe returned [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) 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/api-reference/esri-geometry-Point.html#clone) method.\n\n**Notes**\n\n* If the spatial reference of `center` set in the constructor does not match the [spatialReference](#spatialReference) of the view, then the\n[projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) will be loaded dynamically.\n* At runtime, the [projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) must be\n[loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#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/api-reference/esri-geometry-operators-projectOperator.html#isLoaded)\nmethod. If it is not yet loaded, you can call [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) method.","values":[]},{"name":"display-filter-disabled","description":"Indicates whether a layer's `displayFilterInfo` is honored when rendering layers in the view.\nIf `false`, display filters are ignored and all features are rendered.","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/api-reference/esri-config.html#portalUrl) before the Map component loads.","values":[]},{"name":"popup-disabled","description":"Controls whether the popup opens automatically when users click on the view.","values":[]},{"name":"popup-widget-disabled","description":"Indicates whether the popup widget is disabled. When set to `true`, the Popup component will be used for popups instead of the widget.","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":"center"},{"name":"left"},{"name":"right"},{"name":"top"},{"name":"bottom"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-left"},{"name":"top-right"}]},{"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](#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()](#goTo) method.","values":[]},{"name":"spatial-reference-locked","description":"Indicates if the map's [spatialReference](#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/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-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()](#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/arcgis-map/"},{"name":"Map","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-map--demo&singleStory=true"}]},{"name":"arcgis-measurement","description":"The Measurement component groups and manages multiple measurement tools and allows you to easily switch between them using\nthe [activeTool](#activeTool) property. The tools correspond to the measurement components for area and distance in 2D\n[arcgis-area-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/), [arcgis-distance-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/) and in 3D\n[arcgis-area-measurement-3d](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/), [arcgis-direct-line-measurement-3d](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/).\n\nThis component follows a composite pattern that allows developers to configure the UI to best match their specific requirements.\nThe measurement tools, placements, and icons can all be configured, which offers great flexibility to use with tabbed\ninterfaces or other customized UI.\n\nHow distances, areas, and perimeters are computed depends on the view type and its spatial reference.\n\nIn 2D Maps:\n- In geographic coordinate systems (GCS) and in Web Mercator, they are computed geodetically.\n- In projected coordinate systems (PCS), apart from Web Mercator, they are computed\n  in a Euclidean manner (in their respective PCS).\n\nIn 3D Scenes:\n- In geographic coordinate systems (GCS) and in Web Mercator:\n  - horizontal distance is computed geodetically;\n  - vertical distance is computed as a difference in z-values;\n  - direct distance is computed in a Euclidean manner;\n  - area and perimeter are computed:\n    - in a Euclidean manner if the perimeter is below 100km;\n    - geodetically if the perimeter is above 100km.\n- In projected coordinate systems (PCS), apart from Web Mercator:\n  - all three distances (direct, horizontal, and vertical), areas, and perimeters are computed in a Euclidean manner (in their respective PCS).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Removes all measurement widgets and associated graphics.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `startMeasurement(): Promise<void>` - Starts a new measurement for the active measurement widget.","attributes":[{"name":"active-tool","description":"Specifies the current measurement tool to display. Setting its value to `area` activates\nthe area measurement tool and it works in both [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) and [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). To measure distance in a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/),\nset the property to `distance` and in a [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) set it to `direct-line`.\nIf this property is not set, the component will not be displayed.","values":[{"name":"area"},{"name":"distance"},{"name":"direct-line"}]},{"name":"area-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the area values.","values":[{"name":"imperial"},{"name":"metric"},{"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/arcgis-measurement/#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":"linear-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the distance values.","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"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/arcgis-measurement/"},{"name":"Measurement","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-measurement--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 [Scene](https://developers.arcgis.com/javascript/latest/references/map-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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"state","description":"The current state of the component.","values":[{"name":"disabled"},{"name":"ready"}]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-navigation-toggle/"},{"name":"Navigation Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 galley 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":"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":"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","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/arcgis-oriented-imagery-viewer/"},{"name":"Oriented Imagery Viewer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-oriented-imagery-viewer--demo&singleStory=true"}]},{"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- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `cancelMoveClipboard(): Promise<void>` - Cancels any running Clipboard Move Interaction\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component\n- `registerPasteCommand(pasteCommand: CustomPasteCommand): Promise<void>` - Registers a custom Paste Command\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).","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/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":"hide-error-notice","description":"Determines if the component should show error notices","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-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":"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/arcgis-paste/"},{"name":"Paste","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-paste--demo&singleStory=true"},{"name":"Paste (with tools)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-paste--demo-with-tools&singleStory=true"},{"name":"Beta: Paste Kitchen Sink","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-paste--paste-special&singleStory=true"},{"name":"Beta: Paste with Custom","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-paste--paste-with-custom&singleStory=true"}]},{"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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"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/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>` - Create a promise that resolves once 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/arcgis-feature-image/"},{"name":"Feature Image","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-feature-image--demo&singleStory=true"}]},{"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>` - Create a promise that resolves once 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/arcgis-feature-title/"},{"name":"Feature Title","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-feature-title--demo&singleStory=true"}]},{"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 to be interacted with.\n- **arcgisSubmit** - Fires when the [submit()](#submit) method is called.\n- **arcgisValueChange** - Fires when a field value is updated.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 headings in the component.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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":"**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ","values":[{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-left"},{"name":"top-right"},{"name":"manual"},{"name":"top-leading"},{"name":"top-trailing"},{"name":"bottom-leading"},{"name":"bottom-trailing"}]},{"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":"status","values":[{"name":"loaded"},{"name":"loading"},{"name":"not-loaded"},{"name":"failed"}]},{"name":"submit-has-been-attempted","values":[]},{"name":"time-zone","values":[]},{"name":"updating","values":[]},{"name":"valid","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-multi-feature-form/"},{"name":"Multi Feature Form","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-multi-feature-form--demo&singleStory=true"}]},{"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 [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), and [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components currently use the [Popup widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) by default.\nTo use the Popup component, add it to the [arcgis-map.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#popup), [arcgis-scene.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup), or [arcgis-link-chart.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#popup) component using the `popup` slot.\nThe Popup component will be opened automatically to display the selected feature's popup template when features in the Map, Scene, or Link Chart are clicked.\n\n```html\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\">\n  <!-- Add the popup component to the popup slot. -->\n  <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n```\nThe Popup component can also be opened manually at a specific location with custom content specified in the method parameters using the `open()` method.\nTo prevent the popup from opening automatically when clicking on features within view components, set the `popup-disabled` attribute to `true`.\n\n```html\n<!-- Set popup-disabled attribute -->\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.open({\n    location: mapPoint,\n    heading: \"You clicked here\",\n    content: \"Latitude: \" + mapPoint.latitude.toFixed(3) + \", Longitude: \" + mapPoint.longitude.toFixed(3)\n  });\n});\n</script>\n```\n\n## Popup UI\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components contain a default popup.\nThis popup can display generic content, which is set in its [heading](#heading)\nand [content](#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/img/apiref/widgets/popup/popup-basic.png)\n\nIn the image above, the text \"Marriage in Nassau County Census Tract 5177.01\" is the popup's [heading](#heading).\nThe remaining text is the popup's [content](#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](#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](#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](#actions) property for information about adding custom actions to a popup.\n\nThe Popup component is tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-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/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/), the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-PopupTemplate.html) are closely related to Popup, but are more specific to [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)\nand [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). Popup templates allow you to define custom titles and content templates based on the source of the\n[selected feature](#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 [selected feature](#selectedFeature).\n\nCustom PopupTemplates may also be assigned directly to a popup by setting [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) on the\n[features](#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 to be interacted with.\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 [promises](#promises), [features](#features), [content](#content),\n[heading](#heading) and [location](#location) from the Popup.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `fetchFeatures(screenPoint: __esri.ScreenPoint, options?: FetchFeaturesOptions): Promise<__esri.FetchPopupFeaturesResult>` - Use this method to return feature(s) at a given screen location.\nThese features are fetched from all of the [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nin the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). In order to use this, a layer must already have an\nassociated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) and have its [popupEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupEnabled).\n- `handleViewClick(event: __esri.ViewClickEvent): Promise<__esri.FeaturesViewModelOpenOptions>`\n- `next(): Promise<FeaturesViewModel>` - Selects the feature at the next index in relation to the selected feature.\n- `open(options?: __esri.FeaturesViewModelOpenOptions): Promise<void>` - Opens the popup at the given location with content defined either explicitly with `content`\nor driven from the [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) of input features. This method sets\nthe popup's [visible](#visible) property to `true`. Users can alternatively open the popup\nby directly setting the [visible](#visible) property to `true`.\n\n***Note:***\nThe popup will only display if the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) size constraints in [dockOptions](#dockOptions) are met or the [location](#location)\nproperty is set to a geometry.\n- `previous(): Promise<FeaturesViewModel>` - 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- `triggerAction(action: __esri.ActionButton | __esri.ActionToggle): Promise<void>` - Triggers the [arcgisTriggerAction](#arcgisTriggerAction) event and executes the [action](#actions)\nat the specified index in the [actions](#actions) array.","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":"auto"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-left"},{"name":"top-right"},{"name":"top-start"},{"name":"top-end"},{"name":"bottom-start"},{"name":"bottom-end"},{"name":"bottom-center"},{"name":"top-center"}]},{"name":"auto-close-enabled","description":"This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) 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/arcgis-popup/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"content","description":"The content of the popup. When set directly on the Popup, this content is\nstatic and cannot use fields to set content templates. To set a template\nfor the content based on field or attribute names, see\n[PopupTemplate.content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content).","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/api-reference/esri-layers-FeatureLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html),\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), and\n[VoxelLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html)).\n\n**Note:**\n* Starting with version 4.12, [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) content can no longer be set using a\nwildcard, e.g. `*`. Instead, set the `defaultPopupTemplateEnabled` property to `true`.\n* Starting with 4.16, the default popup has been improved to no longer display system\n[fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html)\nthat do not hold significant value, e.g. `Shape__Area` and `Shape__Length` are two fields that\nno longer display.\n* Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#dateFormat)\nrather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) 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 [selected feature](#selectedFeature) or the [location](#location)\nassigned to it. Rather it is attached to a side, the top, or the bottom of the view.\n\nSee [dockOptions](#dockOptions) to override default options related to docking the popup.","values":[]},{"name":"feature-menu-open","description":"This property enables showing a list of features.\nSetting this to `true` allows the user to scroll through the list of features.\nThis value will only be honored if [`initialDisplayMode`](#initialDisplayMode) is set to \"feature\".","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 [selected feature](#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html), 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](#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's [actions](#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-feature-list-layer-title","description":"Indicates whether to hide the group heading for a list of multiple features in the feature menu.","values":[]},{"name":"hide-feature-menu-heading","description":"Indicates whether to hide a heading and description on the component feature menu list.","values":[]},{"name":"hide-feature-navigation","description":"Indicates whether pagination for feature navigation will be displayed. This allows the user to scroll through various [selected features](#features) using pagination arrows.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the heading in the component.","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/arcgis-map/#highlights) or the [arcgis-scene.highlights](https://developers.arcgis.com/javascript/latest/references/map-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.","values":[{"name":"feature"},{"name":"list"}]},{"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":"selected-feature-index","description":"Index of the feature that is [selected](#selectedFeature). When [features](#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":"visible","description":"Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open.\nUse the property to check if the popup is visible.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/"},{"name":"Popup\nThe Popup component opens on view element click.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/?path=/story/arcgis-popup--custom-popup&singleStory=true"},{"name":"Small Map","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"scale","description":"specifies the size of the component","values":[{"name":"l"},{"name":"m"},{"name":"s"}]},{"name":"slide-id","description":"The id of the slide applied to the view","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-presentation/"},{"name":"Presentation","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-presentation--demo&singleStory=true"}]},{"name":"arcgis-print","description":"The Print component connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) 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/api-reference/esri-rest-print.html) 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](#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/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) to preserve scale instead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#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](#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions).\n\n**Known limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) 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 to be interacted with.\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: __esri.PortalItem): Promise<void>` - Adds a portal item to a collection of browse templates available in the Print component UI.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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](#portal) property.","values":[]},{"name":"exclude-default-templates","description":"Indicates whether or not to include [defaultTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-advanced-options","description":"Indicates whether the advanced options section in the Print component UI is hidden.","values":[]},{"name":"hide-header","description":"Indicates whether the component's header is 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":"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](#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/arcgis-print/"},{"name":"Print","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-print--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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"imperial"},{"name":"metric"},{"name":"dual"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-bar/"},{"name":"Scale Bar","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-scale-bar--demo&singleStory=true"}]},{"name":"arcgis-scale-range-slider","description":"The Scale Range Slider component allows the user to set a minimum and maximum scale based on named scale ranges.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-scale-range-slider/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When `true`, sets the component to a disabled state so the user cannot interact with it.","values":[]},{"name":"hide-preview","description":"Indicates whether the preview thumbnail of the scale is visible.\nDefault value is `true`.","values":[]},{"name":"hide-scale-menus-max-scale-menu","description":"Indicates whether the maximum scale dropdown menu is visible. Default value is `true`.","values":[]},{"name":"hide-scale-menus-min-scale-menu","description":"Indicates whether the minimum scale dropdown menu is visible. 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":"max-scale","description":"The maximum scale of the active scale range. When the maxScale\nreaches the [maxScaleLimit](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#maxScaleLimit), the maxScale\nvalue becomes 0 and there is no maximum scale set.","values":[]},{"name":"max-scale-limit","description":"The lowest possible maximum scale value on the slider.","values":[]},{"name":"min-scale","description":"The minimum scale of the active scale range. When the minScale\nreaches the [minScaleLimit](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#minScaleLimit), the minScale\nvalue becomes 0 and there is no minimum scale.","values":[]},{"name":"min-scale-limit","description":"The highest possible minimum scale value on the slider.","values":[]},{"name":"mode","description":"The mode of the component, indicating which slider thumbs can be adjusted.","values":[{"name":"range"},{"name":"max-scale-only"},{"name":"min-scale-only"}]},{"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).\nSee [SupportedRegion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-types.html#SupportedRegion) for the list of regions that are currently supported.","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/arcgis-scale-range-slider/"},{"name":"Demo","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-scale-range-slider--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 component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n  basemap=\"satellite\"\n  ground=\"world-elevation\"\n  camera-position=\"12.3808, 46.3959, 4400\"\n  camera-tilt=\"75\"\n  camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n   <arcgis-layer-list 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/api-reference/)\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 a ArcgisScene 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/api-reference/esri-views-SceneView.html#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/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes: [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[camera](#camera), [viewpoint](#viewpoint). This event will also emit if [stationary](#stationary) toggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n   viewElement.hitTest(event.detail).then((response) => {\n      const result = response.results[0];\n      // ....\n   });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **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/api-reference/esri-views-SceneView.html#event-double-tap-drag)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed.\n- **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/api-reference/esri-views-SceneView.html#event-vertical-two-finger-drag)\n\n### Methods\n- `addLayer(layer: __esri.Layer | PromiseLike<__esri.Layer>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](#popup).\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its [map](#map), [popup](#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n   viewElement.hitTest(event.detail).then((response) => {\n      const result = response.results[0];\n      if (result?.type === \"graphic\") {\n         const { longitude, latitude } = result.mapPoint;\n         console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n      } else {\n         console.log(\"Did not hit any graphic\");\n      }\n   });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView<AnalysisType extends __esri.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/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView<TLayer extends __esri.Layer>(layer: TLayer): Promise<__esri.Layer extends TLayer ? __esri.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/api-reference/esri-views-SceneView.html#whenLayerView)\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 [Popup](https://developers.arcgis.com/javascript/latest/references/map-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. ","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/api-reference/esri-symbols-CIMSymbol.html),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","values":[{"name":"light"},{"name":"dark"}]},{"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/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/api-reference/esri-Map.html#basemap)),\n[Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)\nor [BasemapStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#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()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#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()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#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/api-reference/esri-geometry-Point.html) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)","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()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#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/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)","values":[]},{"name":"display-filter-disabled","description":"Indicates whether a layer's `displayFilter` is honored when rendering layers in the view.\nIf `false`, the display filters are ignored and all features are rendered.","values":[]},{"name":"ground","description":"Specifies the surface properties for the [map](#map). It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\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/api-reference/esri-Map.html#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/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\nTo configure the portal url you must set the [config.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) property before the Scene component loads.","values":[]},{"name":"popup-disabled","description":"Controls whether the popup opens automatically when users click on the view.","values":[]},{"name":"popup-widget-disabled","description":"Indicates whether the popup widget is disabled. When set to `true`, the Popup component will be used for popups instead of the widget.","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/api-reference/esri-views-SceneView.html#qualityProfile)","values":[{"name":"high"},{"name":"low"},{"name":"medium"}]},{"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()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)","values":[]},{"name":"suspended","description":"Indicates if the view is visible on the page.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#suspended)","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/api-reference/esri-views-SceneView.html#supported-coordinate-systems) are available.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#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()](#goTo) method.\nSetting this property in conjunction with [center](#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom)","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/"},{"name":"Scene","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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\nfindAddressCandidates 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.\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--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisSearchClear** - Fires when a result is cleared from the input box or a new result is selected.\n- **arcgisSearchComplete** - Fires when the [search()](#search) method is called and returns its results.\n- **arcgisSearchStart** - Fires when the [search()](#search) method starts.\n- **arcgisSelectResult** - Fires when a search result is selected.\n- **arcgisSuggestComplete** - Fires when the [suggest](#suggest) method is called and returns its results.\n- **arcgisSuggestStart** - Fires when the [suggest()](#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>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `search(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | null | undefined | number[] | string): Promise<__esri.SearchResponse | null | undefined>` - 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/api-reference/esri-rest-locator.html) and\nreturns any applicable results.\n- `setFocus(): Promise<void>` - Brings focus to the component's text input.\n- `suggest(query?: string): Promise<__esri.SuggestResponse | null | undefined>` - 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/img/apiref/widgets/search-allplaceholder.png)","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/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 [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.","values":[]},{"name":"disabled","description":"When `true`, the component is visually withdrawn and cannot be interacted with.","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/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.","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/img/apiref/widgets/search-locationEnabled.png)\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 supports\n[Window.isSecureContext](https://developer.mozilla.org/en-US/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/api-reference/esri-widgets-Popup.html).\nWhen `true`, disables displaying the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) 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](#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/img/apiref/widgets/search-enablesearchingall-true.png)\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/img/apiref/widgets/search-enablesearchingall-false.png)","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":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/"},{"name":"Search","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-search--demo&singleStory=true"}]},{"name":"arcgis-search-result-renderer","description":"The Search Result Renderer renders the Search component results and allows expanding a DOM element to show alternative matches.\nThese alternative matches appear in the Show more results link.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/arcgis-search-result-renderer/"}]},{"name":"arcgis-shadow-cast","description":"The Shadow Cast component displays the cumulative shadows of 3D features in a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nThis type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.\n\nThe component calculates the cumulative shadows for a time range during a single day. The user can\nconfigure the time range and select a calendar date. This time range and calendar date are only used\nfor the shadow analysis and are not connected to the lighting in the scene.\nTo control the lighting in the scene, the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component can be used.\nChanging the timezone in the component updates the visualization by interpreting the time range as being\nin that timezone. This behavior is different from the [Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component,\nwhere selecting a timezone updates the [environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment) date and time according to the camera position.\n\nThe component provides three [modes](#mode): minimum duration, total duration, and discrete mode.\n\nIn the **minimum duration** mode, only the areas that receive\nshadows for more than a certain amount of time are displayed. In the image below, on May 1, 2021 the red areas receive\nshadow for more than 4 hours within the time interval of 10AM to 4PM.\n\n[![threshold mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-threshold.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Total shadow duration** mode displays the duration of the cumulative shadow using opacity: areas that don't\nreceive any shadow are fully transparent and areas that receive a maximum amount of shadow have a default opacity\nof 0.7. The values in between are interpolated. Hovering over the Scene will display a tooltip showing the\namount of time that location is in shadow, rounded to 15-minute intervals. In this mode, the visualization\ncan display shadow cast in a continuous way or in 1-hour intervals.\n\n[![duration mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-duration.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Discrete shadows** is a third mode which displays individual shadows at a given time interval.\nFor example, setting the time range to 10AM-11AM and the interval to 30 minutes will display\nshadows for 10AM, 10:30AM and 11:00AM.\n\n[![discrete mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-discrete.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\nThe defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#startTimeOfDay),\n[endTimeOfDay](#endTimeOfDay), and [mode](#mode) properties.\n\n**Known limitations**\n\n* Shadow Cast is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* Terrain does not cast shadows and it is therefore not taken into account in this analysis.\nThis influences the results when the start time of the range is before sunrise or when the end time is after the sunset.\n* The component does not take into account the daylight savings.\nUse the timezone dropdown to adjust the offset from the Coordinated Universal Time (UTC) and account for the daylight saving time.\n* The timezone is automatically detected by the component based on the camera location. In some situations, this might not be accurate.\nIn case of an inaccurate timezone, users can set it manually using the timezone dropdown.\n\n**See also**\n\n- [Sample - Shadow cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getDurationAtScreen(point: __esri.Point): Promise<number>` - Returns the time (in milliseconds) spent in shadow for a certain point on the screen.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ShadowCast-ShadowCastAnalysisView3D.html#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/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 cast. 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/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)","values":[]},{"name":"discrete-interval","description":"Individual shadows are displayed at this time interval in \"discrete\" [mode](#mode), starting with the start time of\nday. The interval is expressed in milliseconds. If set to 0, we'll use the smallest possible interval, up to a\nmaximum of 255 samples.","values":[]},{"name":"end-time-of-day","description":"Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#endTimeOfDay)","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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 amount of shadow 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](#minDuration) property, in milliseconds.","values":[]},{"name":"min-duration","description":"The minimum duration (in milliseconds) used in \"min-duration\" [mode](#mode) to determine which shadow 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 the \"min-duration\" [mode](#mode). The [minDurationContextColor](#minDurationContextColor)\nand [minDurationContextInterval](#minDurationContextInterval) properties are used to configure the visualization of the\ndiscrete shadows when context is enabled.","values":[]},{"name":"min-duration-context-interval","description":"The interval in milliseconds used when showing additional context in \"min-duration\" [mode](#mode) when\n[minDurationContextEnabled](#contextEnabled) is true.","values":[]},{"name":"min-min-duration","description":"Minimum allowed value for the [minDuration](#minDuration) property, in milliseconds.","values":[]},{"name":"mode","description":"Mode of analysis to use when computing and displaying the shadows. There are 3 types:\n- \"discrete\" mode displays individual shadows cast at a given time interval.\n- \"total-duration\" displays all areas that receive shadows either in a continuous mode or in 1 hour time intervals.\n- \"min-duration\" only displays areas that receive shadows for a period longer than a given minimum duration.","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](#date)) when the shadow cast computation should start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#startTimeOfDay)","values":[]},{"name":"total-duration-mode","description":"Mode in which the cumulative shadow duration should be displayed in \"total-duration\" [mode](#mode): as a continuous\nsurface or as an hourly aggregation of values.","values":[{"name":"continuous"},{"name":"hourly"}]},{"name":"utc-offset","description":"The difference in hours between UTC time and the times displayed in the 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/arcgis-shadow-cast/"},{"name":"Shadow Cast","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-shadow-cast--demo&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/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).\n--\n\n### Events\n- **arcgisCreate**\n- **arcgisDelete**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisRedo**\n- **arcgisUndo**\n- **arcgisUpdate**\n\n### Methods\n- `cancel(): Promise<void>`\n- `complete(): Promise<void>`\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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- `duplicate(): Promise<void>`\n- `redo(): Promise<void>`\n- `triggerUpdate(graphic: Parameters<Sketch[\"update\"]>[0], updateOptions?: Parameters<Sketch[\"update\"]>[1]): Promise<void>`\n- `undo(): Promise<void>`","attributes":[{"name":"active-tool","description":"When creating new graphics (for example after [create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) has been called),\nthis property reflects the create tool being used. When updating graphics\n(for example after [update()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#update) has been called), this property reflects the\nupdate tool being used. If no create or update operation is in progress, this is `null`.\n\nPrior to 4.32, creation tools were modeled as a combination of a geometry type (point, line, polygon)\nand an interaction mode (click, freehand, hybrid).\nAt 4.32, the available create tools were expanded to include \"freehandPolyline\" and \"freehandPolygon\".\nThese tools are made available to enable interoperability with other components of the ArcGIS system,\nwhere freehand polyline is a distinct create tool from polyline.\n\nTo minimize compatibility issues, if \"freehandPolyline\" and \"freehandPolygon\" are not in the list\nof available create tools, they will not be returned by this property, even if the user is drawing a\npolygon in freehand mode.\n\nTo opt in to freehandPolyline and freehandPolygon tools, include them when setting availableCreateTools,\nand hideCreateTools* properties","values":[{"name":"circle"},{"name":"move"},{"name":"point"},{"name":"polygon"},{"name":"rectangle"},{"name":"text"},{"name":"reshape"},{"name":"polyline"},{"name":"transform"},{"name":"multipoint"},{"name":"mesh"},{"name":"freehandPolyline"},{"name":"freehandPolygon"},{"name":"lasso-selection"},{"name":"rectangle-selection"},{"name":"custom-selection"}]},{"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/arcgis-sketch/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"creation-mode","description":"Defines the default behavior once the [create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#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/api-reference/esri-widgets-Sketch.html#update) operation once the `create` operation is completed.","values":[{"name":"single"},{"name":"update"},{"name":"continuous"}]},{"name":"default-graphics-layer-disabled","description":"By default, sketch will auto-create a new graphics layer if none was\nprovided. Set this prop to true to disable this behavior.","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-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","values":[]},{"name":"hide-selection-tools-rectangle-selection","values":[]},{"name":"hide-settings-menu","description":"Indicates whether to hide the settings menu. Currently this menu contains snapping options`.","values":[]},{"name":"hide-snapping-controls","description":"Indicates whether to hide the `SnappingControls` component.","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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#featureEnabled) property.","values":[]},{"name":"hide-snapping-controls-elements-layer-list","description":"Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html) 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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#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":"scale","description":"Determines the size of component elements.","values":[{"name":"s"},{"name":"m"},{"name":"l"}]},{"name":"show-create-tools-freehand-polygon","description":"Indicates whether to display the freehandPolygon tool. Default is `false`.","values":[]},{"name":"show-create-tools-freehand-polyline","description":"Indicates whether to display the freehandPolyline tool. Default is `false`.","values":[]},{"name":"show-snapping-controls-elements-header","description":"Indicates whether to display the header. Default is `false`.","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":"floating"},{"name":"docked"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-sketch/"},{"name":"Sketch","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-sketch--demo&singleStory=true"}]},{"name":"arcgis-slice","description":"The Slice component is a 3D analysis tool that can be used to reveal occluded content in a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). It applies\n[slice analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\nto any layer type, making it possible to see inside buildings or to explore geological surfaces.\n\n[![slice](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/slice.gif)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nThe slicing [shape](#shape)\nis always a [plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).\nBy default, the plane is either horizontal or vertical. To allow a tilt angle for the plane, set\n[tiltEnabled](#tiltEnabled)\nto `true`. The slice hides any content in front of the surface. The handles on the sides of the plane can be used to adjust\nthe size, heading, tilt, and position of the slice plane.\nThe [SlicePlane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html)\ncan be set or retrieved using the [shape](#shape) property.\n\nOnce the slice plane is applied, layers can be excluded from the slicing. For example, by excluding the sublayers which include\ncolumns and floor slabs, the inner structure of a building can investigated.\n\n[![slice-exclude](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/slice-exclude.png)](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 [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the [shape](#shape) of the slice, effectively removing it from the view. Other properties like [excludedLayers](#excludedLayers)\nand [excludeGroundSurface](#excludeGroundSurface) are not modified.\nCalling this method changes the [state](#state) to `ready`.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start the interactive placement of a new slice, clearing the previous [shape](#shape).\nCalling this method changes the [state](#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/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/api-reference/esri-Ground.html) 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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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":"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/arcgis-slice/"},{"name":"Slice","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-slice--demo&singleStory=true"}]},{"name":"arcgis-slider-binary-color-size-legacy","description":"The Binary Color Size Slider (Legacy) 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/api-reference/esri-renderers-visualVariables-SizeVariable.html).\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#fromRendererResult)\nmethod can be used to intelligently populate slider properties including [max](#max), [min](#min), [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html)\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/api-reference/esri-smartMapping-renderers-univariateColorSize.html#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\")!;\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\" as UnivariateTheme,\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 as ClassBreaksRenderer);\n  featureLayer.renderer = result;\n};\n\nbinaryColorSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nbinaryColorSizeSlider.addEventListener(\"arcgisThumbDrag\", 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 to be interacted with.\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>` - Create a promise that resolves once 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 BinaryColorSizeSlider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#RendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#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/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#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/arcgis-slider-binary-color-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()](#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()](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-binary-color-size-legacy/"},{"name":"Slider Binary Color Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-slider-binary-color-size-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-classed-color-legacy","description":"The Classed Color Slider (Legacy) 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/api-reference/esri-renderers-ClassBreaksRenderer.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![ClassedColorSlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/classedcolorslider-labels.png \"ClassedColorSlider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#fromRendererResult) method can be used to intelligently populate slider properties including\n[max](#max), [min](#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#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/api-reference/esri-smartMapping-renderers-color.html#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\")!;\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/api-reference/esri-renderers-ClassBreaksRenderer.html#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);\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 to be interacted with.\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>` - Create a promise that resolves once 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/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos)\nof a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) 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 [fromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#fromRendererResult) method.\n- `updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties a ClassedColorSlider from the result\nof the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#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/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()](#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()](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-classed-color-legacy/"},{"name":"Slider Classed Color (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-slider-classed-color-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-classed-size-legacy","description":"The Classed Size Slider (Legacy) 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/api-reference/esri-renderers-ClassBreaksRenderer.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![ClassedSizeSlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/classedsizeslider-labels.png \"ClassedSizeSlider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#fromRendererResult) method can be used to intelligently populate slider properties including\n[max](#max), [min](#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#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/api-reference/esri-smartMapping-renderers-size.html#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\")!;\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/api-reference/esri-renderers-ClassBreaksRenderer.html#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)) as any;\n  featureLayer.renderer = renderer;\n};\n\nclassedSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nclassedSizeSlider.addEventListener(\"arcgisThumbDrag\", 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 to be interacted with.\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>` - Create a promise that resolves once 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/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos)\nof a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) 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 [fromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#fromRendererResult) method.\n- `updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties a ClassedSizeSlider from the result\nof the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#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/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()](#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()](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-classed-size-legacy/"},{"name":"Slider Classed Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-slider-classed-size-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-color-legacy","description":"The Color Slider (Legacy) 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/api-reference/esri-renderers-visualVariables-ColorVariable.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![ColorSlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/colorslider-2-labels.png \"ColorSlider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#fromRendererResult) method can be used to intelligently populate slider properties including\n[max](#max), [min](#min), the [color visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) configuration,\nand the slider's histogram after the renderer has been created from the result of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#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\")!;\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/api-reference/esri-renderers-visualVariables-ColorVariable.html)\nin a layer's renderer. It is the responsibility of the app developer\nto set up event listeners on this slider that update the color variable of the appropriate renderer.\n\n```js\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() as __esri.ColorVariable;\n  colorVariable.stops = colorSlider.stops;\n\n  renderer.visualVariables = [colorVariable];\n  featureLayer.renderer = renderer;\n};\n\ncolorSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\ncolorSlider.addEventListener(\"arcgisThumbDrag\", 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 to be interacted with.\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>` - Create a promise that resolves once 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 ColorSlider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer)\nmethod. This method is used to configure an empty ColorSlider 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/arcgis-slider-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()](#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()](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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/arcgis-slider-color-legacy/"},{"name":"Slider Color (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-slider-color-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-color-size-legacy","description":"The Color Size Slider (Legacy) 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/api-reference/esri-renderers-visualVariables-ColorVariable.html) and\na [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html). 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/api-reference/esri-Camera.html) 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/img/apiref/widgets/sliders/colorsizeslider-perspective.png \"Slider Color Size with perspective\")\n\n<span id=\"image-annotations\"></span>\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/img/apiref/widgets/sliders/colorsizeslider-labels.png \"Slider Color Size with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#fromRendererResult) method can be used to intelligently populate slider properties including\n[max](#max), [min](#min), [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) configuration,\n[color visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) configuration, and the slider's histogram after the\nrenderer has been created from the result of the [createContinuousRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#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\")!;\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 matching [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html)\nand [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) 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);\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 to be interacted with.\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>` - Create a promise that resolves once 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/api-reference/esri-smartMapping-renderers-univariateColorSize.html#RendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#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/api-reference/esri-smartMapping-renderers-univariateColorSize.html#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/arcgis-slider-color-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()](#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()](#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":"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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-color-size-legacy/"},{"name":"Slider Color Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-slider-color-size-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-heatmap-legacy","description":"The Heatmap Slider (Legacy) 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/api-reference/esri-renderers-HeatmapRenderer.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![HeatmapSlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/heatmapslider-labels.png \"HeatmapSlider 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/api-reference/esri-renderers-HeatmapRenderer.html#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](#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);\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 to be interacted with.\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>` - Create a promise that resolves once 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/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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-heatmap-legacy/"},{"name":"Slider Heatmap (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-slider-heatmap-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-opacity-legacy","description":"The Opacity Slider (Legacy) 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/api-reference/esri-renderers-visualVariables-OpacityVariable.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![OpacitySlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/opacityslider-labels.png \"OpacitySlider with annotations\")\n\nThe [updateFromVisualVariableResult()](#updateFromVisualVariableResult()) method can be used to intelligently populate slider properties including [max](#max), [min](#min),\nthe [opacity visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html) 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/api-reference/esri-smartMapping-renderers-opacity.html#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\")!;\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/api-reference/esri-renderers-visualVariables-OpacityVariable.html)\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);\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 to be interacted with.\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>` - Create a promise that resolves once 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/api-reference/esri-smartMapping-renderers-opacity.html#VisualVariableResult) of\nthe [createVisualVariable()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#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/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()](#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()](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-opacity-legacy/"},{"name":"Slider Opacity (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-slider-opacity-legacy--demo&singleStory=true"}]},{"name":"arcgis-slider-size-legacy","description":"The Size Slider (Legacy) 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/api-reference/esri-renderers-visualVariables-SizeVariable.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![SizeSlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/sizeslider-labels.png \"SizeSlider with annotations\")\n\nThe [updateFromRendererResult()](#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](#max), [min](#min), [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html)\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/api-reference/esri-smartMapping-renderers-size.html#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\")!;\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/api-reference/esri-renderers-visualVariables-SizeVariable.html)\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] as __esri.SizeVariable;\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);\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 to be interacted with.\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>` - Create a promise that resolves once 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/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#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: __esri.SizeVariable): __esri.SizeVariable | null | undefined` - A convenience function used to update the [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html)\nto match the values of the [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#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/api-reference/esri-renderers-visualVariables-SizeVariable.html#minDataValue) and\n[maxDataValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#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/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](#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](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-size-legacy/"},{"name":"Slider Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-slider-size-legacy--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>` - Create a promise that resolves once 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/arcgis-color-select/"},{"name":"Color Select","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-color-select--demo&singleStory=true"}]},{"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>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"end-time","description":"The end time of the time range in milliseconds since midnight.","values":[]},{"name":"label","description":"The label for the component.","values":[]},{"name":"mode","values":[{"name":"range"},{"name":"single"}]},{"name":"start-time","description":"The start time of the time range in milliseconds since midnight.","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/arcgis-time-of-day-slider/"},{"name":"Time-of-day Slider","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-time-of-day-slider--demo&singleStory=true"}]},{"name":"arcgis-webgl-error","description":"Warning for WebGL errors.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 to be interacted with.\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>` - Create a promise that resolves once 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/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`, sets the component to a disabled state so the user cannot interact with it.","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](#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":[]},{"name":"swipe-position","description":"**Deprecated**: since 5.0, use [`position`](#position) instead.. The position of the Swipe component. This determines what percentage\nof the view will be taken up by the [startLayers](#startLayers).","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/"},{"name":"Swipe","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-Map.html).\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/api-reference/esri-widgets-TableList-ListItem.html) 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 than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true.","values":[]},{"name":"hide-flow","description":"Determines whether the table list should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The table list will be displayed within its original flow component if set to `true`. The flow component will be omitted from the table list if set to `false`. To place the table list into an existing Calcite flow component, set this property to `false`.","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/api-reference/esri-widgets-TableList.html#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/api-reference/esri-widgets-TableList-TableListVisibleElements.html) 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/api-reference/esri-widgets-TableList.html#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":"multiple"},{"name":"single"},{"name":"single-persist"}]},{"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 then number of list items is equal to or greater than the value set in [TableList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minFilterItems), allowing users to filter tables by their title.","values":[]},{"name":"show-heading","description":"Indicates whether to display the table list heading. The heading text is \"Table List\". The heading level can be set with the [TableList#headingLevel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#headingLevel).","values":[]},{"name":"show-temporary-table-indicators","description":"Indicates whether temporary table indicators will be displayed for tables with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#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/arcgis-table-list/"},{"name":"Table List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-table-list--demo&singleStory=true"}]},{"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 to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `applyTimeSliderSettings(settings: Pick<__esri.TimeSliderProperties, \"fullTimeExtent\" | \"loop\" | \"stops\">): Promise<void>`\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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: __esri.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/arcgis-time-slider/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When `true`, sets the component to a disabled state so the user cannot interact with it.","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/api-reference/esri-widgets-TimeSlider.html#timeExtent) property's `start` and `end` dates to same date: `{start: sameDate, end: sameDate}` | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/timeslider/mode-instance.png\"> |\ntime-window           | The slider will show temporal data that falls within a given time range. This is the default. Set [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#timeExtent) property's `start` and `date` properties to desired dates. | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/timeslider/mode-time-window.png\"> |\ncumulative-from-start | Similar to `time-window` with the start time is always pinned to the start of the slider. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#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/img/apiref/widgets/timeslider/mode-from-start.png\"> |\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/api-reference/esri-widgets-TimeSlider.html#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/img/apiref/widgets/timeslider/mode-from-end.png\"> |","values":[{"name":"time-window"},{"name":"instant"},{"name":"cumulative-from-start"},{"name":"cumulative-from-end"}]},{"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/api-reference/esri-views-View.html) 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 [MapView#timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone). When a MapView 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 time are not adjusted for any timezone. [TimeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html) 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/arcgis-time-slider/"},{"name":"Time Slider","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-time-slider--demo&singleStory=true"}]},{"name":"arcgis-time-zone-label","description":"Time Zone Label is a component for displaying the current [time zone](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeZone) of a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\nThe component has two states, collapsed as a small button and expanded displaying the internationalized name of the Map's time zone.\nUsers can toggle between these states by clicking the component's expand/collapse button.\nBy default the component is collapsed.\n\nWhen expanding, the component will lengthen inwards when [positioned](#position) within a Map.\nThis behavior can be overridden by setting the [expandDirection](#expandDirection) property to either `\"start\"` or `\"end\"`.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"disabled","description":"When `true`, sets the component to a disabled state so the user cannot interact with it.","values":[]},{"name":"expand-direction","description":"The direction the component will expand.\n\nBy default, the component will expand inward if assigned to a View UI corner. If the component is positioned manually,\nthe component will expand towards the \"end\" which is equivalent to right in a LTR application.","values":[{"name":"start"},{"name":"end"}]},{"name":"expanded","description":"The expanded state of 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":"position","values":[{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-left"},{"name":"top-right"},{"name":"manual"},{"name":"top-leading"},{"name":"top-trailing"},{"name":"bottom-leading"},{"name":"bottom-trailing"}]},{"name":"reference-element","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-time-zone-label/"},{"name":"Time Zone Label","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-time-zone-label--demo&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/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), 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/en-US/docs/Web/API/isSecureContext#browser_compatibility).\n\n**Known limitations**\n\n- The heading symbol is not currently supported within a [Scene component](https://developers.arcgis.com/javascript/latest/references/map-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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 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":"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/en-US/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/api-reference/esri-views-MapView.html#constraints) to `false`.\nFor 2D views the value should be within the [effectiveMinScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints)\nand [effectiveMaxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints).","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-track/"},{"name":"Track","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/api-reference/esri-widgets-UtilityNetworkAssociations.html#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/api-reference/esri-widgets-UtilityNetworkAssociations.html#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/arcgis-utility-network-associations/"}]},{"name":"arcgis-utility-network-trace","description":"Utility Network Trace component provides a way to run traces in a Utility Network based on connectivity or traversability from set input flags. Input flags (starting points and barriers) can be set by clicking the view.\n\n> The Utility Network Trace 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- **arcgisAddFlag**\n- **arcgisAddFlagComplete**\n- **arcgisAddFlagError**\n- **arcgisAddResultArea**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisRemoveResultArea**\n\n### Methods\n- `checkCanTrace(): Promise<void>`\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `confirmReset(): Promise<void>`\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/arcgis-utility-network-trace/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually withdrawn and cannot be interacted with.","values":[]},{"name":"enable-result-area","description":"When `true`, provides the ability to show the convex hull or buffer.","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":"select-on-complete-disabled","description":"When true, the utility network elements are selected in the view when traces are completed.","values":[]},{"name":"show-graphics-on-complete-disabled","description":"When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed.","values":[]},{"name":"show-selection-attributes-disabled","description":"Determines whether to show list of selection attributes","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace/"},{"name":"Utility Network Trace","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-utility-network-trace--demo&singleStory=true"}]},{"name":"arcgis-utility-network-trace-analysis","description":"### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\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- **arcgisTraceResultFeaturesReady** - Fires when the trace result features are ready.\nCheck property `traceResultFeatures` for the trace result features.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-utility-network-trace-analysis/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closable","values":[]},{"name":"icon","values":[]},{"name":"label","values":[]},{"name":"mode","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/arcgis-utility-network-trace-analysis/"},{"name":"Utility Network Trace Analysis","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-utility-network-trace-analysis--demo&singleStory=true"}]},{"name":"arcgis-utility-network-subnetwork-info","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a utility network and named trace configuration as input.\nThe sub-component displays information from the trace configuration relevant to subnetworks:\nDomain network name, tier name, and target tier name.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-subnetwork-info/"}]},{"name":"arcgis-utility-network-trace-inputs","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a map view as an input.\nIt allows users to select utility networks, trace configurations, and input features for tracing.\n--\n\n### Events\n- **arcgisPropertyChange**\n- **arcgisSelectedNamedTraceConfigurationChange** - Fires when the user changes the selected named trace configuration.\n- **arcgisTraceInputsChange** - There will be more added to this event as we increase the functionality of this component\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- **arcgisUtilityNetworkChange** - This will be fired less often than above, only when the utility network changes\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"mode","values":[{"name":"add-spatial"},{"name":"default"}]},{"name":"reference-element","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace-inputs/"}]},{"name":"arcgis-utility-network-trace-location","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a map view as an input.\nIt allows users to select locations on the map to use as trace inputs.\n--\n\n### Events\n- **arcgisTraceLocationChange**\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>` - Create a promise that resolves once component is fully loaded.","attributes":[{"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/arcgis-utility-network-trace-location/"}]},{"name":"arcgis-utility-network-trace-location-list","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component renders a collection of trace locations as a list.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"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/arcgis-utility-network-trace-location-list/"}]},{"name":"arcgis-utility-network-trace-results","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a `TraceResult` instance as input.\nOptionally, the title of a trace configuration can be provided as a heading to display.\n--\n\n### Events\n- **arcgisSelectedLayerChange**\n- **arcgisSelectedResultTypeChange**\n- **arcgisTraceResultFeaturesReady**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"is-elements-selected","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":"ready"},{"name":"loading"}]},{"name":"trace-config-title","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace-results/"}]},{"name":"arcgis-utility-network-validate-topology","description":"The UtilityNetworkValidateTopology component simplifies the process of validating a DirtyArea within a utility network. It offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The UtilityNetworkValidateTopology Component does not support proxied feature services or feature services that utilize stored credentials.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-utility-network-validate-topology/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"extent-to-validate","description":"Specifies the extent of the validation.","values":[{"name":"current"},{"name":"entire"}]},{"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/arcgis-utility-network-validate-topology/"}]},{"name":"arcgis-value-picker","description":"### Events\n- **arcgisAnimate**\n- **arcgisNext**\n- **arcgisPause**\n- **arcgisPlay**\n- **arcgisPrevious**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): Promise<void>`\n- `pause(): Promise<void>`\n- `play(): Promise<void>`\n- `previous(): 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/arcgis-value-picker/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"can-next","description":"Returns `true` if the ValuePicker can be advanced to the next position.","values":[]},{"name":"can-play","description":"Returns `true` if the ValuePicker can be played.","values":[]},{"name":"can-previous","description":"Returns `true` if the ValuePicker can moved to the previous item.","values":[]},{"name":"caption","description":"An optional caption that appears on the ValuePicker component to give context for the user. This is particularly\nuseful when an application is using more than one ValuePicker component.","values":[]},{"name":"hide-next-button","description":"When set to `false`, the next button (or up button when vertical) is not displayed.","values":[]},{"name":"hide-play-button","description":"When set to `false`, the play/pause button is not displayed.","values":[]},{"name":"hide-previous-button","description":"When set to `false`, the previous button (or down button when vertical) is not 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":"layout","description":"Indicates if the component should be orientated horizontally (default) or vertically.\n\nPlease note that [ValuePickerCombobox](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerCombobox.html) and\n[ValuePickerLabel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerLabel.html) do not support vertical layout.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"name":"loop","description":"If true, playback will restart when it reaches the end.","values":[]},{"name":"play-rate","description":"The pause, in milliseconds between playback advancement.","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/arcgis-value-picker/"}]},{"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/api-reference/esri-views-View.html) 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 to be interacted with.\n- **arcgisVersioningStateChanged**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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","values":[]},{"name":"mode","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/arcgis-version-management/"},{"name":"Version Management","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-layers-VideoLayer.html).\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>` - Create a promise that resolves once 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. ","attributes":[{"name":"attribution-mode","description":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","values":[{"name":"light"},{"name":"dark"}]},{"name":"auto-destroy-disabled","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/"}]},{"name":"arcgis-video-player","description":"The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\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\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[![](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/video-player-video-preview.png)](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 to be interacted with.\n- **arcgisVideoReady**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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-sensor"},{"name":"follow-frame"},{"name":"follow-both"}]},{"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","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-fullscreen-toggle","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/"}]},{"name":"arcgis-volume-measurement","description":"The Volume Measurement component can be added to a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-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/img/components/volume-measurement/volume_measurement_poster.png)](https://developers.arcgis.com/javascript/latest/sample-code/analysis-volume-measurement/)*\n\nVolume 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-  Volume Measurement component can only be added to a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-Map.html#ground),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html)\nand an [IntegratedMesh3DTilesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html).\n- This tool does not support WGS 1984 spatial reference in a local\n[viewing mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewingMode).\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/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [Volume Measurement Analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html)\n- [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurementAnalysisView3D.html)\n- [VolumeMeasurementCutFillOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementCutFillOptions.html)\n- [VolumeMeasurementResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurement-VolumeMeasurementResult.html)\n- [VolumeMeasurementDisplayUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementDisplayUnits.html)\n- [VolumeMeasurementInputUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementInputUnits.html)\n- [VolumeMeasurementError](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurement-VolumeMeasurementError.html)\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 to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","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](#areaDisplayUnitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"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/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](#elevationDisplayUnitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"name":"elevation-input-unit","values":[{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"name":"heading-level","description":"Indicates the heading level to use for the headings in the component.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-area-display-unit-select","description":"Hides the area display unit dropdown.","values":[]},{"name":"hide-elevation-display-unit-select","description":"Hides the elevation display unit dropdown.","values":[]},{"name":"hide-elevation-input-unit-select","description":"Hides the elevation input unit dropdown.","values":[]},{"name":"hide-header","description":"Hides the header.","values":[]},{"name":"hide-mode-select","description":"Hides the mode selection dropdown.","values":[]},{"name":"hide-perimeter-display-unit-select","description":"Hides the perimeter display unit dropdown.","values":[]},{"name":"hide-unit-settings","description":"Hides the unit settings button.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"hide-volume-display-unit-select","description":"Hides the volume display unit dropdown.","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":"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 area. Possible values are listed in\n[areaDisplayUnitOptions](#areaDisplayUnitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"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](#volumeDisplayUnitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"name":"cubic-inches"},{"name":"cubic-feet"},{"name":"cubic-yards"},{"name":"cubic-miles"},{"name":"cubic-us-feet"},{"name":"liters"},{"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/arcgis-volume-measurement/"},{"name":"Volume Measurement","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThe available weather types are:\n[sunny](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html),\n[cloudy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html),\n[rainy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html),\n[snowy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html), and\n[foggy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html).\n\nTo set the weather programmatically, apply the desired weather type to the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-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` [viewing mode](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewingMode),\n   * when `atmosphereEnabled` property on [environment](https://developers.arcgis.com/javascript/latest/references/map-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 [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html)\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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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/arcgis-weather/"},{"name":"Weather","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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- **arcgisClick** - Emitted when one of the zoom controls is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-zoom/"},{"name":"Zoom","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent to calculate and display the area and perimeter of a polygon.\n\nHow areas and perimeters are computed depends on the map's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, areas and perimeters are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, areas and perimeters are computed in a Euclidean manner (in their respective PCS).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","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/arcgis-area-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.","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":"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](#unitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"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/arcgis-area-measurement-2d/"},{"name":"Area Measurement 2D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-area-measurement-2d--demo&singleStory=true"}]},{"name":"arcgis-area-measurement-3d","description":"The Area Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-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/img/apiref/widgets/3D_AreaMeasurement_widget.png)](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/img/apiref/widgets/area-measurement-3d-types.png)\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 [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Area Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/).\n* 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/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-AreaMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","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/arcgis-area-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.","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":"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](#unitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"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/arcgis-area-measurement-3d/"},{"name":"Area Measurement 3D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/api-reference/esri-widgets-Attachments.html#displayType) the attachments.\n\n| Value    | Description |\n| ------ | ----------- |\n| auto     | Default value. If a feature layer's capabilities supports [resizing attachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#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":"auto"},{"name":"list"},{"name":"preview"}]},{"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 on 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/arcgis-attachments/"}]},{"name":"arcgis-basemap-gallery","description":"The Basemap Gallery component displays a collection images representing basemaps from [ArcGIS.com](https://www.arcgis.com/index.html) or a user-defined set of map or image services. When a new basemap is selected from the Basemap Gallery, the map's basemap layers are removed and replaced with the basemap layers of the associated basemap selected in the gallery.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/api-reference/esri-Map.html#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/arcgis-basemap-gallery/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When `true`, sets the component to a disabled state so the user cannot interact with it.","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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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/arcgis-basemap-gallery/"},{"name":"Basemap Gallery","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-Basemap.html) layers and switch on/off their visibility. [Base layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#baseLayers) and [reference layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html#referenceLayers) are divided into separate sections. When editing is enabled, layers can be reordered by dragging and dropping between the lists and the title can be edited.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) 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/api-reference/esri-widgets-LayerList-ListItem.html) may be reordered within the list by dragging and dropping.\nMapImageLayer [sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the widget 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 widget's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-base-layers","description":"Indicates whether the base layers will be displayed.","values":[]},{"name":"hide-flow","description":"Determines whether the basemap layer list should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The basemap layer list will be displayed within its original flow component if set to `true`. The flow component will be omitted from the basemap layer list if set to `false`. To place the basemap layer list into an existing Calcite flow component, set this property to `false`.","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/api-reference/esri-widgets-BasemapLayerList.html#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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListVisibleElements.html) 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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibleElements) is true.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#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":"multiple"},{"name":"single"},{"name":"single-persist"}]},{"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 then number of list items is equal to or greater than the value set in [BasemapLayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#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/api-reference/esri-layers-Layer.html#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/img/apiref/widgets/basemap-layer-list/visibilityAppearance-default.png) |\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/img/apiref/widgets/basemap-layer-list/visibilityAppearance-checkbox.png) |","values":[{"name":"default"},{"name":"checkbox"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/"},{"name":"Basemap Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-basemap-layer-list--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--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `toggle(): Promise<any>` - Toggles to the [next basemap](#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/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/arcgis-basemap-toggle/"},{"name":"Basemap Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-webmap-Bookmark.html),\nwhich are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#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/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/arcgis-bookmarks/#timeDisabled) to `true`.\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/arcgis-bookmarks/#showAddBookmarkButton), [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton), and [dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#dragEnabled).\n\n**Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) only if they come from a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks) or are [provided manually](#bookmarks). [Presentation](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html) provides a similar experience for [WebScenes](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-Presentation.html).\n--\n\n### Events\n- **arcgisBookmarkEdit** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited.\n- **arcgisBookmarkSelect** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) 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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `goTo(bookmark: __esri.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/arcgis-bookmarks/#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":"disabled","description":"When true, the component is visually withdrawn and cannot be interacted with.","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/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/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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-flow","description":"Determines whether the component should be rendered within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/).","values":[]},{"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":"Indicates whether to display the close button.","values":[]},{"name":"show-collapse-button","description":"Indicates whether to display 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":"Indicates whether to display 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/arcgis-bookmarks/"},{"name":"Bookmarks","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-layers-BuildingSceneLayer.html). 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](#level), [construction phase](#phase) or by disciplines and categories.\nThe visibility of these elements can be configured using the component's [hideLevels](#hidelevels), [hidePhases](#hidephases) and [hideDisciplines](#hidedisciplines) properties.\n\n[![building-explorer](https://developers.arcgis.com/javascript/latest/assets/img/components/building-explorer/building-explorer.png)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-filter/)\n\nThe [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) to be explored have to be set on the [layers](#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/api-reference/esri-layers-BuildingSceneLayer.html) contain an _Overview_ [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html) 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/api-reference/esri-layers-buildingSublayers-BuildingGroupSublayer.html).\n\nThe Level element of the Building Explorer component allows 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/api-reference/esri-layers-BuildingSceneLayer.html) 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/api-reference/esri-layers-buildingSublayers-BuildingGroupSublayer.html) that organize the [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html) 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 [Scene](https://developers.arcgis.com/javascript/latest/references/map-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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-disciplines","description":"Hides the disciplines tree from the UI.","values":[]},{"name":"hide-levels","description":"Hides the levels filter from the UI.","values":[]},{"name":"hide-phases","description":"Hides the phases filter from the UI.","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 building level.","values":[]},{"name":"phase","description":"The currently selected construction 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":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/"},{"name":"Building Explorer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-building-explorer--demo&singleStory=true"}]},{"name":"arcgis-building-discipline-tree","description":"### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"toggle-siblings-visibility","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-discipline-tree/"}]},{"name":"arcgis-building-level-picker","description":"### Events\n- **arcgisBuildingLevelChange**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-level-picker/"}]},{"name":"arcgis-building-level-item","description":"### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"active","values":[]},{"name":"base-width","values":[]},{"name":"height","description":"The height of the component.","values":[]},{"name":"hovered","values":[]},{"name":"level","values":[]},{"name":"width","description":"The width of the component.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-level-item/"}]},{"name":"arcgis-building-phase-picker","description":"### Events\n- **arcgisBuildingPhaseChange**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-phase-picker/"}]},{"name":"arcgis-catalog-layer-list","description":"The Catalog Layer List component provides a way to display and interact with CatalogLayers.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#visibleElements) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#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>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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-flow","description":"Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The component will be displayed within its original flow component if set to `true`. The flow component will be omitted from the component if set to `false`. To place the component into an existing Calcite flow component, set this property to `false`.","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 [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList-CatalogLayerListVisibleElements.html) 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/api-reference/esri-widgets-CatalogLayerList.html#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":"multiple"},{"name":"single"},{"name":"single-persist"}]},{"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 then number of list items is equal to or greater than the value set in [CatalogLayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#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/api-reference/esri-widgets-CatalogLayerList.html#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/api-reference/esri-layers-Layer.html#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/img/apiref/widgets/layer-list/visibilityAppearance-default.png) |\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/img/apiref/widgets/layer-list/visibilityAppearance-checkbox.png) |","values":[{"name":"default"},{"name":"checkbox"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-catalog-layer-list/"},{"name":"Catalog Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-catalog-layer-list--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/api-reference/esri-views-MapView.html#rotation) or [camera heading](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-compass/#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":"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":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-compass/"},{"name":"Compass","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-compass--demo&singleStory=true"}]},{"name":"arcgis-coordinate-conversion","description":"The 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/api-reference/esri-geometry-Point.html).\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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `reverseConvert(coordinate: string, format: Format): Promise<__esri.Point | nullish>` - Attempt to convert a string into a [point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).  The format of the\nstring must be specified.  A [collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html) of available formats can be\nobtained from the [formats](#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/arcgis-coordinate-conversion/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"expanded","description":"Describes whether the component is expanded or not. If `true`, the component is expanded and all conversions are visible.","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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-capture-button","description":"Determines whether the capture button will be shown in the component. If `true`, the capture button will be hidden.","values":[]},{"name":"hide-expand-button","description":"Determines whether the expand button will be shown in the component. If `true`, the expand button will be hidden.","values":[]},{"name":"hide-input-button","description":"Determines whether the input coordinate button will be shown in the component. If `true`, the input button 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":"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":"live"},{"name":"capture"}]},{"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":"storage-disabled","description":"If this property is set to `true`, sessionStorage or localStorage (depending on [storageType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CoordinateConversion.html#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/arcgis-coordinate-conversion/"},{"name":"Coordinate Conversion","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-coordinate-conversion--demo&singleStory=true"}]},{"name":"arcgis-daylight","description":"The Daylight component can be used to manipulate the lighting conditions of a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nTo achieve this, the component modifies the `lighting` property of the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-views-3d-environment-SunLighting.html) or switch to the\n[virtual](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html) mode,\nwhere the light source is relative to the camera.\n\nWhen illuminating the scene with **[sunlight](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunLighting.html)**\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/api-reference/esri-views-3d-environment-SunLighting.html#date) property of\n[environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\n\n[![daylight-default](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-default.png)](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](#hideTimezone) property.\n\nBy default, a calendar is displayed to select the day, month, and year.\nWith the [dateOrSeason](#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/img/apiref/components/daylight/daylight-seasons.png)\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](#playSpeedMultiplier) property.\n\n![daylight-animation](https://developers.arcgis.com/javascript/latest/assets/img/apiref/components/daylight/daylight-animation.gif)\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/img/apiref/components/daylight/daylight-no-elements.png)\n\nWhenever the sun position option is unchecked, the scene applies the\n**[virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html)** 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/img/apiref/components/daylight/daylight-virtual.png)\n\n**Things to consider**\n\n* Daylight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* The Daylight component uses UTC time and does not account for the daylight savings times in different countries and regions of the world.\n* When using the [virtual light](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-VirtualLighting.html),\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/api-reference/esri-views-3d-environment-SunLighting.html),\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/api-reference/esri-views-3d-environment-SunLighting.html#cameraTrackingEnabled)\nproperty on [environment.lighting](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment).\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisUserDateTimeChange** - Fires when the user changes the date or time in the component by interacting with the slider, the date picker, the\nseason selector or the play buttons.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"spring"},{"name":"summer"},{"name":"fall"},{"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 date corresponding to the equinoxes and solstices of 2014.","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.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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](#utcOffset).","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](#utcOffset). The position represents the time\nof the day in minutes. Possible values range between 0 and 1440.","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":"utc-offset","description":"The difference in hours between UTC time and the time displayed in the component.","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.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/"},{"name":"Daylight","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-directional-pad/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"Indicates whether interaction is allowed on the component. When `true`,\nthis property sets the component to a disabled state to disable any user\ninteraction.","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":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directional-pad/"},{"name":"Directional Pad","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-layers-RouteLayer.html), using ArcGIS Online and custom Network Analysis Route services.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getDirections(): Promise<__esri.RouteLayerSolveResult>`\n- `save(): Promise<__esri.PortalItem>`\n- `saveAs(portalItem: __esri.PortalItem, options: { folder: __esri.PortalFolder; }): Promise<__esri.PortalItem>`\n- `zoomToRoute(): Promise<void>`","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/api-reference/esri-config.html#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/arcgis-directions/#destroy) method when you are done to\nprevent memory leaks.","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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-layer-details","description":"Indicates whether to a link to the route layer portal-item (if any) 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":"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":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"name":"use-default-route-layer","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-directions/"},{"name":"Directions","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-directions--demo&singleStory=true"}]},{"name":"arcgis-direct-line-measurement-3d","description":"The Direct Line Measurement 3D component can be added to a [Scene](https://developers.arcgis.com/javascript/latest/references/map-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/img/apiref/widgets/3D_DirectLineMeasurement_widget.png)](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/img/apiref/widgets/direct-line-measurement-3d.png)\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 [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent, use [Distance Measurement 2D](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/).\n* Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [DirectLineMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DirectLineMeasurementAnalysis.html)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n- [Sample - Color theming for interactive tools](https://developers.arcgis.com/javascript/latest/sample-code/view-theme/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","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/arcgis-direct-line-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.","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":"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](#unitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/"},{"name":"Direct Line Measurement 3D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)\ncomponent to calculate and display the length of a polyline.\n\nHow distances are computed depends on the scene'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 to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","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/arcgis-distance-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.","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":"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](#unitOptions).","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/"},{"name":"Distance Measurement 2D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\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- `cancelWorkflow(): Promise<void>`\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `deleteFeatureFromWorkflow(): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `startCreateFeaturesWorkflowAtFeatureCreation(info: __esri.CreateFeaturesCreationInfo): Promise<void>`\n- `startCreateFeaturesWorkflowAtFeatureTypeSelection(): Promise<void>`\n- `startUpdateWorkflowAtFeatureEdit(feature: __esri.Graphic): Promise<void>`\n- `startUpdateWorkflowAtFeatureSelection(): Promise<void>`\n- `startUpdateWorkflowAtMultipleFeatureSelection(candidates: __esri.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/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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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-flow","description":"Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The component will be displayed within its original flow component if set to `true`. The flow component will be omitted from the component if set to `false`. To place the component into an existing Calcite flow component, set this property to `false`.","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-settings-menu","description":"Indicates whether to hide the settings menu. This menu contains the snapping and tooltips settings.","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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#featureEnabled) property.","values":[]},{"name":"hide-snapping-controls-elements-layer-list","description":"Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html) 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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#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":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-editor/"},{"name":"Editor","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-analysis-ElevationProfileAnalysis.html) and displays its elevation profiles.\n\n[![elevation profile poster](https://developers.arcgis.com/javascript/latest/assets/img/components/elevation-profile/elevation_profile_poster.png)](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 a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) component or a [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component and on the available elevation source data:\n\n* [**ElevationProfileLineGround**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineGround.html): represents a profile line that uses elevation from [Map.ground](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineInput.html): 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/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html): represents a profile line that samples elevation from the elevation source set in the [source](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineQuery.html#source) property. The elevation source can be an [ElevationLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html) or ant object with a method called `queryElevation` that has the same signature as [queryElevation()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ElevationLayer.html#queryElevation).\n* [**ElevationProfileLineScene**](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineScene.html): 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](#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\n[![elevation profile chart gif](https://developers.arcgis.com/javascript/latest/assets/img/components/elevation-profile/elevation_profile_chart_gif.gif)](https://developers.arcgis.com/javascript/latest/sample-code/elevation-profile/)\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/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineInput.html) in 2D is only valid when the analysis [geometry](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#geometry) has z values, `hasZ===true` and no [elevationInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html#elevationInfo) is set.\n- [ElevationProfileLineScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfile-ElevationProfileLineScene.html) is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [ElevationProfileAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ElevationProfileAnalysis.html)\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 to be interacted with.\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>` - Create a promise that resolves once 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/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/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/arcgis-elevation-profile/#start) or\n[select()](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#select).","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/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.","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"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.","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"name":"hide-chart","description":"If true, the elevation profile chart will be hidden.","values":[]},{"name":"hide-clear-button","description":"If true, the clear button will be hidden.","values":[]},{"name":"hide-legend","description":"If true, the legend will be hidden.","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-sketch-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-unit-selector","description":"If true, the unit selector 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":"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/arcgis-elevation-profile/"},{"name":"Elevation Profile","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `collapse(): Promise<void>` - Collapse the component.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/api-reference/esri-views-View.html#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/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.png)","values":[]},{"name":"label","description":"The component's default label.","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":"auto"},{"name":"left"},{"name":"right"},{"name":"top"},{"name":"bottom"},{"name":"top-start"},{"name":"top-end"},{"name":"bottom-start"},{"name":"bottom-end"},{"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":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/"},{"name":"Expand with Custom Content\nThe Expand component with custom content.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/arcgis-basemap-gallery/) component.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-expand--component-content&singleStory=true"}]},{"name":"arcgis-feature","description":"The Feature component displays a graphic according to its [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html).\nThis component is useful in instances where you want to display information about a feature but without\nthe use of a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).\n\nIf wanting to show a feature's content with [actions](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#actions), [related](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-RelationshipContent.html), or [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate), etc., then use the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-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](#map) and [spatialReference](#spatialReference) properties need to be defined in the Feature 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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/api-reference/esri-popup-content-MediaContent.html) info.\n- `previousMedia(contentElementIndex: number): Promise<void>` - Paginates to the previous [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info.\n- `setActiveMedia(contentElementIndex: number, mediaInfoIndex: number): Promise<void>` - Paginates to a specified [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) info object. For example,\nyou may have [media](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-MediaContent.html) 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/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/api-reference/esri-layers-FeatureLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html)\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html), and\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html)).\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/api-reference/esri-popup-support-FieldInfoFormat.html#dateFormat)\nrather than `long-month-day-year` in the default [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) 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](#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-attachments-content","description":"This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html) 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/api-reference/esri-popup-content-CustomContent.html) 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/api-reference/esri-popup-content-ExpressionContent.html) 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/api-reference/esri-popup-content-FieldsContent.html) within the component.","values":[]},{"name":"hide-heading","description":"This property provides the ability to hide or show the component's [heading](#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/api-reference/esri-popup-content-MediaContent.html) 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/api-reference/esri-popup-content-TextContent.html) 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/api-reference/esri-popup-content-RelationshipContent.html) 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/api-reference/esri-popup-content-UtilityNetworkAssociationsContent.html) 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 [MapView.timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone). When a MapView 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 time 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/arcgis-feature/"},{"name":"Feature\nThe Feature component displays on hover.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n- **arcgisSubmit** - Fires when the [submit()](#submit) method is called.\n- **arcgisValueChange** - Fires when a field value is updated.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-feature-form/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","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/api-reference/esri-widgets-FeatureForm.html#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/api-reference/esri-form-elements-GroupElement.html) configured in the Editor's [layer infos](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Editor-types.html#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/api-reference/esri-form-FormTemplate.html#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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":"The timezone displayed within the form. If `unknown`, it first checks if the  layer has a [FeatureLayer#preferredTimeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#preferredTimeZone). If so, it displays this. If not, it will default to UTC.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-form/"},{"name":"Feature Form","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-feature-form--demo&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**\n- **arcgisCellKeydown**\n- **arcgisCellPointerout**\n- **arcgisCellPointerover**\n- **arcgisColumnReorder**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisSelectionChange**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `deleteSelection(showWarningPrompt?: boolean): Promise<void>`\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `exportSelectionToCSV(includeGeometry?: boolean): Promise<void>`\n- `findColumn(fieldName: string): Promise<__esri.ActionColumn | __esri.AttachmentsColumn | __esri.Column | __esri.GroupColumn | __esri.RelationshipColumn | nullish>`\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- `scrollToBottom(): Promise<void>`\n- `scrollToIndex(index: number): Promise<void>`\n- `scrollToLeft(): Promise<void>`\n- `scrollToRow(objectId: number): 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- `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/api-reference/esri-layers-FeatureLayer.html#capabilities).\n\n![featuretable attachmentsEnabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featuretable/attachments-enabled.png)","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/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":"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":"Indicates whether the table is disabled. When disabled, the table will not display any data or allow interaction. This is purely a visual override and does not prevent the table from attempting to render data. This property has no effect on the current [state](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#state) property value.","values":[]},{"name":"editing-enabled","description":"Indicates whether [editing](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#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-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":"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.","values":[]},{"name":"hide-column-menu-items-sort-descending","description":"Indicates whether to display the Sort Descending menu item.","values":[]},{"name":"hide-column-menus","description":"Indicates whether to display the menu items within the individual columns","values":[]},{"name":"hide-header","description":"Indicates whether to display the feature table's header information.","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-toggle-columns","description":"Indicates whether to enable toggling column visibility within the menu.","values":[]},{"name":"hide-menu-items-zoom-to-selection","description":"Indicates whether to display the Zoom to selected 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/api-reference/esri-widgets-FeatureTable.html#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/api-reference/esri-widgets-FeatureTable.html#refresh).","values":[]},{"name":"label","description":"The components label.","values":[]},{"name":"layer-item-id","description":"Portal Item Id for a layer to load. You can set, `layer`, `layerUrl`, or `itemId`,\nbut not more than one.","values":[]},{"name":"layer-url","description":"Url for a layer to load. You can set, `layer`, `layerUrl`, or `itemId`,\nbut not more than one.","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/api-reference/esri-widgets-FeatureTable.html#paginationEnabled) is `true`, and `maxSize` is greater than the current value of [pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#pageSize), multiple pages usually display. If `maxSize` is less than [pageSize](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#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":"s"},{"name":"m"},{"name":"l"}]},{"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/api-reference/esri-widgets-FeatureTable.html#pageSize). [Pagination](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#paginationEnabled) must be enabled or the value of this property may not be not 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/api-reference/esri-widgets-FeatureTable.html#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/api-reference/esri-widgets-FeatureTable.html#pageIndex) property. The current page can be modified by calling the [goToPage()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#goToPage) method and passing in the desired [page index](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#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/api-reference/esri-widgets-FeatureTable.html#layers) property when there is no associated [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#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/api-reference/esri-widgets-FeatureTable.html#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/api-reference/esri-widgets-FeatureTable.html#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-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":"table-disabled","description":"**Deprecated**: since 5.0, use `element.disabled` instead.. ","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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html) displays timezones for `date` and `timestamp-offset` field [types](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Field.html#type) reflecting the MapView's timezone. This timezone can be overridden by setting the table's [timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#timeZone) property.\n> If the table's [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTable.html#view) isn't set, and the table's [Feature#timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Feature.html#timeZone) isn't set, the table defaults to `system` time. The only time that this is not the case is when there is a [FeatureLayer#preferredTimeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#preferredTimeZone) set on the table's layer. If the latter is true, the preferred time zone is used as opposed to `system`.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-feature-table/"},{"name":"Feature Table","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-feature-table--demo&singleStory=true"}]},{"name":"arcgis-feature-templates","description":"### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisSelect**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-feature-templates/#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/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html) 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/api-reference/esri-widgets-FeatureTemplates-TemplateItem.html). 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/img/apiref/widgets/groupByLayers.png)\ngeometry | Groups template items by geometry type. | ![FeatureTemplatesGroupByGeometry](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/groupByGeometry.png)\nnone | The component displays everything in one list with no grouping. | ![featureTemplatesGroupByLayer](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/groupByNone.png)\n[GroupByFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FeatureTemplates-types.html#GroupByFunction) | Custom function that takes an object containing a [FeatureTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureTemplate.html) and [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). | ![FeatureTemplatesGroupByCustomGroupFunction](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/groupCustomGroup.png)","values":[{"name":"geometry"},{"name":"layer"},{"name":"none"}]},{"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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-filter","description":"Indicates whether the templates filter displays.\n![](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/featureTemplatesFilter.png)","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/arcgis-feature-templates/"}]},{"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 a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThis component looks and behaves similarly to the [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-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/arcgis-map/),\nthe [arcgis-popup](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-layers-support-FeatureReductionBinning.html#popupTemplate) and [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate).\n\nThe Features component should be used if needing to use the Popup functionality outside of the map or scene component. If wanting 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/arcgis-feature/) 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 to be interacted with.\n- **arcgisTriggerAction** - Fires after the user clicks on an action in the Features 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](#promises), [features](#features), [content](#content), and\n[heading](#heading) from the Features component.\n- `close(): Promise<void>` - A convenience method to close the component.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `fetchFeatures(screenPoint?: __esri.ScreenPoint, options?: __esri.FetchFeaturesOptions): Promise<void>` - Use this method to return feature(s) at a given screen location.\nThese features are fetched from all of the [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nin the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). In order to use this, a layer must already have an\nassociated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html). This method allows a developer to\ncontrol how the input location is handled.\n- `next(): Promise<FeaturesViewModel>` - Selects the feature at the next index in relation to the [selected feature](#selectedFeature).\n- `previous(): Promise<FeaturesViewModel>` - Selects the feature at the previous index in relation to the [selected feature](#selectedFeature).\n- `setFocus(): Promise<void>` - Use this method to give focus to the Component if the component is able to be focused.\n- `triggerAction(action: __esri.ActionButton | __esri.ActionToggle): Promise<void>` - Triggers the [`arcgisTriggerAction`](#arcgisTriggerAction) event and executes the action\nat the specified index in the [actions](#actions) array.","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/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 [`showCollapsed`](#showCollapsed) is `true`.","values":[]},{"name":"content","description":"The content of the Features component. When set directly on the component, this content is\nstatic and cannot use fields to set content templates. To set a template\nfor the content based on field or attribute names, see\n[PopupTemplate.content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content).","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/api-reference/esri-layers-FeatureLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html), and\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html)).","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.\nSetting this to `true` allows the user to scroll through the list of features.\nThis value will only be honored if [`initialDisplayMode`](#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.","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 [selected feature](#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html), 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](#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's [actions](#actions).","values":[]},{"name":"hide-attachments-content","description":"This property provides the ability to hide or show [attachments content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-AttachmentsContent.html) 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/api-reference/esri-popup-content-CustomContent.html) 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/api-reference/esri-popup-content-ExpressionContent.html) 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 pagination in the component.\nThis allows the user to scroll through various [selected 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/api-reference/esri-popup-content-FieldsContent.html) within the component.","values":[]},{"name":"hide-flow","description":"Determines whether the component should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded.\nThe component will be displayed within its original flow component if set to `false`.\nThe flow component will be omitted from the component if set to `true`.\nTo place the component into an existing Calcite flow component, set this property to `false`.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the component's [heading](#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/api-reference/esri-popup-content-MediaContent.html) 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/api-reference/esri-popup-content-RelationshipContent.html) within the component.","values":[]},{"name":"hide-spinner","description":"Indicates whether to hide the component's loading spinner.","values":[]},{"name":"hide-text-content","description":"This property provides the ability to hide or show [text content](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-content-TextContent.html) 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/api-reference/esri-popup-content-UtilityNetworkAssociationsContent.html) within the component.","values":[]},{"name":"highlight-disabled","description":"Indicates whether to highlight the [selected feature](#selectedFeature) in the associated\n[arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-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":"feature"},{"name":"list"}]},{"name":"label","description":"The component's default label.","values":[]},{"name":"open","description":"Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open in the view.\nUse the 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 [selected](#selectedFeature). When [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 [arcgis-map.timeZone](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeZone) if the [view](#view) property is set. When a MapView 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 time 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 [location](#location) when the [selectedFeatureIndex](#selectedFeatureIndex) changes.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-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/?path=/story/arcgis-features--demo&singleStory=true"}]},{"name":"arcgis-floor-filter","description":"The Floor Filter component simplifies visualization of GIS data for a specific floor of a building in your application.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `updateWebDocument(webMap: __esri.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/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 widget's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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/arcgis-floor-filter/"},{"name":"Floor Filter","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/en-US/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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"element","description":"The [HTMLElement](https://developer.mozilla.org/en-US/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":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-fullscreen/"},{"name":"Fullscreen","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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](#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](#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](#snappingOptions) has been defined.\nIf [snappingOptions](#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](#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](#customColor) is shown, otherwise a default light or dark theme color is used.","values":[{"name":"custom"},{"name":"light"},{"name":"dark"}]},{"name":"unit","description":"Unit of measure (foot, meter, etc) used when defining the [spacing](#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":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-grid-controls/"},{"name":"Grid Controls","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `generateWhereClause(field: string): Promise<nullish | string>` - 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/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/api-reference/esri-smartMapping-statistics-types.html#SummaryStatisticsResult),\nwhich is the result of the\n[summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) 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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType), use the [includedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType), use the [excludedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#labels) when the data range\n([max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#max) - [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#min)) is less than `10`.\n\nWhen the data range is larger than `10`, [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#values) and shouldn't be used exclusively\nfor formatting purposes. To format thumb `labels`, use the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor) and\n[excludedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor) properties.\n\nThis property also determines the SQL where clause generated in [generateWhereClause()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#generateWhereClause)\nfor filtering purposes. The value set here determines the number of [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#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/api-reference/esri-widgets-HistogramRangeSlider.html#values) | [Where clause](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#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":"not-equal"},{"name":"less-than"},{"name":"greater-than"},{"name":"at-most"},{"name":"at-least"},{"name":"between"},{"name":"not-between"}]},{"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/api-reference/esri-widgets-HistogramRangeSlider.html#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/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/api-reference/esri-Viewpoint.html)\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 to be interacted with.\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>` - Create a promise that resolves once 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/arcgis-home/#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":"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":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-home/"},{"name":"Home","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-home--demo&singleStory=true"}]},{"name":"arcgis-layer-list","description":"The Layer List component provides a way to display a list of layers, and switch on/off their visibility.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `triggerAction(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.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/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/api-reference/esri-widgets-LayerList-ListItem.html) may be reordered within the list by dragging and dropping.\nMapImageLayer [MapImageLayer#sublayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html#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 than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-catalog-layer-list","description":"Indicates whether to display the [LayerList#catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogLayerList).","values":[]},{"name":"hide-flow","description":"Indicates whether the layer list should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The layer list will be displayed within its original flow component if set to `true`. The flow component will be omitted from the layer list if set to `false`. To place the layer list into an existing Calcite flow component, set this property to `false`.","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/api-reference/esri-widgets-LayerList.html#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/api-reference/esri-widgets-LayerList-LayerListVisibleElements.html) 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/api-reference/esri-widgets-LayerList.html#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":"multiple"},{"name":"single"},{"name":"single-persist"}]},{"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 then number of list items is equal to or greater than the value set in [LayerList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#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/api-reference/esri-widgets-LayerList.html#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/api-reference/esri-layers-Layer.html#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/img/apiref/widgets/layer-list/visibilityAppearance-default.png) |\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/img/apiref/widgets/layer-list/visibilityAppearance-checkbox.png) |","values":[{"name":"default"},{"name":"checkbox"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-layer-list/"},{"name":"Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-layer-list--demo&singleStory=true"}]},{"name":"arcgis-legend","description":"The Legend component displays the symbols and labels used to represent layers in a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) or [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nOnly layers and sublayers visible in the view are shown, unless [ignoreLayerVisibility](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-layers-ElevationLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html),\n[KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html),\n[MapNotesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html),\n[OpenStreetMapLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OpenStreetMapLayer.html),\n[VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html), and\n[WebTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html).\n* [Symbol3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3D.html) with more than one\n[symbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-Symbol3DLayer.html) are not supported.\n* [DictionaryRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DictionaryRenderer.html) is not supported.\n* [TrackInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TrackInfo.html) is not supported.\n* CIM Symbol [primitiveOverride](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html#PrimitiveOverride) is not supported.\n* RasterStretchRenderer [dynamicRangeAdjustment](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.html#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/img/apiref/widgets/legend/legend-unique-values.png)](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/img/apiref/widgets/legend/legend-color-vv.png)](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/img/apiref/widgets/legend/legend-class-breaks.png)](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/img/apiref/widgets/legend/legend-size.png)](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/img/apiref/widgets/legend/legend-size-themes.png)](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/img/apiref/widgets/legend/legend-dot-density.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-dot-density/)\n\n### Predominance\n\n[![Predominance](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/legend/legend-predominance.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-arcade/)\n\n### Relationship\n\n[![Relationship](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/legend/legend-relationship.png)](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/api-reference/esri-layers-Layer.html) and [renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) 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/api-reference/esri-layers-support-FieldConfiguration.html) 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/api-reference/esri-renderers-ClassBreaksRenderer.html#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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/api-reference/esri-Basemap.html) layers in the Legend. If you set this property to\n`true` and specify [layerInfos](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/#layerInfos) that include the basemap layers, the basemap will be displayed in the legend.","values":[]},{"name":"card-style-layout","description":"Indicates the layout of the legend when the [legendStyle](https://developers.arcgis.com/javascript/latest/references/map-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/img/components/legend/card-style-layout.png)](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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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/api-reference/esri-layers-FeatureLayer.html#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/api-reference/esri-layers-FeatureLayer.html#minScale) and\n[maxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#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/img/components/legend/legend-style.png)](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 render, only features that satisfy the layer's\n[definition](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#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/arcgis-legend/"},{"name":"Legend","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-analysis-LineOfSightAnalysis.html)\nin a [Scene](https://developers.arcgis.com/javascript/latest/references/map-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/img/apiref/widgets/line-of-sight.png)\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/api-reference/esri-analysis-LineOfSightAnalysisObserver.html)\nand subsequent clicks place the [targets](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysisTarget.html).\nBoth the observer and target points can be moved by dragging. Additionally, the target points can be removed with a right click.\n\n**Known limitation**\n\nLine Of Sight is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [LineOfSightAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-LineOfSightAnalysis.html)\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 to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the current analysis results. After calling this method, the user can set a new observer and targets.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `continue(): Promise<void>` - After [stop()](#stop) was called, this method allows to continue the line of sight analysis and add more targets.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start a new line of sight analysis.\n- `stop(): Promise<void>` - Stop the current placing of line of sight analysis. Any lines added this 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/arcgis-line-of-sight/#destroy) method when you are done to\nprevent memory leaks.","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":"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/arcgis-line-of-sight/"},{"name":"Line of Sight","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-line-of-sight--demo&singleStory=true"}]},{"name":"arcgis-link-chart","description":"Loads a [WebLinkChart](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebLinkChart.html) from an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) into a [LinkChartView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html).\n\nNote: Sign in to access the data in this demo, U/P: `viewer01`/`I68VGU^nMurF`\n--\n\n### Events\n- **arcgisLoadError** - Fires when a ArcgisLinkChart 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/api-reference/esri-views-MapView.html#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/api-reference/esri-views-MapView.html#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#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- **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- `addLayer(layer: __esri.Layer | Promise<Layer>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): 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: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-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: __esri.Analysis): Promise<__esri.AnalysisView2DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenAnalysisView)\n- `whenLayerView(layer: __esri.Layer): Promise<__esri.LayerView>` - Gets the LayerView created on the view for the given layer.\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 [Popup](https://developers.arcgis.com/javascript/latest/references/map-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. ","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/api-reference/esri-symbols-CIMSymbol.html),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-LinkChartView.html#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","values":[{"name":"light"},{"name":"dark"}]},{"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/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 view's center point; when setting the center, you may pass a\nesri/geometry/Point instance 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 layer's displayFilter are honored when rendering layers in the view.\nIf `false`, display filters are ignored and all features are rendered.","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/api-reference/esri-config.html#portalUrl) before the Link Chart component loads.","values":[]},{"name":"popup-disabled","description":"Controls whether the popup opens automatically when users click on the view.","values":[]},{"name":"popup-widget-disabled","description":"Indicates whether the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#popup) widget is disabled. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#popupElement) will be used for popups instead of the widget.","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":"center"},{"name":"left"},{"name":"right"},{"name":"top"},{"name":"bottom"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-left"},{"name":"top-right"}]},{"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](#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/arcgis-link-chart/"},{"name":"Link Chart","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n- **arcgisSwitchLayout** - Fires when component has completed the layout switch\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/arcgis-link-chart-layout-switcher/"},{"name":"Link Chart Layout Switcher","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 for use in link charts that allows users to switch whether or not nonspatial data is visible in the view.  Spatial entities are those with a value in a defined geometry property in a traditional map context.  A Spatial relationship is one where both endpoints are spatial\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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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","values":[{"name":"l"},{"name":"m"},{"name":"s"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart-nonspatial-visibility-toggle/"},{"name":"Link Chart Nonspatial Visibility Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), 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/en-US/docs/Web/API/isSecureContext#browser_compatibility).\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 to be interacted with.\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>` - Create a promise that resolves once 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/arcgis-locate/#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 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":"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 [track](#event-track) event.","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-locate/"},{"name":"Locate","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n\n#### Initializing the Map component\nThe Map component creates a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html)\nand can be initialized in one of three ways:\n\n##### 1. Using a WebMap\nLoad a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html) from [ArcGIS Online](https://www.arcgis.com/home/index.html)\nor an [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm) by specifying the [item-id](#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](#basemap), [center](#center), and [zoom](#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/api-reference/esri-Map.html) instance to the component.\nThis allows full control over map configuration, including [basemap](#basemap), operational [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#layers)\nand [spatial reference](#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/api-reference/) 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 a ArcgisMap 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/api-reference/esri-views-MapView.html#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/api-reference/esri-views-MapView.html#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is triggered when view-related properties change, such as [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[viewpoint](#viewpoint), or [stationary](#stationary).\nIt reflects user interactions (e.g. panning or zooming) or programmatic updates to the view.\n- **arcgisViewClick** - Fires after a user clicks on the view. This event emits slightly slower than an [arcgisViewImmediateClick](#arcgisViewImmediateClick)\nevent to make sure that an [arcgisViewDoubleClick](#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/api-reference/esri-views-MapView.html#event-double-tap-drag)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\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](#arcgisViewClick) event, the `arcgisViewImmediateClick`\nis emitted as soon as the user clicks on the view, and is not inhibited by a [arcgisViewDoubleClick](#arcgisViewDoubleClick) event.\nThis event is useful for interactive experiences that require feedback without delay.\n- **arcgisViewImmediateDoubleClick** - Fires after two consecutive [arcgisViewImmediateClick](#arcgisViewImmediateClick) events. In contrast to [arcgisViewDoubleClick](#arcgisViewDoubleClick),\nan `arcgisViewImmediateDoubleClick` cannot be prevented by use of `stopPropagation()` on the [arcgisViewImmediateClick](#arcgisViewImmediateClick)\nevent and can therefore be used to react to double-clicking independently of usage of the [arcgisViewImmediateClick](#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/api-reference/esri-views-layers-LayerView.html)\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/api-reference/esri-views-layers-LayerView.html)\nafter a layer has been added to the map.\n- **arcgisViewLayerviewDestroy** - Fires after a [LayerView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\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](#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/api-reference/esri-views-MapView.html#event-vertical-two-finger-drag)\n\n### Methods\n- `addLayer(layer: __esri.Layer | PromiseLike<__esri.Layer>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the map layers collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the map layers collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the map tables collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the map tables collection.. \n- `closePopup(): Promise<void>` - Closes the popup.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the view, and any associated resources, including its map, popup, and UI elements.\n- `goTo(target: __esri.GoToTarget2D, options?: __esri.GoToOptions2D): Promise<unknown>` - Sets the view to a given target.\n- `hitTest(screenPoint: __esri.MapViewScreenPoint | MouseEvent, options?: __esri.MapViewHitTestOptions): Promise<__esri.HitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates. The results are\norganized as an array of objects containing different [result types](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#HitTestResult).\n\nThe following layer types will return all [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit) if a hit is\nmade on intersecting features: [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html),\n[CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[GeoRSSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoRSSLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html),\n[KMLLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KMLLayer.html),\n[MapNotesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapNotesLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html),\n[SubtypeSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-SubtypeSublayer.html),\n[VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html), and\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html).\n\nThe [ParquetLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ParquetLayer.html) hit result returns only the topmost feature\nwhen the hit occurs on overlapping features in a ParquetLayer.\n\nThe [VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html) hit test result contains an array of objects containing\na [graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#GraphicHit).\nThe graphic returns attributes of a style layer. In addition, the graphic's [origin](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html#origin)\ncontains 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).\nSpatial 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).\nOtherwise, the graphic's geometry is `null`.\n\nThe [MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html) hit test result contains all media elements if the hit is made on intersecting elements.\nThe [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) hit test result contains all route elements if the hit is made on intersecting elements.\n\nIf the [polygon](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Polygon.html) feature's symbol\n[style](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#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[color](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html#color) to a transparent color instead.\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): 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?: __esri.MapViewTakeScreenshotOptions): Promise<__esri.Screenshot>` - Create a screenshot of the current view.\n- `toMap(screenPoint: __esri.MapViewScreenPoint | MouseEvent): __esri.Point`\n- `toScreen(point: __esri.Point, options?: __esri.ToScreenOptions2D): __esri.MapViewScreenPoint | nullish`\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-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: __esri.Analysis): Promise<__esri.AnalysisView2DUnion>` - Gets the analysis view created for the given analysis object.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#whenAnalysisView)\n- `whenLayerView<TLayer extends __esri.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/api-reference/esri-views-MapView.html#whenLayerView)\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 [Popup](https://developers.arcgis.com/javascript/latest/references/map-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. ","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/api-reference/esri-symbols-CIMSymbol.html),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","values":[{"name":"light"},{"name":"dark"}]},{"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/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.\nIt can either be set using a basemap ID string ([see values](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap)),\n[Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)\nor [BasemapStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap)","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/api-reference/esri-geometry-Point.html) 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()](#goTo) method.\n\nThe returned [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) 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/api-reference/esri-geometry-Point.html#clone) method.\n\n**Notes**\n\n* If the spatial reference of `center` set in the constructor does not match the [spatialReference](#spatialReference) of the view, then the\n[projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) will be loaded dynamically.\n* At runtime, the [projectOperator](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html) must be\n[loaded](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#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/api-reference/esri-geometry-operators-projectOperator.html#isLoaded)\nmethod. If it is not yet loaded, you can call [load()](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-operators-projectOperator.html#load) method.","values":[]},{"name":"display-filter-disabled","description":"Indicates whether a layer's `displayFilterInfo` is honored when rendering layers in the view.\nIf `false`, display filters are ignored and all features are rendered.","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/api-reference/esri-config.html#portalUrl) before the Map component loads.","values":[]},{"name":"popup-disabled","description":"Controls whether the popup opens automatically when users click on the view.","values":[]},{"name":"popup-widget-disabled","description":"Indicates whether the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#popup) widget is disabled. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#popupElement) will be used for popups instead of the widget.","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":"center"},{"name":"left"},{"name":"right"},{"name":"top"},{"name":"bottom"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-left"},{"name":"top-right"}]},{"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](#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()](#goTo) method.","values":[]},{"name":"spatial-reference-locked","description":"Indicates if the map's [spatialReference](#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/arcgis-basemap-gallery/) and [arcgis-basemap-toggle](https://developers.arcgis.com/javascript/latest/references/map-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()](#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/arcgis-map/"},{"name":"Map","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-map--demo&singleStory=true"}]},{"name":"arcgis-measurement","description":"The Measurement component groups and manages multiple measurement tools and allows you to easily switch between them using\nthe [activeTool](#activeTool) property. The tools correspond to the measurement components for area and distance in 2D\n[arcgis-area-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/), [arcgis-distance-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/) and in 3D\n[arcgis-area-measurement-3d](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/), [arcgis-direct-line-measurement-3d](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-direct-line-measurement-3d/).\n\nThis component follows a composite pattern that allows developers to configure the UI to best match their specific requirements.\nThe measurement tools, placements, and icons can all be configured, which offers great flexibility to use with tabbed\ninterfaces or other customized UI.\n\nHow distances, areas, and perimeters are computed depends on the view type and its spatial reference.\n\nIn 2D Maps:\n- In geographic coordinate systems (GCS) and in Web Mercator, they are computed geodetically.\n- In projected coordinate systems (PCS), apart from Web Mercator, they are computed\n  in a Euclidean manner (in their respective PCS).\n\nIn 3D Scenes:\n- In geographic coordinate systems (GCS) and in Web Mercator:\n  - horizontal distance is computed geodetically;\n  - vertical distance is computed as a difference in z-values;\n  - direct distance is computed in a Euclidean manner;\n  - area and perimeter are computed:\n    - in a Euclidean manner if the perimeter is below 100km;\n    - geodetically if the perimeter is above 100km.\n- In projected coordinate systems (PCS), apart from Web Mercator:\n  - all three distances (direct, horizontal, and vertical), areas, and perimeters are computed in a Euclidean manner (in their respective PCS).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Removes all measurement widgets and associated graphics.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `startMeasurement(): Promise<void>` - Starts a new measurement for the active measurement widget.","attributes":[{"name":"active-tool","description":"Specifies the current measurement tool to display. Setting its value to `area` activates\nthe area measurement tool and it works in both [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/) and [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). To measure distance in a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/),\nset the property to `distance` and in a [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) set it to `direct-line`.\nIf this property is not set, the component will not be displayed.","values":[{"name":"area"},{"name":"distance"},{"name":"direct-line"}]},{"name":"area-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the area values.","values":[{"name":"imperial"},{"name":"metric"},{"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/arcgis-measurement/#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":"linear-unit","description":"Unit system (imperial, metric) or specific unit used for displaying the distance values.","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"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/arcgis-measurement/"},{"name":"Measurement","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-measurement--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 [Scene](https://developers.arcgis.com/javascript/latest/references/map-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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"state","description":"The current state of the component.","values":[{"name":"disabled"},{"name":"ready"}]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-navigation-toggle/"},{"name":"Navigation Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 galley 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":"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":"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","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/arcgis-oriented-imagery-viewer/"},{"name":"Oriented Imagery Viewer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-oriented-imagery-viewer--demo&singleStory=true"}]},{"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- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `cancelMoveClipboard(): Promise<void>` - Cancels any running Clipboard Move Interaction\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component\n- `registerPasteCommand(pasteCommand: CustomPasteCommand): Promise<void>` - Registers a custom Paste Command\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).","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/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":"hide-error-notice","description":"Determines if the component should show error notices","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-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":"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/arcgis-paste/"},{"name":"Paste","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-paste--demo&singleStory=true"},{"name":"Paste (with tools)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-paste--demo-with-tools&singleStory=true"},{"name":"Beta: Paste Kitchen Sink","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-paste--paste-special&singleStory=true"},{"name":"Beta: Paste with Custom","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-paste--paste-with-custom&singleStory=true"}]},{"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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"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/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>` - Create a promise that resolves once 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/arcgis-feature-image/"},{"name":"Feature Image","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-feature-image--demo&singleStory=true"}]},{"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>` - Create a promise that resolves once 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/arcgis-feature-title/"},{"name":"Feature Title","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-feature-title--demo&singleStory=true"}]},{"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 to be interacted with.\n- **arcgisSubmit** - Fires when the [submit()](#submit) method is called.\n- **arcgisValueChange** - Fires when a field value is updated.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 headings in the component.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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":"**Deprecated**: since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead.. ","values":[{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-left"},{"name":"top-right"},{"name":"manual"},{"name":"top-leading"},{"name":"top-trailing"},{"name":"bottom-leading"},{"name":"bottom-trailing"}]},{"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":"status","values":[{"name":"loaded"},{"name":"loading"},{"name":"not-loaded"},{"name":"failed"}]},{"name":"submit-has-been-attempted","values":[]},{"name":"time-zone","values":[]},{"name":"updating","values":[]},{"name":"valid","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-multi-feature-form/"},{"name":"Multi Feature Form","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-multi-feature-form--demo&singleStory=true"}]},{"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 [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), and [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components currently use the [Popup widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) by default.\nTo use the Popup component, add it to the [arcgis-map.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#popup), [arcgis-scene.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup), or [arcgis-link-chart.popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/#popup) component using the `popup` slot.\nThe Popup component will be opened automatically to display the selected feature's popup template when features in the Map, Scene, or Link Chart are clicked.\n\n```html\n<arcgis-map id=\"06ca49d0ddb447e7817cfc343ca30df9\">\n  <!-- Add the popup component to the popup slot. -->\n  <arcgis-popup slot=\"popup\"></arcgis-popup>\n</arcgis-map>\n```\nThe Popup component can also be opened manually at a specific location with custom content specified in the method parameters using the `open()` method.\nTo prevent the popup from opening automatically when clicking on features within view components, set the `popup-disabled` attribute to `true`.\n\n```html\n<!-- Set popup-disabled attribute -->\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.open({\n    location: mapPoint,\n    heading: \"You clicked here\",\n    content: \"Latitude: \" + mapPoint.latitude.toFixed(3) + \", Longitude: \" + mapPoint.longitude.toFixed(3)\n  });\n});\n</script>\n```\n\n## Popup UI\nThe [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/) components contain a default popup.\nThis popup can display generic content, which is set in its [heading](#heading)\nand [content](#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/img/apiref/widgets/popup/popup-basic.png)\n\nIn the image above, the text \"Marriage in Nassau County Census Tract 5177.01\" is the popup's [heading](#heading).\nThe remaining text is the popup's [content](#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](#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](#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](#actions) property for information about adding custom actions to a popup.\n\nThe Popup component is tied to a [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-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/arcgis-map/), [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/), or [arcgis-link-chart](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-link-chart/), the [arcgis-features](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-PopupTemplate.html) are closely related to Popup, but are more specific to [layers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)\nand [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html). Popup templates allow you to define custom titles and content templates based on the source of the\n[selected feature](#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 [selected feature](#selectedFeature).\n\nCustom PopupTemplates may also be assigned directly to a popup by setting [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-Graphic.html) on the\n[features](#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 to be interacted with.\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 [promises](#promises), [features](#features), [content](#content),\n[heading](#heading) and [location](#location) from the Popup.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `fetchFeatures(screenPoint?: __esri.ScreenPoint, options?: FetchFeaturesOptions): Promise<void>` - Use this method to return feature(s) at a given screen location.\nThese features are fetched from all of the [LayerViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)\nin the [view](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html). In order to use this, a layer must already have an\nassociated [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) and have its [popupEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupEnabled).\n- `handleViewClick(event: __esri.ViewClickEvent): Promise<__esri.FeaturesViewModelOpenOptions>`\n- `next(): Promise<FeaturesViewModel>` - Selects the feature at the next index in relation to the selected feature.\n- `previous(): Promise<FeaturesViewModel>` - 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- `triggerAction(action: __esri.ActionButton | __esri.ActionToggle): Promise<void>` - Triggers the [arcgisTriggerAction](#arcgisTriggerAction) event and executes the [action](#actions)\nat the specified index in the [actions](#actions) array.","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":"auto"},{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-left"},{"name":"top-right"},{"name":"top-start"},{"name":"top-end"},{"name":"bottom-start"},{"name":"bottom-end"},{"name":"bottom-center"},{"name":"top-center"}]},{"name":"auto-close-enabled","description":"This closes the popup when the [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) camera or [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html) 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/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 popup. When set directly on the Popup, this content is\nstatic and cannot use fields to set content templates. To set a template\nfor the content based on field or attribute names, see\n[PopupTemplate.content](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html#content).","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/api-reference/esri-layers-FeatureLayer.html),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html),\n[SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html),\n[StreamLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-StreamLayer.html),\n[ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), and\n[VoxelLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VoxelLayer.html)).\n\n**Note:**\n* Starting with version 4.12, [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) content can no longer be set using a\nwildcard, e.g. `*`. Instead, set the `defaultPopupTemplateEnabled` property to `true`.\n* Starting with 4.16, the default popup has been improved to no longer display system\n[fields](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-FieldInfo.html)\nthat do not hold significant value, e.g. `Shape__Area` and `Shape__Length` are two fields that\nno longer display.\n* Starting with version 4.28, `date` fields are formatted using the `short-date-short-time` preset [dateFormat](https://developers.arcgis.com/javascript/latest/api-reference/esri-popup-support-FieldInfoFormat.html#dateFormat)\nrather than `long-month-day-year` in default [popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) 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 [selected feature](#selectedFeature) or the [location](#location)\nassigned to it. Rather it is attached to a side, the top, or the bottom of the view.\n\nSee [dockOptions](#dockOptions) to override default options related to docking the popup.","values":[]},{"name":"feature-menu-open","description":"This property enables showing a list of features.\nSetting this to `true` allows the user to scroll through the list of features.\nThis value will only be honored if [`initialDisplayMode`](#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":"heading","description":"The title of the popup. This can be set generically on the popup no\nmatter the features that are selected. If the [selected feature](#selectedFeature)\nhas a [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html), 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](#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-action-bar","description":"Indicates whether to hide the action bar that holds the feature's [actions](#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-feature-list-layer-title","description":"Indicates whether to hide the group heading for a list of multiple features in the feature menu.","values":[]},{"name":"hide-feature-menu-heading","description":"Indicates whether to hide a heading and description on the component feature menu list.","values":[]},{"name":"hide-feature-navigation","description":"Indicates whether pagination for feature navigation will be displayed. This allows the user to scroll through various [selected features](#features) using pagination arrows.","values":[]},{"name":"hide-heading","description":"Indicates whether to hide the heading in the component.","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/arcgis-map/#highlights) or the [arcgis-scene.highlights](https://developers.arcgis.com/javascript/latest/references/map-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.","values":[{"name":"feature"},{"name":"list"}]},{"name":"label","description":"The component's default label.","values":[]},{"name":"open","description":"Indicates whether the popup is visible. This property is `true` when the popup is querying for results, even if it is not open.\nUse the property to check if the popup 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 [selected](#selectedFeature). When [features](#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](#location) when the [selectedFeatureIndex](#selectedFeatureIndex) changes.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-popup/"},{"name":"Popup\nThe Popup component opens on view element click.","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/?path=/story/arcgis-popup--custom-popup&singleStory=true"},{"name":"Small Map","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"scale","description":"specifies the size of the component","values":[{"name":"l"},{"name":"m"},{"name":"s"}]},{"name":"slide-id","description":"The id of the slide applied to the view","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-presentation/"},{"name":"Presentation","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-presentation--demo&singleStory=true"}]},{"name":"arcgis-print","description":"The Print component connects your application with a [printing service](https://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-the-portal-to-print-maps.htm) 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/api-reference/esri-rest-print.html) 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](#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/api-reference/esri-widgets-Print-TemplateOptions.html#scaleEnabled) to preserve scale instead.\n\nThe Print component prints a localized date for all [layouts](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#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](#templateCustomTextElements) property.\n\nFor more information about printing with the `MAP_ONLY` layout, please see\n[exportOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions).\n\n**Known limitations**\n\nSee [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) 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 to be interacted with.\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: __esri.PortalItem): Promise<void>` - Adds a portal item to a collection of browse templates available in the Print component UI.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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](#portal) property.","values":[]},{"name":"exclude-default-templates","description":"Indicates whether or not to include [defaultTemplates](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-PrintViewModel.html#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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-advanced-options","description":"Indicates whether the advanced options section in the Print component UI is hidden.","values":[]},{"name":"hide-header","description":"Indicates whether the component's header is 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":"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](#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/arcgis-print/"},{"name":"Print","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-print--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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"imperial"},{"name":"metric"},{"name":"dual"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scale-bar/"},{"name":"Scale Bar","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-scale-bar--demo&singleStory=true"}]},{"name":"arcgis-scale-range-slider","description":"The Scale Range Slider component allows the user to set a minimum and maximum scale based on named scale ranges.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-scale-range-slider/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When `true`, sets the component to a disabled state so the user cannot interact with it.","values":[]},{"name":"hide-preview","description":"Indicates whether the preview thumbnail of the scale is visible.\nDefault value is `true`.","values":[]},{"name":"hide-scale-menus-max-scale-menu","description":"Indicates whether the maximum scale dropdown menu is visible. Default value is `true`.","values":[]},{"name":"hide-scale-menus-min-scale-menu","description":"Indicates whether the minimum scale dropdown menu is visible. 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":"max-scale","description":"The maximum scale of the active scale range. When the maxScale\nreaches the [maxScaleLimit](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#maxScaleLimit), the maxScale\nvalue becomes 0 and there is no maximum scale set.","values":[]},{"name":"max-scale-limit","description":"The lowest possible maximum scale value on the slider.","values":[]},{"name":"min-scale","description":"The minimum scale of the active scale range. When the minScale\nreaches the [minScaleLimit](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html#minScaleLimit), the minScale\nvalue becomes 0 and there is no minimum scale.","values":[]},{"name":"min-scale-limit","description":"The highest possible minimum scale value on the slider.","values":[]},{"name":"mode","description":"The mode of the component, indicating which slider thumbs can be adjusted.","values":[{"name":"range"},{"name":"max-scale-only"},{"name":"min-scale-only"}]},{"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).\nSee [SupportedRegion](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider-types.html#SupportedRegion) for the list of regions that are currently supported.","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/arcgis-scale-range-slider/"},{"name":"Demo","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-scale-range-slider--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 component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\n\nThe Scene component creates a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html)\nand loads a [WebScene](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\"></arcgis-scene>\n```\n\nAlternatively, the Scene component can be initialized without a WebScene item:\n\n```html\n<arcgis-scene\n  basemap=\"satellite\"\n  ground=\"world-elevation\"\n  camera-position=\"12.3808, 46.3959, 4400\"\n  camera-tilt=\"75\"\n  camera-heading=\"300\">\n</arcgis-scene>\n```\n\nFurther components can be added and connected to the Scene component:\n\n```html\n<arcgis-scene item-id=\"e2da7564e4f24eaaa918ffd70378056a\">\n   <arcgis-layer-list 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/api-reference/)\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 a ArcgisScene 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/api-reference/esri-views-SceneView.html#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/api-reference/esri-views-SceneView.html#event-analysis-view-create-error)\n- **arcgisViewAnalysisViewDestroy** - Fires after an analysis view is destroyed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-analysis-view-destroy)\n- **arcgisViewChange** - This event is for view related property changes: [zoom](#zoom), [scale](#scale), [center](#center), [rotation](#rotation), [extent](#extent),\n[camera](#camera), [viewpoint](#viewpoint). This event will also emit if [stationary](#stationary) toggles from `true` to `false`.\n- **arcgisViewClick** - Fires after a user clicks on the view.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n   viewElement.hitTest(event.detail).then((response) => {\n      const result = response.results[0];\n      // ....\n   });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-click)\n- **arcgisViewDoubleClick** - Fires after double-clicking on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-double-click)\n- **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/api-reference/esri-views-SceneView.html#event-double-tap-drag)\n- **arcgisViewDrag** - Fires during a pointer drag on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-drag)\n- **arcgisViewHold** - Fires after holding either a mouse button or a single finger on the view for a short amount of time.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-hold)\n- **arcgisViewImmediateClick** - Fires right after a user clicks on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-click)\n- **arcgisViewImmediateDoubleClick** - Is emitted after two consecutive immediate-click events.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-immediate-double-click)\n- **arcgisViewKeyDown** - Fires after a keyboard key is pressed.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-down)\n- **arcgisViewKeyUp** - Fires after a keyboard key is released.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-key-up)\n- **arcgisViewLayerviewCreate** - Fires after each layer in the map has a corresponding LayerView created and rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create)\n- **arcgisViewLayerviewCreateError** - Fires when an error emits during the creation of a LayerView after a layer has been added to the map.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-create-error)\n- **arcgisViewLayerviewDestroy** - Fires after a LayerView is destroyed and is no longer rendered in the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-layerview-destroy)\n- **arcgisViewMouseWheel** - Fires when a wheel button of a pointing device (typically a mouse) is scrolled on the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-mouse-wheel)\n- **arcgisViewPointerDown** - Fires after a mouse button is pressed, or a finger touches the display.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-down)\n- **arcgisViewPointerEnter** - Fires after a mouse cursor enters the view, or a display touch begins.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-enter)\n- **arcgisViewPointerLeave** - Fires after a mouse cursor leaves the view, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-leave)\n- **arcgisViewPointerMove** - Fires after the mouse or a finger on the display moves.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-move)\n- **arcgisViewPointerUp** - Fires after a mouse button is released, or a display touch ends.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#event-pointer-up)\n- **arcgisViewReadyChange** - This event is for the [ready](#ready) property and will be emitted when the view is ready.\nThis event will also emit if the [map](#map) property is changed.\n- **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/api-reference/esri-views-SceneView.html#event-vertical-two-finger-drag)\n\n### Methods\n- `addLayer(layer: __esri.Layer | PromiseLike<__esri.Layer>, index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.add(layer)` instead.\n\nAdds a layer to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addLayers(layers: __esri.Layer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.addMany([layer])` instead.\n\nAdds a layer or array of layers to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `layers` collection.. \n- `addTable(table: __esri.FeatureLayer): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.add(table)` instead.\n\nAdds a table to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `addTables(tables: __esri.FeatureLayer[], index?: number): Promise<void>` - **Deprecated**: since 4.33, use `element.map.tables.addMany([table])` instead.\n\nAdds a table or array of tables to the [map's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#map) `tables` collection.. \n- `closePopup(): Promise<void>` - Closes the [popup](#popup).\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the Scene component, and any associated resources, including its [map](#map), [popup](#popup),\nand removes components or other UI DOM elements added to it.\n- `goTo(target: __esri.GoToTarget3D, options?: __esri.GoToOptions3D): Promise<unknown>` - Sets the view to a given target.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)\n- `hitTest(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewHitTestOptions): Promise<__esri.SceneViewHitTestResult>` - Returns [hit test results](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#HitTestResult)\nfrom each layer that intersects the specified screen coordinates.\n\n```js\nviewElement.addEventListener(\"arcgisViewClick\", (event) => {\n   viewElement.hitTest(event.detail).then((response) => {\n      const result = response.results[0];\n      if (result?.type === \"graphic\") {\n         const { longitude, latitude } = result.mapPoint;\n         console.log(\"Hit graphic at (\" + longitude + \", \" + latitude + \")\", result.graphic);\n      } else {\n         console.log(\"Did not hit any graphic\");\n      }\n   });\n});\n```\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#hitTest)\n- `openPopup(options?: __esri.PopupViewOpenPopupOptions): Promise<void>` - Opens the popup based on input options.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#openPopup)\n- `takeScreenshot(options?: __esri.SceneViewTakeScreenshotOptions): Promise<__esri.SceneViewScreenshot>` - Creates a screenshot of the current view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot)\n- `toMap(screenPoint: __esri.SceneViewScreenPoint | MouseEvent, options?: __esri.SceneViewToMapOptions): __esri.Point | nullish` - Converts the given screen point to a [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\n- `toScreen(point: __esri.Point): __esri.SceneViewScreenPoint` - Converts the given [map point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html) to a screen point.\n- `tryFatalErrorRecovery(): Promise<void>` - Call this method to clear any fatal errors resulting from a lost WebGL context.\n- `viewOnReady(callback?: () => void, errback?: (error: Error) => void): Promise<void>` - `viewOnReady()` may be leveraged once an instance of the component and its underlying [view](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#view) is created and ready.\nThis method takes two input parameters, a `callback` function and an `errback` function, and returns a promise. The `callback` executes when the promise resolves, and the `errback` executes if the promise is rejected.\n- `whenAnalysisView<AnalysisType extends __esri.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/api-reference/esri-views-SceneView.html#whenAnalysisView)\n- `whenLayerView<TLayer extends __esri.Layer>(layer: TLayer): Promise<__esri.Layer extends TLayer ? __esri.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/api-reference/esri-views-SceneView.html#whenLayerView)\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 [Popup](https://developers.arcgis.com/javascript/latest/references/map-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. ","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/api-reference/esri-symbols-CIMSymbol.html),\n[PictureMarkerSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html)\nfrom a GIF/animated PNG), animated renderers\n([FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-rasterRenderers.html#FlowRenderer)),\nanimated layers ([MediaLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MediaLayer.html),\n[VideoLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VideoLayer.html)), and\nanimations triggered by view navigation (for example,\n[goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)).\nSetting this property to `true` disables all animations in the view.","values":[]},{"name":"attribution-mode","description":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","values":[{"name":"light"},{"name":"dark"}]},{"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/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/api-reference/esri-Map.html#basemap)),\n[Basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Basemap.html)\nor [BasemapStyle](https://developers.arcgis.com/javascript/latest/api-reference/esri-support-BasemapStyle.html).\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#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()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#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()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#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/api-reference/esri-geometry-Point.html) instance\nor a string in the format: longitude, latitude, elevation. E.g. `\"12.3808, 46.3959, 4400\"`.\n\nSetting the camera position immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#position)","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()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-Camera.html#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/api-reference/esri-geometry-Point.html) instance.\n\nSetting the center immediately changes the current view. For animating the view, see this component's\n[goTo()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#center)","values":[]},{"name":"display-filter-disabled","description":"Indicates whether a layer's `displayFilter` is honored when rendering layers in the view.\nIf `false`, the display filters are ignored and all features are rendered.","values":[]},{"name":"ground","description":"Specifies the surface properties for the [map](#map). It can be either a [Ground](https://developers.arcgis.com/javascript/latest/api-reference/esri-Ground.html)\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/api-reference/esri-Map.html#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/api-reference/esri-WebScene.html) item from either\n[ArcGIS Online](https://www.arcgis.com/home/index.html) or [ArcGIS Enterprise portal](https://enterprise.arcgis.com/en/portal/latest/administer/windows/what-is-portal-for-arcgis-.htm).\n\nTo configure the portal url you must set the [config.portalUrl](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#portalUrl) property before the Scene component loads.","values":[]},{"name":"popup-disabled","description":"Controls whether the popup opens automatically when users click on the view.","values":[]},{"name":"popup-widget-disabled","description":"Indicates whether the [popup](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popup) widget is disabled. When set to `true`, the [popupElement](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#popupElement) will be used for popups instead of the widget.","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/api-reference/esri-views-SceneView.html#qualityProfile)","values":[{"name":"high"},{"name":"low"},{"name":"medium"}]},{"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()](#goTo) method.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#scale)","values":[]},{"name":"suspended","description":"Indicates if the view is visible on the page.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#suspended)","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/api-reference/esri-views-SceneView.html#supported-coordinate-systems) are available.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#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()](#goTo) method.\nSetting this property in conjunction with [center](#center)\nis a convenient way to set the initial extent of the view.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#zoom)","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/"},{"name":"Scene","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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\nfindAddressCandidates 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.\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--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisSearchClear** - Fires when a result is cleared from the input box or a new result is selected.\n- **arcgisSearchComplete** - Fires when the [search()](#search) method is called and returns its results.\n- **arcgisSearchStart** - Fires when the [search()](#search) method starts.\n- **arcgisSelectResult** - Fires when a search result is selected.\n- **arcgisSuggestComplete** - Fires when the [suggest](#suggest) method is called and returns its results.\n- **arcgisSuggestStart** - Fires when the [suggest()](#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>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `search(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | null | undefined | number[] | string): Promise<__esri.SearchResponse | null | undefined>` - 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/api-reference/esri-rest-locator.html) and\nreturns any applicable results.\n- `setFocus(): Promise<void>` - Brings focus to the component's text input.\n- `suggest(query?: string): Promise<__esri.SuggestResponse | null | undefined>` - 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/img/apiref/widgets/search-allplaceholder.png)","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/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 [search-complete](#event-search-complete) event handler and get the results\nthrough the event object.","values":[]},{"name":"disabled","description":"When `true`, the component is visually withdrawn and cannot be interacted with.","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/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.","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/img/apiref/widgets/search-locationEnabled.png)\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 supports\n[Window.isSecureContext](https://developer.mozilla.org/en-US/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/api-reference/esri-widgets-Popup.html).\nWhen `true`, disables displaying the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) 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](#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/img/apiref/widgets/search-enablesearchingall-true.png)\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/img/apiref/widgets/search-enablesearchingall-false.png)","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":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/"},{"name":"Search","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-search--demo&singleStory=true"}]},{"name":"arcgis-search-result-renderer","description":"The Search Result Renderer renders the Search component results and allows expanding a DOM element to show alternative matches.\nThese alternative matches appear in the Show more results link.\n--\n\n### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/arcgis-search-result-renderer/"}]},{"name":"arcgis-shadow-cast","description":"The Shadow Cast component displays the cumulative shadows of 3D features in a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\nThis type of analysis is helpful in urban development, where new projects have to satisfy certain shadow duration constraints.\n\nThe component calculates the cumulative shadows for a time range during a single day. The user can\nconfigure the time range and select a calendar date. This time range and calendar date are only used\nfor the shadow analysis and are not connected to the lighting in the scene.\nTo control the lighting in the scene, use the\n[Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component.\nChanging the timezone in the component updates the visualization by interpreting the time range as being\nin that timezone. This behavior is different from the\n[Daylight](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-daylight/) component,\nwhere selecting a timezone updates the\n[environment lighting's](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#environment)\ndate and time according to the camera position.\n\nThe component provides three [modes](#mode): minimum duration, total duration, and discrete mode.\n\n**Minimum duration** mode displays shadows only in areas where shading accumulates for longer than a specified duration\nwithin the selected time range. Areas that receive less shading than the minimum show no shadow. In the image below,\non May 1, 2021, shadows are displayed only where shading exceeds 4 hours between 10AM and 4PM.\n\n[![minimum-duration mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-threshold.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Total shadow duration** mode displays the cumulative duration of shadow within the selected time range using opacity:\nareas that receive no shadow remain fully transparent, while areas receiving the highest accumulated shadow duration\nuse a default opacity of 0.7. Intermediate values are interpolated. This mode can visualize shadows continuously or\nin 1-hour intervals.\n\n[![total-duration mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-duration.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\n**Discrete shadows** mode displays individual shadows at regular intervals within the selected time range.\nFor example, with a time range from 10AM to 11AM and an interval set to 30 minutes, the shadows at 10AM, 10:30AM and\n11:00AM will be displayed.\n\n[![discrete mode](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/shadow-cast/shadow-cast-discrete.png)](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n\nHovering over the Scene will display a tooltip showing the  amount of time that location is in shadow, rounded to 15-minute intervals.\n\nThe defaults for the time range and visualization settings can be changed using the [startTimeOfDay](#starttimeofday),\n[endTimeOfDay](#endtimeofday), and [mode](#mode) properties.\n\n**Known limitations**\n\n* Shadow Cast is only supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n* Terrain does not cast shadows in this analysis. As a result, to avoid incorrect shadow visualization, `startTimeOfDay`\nshould be set after local sunrise and `endTimeOfDay` before local sunset. If these times fall outside daylight hours,\nshadows may be missing in areas where terrain would normally block sunlight.\n* The analysis does not take daylight savings into account. Use the timezone dropdown to adjust the offset from the\nCoordinated Universal Time (UTC) and account for the daylight saving time.\n* The timezone is automatically detected by the component based on the camera location. In some situations, this might not be accurate.\nIn case of an inaccurate timezone, users can set it manually using the timezone dropdown.\n\n**See also**\n\n- [Sample - Shadow cast component](https://developers.arcgis.com/javascript/latest/sample-code/shadow-cast/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `getDurationAtScreen(point: __esri.Point): Promise<number>` - Returns the time (in milliseconds) spent in shadow for a certain point on the screen.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-ShadowCast-ShadowCastAnalysisView3D.html#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/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 cast. 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/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date)","values":[]},{"name":"discrete-interval","description":"Individual shadows are displayed at this time interval in \"discrete\" [mode](#mode), starting with the start time of\nday. The interval is expressed in milliseconds. If set to 0, we'll use the smallest possible interval, up to a\nmaximum of 255 samples.","values":[]},{"name":"end-time-of-day","description":"Time (in milliseconds from midnight of the [date](#date)) when the shadow cast computation should stop.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#endTimeOfDay)","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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 amount of shadow 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](#minDuration) property, in milliseconds.","values":[]},{"name":"min-duration","description":"The minimum duration (in milliseconds) used in \"min-duration\" [mode](#mode) to determine which shadow 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 the \"min-duration\" [mode](#mode). The [minDurationContextColor](#minDurationContextColor)\nand [minDurationContextInterval](#minDurationContextInterval) properties are used to configure the visualization of the\ndiscrete shadows when context is enabled.","values":[]},{"name":"min-duration-context-interval","description":"The interval in milliseconds used when showing additional context in \"min-duration\" [mode](#mode) when\n[minDurationContextEnabled](#contextEnabled) is true.","values":[]},{"name":"min-min-duration","description":"Minimum allowed value for the [minDuration](#minDuration) property, in milliseconds.","values":[]},{"name":"mode","description":"Mode of analysis to use when computing and displaying the shadows. There are 3 types:\n- \"discrete\": Displays individual shadow snapshots at regular time intervals within the selected time range.\n- \"min-duration\": Displays shadows only in areas where accumulated shading exceeds a user‑defined minimum duration\nwithin the selected time range. Optional discrete shadow overlays can provide additional context.\n- \"total-duration\": Displays total shadow accumulation within the selected time range using opacity: areas with\nlonger shadow duration appear more opaque. 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](#date)) when the shadow cast computation should start.\n\n[Read more](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-ShadowCastAnalysis.html#startTimeOfDay)","values":[]},{"name":"total-duration-mode","description":"Mode in which the cumulative shadow duration should be displayed in \"total-duration\" [mode](#mode): as a continuous\nsurface or as an hourly aggregation of values.","values":[{"name":"continuous"},{"name":"hourly"}]},{"name":"utc-offset","description":"The difference in hours between UTC time and the times displayed in the 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/arcgis-shadow-cast/"},{"name":"Shadow Cast","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-shadow-cast--demo&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/api-reference/esri-views-MapView.html) or a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).\n--\n\n### Events\n- **arcgisCreate**\n- **arcgisDelete**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisRedo**\n- **arcgisUndo**\n- **arcgisUpdate**\n\n### Methods\n- `cancel(): Promise<void>`\n- `complete(): Promise<void>`\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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- `duplicate(): Promise<void>`\n- `redo(): Promise<void>`\n- `triggerUpdate(graphic: Parameters<Sketch[\"update\"]>[0], updateOptions?: Parameters<Sketch[\"update\"]>[1]): Promise<void>`\n- `undo(): Promise<void>`","attributes":[{"name":"active-tool","description":"When creating new graphics (for example after [create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#create) has been called),\nthis property reflects the create tool being used. When updating graphics\n(for example after [update()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#update) has been called), this property reflects the\nupdate tool being used. If no create or update operation is in progress, this is `null`.\n\nPrior to 4.32, creation tools were modeled as a combination of a geometry type (point, line, polygon)\nand an interaction mode (click, freehand, hybrid).\nAt 4.32, the available create tools were expanded to include \"freehandPolyline\" and \"freehandPolygon\".\nThese tools are made available to enable interoperability with other components of the ArcGIS system,\nwhere freehand polyline is a distinct create tool from polyline.\n\nTo minimize compatibility issues, if \"freehandPolyline\" and \"freehandPolygon\" are not in the list\nof available create tools, they will not be returned by this property, even if the user is drawing a\npolygon in freehand mode.\n\nTo opt in to freehandPolyline and freehandPolygon tools, include them when setting availableCreateTools,\nand hideCreateTools* properties","values":[{"name":"circle"},{"name":"move"},{"name":"point"},{"name":"polygon"},{"name":"rectangle"},{"name":"text"},{"name":"reshape"},{"name":"polyline"},{"name":"transform"},{"name":"multipoint"},{"name":"mesh"},{"name":"freehandPolyline"},{"name":"freehandPolygon"},{"name":"lasso-selection"},{"name":"rectangle-selection"},{"name":"custom-selection"}]},{"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/arcgis-sketch/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"creation-mode","description":"Defines the default behavior once the [create()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Sketch.html#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/api-reference/esri-widgets-Sketch.html#update) operation once the `create` operation is completed.","values":[{"name":"single"},{"name":"update"},{"name":"continuous"}]},{"name":"default-graphics-layer-disabled","description":"By default, sketch will auto-create a new graphics layer if none was\nprovided. Set this prop to true to disable this behavior.","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-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","values":[]},{"name":"hide-selection-tools-rectangle-selection","values":[]},{"name":"hide-settings-menu","description":"Indicates whether to hide the settings menu. Currently this menu contains snapping options`.","values":[]},{"name":"hide-snapping-controls","description":"Indicates whether to hide the `SnappingControls` component.","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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#featureEnabled) property.","values":[]},{"name":"hide-snapping-controls-elements-layer-list","description":"Indicates whether to hide the [FeatureSnappingLayerSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-FeatureSnappingLayerSource.html) 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/api-reference/esri-views-interactive-snapping-SnappingOptions.html#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":"scale","description":"Determines the size of component elements.","values":[{"name":"s"},{"name":"m"},{"name":"l"}]},{"name":"show-create-tools-freehand-polygon","description":"Indicates whether to display the freehandPolygon tool. Default is `false`.","values":[]},{"name":"show-create-tools-freehand-polyline","description":"Indicates whether to display the freehandPolyline tool. Default is `false`.","values":[]},{"name":"show-snapping-controls-elements-header","description":"Indicates whether to display the header. Default is `false`.","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":"floating"},{"name":"docked"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-sketch/"},{"name":"Sketch","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-sketch--demo&singleStory=true"}]},{"name":"arcgis-slice","description":"The Slice component is a 3D analysis tool that can be used to reveal occluded content in a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/). It applies\n[slice analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\nto any layer type, making it possible to see inside buildings or to explore geological surfaces.\n\n[![slice](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/slice.gif)](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/index.html)\n\nThe slicing [shape](#shape)\nis always a [plane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html).\nBy default, the plane is either horizontal or vertical. To allow a tilt angle for the plane, set\n[tiltEnabled](#tiltEnabled)\nto `true`. The slice hides any content in front of the surface. The handles on the sides of the plane can be used to adjust\nthe size, heading, tilt, and position of the slice plane.\nThe [SlicePlane](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SlicePlane.html)\ncan be set or retrieved using the [shape](#shape) property.\n\nOnce the slice plane is applied, layers can be excluded from the slicing. For example, by excluding the sublayers which include\ncolumns and floor slabs, the inner structure of a building can investigated.\n\n[![slice-exclude](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/slice-exclude.png)](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 [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [SliceAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-SliceAnalysis.html)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clear the [shape](#shape) of the slice, effectively removing it from the view. Other properties like [excludedLayers](#excludedLayers)\nand [excludeGroundSurface](#excludeGroundSurface) are not modified.\nCalling this method changes the [state](#state) to `ready`.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Start the interactive placement of a new slice, clearing the previous [shape](#shape).\nCalling this method changes the [state](#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/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/api-reference/esri-Ground.html) 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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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":"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/arcgis-slice/"},{"name":"Slice","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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. At that point, new 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/api-reference/esri-renderers-visualVariables-SizeVariable.html).\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#fromRendererResult)\nmethod can be used to intelligently populate slider properties including [max](#max), [min](#min), [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html)\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/api-reference/esri-smartMapping-renderers-univariateColorSize.html#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\")!;\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\" as UnivariateTheme,\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 as ClassBreaksRenderer);\n  featureLayer.renderer = result;\n};\n\nbinaryColorSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nbinaryColorSizeSlider.addEventListener(\"arcgisThumbDrag\", 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 to be interacted with.\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>` - Create a promise that resolves once 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 BinaryColorSizeSlider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#RendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#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/api-reference/esri-widgets-smartMapping-BinaryColorSizeSlider.html#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/arcgis-slider-binary-color-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()](#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()](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-binary-color-size-legacy/"},{"name":"Slider Binary Color Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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, new 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/api-reference/esri-renderers-ClassBreaksRenderer.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![ClassedColorSlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/classedcolorslider-labels.png \"ClassedColorSlider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#fromRendererResult) method can be used to intelligently populate slider properties including\n[max](#max), [min](#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#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/api-reference/esri-smartMapping-renderers-color.html#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\")!;\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/api-reference/esri-renderers-ClassBreaksRenderer.html#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);\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 to be interacted with.\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>` - Create a promise that resolves once 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/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos)\nof a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) 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 [fromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedColorSlider.html#fromRendererResult) method.\n- `updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties a ClassedColorSlider from the result\nof the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#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/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()](#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()](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-classed-color-legacy/"},{"name":"Slider Classed Color (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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, new 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/api-reference/esri-renderers-ClassBreaksRenderer.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![ClassedSizeSlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/classedsizeslider-labels.png \"ClassedSizeSlider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#fromRendererResult) method can be used to intelligently populate slider properties including\n[max](#max), [min](#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#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/api-reference/esri-smartMapping-renderers-size.html#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\")!;\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/api-reference/esri-renderers-ClassBreaksRenderer.html#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)) as any;\n  featureLayer.renderer = renderer;\n};\n\nclassedSizeSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\nclassedSizeSlider.addEventListener(\"arcgisThumbDrag\", 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 to be interacted with.\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>` - Create a promise that resolves once 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/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos)\nof a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) 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 [fromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#fromRendererResult) method.\n- `updateFromRendererResult(rendererResult: ClassBreaksRendererResult, histogramResult?: HistogramResult): Promise<void>` - A convenience function used to update the properties a ClassedSizeSlider from the result\nof the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#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/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()](#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()](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-classed-size-legacy/"},{"name":"Slider Classed Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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, new 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/api-reference/esri-renderers-visualVariables-ColorVariable.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![ColorSlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/colorslider-2-labels.png \"ColorSlider with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSlider.html#fromRendererResult) method can be used to intelligently populate slider properties including\n[max](#max), [min](#min), the [color visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) configuration,\nand the slider's histogram after the renderer has been created from the result of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#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\")!;\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/api-reference/esri-renderers-visualVariables-ColorVariable.html)\nin a layer's renderer. It is the responsibility of the app developer\nto set up event listeners on this slider that update the color variable of the appropriate renderer.\n\n```js\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() as __esri.ColorVariable;\n  colorVariable.stops = colorSlider.stops;\n\n  renderer.visualVariables = [colorVariable];\n  featureLayer.renderer = renderer;\n};\n\ncolorSlider.addEventListener(\"arcgisThumbChange\", updateRendererFromSlider);\ncolorSlider.addEventListener(\"arcgisThumbDrag\", 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 to be interacted with.\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>` - Create a promise that resolves once 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 ColorSlider component instance from the\n[result](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#ContinuousRendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createContinuousRenderer)\nmethod. This method is used to configure an empty ColorSlider 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/arcgis-slider-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()](#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()](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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/arcgis-slider-color-legacy/"},{"name":"Slider Color (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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, new 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/api-reference/esri-renderers-visualVariables-ColorVariable.html) and\na [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html). 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/api-reference/esri-Camera.html) 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/img/apiref/widgets/sliders/colorsizeslider-perspective.png \"Slider Color Size with perspective\")\n\n<span id=\"image-annotations\"></span>\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/img/apiref/widgets/sliders/colorsizeslider-labels.png \"Slider Color Size with annotations\")\n\nThe [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ColorSizeSlider.html#fromRendererResult) method can be used to intelligently populate slider properties including\n[max](#max), [min](#min), [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) configuration,\n[color visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html) configuration, and the slider's histogram after the\nrenderer has been created from the result of the [createContinuousRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#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\")!;\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 matching [color](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-ColorVariable.html)\nand [size](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html) 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);\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 to be interacted with.\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>` - Create a promise that resolves once 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/api-reference/esri-smartMapping-renderers-univariateColorSize.html#RendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#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/api-reference/esri-smartMapping-renderers-univariateColorSize.html#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/arcgis-slider-color-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()](#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()](#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":"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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-color-size-legacy/"},{"name":"Slider Color Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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, new 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/api-reference/esri-renderers-HeatmapRenderer.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![HeatmapSlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/heatmapslider-labels.png \"HeatmapSlider 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/api-reference/esri-renderers-HeatmapRenderer.html#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](#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);\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 to be interacted with.\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>` - Create a promise that resolves once 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/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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-heatmap-legacy/"},{"name":"Slider Heatmap (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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, new 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/api-reference/esri-renderers-visualVariables-OpacityVariable.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![OpacitySlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/opacityslider-labels.png \"OpacitySlider with annotations\")\n\nThe [updateFromVisualVariableResult()](#updateFromVisualVariableResult()) method can be used to intelligently populate slider properties including [max](#max), [min](#min),\nthe [opacity visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-OpacityVariable.html) 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/api-reference/esri-smartMapping-renderers-opacity.html#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\")!;\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/api-reference/esri-renderers-visualVariables-OpacityVariable.html)\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);\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 to be interacted with.\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>` - Create a promise that resolves once 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/api-reference/esri-smartMapping-renderers-opacity.html#VisualVariableResult) of\nthe [createVisualVariable()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#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/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()](#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()](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-opacity-legacy/"},{"name":"Slider Opacity (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-slider-opacity-legacy--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, new 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/api-reference/esri-renderers-visualVariables-SizeVariable.html).\n\n<span id=\"image-annotations\"></span>\nSee the image below for a summary of the configurable options available on this slider.\n\n![SizeSlider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/sizeslider-labels.png \"SizeSlider with annotations\")\n\nThe [updateFromRendererResult()](#updateFromRendererResult) method can be used to intelligently populate slider properties including\n[max](#max), [min](#min), [size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html)\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/api-reference/esri-smartMapping-renderers-size.html#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\")!;\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/api-reference/esri-renderers-visualVariables-SizeVariable.html)\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] as __esri.SizeVariable;\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);\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 to be interacted with.\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>` - Create a promise that resolves once 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/api-reference/esri-smartMapping-renderers-size.html#ContinuousRendererResult) of\nthe [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#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: __esri.SizeVariable): __esri.SizeVariable | null | undefined` - A convenience function used to update the [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html)\nto match the values of the [stops](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SizeSlider.html#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/api-reference/esri-renderers-visualVariables-SizeVariable.html#minDataValue) and\n[maxDataValue](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html#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/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](#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](#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](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#values) and shouldn't be used exclusively\nfor 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":[]},{"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/arcgis-slider-size-legacy/"},{"name":"Slider Size (Legacy)","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-slider-size-legacy--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>` - Create a promise that resolves once 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/arcgis-color-select/"},{"name":"Color Select","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-color-select--demo&singleStory=true"}]},{"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>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"end-time","description":"The end time of the time range in milliseconds since midnight.","values":[]},{"name":"label","description":"The label for the component.","values":[]},{"name":"mode","values":[{"name":"range"},{"name":"single"}]},{"name":"start-time","description":"The start time of the time range in milliseconds since midnight.","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/arcgis-time-of-day-slider/"},{"name":"Time-of-day Slider","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-time-of-day-slider--demo&singleStory=true"}]},{"name":"arcgis-webgl-error","description":"Warning for WebGL errors.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 to be interacted with.\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>` - Create a promise that resolves once 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/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`, sets the component to a disabled state so the user cannot interact with it.","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](#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":[]},{"name":"swipe-position","description":"**Deprecated**: since 5.0, use [`position`](#position) instead.. The position of the Swipe component. This determines what percentage\nof the view will be taken up by the [startLayers](#startLayers).","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-swipe/"},{"name":"Swipe","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-Map.html).\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/api-reference/esri-widgets-TableList-ListItem.html) 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 than the value set set in [minDragEnabledItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minDragEnabledItems).","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input text string if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#visibleElements) is true.","values":[]},{"name":"hide-flow","description":"Determines whether the table list should be shown within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/) or if the flow component should be excluded. The table list will be displayed within its original flow component if set to `true`. The flow component will be omitted from the table list if set to `false`. To place the table list into an existing Calcite flow component, set this property to `false`.","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/api-reference/esri-widgets-TableList.html#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/api-reference/esri-widgets-TableList-TableListVisibleElements.html) 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/api-reference/esri-widgets-TableList.html#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":"multiple"},{"name":"single"},{"name":"single-persist"}]},{"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 then number of list items is equal to or greater than the value set in [TableList#minFilterItems](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#minFilterItems), allowing users to filter tables by their title.","values":[]},{"name":"show-heading","description":"Indicates whether to display the table list heading. The heading text is \"Table List\". The heading level can be set with the [TableList#headingLevel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TableList.html#headingLevel).","values":[]},{"name":"show-temporary-table-indicators","description":"Indicates whether temporary table indicators will be displayed for tables with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#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/arcgis-table-list/"},{"name":"Table List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-table-list--demo&singleStory=true"}]},{"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 to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `applyTimeSliderSettings(settings: Pick<__esri.TimeSliderProperties, \"fullTimeExtent\" | \"loop\" | \"stops\">): Promise<void>`\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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: __esri.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/arcgis-time-slider/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When `true`, sets the component to a disabled state so the user cannot interact with it.","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/api-reference/esri-widgets-TimeSlider.html#timeExtent) property's `start` and `end` dates to same date: `{start: sameDate, end: sameDate}` | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/timeslider/mode-instance.png\"> |\ntime-window           | The slider will show temporal data that falls within a given time range. This is the default. Set [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#timeExtent) property's `start` and `date` properties to desired dates. | <img alt=\"mode-instance\" src=\"https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/timeslider/mode-time-window.png\"> |\ncumulative-from-start | Similar to `time-window` with the start time is always pinned to the start of the slider. Set the [timeExtent](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html#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/img/apiref/widgets/timeslider/mode-from-start.png\"> |\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/api-reference/esri-widgets-TimeSlider.html#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/img/apiref/widgets/timeslider/mode-from-end.png\"> |","values":[{"name":"time-window"},{"name":"instant"},{"name":"cumulative-from-start"},{"name":"cumulative-from-end"}]},{"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/api-reference/esri-views-View.html) 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 [MapView#timeZone](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#timeZone). When a MapView 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 time are not adjusted for any timezone. [TimeSlider](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html) 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/arcgis-time-slider/"},{"name":"Time Slider","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-time-slider--demo&singleStory=true"}]},{"name":"arcgis-time-zone-label","description":"Time Zone Label is a component for displaying the current [time zone](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeZone) of a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).\nThe component has two states, collapsed as a small button and expanded displaying the internationalized name of the Map's time zone.\nUsers can toggle between these states by clicking the component's expand/collapse button.\nBy default the component is collapsed.\n\nWhen expanding, the component will lengthen inwards when [positioned](#position) within a Map.\nThis behavior can be overridden by setting the [expandDirection](#expandDirection) property to either `\"start\"` or `\"end\"`.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"disabled","description":"When `true`, sets the component to a disabled state so the user cannot interact with it.","values":[]},{"name":"expand-direction","description":"The direction the component will expand.\n\nBy default, the component will expand inward if assigned to a View UI corner. If the component is positioned manually,\nthe component will expand towards the \"end\" which is equivalent to right in a LTR application.","values":[{"name":"start"},{"name":"end"}]},{"name":"expanded","description":"The expanded state of 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":"position","values":[{"name":"bottom-left"},{"name":"bottom-right"},{"name":"top-left"},{"name":"top-right"},{"name":"manual"},{"name":"top-leading"},{"name":"top-trailing"},{"name":"bottom-leading"},{"name":"bottom-trailing"}]},{"name":"reference-element","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-time-zone-label/"},{"name":"Time Zone Label","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-time-zone-label--demo&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/en-US/docs/Web/API/Geolocation_API) which is only available in [secure contexts](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), 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/en-US/docs/Web/API/isSecureContext#browser_compatibility).\n\n**Known limitations**\n\n- The heading symbol is not currently supported within a [Scene component](https://developers.arcgis.com/javascript/latest/references/map-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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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 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":"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/en-US/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/api-reference/esri-views-MapView.html#constraints) to `false`.\nFor 2D views the value should be within the [effectiveMinScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints)\nand [effectiveMaxScale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#constraints).","values":[]},{"name":"visual-scale","description":"Specifies the size of the component.","values":[{"name":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-track/"},{"name":"Track","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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/api-reference/esri-widgets-UtilityNetworkAssociations.html#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/api-reference/esri-widgets-UtilityNetworkAssociations.html#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/arcgis-utility-network-associations/"}]},{"name":"arcgis-utility-network-trace","description":"Utility Network Trace component provides a way to run traces in a Utility Network based on connectivity or traversability from set input flags. Input flags (starting points and barriers) can be set by clicking the view.\n\n> The Utility Network Trace 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- **arcgisAddFlag**\n- **arcgisAddFlagComplete**\n- **arcgisAddFlagError**\n- **arcgisAddResultArea**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisRemoveResultArea**\n\n### Methods\n- `checkCanTrace(): Promise<void>`\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `confirmReset(): Promise<void>`\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/arcgis-utility-network-trace/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually withdrawn and cannot be interacted with.","values":[]},{"name":"enable-result-area","description":"When `true`, provides the ability to show the convex hull or buffer.","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":"select-on-complete-disabled","description":"When true, the utility network elements are selected in the view when traces are completed.","values":[]},{"name":"show-graphics-on-complete-disabled","description":"When true, a graphic layer is added to the view to highlight the utility network elements when traces are completed.","values":[]},{"name":"show-selection-attributes-disabled","description":"Determines whether to show list of selection attributes","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace/"},{"name":"Utility Network Trace","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-utility-network-trace--demo&singleStory=true"}]},{"name":"arcgis-utility-network-trace-analysis","description":"### Events\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\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- **arcgisTraceResultFeaturesReady** - Fires when the trace result features are ready.\nCheck property `traceResultFeatures` for the trace result features.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-utility-network-trace-analysis/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closable","values":[]},{"name":"icon","values":[]},{"name":"label","values":[]},{"name":"mode","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/arcgis-utility-network-trace-analysis/"},{"name":"Utility Network Trace Analysis","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-utility-network-trace-analysis--demo&singleStory=true"}]},{"name":"arcgis-utility-network-subnetwork-info","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a utility network and named trace configuration as input.\nThe sub-component displays information from the trace configuration relevant to subnetworks:\nDomain network name, tier name, and target tier name.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-subnetwork-info/"}]},{"name":"arcgis-utility-network-trace-inputs","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a map view as an input.\nIt allows users to select utility networks, trace configurations, and input features for tracing.\n--\n\n### Events\n- **arcgisPropertyChange**\n- **arcgisSelectedNamedTraceConfigurationChange** - Fires when the user changes the selected named trace configuration.\n- **arcgisTraceInputsChange** - There will be more added to this event as we increase the functionality of this component\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- **arcgisUtilityNetworkChange** - This will be fired less often than above, only when the utility network changes\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"mode","values":[{"name":"add-spatial"},{"name":"default"}]},{"name":"reference-element","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace-inputs/"}]},{"name":"arcgis-utility-network-trace-location","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a map view as an input.\nIt allows users to select locations on the map to use as trace inputs.\n--\n\n### Events\n- **arcgisTraceLocationChange**\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>` - Create a promise that resolves once component is fully loaded.","attributes":[{"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/arcgis-utility-network-trace-location/"}]},{"name":"arcgis-utility-network-trace-location-list","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component renders a collection of trace locations as a list.\n--\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"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/arcgis-utility-network-trace-location-list/"}]},{"name":"arcgis-utility-network-trace-results","description":"This is a sub-component used by the **ArcgisUtilityNetworkTraceAnalysis** component.\n\nThis sub-component takes a `TraceResult` instance as input.\nOptionally, the title of a trace configuration can be provided as a heading to display.\n--\n\n### Events\n- **arcgisSelectedLayerChange**\n- **arcgisSelectedResultTypeChange**\n- **arcgisTraceResultFeaturesReady**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.","attributes":[{"name":"is-elements-selected","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":"ready"},{"name":"loading"}]},{"name":"trace-config-title","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-trace-results/"}]},{"name":"arcgis-utility-network-validate-topology","description":"The UtilityNetworkValidateTopology component simplifies the process of validating a DirtyArea within a utility network. It offers an intuitive user interface, reducing the complexity of working with utility network associations.\n\n> The UtilityNetworkValidateTopology Component does not support proxied feature services or feature services that utilize stored credentials.\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/arcgis-utility-network-validate-topology/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"extent-to-validate","description":"Specifies the extent of the validation.","values":[{"name":"current"},{"name":"entire"}]},{"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/arcgis-utility-network-validate-topology/"}]},{"name":"arcgis-value-picker","description":"### Events\n- **arcgisAnimate**\n- **arcgisNext**\n- **arcgisPause**\n- **arcgisPlay**\n- **arcgisPrevious**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `next(): Promise<void>`\n- `pause(): Promise<void>`\n- `play(): Promise<void>`\n- `previous(): 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/arcgis-value-picker/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"can-next","description":"Returns `true` if the ValuePicker can be advanced to the next position.","values":[]},{"name":"can-play","description":"Returns `true` if the ValuePicker can be played.","values":[]},{"name":"can-previous","description":"Returns `true` if the ValuePicker can moved to the previous item.","values":[]},{"name":"caption","description":"An optional caption that appears on the ValuePicker component to give context for the user. This is particularly\nuseful when an application is using more than one ValuePicker component.","values":[]},{"name":"hide-next-button","description":"When set to `false`, the next button (or up button when vertical) is not displayed.","values":[]},{"name":"hide-play-button","description":"When set to `false`, the play/pause button is not displayed.","values":[]},{"name":"hide-previous-button","description":"When set to `false`, the previous button (or down button when vertical) is not 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":"layout","description":"Indicates if the component should be orientated horizontally (default) or vertically.\n\nPlease note that [ValuePickerCombobox](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerCombobox.html) and\n[ValuePickerLabel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker-ValuePickerLabel.html) do not support vertical layout.","values":[{"name":"horizontal"},{"name":"vertical"}]},{"name":"loop","description":"If true, playback will restart when it reaches the end.","values":[]},{"name":"play-rate","description":"The pause, in milliseconds between playback advancement.","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/arcgis-value-picker/"}]},{"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/api-reference/esri-views-View.html) 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 to be interacted with.\n- **arcgisVersioningStateChanged**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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","values":[]},{"name":"mode","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/arcgis-version-management/"},{"name":"Version Management","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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/api-reference/esri-layers-VideoLayer.html).\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>` - Create a promise that resolves once 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. ","attributes":[{"name":"attribution-mode","description":"The light or dark mode used to display the attribution.\nBy default, the mode is inherited from the [Calcite's mode](https://developers.arcgis.com/calcite-design-system/core-concepts/#modes).\nYou can override the value to style the attribution alongside the map or scene content.","values":[{"name":"light"},{"name":"dark"}]},{"name":"auto-destroy-disabled","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video/"}]},{"name":"arcgis-video-player","description":"The Video Player component provides a user interface for interacting with a [VideoLayer](api-reference/esri-layers-VideoLayer.html).\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\nThe [VideoPlayerViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-VideoPlayer-VideoPlayerViewModel.html) class provides the logic for the Video Player.\n\n**Known limitations**\n\n* Not supported in 3D [Scenes](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/).\n* Not supported on macOS and iOS devices.\n\n[![](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/video-player-video-preview.png)](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 to be interacted with.\n- **arcgisVideoReady**\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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-sensor"},{"name":"follow-frame"},{"name":"follow-both"}]},{"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","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-fullscreen-toggle","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-video-player/"}]},{"name":"arcgis-volume-measurement","description":"The Volume Measurement component can be added to a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-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/img/components/volume-measurement/volume_measurement_poster.png)\n\nVolume 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-  Volume Measurement component can only be added to a\n[Scene](https://developers.arcgis.com/javascript/latest/references/map-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/api-reference/esri-Map.html#ground),\n[IntegratedMeshLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMeshLayer.html)\nand an [IntegratedMesh3DTilesLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-IntegratedMesh3DTilesLayer.html).\n- This tool does not support WGS 1984 spatial reference in a local\n[viewing mode](https://developers.arcgis.com/javascript/latest/api-reference/esri-webscene-InitialViewProperties.html#viewingMode).\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/api-reference/esri-layers-FeatureLayer.html),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GraphicsLayer.html) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-BuildingSceneLayer.html).\n\n**See also**\n\n- [Volume Measurement Analysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurementAnalysis.html)\n- [VolumeMeasurementAnalysisView3D](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurementAnalysisView3D.html)\n- [VolumeMeasurementResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurement-VolumeMeasurementResult.html)\n- [VolumeMeasurementDisplayUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementDisplayUnits.html)\nand [VolumeMeasurementInputUnits](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-VolumeMeasurement-VolumeMeasurementInputUnits.html)\n- [VolumeMeasurementError](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-analysis-VolumeMeasurement-VolumeMeasurementError.html)\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 to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","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](#areadisplayunitoptions).","values":[{"name":"imperial"},{"name":"metric"},{"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/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](#elevationdisplayunitoptions).","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"name":"elevation-input-unit","description":"Unit used for inputting the cut and fill target elevation.\nPossible values are listed in [elevationInputUnitOptions](#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).","values":[{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"name":"heading-level","description":"Indicates the heading level to use for the headings in the component.","values":[{"name":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"name":"hide-area-display-unit-select","description":"Hides the area display unit dropdown.","values":[]},{"name":"hide-elevation-display-unit-select","description":"Hides the elevation display unit dropdown.","values":[]},{"name":"hide-elevation-input-unit-select","description":"Hides the elevation input unit dropdown.","values":[]},{"name":"hide-header","description":"Hides the header.","values":[]},{"name":"hide-mode-select","description":"Hides the mode selection dropdown.","values":[]},{"name":"hide-perimeter-display-unit-select","description":"Hides the perimeter display unit dropdown.","values":[]},{"name":"hide-unit-settings","description":"Hides the unit settings button.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"hide-volume-display-unit-select","description":"Hides the volume display unit dropdown.","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":"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](#perimeterdisplayunitoptions).","values":[{"name":"imperial"},{"name":"metric"},{"name":"inches"},{"name":"feet"},{"name":"yards"},{"name":"miles"},{"name":"nautical-miles"},{"name":"us-feet"},{"name":"millimeters"},{"name":"centimeters"},{"name":"decimeters"},{"name":"meters"},{"name":"kilometers"}]},{"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](#volumedisplayunitoptions).","values":[{"name":"imperial"},{"name":"metric"},{"name":"cubic-inches"},{"name":"cubic-feet"},{"name":"cubic-yards"},{"name":"cubic-miles"},{"name":"cubic-us-feet"},{"name":"liters"},{"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/arcgis-volume-measurement/"},{"name":"Volume Measurement","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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[Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\nThe available weather types are:\n[sunny](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html),\n[cloudy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html),\n[rainy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html),\n[snowy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html), and\n[foggy](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html).\n\nTo set the weather programmatically, apply the desired weather type to the\n[environment](https://developers.arcgis.com/javascript/latest/references/map-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` [viewing mode](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/#viewingMode),\n   * when `atmosphereEnabled` property on [environment](https://developers.arcgis.com/javascript/latest/references/map-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 [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-scene/) component.\n\n**See also**\n\n- [SunnyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SunnyWeather.html)\n- [CloudyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-CloudyWeather.html)\n- [RainyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-RainyWeather.html)\n- [SnowyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-SnowyWeather.html)\n- [FoggyWeather](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-3d-environment-FoggyWeather.html)\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 to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"1"},{"name":"2"},{"name":"4"},{"name":"3"},{"name":"5"},{"name":"6"}]},{"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/arcgis-weather/"},{"name":"Weather","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?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- **arcgisClick** - Emitted when one of the zoom controls is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Create a promise that resolves once 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/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":"s"},{"name":"m"},{"name":"l"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-zoom/"},{"name":"Zoom","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-zoom--demo&singleStory=true"}]}]}