▾
import "@arcgis/map-components/components/arcgis-basemap-toggle";- Inheritance
- ArcgisBasemapToggle→
HTMLElement
- Since
- ArcGIS Maps SDK for JavaScript 4.28
The Basemap Toggle component allows an end-user to switch between two basemaps.
The basemaps can have different spatial references.
Starting at 5.2, when the activeBasemap changes, the selected basemap is announced to assistive technologies.
Visit the Accessibility guide to learn more about live announcements supporting more audiences.
Demo
Properties
| Property | Attribute | Type |
|---|---|---|
| readonly | | |
| auto-destroy-disabled | ||
| icon | ||
| label | ||
| | ||
| next-basemap | ||
| reference-element | ||
| show-title | ||
| readonly | | |
| |
autoDestroyDisabled
- Type
- boolean
If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the destroy() method when you are done to prevent memory leaks.
- Attribute
- auto-destroy-disabled
- Default value
- false
- Example
- <arcgis-basemap-toggle auto-destroy-disabled></arcgis-basemap-toggle>basemapToggleElement.autoDestroyDisabled = true;
nextBasemap
- Type
- BasemapProperties | string | undefined
The next basemap for toggling.
- Attribute
- next-basemap
referenceElement
- Type
- ArcgisReferenceElement | string | undefined
By assigning the id attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
- Attribute
- reference-element
showTitle
- Type
- boolean
Indicates if the Basemap title is displayed.
- Attribute
- show-title
- Default value
- false
view
- Type
- MapViewOrSceneView | undefined
The view associated with the component.
Note: The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this
viewproperty which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-basemap-toggle component will be associated with a map or scene component rather than using theviewproperty.
Methods
| Method | Signature |
|---|---|
| inherited | componentOnReady(): Promise<this> |
| destroy(): Promise<void> | |
| toggle(): Promise<any> |
componentOnReady
- Signature
-
componentOnReady (): Promise<this>
Creates a promise that resolves once the component is fully loaded.
- Returns
- Promise<this>
- Example
- const arcgisBasemapToggle = document.createElement("arcgis-basemap-toggle");document.body.append(arcgisBasemapToggle);await arcgisBasemapToggle.componentOnReady();console.log("arcgis-basemap-toggle is ready to go!");
Events
| Name | Type |
|---|---|
| CustomEvent<{ name: "activeBasemap" | "nextBasemap" | "state"; }> | |
arcgisPropertyChange
arcgisPropertyChange: CustomEvent<{ name: "activeBasemap" | "nextBasemap" | "state"; }> Emitted when the value of a property is changed. Use this to listen to changes to properties.
arcgisReady
arcgisReady: CustomEvent<void> Emitted when the component associated with a map or scene view is ready for user interaction.