var 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
  }
});

Property Overview

Property Details

activeBasemap Basemapreadonly

The map's basemap.

declaredClass Stringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

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 Stringreadonly

The view model's state.

Possible Values:"ready"|"disabled"

Default Value:disabled

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

Method Details

emit(type, event){Boolean}

Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:

type String The name of the event.

event Object optional The event payload.

Returns:

Type	Description
Boolean	true if a listener was notified

getThumbnailUrl(basemap){String}static

Since: ArcGIS API for JavaScript 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.

hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:

type String The name of the event.

Returns:

Type	Description
Boolean	Returns true if the class supports the input event.

on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

type String|String[] A event type, or an array of event types, to listen for.

listener Function The function to call when the event is fired.

Returns:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event(s). Property Type Description remove Function When called, removes the listener from the event.

Example:

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

toggle()

Toggles to the next basemap.