BasemapToggleViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Provides the logic for the BasemapToggle widget. Use the nextBasemap property to determining the secondary basemap to toggle to.

See also

Example

let basemapToggle = new BasemapToggle({
  viewModel: {  // autocasts as new BasemapToggleViewModel()
    view: view,  // view with map that uses "streets-vector" basemap
    nextBasemap: "hybrid"  // Allows for toggling to "hybrid" basemap
  }
});

Constructors

BasemapToggleViewModel Constructor new BasemapToggleViewModel(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Basemap	The map's basemap.	BasemapToggleViewModel
String	The name of the class.	Accessor
Basemap	The next basemap for toggling.	BasemapToggleViewModel
String	The view model's state.	BasemapToggleViewModel
MapView\|SceneView	The view from which the widget will operate.	BasemapToggleViewModel

Property Details

activeBasemap Property activeBasemap Basemapreadonly

The map's basemap.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

The name of the class. The declared class name is formatted as esri.folder.className.

nextBasemap Property nextBasemap Basemapautocast Autocasts from String|Object

The next basemap for toggling. One of the following values may be set to this property:

The string ID of any Esri basemap.
A custom Basemap object.

state Property state Stringreadonly

The view model's state.

Possible Values:"ready" |"incompatible-next-basemap" |"loading" |"disabled"

Default Value:"disabled"

view Property view MapView |SceneView

The view from which the widget will operate. This view provides access to the initial basemap to toggle from via the view's map property.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
String	Helper method to find a basemap's thumbnail URL.	BasemapToggleViewModel
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Promise	Toggles to the next basemap.	BasemapToggleViewModel

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

getThumbnailUrl Method getThumbnailUrl(basemap){String} Since: ArcGIS Maps SDK for JavaScript 4.4 BasemapToggleViewModel since 4.0, getThumbnailUrl added at 4.4.

Helper method to find a basemap's thumbnail URL.

If the basemap does not have a thumbnail URL defined, this utility will try to find a thumbnail URL from the best matching well-known basemap. If no match is found, a thumbnail URL from the basemap's base layers will be used.

Parameter

basemap Basemap

The basemap used to retrieve the thumbnail URL.

Returns

Type	Description
String	The basemap's thumbnail URL.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toggle Method toggle(){Promise}

Toggles to the next basemap.

Returns

Type	Description
Promise	Resolves after the widget has toggled to the next basemap.