A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-basemap-toggle/ below:

Basemap Toggle | ArcGIS Maps SDK for JavaScript 4.33

Use dark colors for code blocks Copy

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

No specific import is needed for this component.

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

The basemaps can have different spatial references.

Demo Properties activeBasemap

readonlyProperty

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 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

icon: string

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

See also
Attribute
icon
Default value
"layer-basemap"
label

Property

label: string

The component's default label.

Attribute
label
messageOverrides

Property

messageOverrides: Record<string, unknown>

Replace localized message strings with your own strings.

Note: Individual message keys may change between releases.

nextBasemap

Property

The next basemap for toggling.

Attribute
next-basemap
position

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

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
Attribute
reference-element
showTitle

Property

showTitle: boolean

Indicates if the Basemap title is displayed.

Attribute
show-title
Default value
false
state

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

The current state of the component.

Attribute
state
Default value
"disabled"
Slots

No slots to display.

Events arcgisPropertyChange

Event

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

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

bubbles

Events triggered on this element will be propagated to their outermost elements.

composed

The event is composable and will propagate across the shadow DOM into the standard DOM.

cancelable

The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.

arcgisReady

Event

arcgisReady: CustomEvent<void>

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

bubbles

Events triggered on this element will be propagated to their outermost elements.

composed

The event is composable and will propagate across the shadow DOM into the standard DOM.

cancelable

The event's default behavior can be canceled, allowing for custom behavior to be implemented instead.

Methods componentOnReady

Method

componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Example

Use dark colors for code blocks Copy

1
2
3
4
const arcgisBasemapToggle = document.querySelector("arcgis-basemap-toggle");
document.body.append(arcgisBasemapToggle);
await arcgisBasemapToggle.componentOnReady();
console.log("arcgis-basemap-toggle is ready to go!");
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>

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4