@arcgis/map-components
Version:
ArcGIS Map Components
1 lines • 729 kB
JSON
{"$schema":"https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json","version":1.1,"tags":[{"name":"arcgis-area-measurement-2d","description":"The Area Measurement 2D component can be added to an [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent to calculate and display the area and perimeter of a polygon.\n\nHow areas and perimeters are computed depends on the map's spatial reference.\n\nIn **geographic coordinate systems** (GCS), and in **Web Mercator**, areas and perimeters are computed geodetically, taking into consideration the curvature of the planet.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, areas and perimeters are computed in a Euclidean manner (in their respective PCS).\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","attributes":[{"name":"auto-destroy-disabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"reference-element","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","values":[]},{"name":"unit","description":"Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in\n[unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/#unitOptions).","values":[{"name":"metric"},{"name":"imperial"},{"name":"square-inches"},{"name":"square-feet"},{"name":"square-yards"},{"name":"square-miles"},{"name":"square-nautical-miles"},{"name":"square-us-feet"},{"name":"square-millimeters"},{"name":"square-centimeters"},{"name":"square-decimeters"},{"name":"square-meters"},{"name":"square-kilometers"},{"name":"acres"},{"name":"ares"},{"name":"hectares"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/"},{"name":"Area Measurement 2D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-area-measurement-2d--demo&singleStory=true"}]},{"name":"arcgis-area-measurement-3d","description":"The Area Measurement 3D component can be added to an [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/)\ncomponent to calculate and display area and perimeter of polygons.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n\nHow the area and perimeter are computed depends on the scene's spatial reference and the length of the measured perimeter.\n\nIn **geographic coordinate systems** (GCS) and in **Web Mercator**:\n- If the measurement's perimeter is below 100 km, they are computed in a Euclidean manner,\n in an [ECEF](https://en.wikipedia.org/wiki/ECEF) coordinate system (or equivalent on other planets).\n- If the perimeter is above 100 km, they are computed geodetically, and the visualization takes\n the curvature of the planet into consideration.\n\nIn **projected coordinate systems** (PCS), apart from Web Mercator, the area and perimeter\nare always calculated in a Euclidean manner (in their respective PCS).\n\nThe area may be visualized and calculated in two ways:\n1. If all the vertices are mostly coplanar (lying on the same plane),\n the measurement polygon is formed on that plane, and area and perimeter are calculated from its geometry.\n2. If the vertices don't form a planar surface, the measurement polygon\n is projected to a horizontal plane, and area and perimeter are calculated from its geometry.\n\n\n\nWhen the component is active, a horizontal \"laser\" line is drawn which indicates the height at the current mouse position.\nThis line can help in analyzing the heights of objects relative to each other and the terrain.\n\n**Things to consider**\n\n* Area Measurement 3D is designed to work in the Scene component. For measurements in the [arcgis-map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/)\ncomponent, use [arcgis-area-measurement-2d](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-2d/).\n* Snapping is enabled by default. Holding the `CTRL` key disables it.\n* Layer types currently supported for snapping are:\n[FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/),\n[GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/) (except Mesh geometries),\n[GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/),\n[WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/),\n[CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),\n[3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/),\nand [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/).\n\n**See also**\n\n- [AreaMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/AreaMeasurementAnalysis/)\n- [Sample - Measurement in 3D](https://developers.arcgis.com/javascript/latest/sample-code/measurement-3d/)\n- [Sample - Analysis objects](https://developers.arcgis.com/javascript/latest/sample-code/analysis-objects/)\n--\n\n### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the current measurement.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): Promise<void>` - Starts a new measurement.","attributes":[{"name":"auto-destroy-disabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"hide-start-button","description":"If true, the button that starts a new measurement will be hidden.","values":[]},{"name":"hide-unit-select","description":"If true, the unit selection dropdown will be hidden.","values":[]},{"name":"hide-visualization","description":"Indicates whether the component's visualization is hidden in the view.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"reference-element","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","values":[]},{"name":"unit","description":"Unit system (imperial, metric) or specific unit used for displaying the area values. Possible values are listed in\n[unitOptions](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/#unitOptions).","values":[{"name":"metric"},{"name":"imperial"},{"name":"square-inches"},{"name":"square-feet"},{"name":"square-yards"},{"name":"square-miles"},{"name":"square-nautical-miles"},{"name":"square-us-feet"},{"name":"square-millimeters"},{"name":"square-centimeters"},{"name":"square-decimeters"},{"name":"square-meters"},{"name":"square-kilometers"},{"name":"acres"},{"name":"ares"},{"name":"hectares"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-area-measurement-3d/"},{"name":"Area Measurement 3D","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-area-measurement-3d--demo&singleStory=true"}]},{"name":"arcgis-attachments","description":"### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","attributes":[{"name":"auto-destroy-disabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-attachments/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"display-type","description":"String indicating how to [display](https://developers.arcgis.com/javascript/latest/references/core/widgets/Attachments/#displayType) the attachments.\n\n| Value | Description |\n| ------ | ----------- |\n| auto | Default value. If a feature layer's capabilities supports [resizing attachments](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#capabilities), the popup will display attachments in `preview` mode.|\n| preview | Shows a thumbnail image of the attachment.|\n| list | Shows a list of attachment links. |","values":[{"name":"list"},{"name":"auto"},{"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/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>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","attributes":[{"name":"active-basemap","description":"The map's current [basemap](https://developers.arcgis.com/javascript/latest/references/core/Map/#basemap).","values":[]},{"name":"auto-destroy-disabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"disabled","description":"When true, the component is visually withdrawn and cannot receive user interaction.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the message \"No basemaps available\"\nwhen no basemaps are available in the Basemap Gallery.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"reference-element","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-gallery/"},{"name":"Basemap Gallery","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-basemap-gallery--demo&singleStory=true"}]},{"name":"arcgis-basemap-layer-list","description":"The Basemap Layer List component provides a way to display a list of [Basemap](https://developers.arcgis.com/javascript/latest/references/core/Basemap/) layers and switch on/off their visibility. [Base layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#baseLayers) and [reference layers](https://developers.arcgis.com/javascript/latest/references/core/Basemap/#referenceLayers) are divided into separate sections. When editing is enabled, layers can be reordered by dragging and dropping between the lists and the title can be edited.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","attributes":[{"name":"auto-destroy-disabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"base-filter-text","description":"The value of the filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.","values":[]},{"name":"basemap-title","description":"The current basemap's title.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and heading are displayed.","values":[]},{"name":"drag-enabled","description":"Indicates whether [list items](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) may be reordered within the list by dragging and dropping.\nMapImageLayer [sublayers](https://developers.arcgis.com/javascript/latest/references/core/layers/MapImageLayer/#sublayers) can be reordered only within their parent MapImageLayer and can not be dragged out as a separate layer.","values":[]},{"name":"editing-title","description":"Indicates whether the form to edit the basemap's title is currently visible.\nAny edits made will only be shown locally and will not be saved.","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component's title (i.e. \"Navigation\").\nBy default, the basemap's title is rendered\nas a level 2 heading (e.g. `<h2>Navigation</h2>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-base-layers","description":"Indicates whether the base layers will be displayed.","values":[]},{"name":"hide-heading","description":"Indicates whether the basemap layer list displays a heading. The heading text is the title of the basemap. The heading level can be set with the [BasemapLayerList#headingLevel](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#headingLevel).","values":[]},{"name":"hide-reference-layers","description":"Indicates whether to the reference layers will be displayed.","values":[]},{"name":"hide-status-indicators","description":"Indicates whether the status indicators will be displayed.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) input box.","values":[]},{"name":"reference-element","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","values":[]},{"name":"reference-filter-text","description":"The value of the filter input text string if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/#showFilter) is true.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/BasemapLayerList/#selectedItems) property.\n\n| Value | Description |\n| ----- | ----------- |\n| multiple | Allows any number of items to be selected at once. This is useful when you want to apply an operation to multiple items at the same time. |\n| none | Disables selection. Use this when you want to prevent selecting items. |\n| single | Allows only one item to be selected at a time. If another item is selected, the previous selection is cleared. This is useful when you want to ensure that a maximum of one item is selected at a time. |\n| single-persist | Allows only one item to be selected at a time and prevents de-selection. Once an item is selected, it remains selected until another item is selected. This is useful when you want to ensure that there is always exactly one selected item. |","values":[{"name":"multiple"},{"name":"single"},{"name":"none"},{"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/references/core/widgets/BasemapLayerList/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-temporary-layer-indicators","description":"Indicates whether temporary layer indicators will be displayed for layers with [Layer#persistenceEnabled](https://developers.arcgis.com/javascript/latest/references/core/layers/Layer/#persistenceEnabled) set to `false`. A [temporary icon](https://developers.arcgis.com/calcite-design-system/icons/?icon=temporary&library=Calcite%20UI&query=temporary) will be displayed on the near side of the layer title.","values":[]},{"name":"visibility-appearance","description":"Determines the icons used to indicate visibility.\n\n| Value | Description | Example |\n| ----- | ----------- | ------- |\n| default | Displays view icons on the far side. Icons are hidden except on hover or if they have keyboard focus. See [view-visible](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-visible&library=Calcite%20UI&query=view) and [view-hide](https://developers.arcgis.com/calcite-design-system/icons/?icon=view-hide&library=Calcite%20UI&query=view) calcite icons. |  |\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. |  |","values":[{"name":"checkbox"},{"name":"default"}]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-layer-list/"},{"name":"Basemap Layer List","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-basemap-layer-list--demo&singleStory=true"}]},{"name":"arcgis-basemap-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>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `toggle(): Promise<any>` - Toggles to the [nextBasemap](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/#nextBasemap).","attributes":[{"name":"auto-destroy-disabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"next-basemap","description":"The next basemap for toggling.","values":[]},{"name":"reference-element","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","values":[]},{"name":"show-title","description":"Indicates if the Basemap title is displayed.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-basemap-toggle/"},{"name":"Basemap Toggle","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-basemap-toggle--demo&singleStory=true"}]},{"name":"arcgis-bookmarks","description":"The Bookmarks component allows end users to quickly navigate to a particular area of interest.\nIt displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/),\nwhich are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks).\n\nEach bookmark may contain the following properties: `name`, `thumbnail`, `viewpoint` (defines rotation, scale, and target geometry), and `timeExtent`.\nWhen a bookmark with a timeExtent is selected, the [arcgis-map.timeExtent](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeExtent) of the Map will be set to the timeExtent of the selected bookmark.\nTo disable time capability in the Bookmarks component, set [timeDisabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#timeDisabled) to `true`.\n\nStarting with version `5.1`, on [@arcgisBookmarkSelect](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#event-arcgisBookmarkSelect) the selected bookmark's name is announced to assistive technologies. Visit the [Accessibility guide](https://developers.arcgis.com/javascript/latest/accessibility/#assistive-technologies) to learn more\nabout live announcements supporting more audiences.\n\nThe Bookmarks component can be used to create, edit, reorder, and delete bookmarks.\nTo enable these features, set the following properties to `true`:\n[showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showAddBookmarkButton), [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showEditBookmarkButton), and [dragEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#dragEnabled).\n\n**Note:** Bookmarks are supported in a 3D [Scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) only if they come from a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks) or are provided manually from [bookmarks](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#bookmarks). [Presentation](https://developers.arcgis.com/javascript/latest/references/core/webscene/Presentation/) provides a similar experience for [WebScenes](https://developers.arcgis.com/javascript/latest/references/core/webscene/Presentation/).\n--\n\n### Events\n- **arcgisBookmarkEdit** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/) is edited.\n- **arcgisBookmarkSelect** - Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/) is selected.\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `goTo(bookmark: Bookmark): Promise<void>` - Zoom to a specific bookmark.","attributes":[{"name":"auto-destroy-disabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"bookmarks","description":"A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/references/core/webmap/Bookmark/)s. These are typically defined inside of a [WebMap](https://developers.arcgis.com/javascript/latest/references/core/WebMap/#bookmarks), but can also be defined manually, as shown in the code snippet below.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"disabled","description":"When true, the component is visually withdrawn and cannot receive user interaction.","values":[]},{"name":"drag-enabled","description":"Indicates if a Bookmark is able to be dragged in order to update its position in the list.","values":[]},{"name":"filter-placeholder","description":"Defines the text used as a placeholder when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showFilter) is set to `true`.","values":[]},{"name":"filter-text","description":"Defines the text used to filter the bookmarks when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-bookmarks/#showFilter) is set to `true`.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the message \"No bookmarks\" when no bookmarks\nare available. By default, this message is rendered\nas a level 2 heading (e.g. `<h2>No bookmarks</h2>`). Depending on the component's placement\nin your app, you may need to adjust this heading for proper semantics. This is\nimportant for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-thumbnail","description":"Indicates whether the thumbnail associated with the bookmark is hidden.","values":[]},{"name":"hide-time","description":"Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"reference-element","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","values":[]},{"name":"show-add-bookmark-button","description":"Indicates whether to display the button to add a new bookmark.","values":[]},{"name":"show-close-button","description":"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/components/arcgis-bookmarks/"},{"name":"Bookmarks","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-bookmarks--demo&singleStory=true"}]},{"name":"arcgis-building-explorer","description":"The Building Explorer component is used to filter and explore the various building elements of [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/). BuildingSceneLayers are complex digital models of buildings and interiors and can contain thousands of building elements grouped in sublayers. Using the Building Explorer component, buildings can be filtered by [level](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#level), [phase](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#phase) or by disciplines and categories.\nThe visibility of these elements can be configured using the component's [hideLevels](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hideLevels), [hidePhases](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hidePhases) and [hideDisciplines](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#hideDisciplines) properties.\n\n[](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-filter/)\n\nThe [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) to be explored have to be set on the [layers](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#layers) property of the component. When setting multiple layers, the filters set by the Building Explorer component will be applied on all layers. The component doesn't allow the user to select between multiple layers present in a scene.\n\nOften, [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) contain an _Overview_ [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingComponentSublayer/) that serves as an exterior shell and views the building model as a single feature. When a layer is added to the Building Explorer component, the visibility of the _Overview_ layer is turned off, so that the user can directly interact with the individual features in the _Full Model_ [BuildingGroupSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingGroupSublayer/).\n\nThe Level element of the Building Explorer component allows to select a single level in one or several buildings. When selecting a level, the levels above it are hidden and the levels below it become semi-transparent for added visual context.\n\nSome [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) include information indicating the phase in which building elements, such as doors or pipes, were created and, optionally, when they were demolished. If a layer has multiple construction phases, these will be displayed in the Construction phases element. When selecting a construction phase, all the building elements created during or before the phase are selected. Demolished building elements aren't displayed.\n\nDiscipline layers are [group layers](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingGroupSublayer/) that organize the [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/) content into architectural, structural, mechanical, or electrical groups. These layers contain a number of Category layers such as walls, windows, furniture, and lighting fixtures. These layers can be turned on and off in the Disciplines and Categories list.\n\nThe Building Explorer component can only display filters set by the component itself. Filters set by other applications will be ignored.\n\n**Known limitations**\n\nBuilding Explorer is only supported in a 3D [arcgis-scene](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scene/) component.\n\n**See also**\n\n- [Sample - Filter BuildingSceneLayer with Building Explorer](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-filter/)\n- [Sample - BuildingSceneLayer with Slice component](https://developers.arcgis.com/javascript/latest/sample-code/building-scene-layer-slice/)\n--\n\n### Events\n- **arcgisBuildingLevelChange** - Emitted when the user changes the selected building level, or when a new filter instance is loaded.\n- **arcgisBuildingPhaseChange** - Emitted when the user changes the selected construction phase, or when a new filter instance is loaded.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","attributes":[{"name":"auto-destroy-disabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the component title.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-disciplines","description":"If true, the disciplines tree will be hidden.","values":[]},{"name":"hide-levels","description":"If true, the levels filter will be hidden.","values":[]},{"name":"hide-phases","description":"If true, the phases filter 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":"level","description":"The currently selected value for the building level filter.","values":[]},{"name":"phase","description":"The currently selected value for the construction phase filter.\nConstruction phases are used to track site development for a [BuildingSceneLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/). Setting a construction phase in the Building Explorer selects everything in the layer which is already constructed at that phase (created phase <= selected phase) but not yet demolished (demolished phase > selected phase). The goal is to display what the building or construction site looks like at that selected phase.","values":[]},{"name":"reference-element","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","values":[]}],"references":[{"name":"Docs","url":"https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-building-explorer/"},{"name":"Building Explorer","url":"https://developers.arcgis.com/javascript/latest/storybook/map-components/index.html?path=/story/arcgis-building-explorer--demo&singleStory=true"}]},{"name":"arcgis-catalog-layer-list","description":"The Catalog Layer List provides a way to display and interact with [CatalogLayers](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/).\nThe component displays a list of layers in the [dynamicGroupLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CatalogLayer/#dynamicGroupLayer)\nand allows you to toggle their visibility.\n\nThe [ListItem](https://developers.arcgis.com/javascript/latest/references/core/widgets/LayerList/ListItem/) API provides access to each layer's properties, allows\nthe developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.\n--\n\n### Events\n- **arcgisClose** - Emitted when the component's close button is clicked.\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map or scene view is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.","attributes":[{"name":"auto-destroy-disabled","description":"If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#destroy) method when you are done to\nprevent memory leaks.","values":[]},{"name":"closed","description":"Indicates whether a component is closed. When `true`, the component will be hidden.","values":[]},{"name":"collapsed","description":"Indicates whether the component is collapsed.\nWhen collapsed, only the collapse button and the heading are displayed.","values":[]},{"name":"filter-placeholder","description":"Placeholder text used in the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter) is true.","values":[]},{"name":"filter-text","description":"The value of the filter input if [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter) is true.","values":[]},{"name":"heading-level","description":"Indicates the heading level to use for the heading of the component.\nBy default, the heading is rendered as a level 2 heading (e.g., `<h2>Catalog Layer List</h2>`).\nDepending on the component's placement in your app, you may need to adjust this heading for proper semantics.\nThis is important for meeting accessibility standards.","values":[{"name":"6"},{"name":"1"},{"name":"2"},{"name":"3"},{"name":"4"},{"name":"5"}]},{"name":"hide-status-indicators","description":"Indicates whether the status indicators will be displayed.","values":[]},{"name":"icon","description":"Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).","values":[]},{"name":"label","description":"The component's default label.","values":[]},{"name":"min-filter-items","description":"The minimum number of list items required to display the [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-catalog-layer-list/#showFilter) input box.","values":[]},{"name":"reference-element","description":"By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.","values":[]},{"name":"selection-mode","description":"Specifies the selection mode.\nSelected items are available in the [selectedItems](https://developers.arcgis.com/javascript/latest/references/core/widgets/CatalogLayerList/#selectedItems) property.\n\n| Value | Description |\n| ----- | ----------- |\n| multiple | Allows any number of items to be selected at once. This is useful when you want to apply an operation to multiple items at the same time. |\n| none | Disables selection. Use this when you want to prevent selecting items. |\n| single | Allows only one item to be selected at a time. If another item is selected, the previous selection is cleared. This is useful when you want to ensure that a maximum of one item is selected at a time. |\n| single-persist | Allows only one item to be selected at a time and prevents de-selection. Once an item is selected, it remains selected until another item is selected. This is useful when you want to ensure that there is always exactly one selected item. |","values":[{"name":"multiple"},{"name":"single"},{"name":"none"},{"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/references/core/widgets/CatalogLayerList/#minFilterItems), allowing users to filter layers by their title.","values":[]},{"name":"show-heading","description":"Indicates whether to display the component's heading. The heading text is \"Layer List\". The