arcgis-basemap-toggle | References | ArcGIS Maps SDK for JavaScript

ESM

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

Inheritance:: ArcgisBasemapToggle→PublicLitElement

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.

Demo

Properties

Property	Attribute	Type
`activeBasemap` readonly		`Basemap \| null \| undefined`
`autoDestroyDisabled`	`auto-destroy-disabled`	`boolean`
`icon`	`icon`	`string \| undefined`
`label`	`label`	`string \| undefined`
`messageOverrides`		`Record<string, unknown> \| undefined`
`nextBasemap`	`next-basemap`	`BasemapProperties \| string \| undefined`
`referenceElement`	`reference-element`	`ArcgisReferenceElement \| string \| undefined`
`showTitle`	`show-title`	`boolean`
`state` readonly		`BasemapToggleViewModelState`
`view`		`MapViewOrSceneView \| null \| undefined`

activeBasemap

readonly Property

Type: Basemap | null | undefined

The map's current basemap.

autoDestroyDisabled

Property

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

icon

Property

Type: string | undefined

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

See also

Calcite Icons

Attribute: icon
Default value: "layer-basemap"

label

Property

Type: string | undefined

The component's default label.

Attribute: label

messageOverrides

Property

Type: Record<string, unknown> | undefined

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

nextBasemap

Property

Type: BasemapProperties | string | undefined

The next basemap for toggling.

Attribute: next-basemap

referenceElement

Property

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.

See also

Associate components with a Map or Scene component

Attribute: reference-element

showTitle

Property

Type: boolean

Indicates if the Basemap title is displayed.

Attribute: show-title
Default value: false

state

readonly Property

Type: BasemapToggleViewModelState

The current state of the component.

Default value: "disabled"

view

Property

Type: MapViewOrSceneView | null | 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 view property 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 the view property.

Methods

Method	Signature
`componentOnReady` inherited	`componentOnReady(): Promise<this>`
`destroy`	`destroy(): Promise<void>`
`toggle`	`toggle(): Promise<any>`

componentOnReady

inherited Method

Signature: componentOnReady (): Promise<this>

Inherited from: PublicLitElement

Creates a promise that resolves once the component is fully loaded.

Returns: Promise<this>

Example

const arcgisBasemapToggle = document.querySelector("arcgis-basemap-toggle");
document.body.append(arcgisBasemapToggle);
await arcgisBasemapToggle.componentOnReady();
console.log("arcgis-basemap-toggle is ready to go!");

destroy

Method

Signature: destroy (): Promise<void>

Permanently destroy the component.

Returns: Promise<void>

toggle

Method

Signature: toggle (): Promise<any>

Toggles to the nextBasemap.

Returns: Promise<any>

Events

Name	Type
`arcgisPropertyChange`	CustomEvent<{ name: "activeBasemap" \| "nextBasemap" \| "state"; }>
`arcgisReady`	CustomEvent<void>

arcgisPropertyChange

Event

arcgisPropertyChange: CustomEvent<{ name: "activeBasemap" | "nextBasemap" | "state"; }>

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

arcgisReady

Event

arcgisReady: CustomEvent<void>

Emitted when the component associated with a map or scene view is ready to be interacted with.