Basemap Toggle

1
import "@arcgis/map-components/components/arcgis-basemap-toggle";

Basemap Toggle component allows an end-user to switch between two basemaps.

The basemaps can have different spatial references.

Demo

Properties

PropertyAttributeType
auto-destroy-disabled
boolean
icon
string
label
string
{ componentLabel?: string | undefined; incompatibleSpatialReference?: string | undefined; }
position
"bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
reference-element
ArcgisLinkChart | ArcgisMap | ArcgisScene | string
show-title
boolean
state
readonly
state
"disabled" | "incompatible-next-basemap" | "loading" | "ready"

activeBasemap

readonlyProperty
activeBasemap: Basemap

The map's current basemap.

autoDestroyDisabled

Property
autoDestroyDisabled: 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 temporary 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

icon

Property
icon: string

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component).

Attribute
icon
Default value
"layer-basemap"

label

Property
label: string

The component's default label.

Attribute
label

messageOverrides

Property
messageOverrides: { componentLabel?: string | undefined; incompatibleSpatialReference?: string | undefined; }

Replace localized message strings with your own strings.

nextBasemap

Property
nextBasemap: Basemap

The next basemap for toggling.

position

Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Attribute
position
Default value
"top-left"

referenceElement

Property
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
Attribute
reference-element

showTitle

Property
showTitle: boolean

Indicates if the Basemap title is displayed.

Attribute
show-title
Default value
false

state

readonly
Property
state: "disabled" | "incompatible-next-basemap" | "loading" | "ready"

The current state of the component.

Attribute
state
Default value
"disabled"

Methods

MethodSignature
componentOnReady(): Promise<void>
destroy(): Promise<void>
toggle(): Promise<any>

componentOnReady

Method
componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns
Promise<void>

destroy

Method
destroy(): Promise<void>

Permanently destroy the component

Returns
Promise<void>

toggle

Method
toggle(): Promise<any>

Toggles to the next basemap.

Returns
Promise<any>

Events

EventType
{ name: "state" | "nextBasemap"; }
undefined

arcgisPropertyChange

Event
arcgisPropertyChange: { name: "state" | "nextBasemap"; }

Fired when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event
arcgisReady: undefined

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close