UNPKG

@arcgis/map-components

Version:
1,306 lines • 348 kB
{ "$schema": "https://raw.githubusercontent.com/microsoft/vscode-html-languageservice/main/docs/customData.schema.json", "version": 1.1, "tags": [ { "name": "arcgis-area-measurement-2d", "description": "AreaMeasurement2D component calculates and displays the area and perimeter of a polygon only in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).\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 view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - 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\\` method when you are done to prevent\nmemory 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).\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": "position", "values": [ { "name": "bottom-leading" }, { "name": "bottom-left" }, { "name": "bottom-right" }, { "name": "bottom-trailing" }, { "name": "manual" }, { "name": "top-leading" }, { "name": "top-left" }, { "name": "top-right" }, { "name": "top-trailing" } ] }, { "name": "reference-element", "values": [] }, { "name": "state", "description": "The ViewModel's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D-AreaMeasurement2DViewModel.html#state)", "values": [ { "name": "disabled" }, { "name": "measured" }, { "name": "measuring" }, { "name": "ready" } ] }, { "name": "unit", "description": "Unit system (imperial, metric) or specific unit used for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unit)", "values": [ { "name": "acres" }, { "name": "ares" }, { "name": "hectares" }, { "name": "imperial" }, { "name": "metric" }, { "name": "square-centimeters" }, { "name": "square-decimeters" }, { "name": "square-feet" }, { "name": "square-inches" }, { "name": "square-kilometers" }, { "name": "square-meters" }, { "name": "square-miles" }, { "name": "square-millimeters" }, { "name": "square-nautical-miles" }, { "name": "square-us-feet" }, { "name": "square-yards" } ] } ], "references": [ { "name": "Docs", "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/" }, { "name": "Demo", "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": "AreaMeasurement3D component calculates and displays the area and perimeter of a polygon. This component can be used in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html) to measure the area and perimeter of a polygon.\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 view is is ready to be interacted with.\n\n### Methods\n- `clear(): Promise<void>` - Clears the component.\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\n- `start(): 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\\` method when you are done to prevent\nmemory 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).\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": "position", "values": [ { "name": "bottom-leading" }, { "name": "bottom-left" }, { "name": "bottom-right" }, { "name": "bottom-trailing" }, { "name": "manual" }, { "name": "top-leading" }, { "name": "top-left" }, { "name": "top-right" }, { "name": "top-trailing" } ] }, { "name": "reference-element", "values": [] }, { "name": "state", "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D-AreaMeasurement3DViewModel.html#state)", "values": [ { "name": "disabled" }, { "name": "measured" }, { "name": "measuring" }, { "name": "ready" } ] }, { "name": "unit", "description": "Unit system (imperial, metric) or specific unit used for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unit)", "values": [ { "name": "acres" }, { "name": "ares" }, { "name": "hectares" }, { "name": "imperial" }, { "name": "metric" }, { "name": "square-centimeters" }, { "name": "square-decimeters" }, { "name": "square-feet" }, { "name": "square-inches" }, { "name": "square-kilometers" }, { "name": "square-meters" }, { "name": "square-miles" }, { "name": "square-millimeters" }, { "name": "square-nautical-miles" }, { "name": "square-us-feet" }, { "name": "square-yards" } ] } ], "references": [ { "name": "Docs", "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/" }, { "name": "Demo", "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 view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - 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\\` method when you are done to prevent\nmemory leaks.", "values": [] }, { "name": "display-type", "description": "A string value indicating how to display an attachment.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#displayType)", "values": [ { "name": "auto" }, { "name": "list" }, { "name": "preview" } ] }, { "name": "hide-add-button", "values": [] }, { "name": "hide-add-submit-button", "values": [] }, { "name": "hide-cancel-add-button", "values": [] }, { "name": "hide-cancel-update-button", "values": [] }, { "name": "hide-delete-button", "values": [] }, { "name": "hide-error-message", "values": [] }, { "name": "hide-progress-bar", "values": [] }, { "name": "hide-update-button", "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": "position", "values": [ { "name": "bottom-leading" }, { "name": "bottom-left" }, { "name": "bottom-right" }, { "name": "bottom-trailing" }, { "name": "manual" }, { "name": "top-leading" }, { "name": "top-left" }, { "name": "top-right" }, { "name": "top-trailing" } ] }, { "name": "reference-element", "values": [] }, { "name": "state", "description": "The current state of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments-AttachmentsViewModel.html#state)", "values": [ { "name": "disabled" }, { "name": "loading" }, { "name": "ready" } ] } ], "references": [ { "name": "Docs", "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-attachments/" }, { "name": "Demo", "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-attachments--demo&singleStory=true" } ] }, { "name": "arcgis-basemap-gallery", "description": "BasemapGallery 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 BasemapGallery, 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 view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - 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\\` method when you are done to prevent\nmemory 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 BasemapGallery.", "values": [ { "name": "1" }, { "name": "2" }, { "name": "3" }, { "name": "4" }, { "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).\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": "position", "values": [ { "name": "bottom-leading" }, { "name": "bottom-left" }, { "name": "bottom-right" }, { "name": "bottom-trailing" }, { "name": "manual" }, { "name": "top-leading" }, { "name": "top-left" }, { "name": "top-right" }, { "name": "top-trailing" } ] }, { "name": "reference-element", "values": [] }, { "name": "state", "description": "The current state of the component.", "values": [ { "name": "disabled" }, { "name": "loading" }, { "name": "ready" }, { "name": "unsupported" } ] } ], "references": [ { "name": "Docs", "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/" }, { "name": "Demo", "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-basemap-gallery--demo&singleStory=true" } ] }, { "name": "arcgis-basemap-layer-list", "description": "BasemapLayerList 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- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map view is is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<void>` - 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\\` method when you are done to prevent\nmemory 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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#baseFilterText)", "values": [] }, { "name": "basemap-title", "description": "The current basemap's title.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#basemapTitle)", "values": [] }, { "name": "collapsed", "description": "Indicates whether the widget is collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#collapsed)", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#dragEnabled)", "values": [] }, { "name": "editing-title", "description": "Indicates whether the form to edit the basemap's title is currently visible.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#editingTitle)", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#filterPlaceholder)", "values": [] }, { "name": "heading-level", "description": "Indicates the heading level to use for the widget title (i.e.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#headingLevel)", "values": [] }, { "name": "hide-base-layers", "values": [] }, { "name": "hide-flow", "values": [] }, { "name": "hide-heading", "values": [] }, { "name": "hide-reference-layers", "values": [] }, { "name": "hide-status-indicators", "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": "min-filter-items", "description": "The minimum number of list items required to display the visibleElements.filter input box.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#minFilterItems)", "values": [] }, { "name": "position", "values": [ { "name": "bottom-leading" }, { "name": "bottom-left" }, { "name": "bottom-right" }, { "name": "bottom-trailing" }, { "name": "manual" }, { "name": "top-leading" }, { "name": "top-left" }, { "name": "top-right" }, { "name": "top-trailing" } ] }, { "name": "reference-element", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#referenceFilterText)", "values": [] }, { "name": "selection-mode", "description": "Specifies the selection mode.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#selectionMode)", "values": [ { "name": "multiple" }, { "name": "none" }, { "name": "single" }, { "name": "single-persist" } ] }, { "name": "show-close-button", "values": [] }, { "name": "show-collapse-button", "values": [] }, { "name": "show-edit-title-button", "values": [] }, { "name": "show-errors", "values": [] }, { "name": "show-filter", "values": [] }, { "name": "show-temporary-layer-indicators", "values": [] }, { "name": "state", "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList-BasemapLayerListViewModel.html#state)", "values": [ { "name": "disabled" }, { "name": "loading" }, { "name": "ready" } ] }, { "name": "visibility-appearance", "description": "Determines the icons used to indicate visibility.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#visibilityAppearance)", "values": [ { "name": "checkbox" }, { "name": "default" } ] } ], "references": [ { "name": "Docs", "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/" }, { "name": "Demo", "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-basemap-layer-list--demo&singleStory=true" } ] }, { "name": "arcgis-basemap-toggle", "description": "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 view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - 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\nit is disconnected from the document. This is useful when you\nwant to move the component to a different place on the page, or\ntemporary hide it. If this is set, make sure to call the\n\\`destroy\\` method when you are done to prevent 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": "position", "values": [ { "name": "bottom-leading" }, { "name": "bottom-left" }, { "name": "bottom-right" }, { "name": "bottom-trailing" }, { "name": "manual" }, { "name": "top-leading" }, { "name": "top-left" }, { "name": "top-right" }, { "name": "top-trailing" } ] }, { "name": "reference-element", "values": [] }, { "name": "show-title", "description": "Indicates if the Basemap title is displayed.", "values": [] }, { "name": "state", "description": "The current state of the component.", "values": [ { "name": "disabled" }, { "name": "incompatible-next-basemap" }, { "name": "loading" }, { "name": "ready" } ] } ], "references": [ { "name": "Docs", "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/" }, { "name": "Demo", "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-basemap-toggle--demo&singleStory=true" } ] }, { "name": "arcgis-bookmarks", "description": "Bookmarks component allow end users to quickly navigate to a particular area of interest. It displays a list of [bookmarks](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html), which are typically defined inside the [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks).\n--\n\n### Events\n- **arcgisEdit**\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map view is is ready to be interacted with.\n- **arcgisSelect** - Emitted when the component is selected.\n\n### Methods\n- `componentOnReady(): Promise<void>` - 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\\` method when you are done to prevent\nmemory leaks.", "values": [] }, { "name": "disabled", "description": "When true, the widget is visually withdrawn and cannot be interacted with.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#disabled)", "values": [] }, { "name": "drag-enabled", "description": "Indicates if a Bookmark is able to be dragged in order to update its position in the list.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#dragEnabled)", "values": [] }, { "name": "filter-placeholder", "description": "Defines the text used as a placeholder when visibleElements.filter is set to `true`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#filterPlaceholder)", "values": [] }, { "name": "filter-text", "description": "Defines the text used to filter the bookmarks when visibleElements.filter is set to `true`.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks.html#filterText)", "values": [] }, { "name": "hide-flow", "values": [] }, { "name": "hide-thumbnail", "values": [] }, { "name": "hide-time", "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": "position", "values": [ { "name": "bottom-leading" }, { "name": "bottom-left" }, { "name": "bottom-right" }, { "name": "bottom-trailing" }, { "name": "manual" }, { "name": "top-leading" }, { "name": "top-left" }, { "name": "top-right" }, { "name": "top-trailing" } ] }, { "name": "reference-element", "values": [] }, { "name": "show-add-bookmark-button", "values": [] }, { "name": "show-close-button", "values": [] }, { "name": "show-collapse-button", "values": [] }, { "name": "show-edit-bookmark-button", "values": [] }, { "name": "show-filter", "values": [] }, { "name": "show-heading", "values": [] }, { "name": "state", "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel.html#state)", "values": [ { "name": "loading" }, { "name": "ready" } ] } ], "references": [ { "name": "Docs", "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/" }, { "name": "Demo", "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-bookmarks--demo&singleStory=true" } ] }, { "name": "arcgis-building-explorer", "description": "BuildingExplorer component is used to filter and explore the various components 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 components grouped in sublayers. Using this component, buildings can be filtered by level, construction phase or by disciplines and categories.\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 view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - 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\\` method when you are done to prevent\nmemory leaks.", "values": [] }, { "name": "heading-level", "description": "Indicates the heading level to use for the headings in the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer.html#headingLevel)", "values": [] }, { "name": "hide-disciplines", "values": [] }, { "name": "hide-levels", "values": [] }, { "name": "hide-phases", "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": "position", "values": [ { "name": "bottom-leading" }, { "name": "bottom-left" }, { "name": "bottom-right" }, { "name": "bottom-trailing" }, { "name": "manual" }, { "name": "top-leading" }, { "name": "top-left" }, { "name": "top-right" }, { "name": "top-trailing" } ] }, { "name": "reference-element", "values": [] }, { "name": "state", "description": "The current state of the view model that can be used for rendering the UI of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BuildingExplorer-BuildingExplorerViewModel.html#state)", "values": [ { "name": "disabled" }, { "name": "failed" }, { "name": "loading" }, { "name": "ready" } ] } ], "references": [ { "name": "Docs", "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-building-explorer/" }, { "name": "Demo", "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-building-explorer--demo&singleStory=true" } ] }, { "name": "arcgis-catalog-layer-list", "description": "The CatalogLayerList component provides a way to display and interact with CatalogLayers.\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 view is is ready to be interacted with.\n- **arcgisTriggerAction** - Emitted when an action is triggered on the component.\n\n### Methods\n- `componentOnReady(): Promise<void>` - 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\\` method when you are done to prevent\nmemory leaks.", "values": [] }, { "name": "collapsed", "description": "Indicates whether the widget is collapsed.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#collapsed)", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#filterPlaceholder)", "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.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#filterText)", "values": [] }, { "name": "heading-level", "description": "Indicates the heading level to use for the heading of the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#headingLevel)", "values": [] }, { "name": "hide-flow", "values": [] }, { "name": "hide-status-indicators", "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": "min-filter-items", "description": "The minimum number of list items required to display the visibleElements.filter input box.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#minFilterItems)", "values": [] }, { "name": "position", "values": [ { "name": "bottom-leading" }, { "name": "bottom-left" }, { "name": "bottom-right" }, { "name": "bottom-trailing" }, { "name": "manual" }, { "name": "top-leading" }, { "name": "top-left" }, { "name": "top-right" }, { "name": "top-trailing" } ] }, { "name": "reference-element", "values": [] }, { "name": "selection-mode", "description": "Specifies the selection mode.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#selectionMode)", "values": [ { "name": "multiple" }, { "name": "none" }, { "name": "single" }, { "name": "single-persist" } ] }, { "name": "show-close-button", "values": [] }, { "name": "show-collapse-button", "values": [] }, { "name": "show-errors", "values": [] }, { "name": "show-filter", "values": [] }, { "name": "show-heading", "values": [] }, { "name": "show-temporary-layer-indicators", "values": [] }, { "name": "state", "description": "The view model's state.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList-CatalogLayerListViewModel.html#state)", "values": [ { "name": "disabled" }, { "name": "loading" }, { "name": "ready" } ] }, { "name": "visibility-appearance", "description": "Determines the icons used to indicate visibility.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-CatalogLayerList.html#visibilityAppearance)", "values": [ { "name": "checkbox" }, { "name": "default" } ] } ], "references": [ { "name": "Docs", "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-catalog-layer-list/" }, { "name": "Demo", "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 view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy(): Promise<void>` - Permanently destroy the component.\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\\` method when you are done to prevent\nmemory leaks.", "values": [] }, { "name": "icon", "values": [] }, { "name": "label", "description": "The component's default label.", "values": [] }, { "name": "position", "values": [ { "name": "bottom-leading" }, { "name": "bottom-left" }, { "name": "bottom-right" }, { "name": "bottom-trailing" }, { "name": "manual" }, { "name": "top-leading" }, { "name": "top-left" }, { "name": "top-right" }, { "name": "top-trailing" } ] }, { "name": "reference-element", "values": [] }, { "name": "state", "description": "The current state of the component.", "values": [ { "name": "compass" }, { "name": "disabled" }, { "name": "rotation" } ] } ], "references": [ { "name": "Docs", "url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-compass/" }, { "name": "Demo", "url": "https://developers.arcgis.com/javascript/latest/storybook/map-components/?path=/story/arcgis-compass--demo&singleStory=true" } ] }, { "name": "arcgis-coordinate-conversion", "description": "CoordinateConversion component provides a way to display user cursor position either as map coordinates or as any of several popular coordinate notations. Additionally, the component provides a way to convert user input coordinates into a [Point](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Point.html).\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 view is is ready to be interacted with.\n\n### Methods\n- `componentOnReady(): Promise<void>` - Create a promise that resolves once component is fully loaded.\n- `destroy():