UNPKG

@arcgis/map-components

Version:
1,023 lines (1,022 loc) • 846 kB
{ "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json", "name": "@arcgis/map-components", "version": "4.32.13", "description-markup": "markdown", "contributions": { "html": { "elements": [ { "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.", "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-2d/", "attributes": [ { "name": "auto-destroy-disabled", "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.", "default": "false", "value": { "type": "boolean" } }, { "name": "icon", "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "default": "\"measure-area\"", "value": { "type": "string" } }, { "name": "label", "description": "The component's default label.", "value": { "type": "string" } }, { "name": "position", "default": "\"bottom-left\"", "value": { "type": [ "\"bottom-leading\"", "\"bottom-left\"", "\"bottom-right\"", "\"bottom-trailing\"", "\"manual\"", "\"top-leading\"", "\"top-left\"", "\"top-right\"", "\"top-trailing\"" ] } }, { "name": "reference-element", "value": { "type": "string" } }, { "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)", "default": "\"disabled\"", "value": { "type": [ "\"disabled\"", "\"measured\"", "\"measuring\"", "\"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)", "value": { "type": [ "\"acres\"", "\"ares\"", "\"hectares\"", "\"imperial\"", "\"metric\"", "\"square-centimeters\"", "\"square-decimeters\"", "\"square-feet\"", "\"square-inches\"", "\"square-kilometers\"", "\"square-meters\"", "\"square-miles\"", "\"square-millimeters\"", "\"square-nautical-miles\"", "\"square-us-feet\"", "\"square-yards\"" ] } } ], "events": [ { "name": "arcgisPropertyChange", "type": "{ name: \"state\"; }", "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties." }, { "name": "arcgisReady", "type": "undefined", "description": "Emitted when the component associated with a map view is is ready to be interacted with." } ], "js": { "properties": [ { "name": "autoDestroyDisabled", "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.", "type": "boolean" }, { "name": "icon", "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "type": "string" }, { "name": "label", "description": "The component's default label.", "type": "string" }, { "name": "position", "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"" }, { "name": "referenceElement", "type": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string" }, { "name": "snappingOptions", "description": "The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#snappingOptions)", "type": "SnappingOptions" }, { "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)", "type": "\"disabled\" | \"measured\" | \"measuring\" | \"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)", "type": "\"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\" | \"square-centimeters\" | \"square-decimeters\" | \"square-feet\" | \"square-inches\" | \"square-kilometers\" | \"square-meters\" | \"square-miles\" | \"square-millimeters\" | \"square-nautical-miles\" | \"square-us-feet\" | \"square-yards\"" }, { "name": "unitOptions", "description": "List of available units and unit systems (imperial, metric) for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement2D.html#unitOptions)", "type": "Array<\"metric\" | \"imperial\" | \"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\">" } ], "events": [ { "name": "arcgisPropertyChange", "type": "{ name: \"state\"; }", "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties." }, { "name": "arcgisReady", "type": "undefined", "description": "Emitted when the component associated with a map view is is ready to be interacted with." } ] } }, { "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>`", "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-area-measurement-3d/", "attributes": [ { "name": "auto-destroy-disabled", "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.", "default": "false", "value": { "type": "boolean" } }, { "name": "icon", "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "default": "\"measure-area\"", "value": { "type": "string" } }, { "name": "label", "description": "The component's default label.", "value": { "type": "string" } }, { "name": "position", "default": "\"bottom-left\"", "value": { "type": [ "\"bottom-leading\"", "\"bottom-left\"", "\"bottom-right\"", "\"bottom-trailing\"", "\"manual\"", "\"top-leading\"", "\"top-left\"", "\"top-right\"", "\"top-trailing\"" ] } }, { "name": "reference-element", "value": { "type": "string" } }, { "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)", "default": "\"disabled\"", "value": { "type": [ "\"disabled\"", "\"measured\"", "\"measuring\"", "\"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)", "value": { "type": [ "\"acres\"", "\"ares\"", "\"hectares\"", "\"imperial\"", "\"metric\"", "\"square-centimeters\"", "\"square-decimeters\"", "\"square-feet\"", "\"square-inches\"", "\"square-kilometers\"", "\"square-meters\"", "\"square-miles\"", "\"square-millimeters\"", "\"square-nautical-miles\"", "\"square-us-feet\"", "\"square-yards\"" ] } } ], "events": [ { "name": "arcgisPropertyChange", "type": "{ name: \"state\" | \"analysis\"; }", "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties." }, { "name": "arcgisReady", "type": "undefined", "description": "Emitted when the component associated with a map view is is ready to be interacted with." } ], "js": { "properties": [ { "name": "analysis", "description": "The area measurement analysis object being created or modified by the widget.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#analysis)", "type": "AreaMeasurementAnalysis" }, { "name": "autoDestroyDisabled", "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.", "type": "boolean" }, { "name": "icon", "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "type": "string" }, { "name": "label", "description": "The component's default label.", "type": "string" }, { "name": "position", "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"" }, { "name": "referenceElement", "type": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string" }, { "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)", "type": "\"disabled\" | \"measured\" | \"measuring\" | \"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)", "type": "\"acres\" | \"ares\" | \"hectares\" | \"imperial\" | \"metric\" | \"square-centimeters\" | \"square-decimeters\" | \"square-feet\" | \"square-inches\" | \"square-kilometers\" | \"square-meters\" | \"square-miles\" | \"square-millimeters\" | \"square-nautical-miles\" | \"square-us-feet\" | \"square-yards\"" }, { "name": "unitOptions", "description": "List of available units and unit systems (imperial, metric) for displaying the area values.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-AreaMeasurement3D.html#unitOptions)", "type": "Array<\"metric\" | \"imperial\" | \"square-millimeters\" | \"square-centimeters\" | \"square-decimeters\" | \"square-meters\" | \"square-kilometers\" | \"square-inches\" | \"square-feet\" | \"square-yards\" | \"square-miles\" | \"square-nautical-miles\" | \"square-us-feet\" | \"acres\" | \"ares\" | \"hectares\">" } ], "events": [ { "name": "arcgisPropertyChange", "type": "{ name: \"state\" | \"analysis\"; }", "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties." }, { "name": "arcgisReady", "type": "undefined", "description": "Emitted when the component associated with a map view is is ready to be interacted with." } ] } }, { "name": "arcgis-attachments", "description": "### Events\n- **arcgisPropertyChange** - Emitted when the value of a property is changed. Use this to listen to changes to properties.\n- **arcgisReady** - Emitted when the component associated with a map 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.", "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-attachments/", "attributes": [ { "name": "auto-destroy-disabled", "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.", "default": "false", "value": { "type": "boolean" } }, { "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)", "default": "\"auto\"", "value": { "type": [ "\"auto\"", "\"list\"", "\"preview\"" ] } }, { "name": "hide-add-button", "default": "false", "value": { "type": "boolean" } }, { "name": "hide-add-submit-button", "default": "false", "value": { "type": "boolean" } }, { "name": "hide-cancel-add-button", "default": "false", "value": { "type": "boolean" } }, { "name": "hide-cancel-update-button", "default": "false", "value": { "type": "boolean" } }, { "name": "hide-delete-button", "default": "false", "value": { "type": "boolean" } }, { "name": "hide-error-message", "default": "false", "value": { "type": "boolean" } }, { "name": "hide-progress-bar", "default": "false", "value": { "type": "boolean" } }, { "name": "hide-update-button", "default": "false", "value": { "type": "boolean" } }, { "name": "icon", "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "default": "\"attachment\"", "value": { "type": "string" } }, { "name": "label", "description": "The component's default label.", "value": { "type": "string" } }, { "name": "position", "default": "\"bottom-left\"", "value": { "type": [ "\"bottom-leading\"", "\"bottom-left\"", "\"bottom-right\"", "\"bottom-trailing\"", "\"manual\"", "\"top-leading\"", "\"top-left\"", "\"top-right\"", "\"top-trailing\"" ] } }, { "name": "reference-element", "value": { "type": "string" } }, { "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)", "default": "\"ready\"", "value": { "type": [ "\"disabled\"", "\"loading\"", "\"ready\"" ] } } ], "events": [ { "name": "arcgisPropertyChange", "type": "{ name: \"state\" | \"submitting\"; }", "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties." }, { "name": "arcgisReady", "type": "undefined", "description": "Emitted when the component associated with a map view is is ready to be interacted with." } ], "js": { "properties": [ { "name": "autoDestroyDisabled", "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.", "type": "boolean" }, { "name": "capabilities", "description": "Configures the attachment editing functionality that can be performed by the user.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#capabilities)", "type": "AttachmentsCapabilities" }, { "name": "displayType", "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)", "type": "\"auto\" | \"list\" | \"preview\"" }, { "name": "graphic", "description": "The graphic for the attachments.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#graphic)", "type": "Graphic" }, { "name": "hideAddButton", "type": "boolean" }, { "name": "hideAddSubmitButton", "type": "boolean" }, { "name": "hideCancelAddButton", "type": "boolean" }, { "name": "hideCancelUpdateButton", "type": "boolean" }, { "name": "hideDeleteButton", "type": "boolean" }, { "name": "hideErrorMessage", "type": "boolean" }, { "name": "hideProgressBar", "type": "boolean" }, { "name": "hideUpdateButton", "type": "boolean" }, { "name": "icon", "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "type": "string" }, { "name": "label", "description": "The component's default label.", "type": "string" }, { "name": "position", "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"" }, { "name": "referenceElement", "type": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string" }, { "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)", "type": "\"disabled\" | \"loading\" | \"ready\"" }, { "name": "submitting", "description": "Indicates whether there is currently an attachment being added, updated or deleted.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Attachments.html#submitting)", "type": "boolean" } ], "events": [ { "name": "arcgisPropertyChange", "type": "{ name: \"state\" | \"submitting\"; }", "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties." }, { "name": "arcgisReady", "type": "undefined", "description": "Emitted when the component associated with a map view is is ready to be interacted with." } ] } }, { "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.", "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-gallery/", "attributes": [ { "name": "auto-destroy-disabled", "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to 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.", "default": "false", "value": { "type": "boolean" } }, { "name": "disabled", "description": "When `true`, sets the component to a disabled state so the user cannot interact with it.", "default": "false", "value": { "type": "boolean" } }, { "name": "heading-level", "description": "Indicates the heading level to use for the message \"No basemaps available\"\nwhen no basemaps are available in the BasemapGallery.", "default": "2", "value": { "type": [ "1", "2", "3", "4", "5", "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.", "default": "\"basemap\"", "value": { "type": "string" } }, { "name": "label", "description": "The component's default label.", "default": "\"\"", "value": { "type": "string" } }, { "name": "position", "default": "\"bottom-left\"", "value": { "type": [ "\"bottom-leading\"", "\"bottom-left\"", "\"bottom-right\"", "\"bottom-trailing\"", "\"manual\"", "\"top-leading\"", "\"top-left\"", "\"top-right\"", "\"top-trailing\"" ] } }, { "name": "reference-element", "value": { "type": "string" } }, { "name": "state", "description": "The current state of the component.", "default": "\"disabled\"", "value": { "type": [ "\"disabled\"", "\"loading\"", "\"ready\"", "\"unsupported\"" ] } } ], "events": [ { "name": "arcgisPropertyChange", "type": "{ name: \"state\" | \"activeBasemap\"; }", "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties." }, { "name": "arcgisReady", "type": "undefined", "description": "Emitted when the component associated with a map view is is ready to be interacted with." } ], "js": { "properties": [ { "name": "activeBasemap", "description": "The map's current [basemap](https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html#basemap).", "type": "Basemap" }, { "name": "autoDestroyDisabled", "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.", "type": "boolean" }, { "name": "disabled", "description": "When `true`, sets the component to a disabled state so the user cannot interact with it.", "type": "boolean" }, { "name": "headingLevel", "description": "Indicates the heading level to use for the message \"No basemaps available\"\nwhen no basemaps are available in the BasemapGallery.", "type": "1 | 2 | 3 | 4 | 5 | 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.", "type": "string" }, { "name": "label", "description": "The component's default label.", "type": "string" }, { "name": "position", "type": "\"bottom-leading\" | \"bottom-left\" | \"bottom-right\" | \"bottom-trailing\" | \"manual\" | \"top-leading\" | \"top-left\" | \"top-right\" | \"top-trailing\"" }, { "name": "referenceElement", "type": "ArcgisLinkChart | ArcgisMap | ArcgisScene | string" }, { "name": "source", "description": "The source for basemaps that the component will display.", "type": "LocalBasemapsSource | PortalBasemapsSource" }, { "name": "state", "description": "The current state of the component.", "type": "\"disabled\" | \"loading\" | \"ready\" | \"unsupported\"" } ], "events": [ { "name": "arcgisPropertyChange", "type": "{ name: \"state\" | \"activeBasemap\"; }", "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties." }, { "name": "arcgisReady", "type": "undefined", "description": "Emitted when the component associated with a map view is is ready to be interacted with." } ] } }, { "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.", "doc-url": "https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-layer-list/", "attributes": [ { "name": "auto-destroy-disabled", "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.", "default": "false", "value": { "type": "boolean" } }, { "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)", "default": "\"\"", "value": { "type": "string" } }, { "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)", "value": { "type": "string" } }, { "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)", "default": "false", "value": { "type": "boolean" } }, { "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)", "default": "false", "value": { "type": "boolean" } }, { "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)", "default": "false", "value": { "type": "boolean" } }, { "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)", "default": "\"\"", "value": { "type": "string" } }, { "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)", "default": "2", "value": { "type": "number" } }, { "name": "hide-base-layers", "default": "false", "value": { "type": "boolean" } }, { "name": "hide-flow", "default": "false", "value": { "type": "boolean" } }, { "name": "hide-heading", "default": "false", "value": { "type": "boolean" } }, { "name": "hide-reference-layers", "default": "false", "value": { "type": "boolean" } }, { "name": "hide-status-indicators", "default": "false", "value": { "type": "boolean" } }, { "name": "icon", "description": "Icon which represents the component.\nTypically used when the component is controlled by another component (e.g. by the Expand component).\nSearch [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.", "default": "\"layers\"", "value": { "type": "string" } }, { "name": "label", "description": "The component's default label.", "value": { "type": "string" } }, { "name": "min-filter-items", "description": "The minimum number of list items required to display the visibleElements.filter input box.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#minFilterItems)", "default": "10", "value": { "type": "number" } }, { "name": "position", "default": "\"bottom-left\"", "value": { "type": [ "\"bottom-leading\"", "\"bottom-left\"", "\"bottom-right\"", "\"bottom-trailing\"", "\"manual\"", "\"top-leading\"", "\"top-left\"", "\"top-right\"", "\"top-trailing\"" ] } }, { "name": "reference-element", "value": { "type": "string" } }, { "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)", "default": "\"\"", "value": { "type": "string" } }, { "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)", "default": "\"none\"", "value": { "type": [ "\"multiple\"", "\"none\"", "\"single\"", "\"single-persist\"" ] } }, { "name": "show-close-button", "default": "false", "value": { "type": "boolean" } }, { "name": "show-collapse-button", "default": "false", "value": { "type": "boolean" } }, { "name": "show-edit-title-button", "default": "false", "value": { "type": "boolean" } }, { "name": "show-errors", "default": "false", "value": { "type": "boolean" } }, { "name": "show-filter", "default": "false", "value": { "type": "boolean" } }, { "name": "show-temporary-layer-indicators", "default": "false", "value": { "type": "boolean" } }, { "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)", "default": "\"disabled\"", "value": { "type": [ "\"disabled\"", "\"loading\"", "\"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)", "default": "\"default\"", "value": { "type": [ "\"checkbox\"", "\"default\"" ] } } ], "events": [ { "name": "arcgisPropertyChange", "type": "{ name: \"state\"; }", "description": "Emitted when the value of a property is changed. Use this to listen to changes to properties." }, { "name": "arcgisReady", "type": "undefined", "description": "Emitted when the component associated with a map view is is ready to be interacted with." }, { "name": "arcgisTriggerAction", "type": "BasemapLayerListTriggerActionEvent", "description": "Emitted when an action is triggered on the component." } ], "js": { "properties": [ { "name": "autoDestroyDisabled", "description": "If true, the component will not be destroyed automatically when it is\ndisconnected from the document. This is useful when you want to move the\ncomponent to a different place on the page, or temporarily hide it. If this\nis set, make sure to call the \\`destroy\\` method when you are done to prevent\nmemory leaks.", "type": "boolean" }, { "name": "baseFilterPredicate", "description": "Specifies a function to handle filtering base layer [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#baseFilterPredicate)", "type": "(((item: ListItem) => void))" }, { "name": "baseFilterText", "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)", "type": "string" }, { "name": "baseItems", "description": "A collection of ListItems representing the baseLayers.", "type": "Collection<ListItem>" }, { "name": "baseListItemCreatedFunction", "description": "Specifies a function that accesses each [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) representing a base layer.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#baseListItemCreatedFunction)", "type": "(((event: any) => void))" }, { "name": "basemapTitle", "description": "The current basemap's title.\n\n[Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-BasemapLayerList.html#basemapTitle)", "type": "string" },