BasemapToggleViewModel

AMD: require(["esri/widgets/BasemapToggle/BasemapToggleViewModel"], (BasemapToggleVM) => { /* code goes here */ });
ESM: import BasemapToggleVM from "@arcgis/core/widgets/BasemapToggle/BasemapToggleViewModel";
Class: esri/widgets/BasemapToggle/BasemapToggleViewModel
Inheritance: BasemapToggleViewModel Accessor
Since: ArcGIS API for JavaScript 4.0

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

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
Name Type Summary Class
Basemapmore details

The map's basemap.

more detailsBasemapToggleViewModel
Stringmore details

The name of the class.

more detailsAccessor
Basemapmore details

The next basemap for toggling.

more detailsBasemapToggleViewModel
Stringmore details

The view model's state.

more detailsBasemapToggleViewModel
MapView|SceneViewmore details

The view from which the widget will operate.

more detailsBasemapToggleViewModel

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:

state Stringreadonly

The view model's state.

Possible Values:"ready"|"disabled"

Default Value:disabled

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

Name Return Type Summary Class
Booleanmore details

Emits an event on the instance.

more detailsBasemapToggleViewModel
Stringmore details

Helper method to find a basemap's thumbnail URL.

more detailsBasemapToggleViewModel
Booleanmore details

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

more detailsBasemapToggleViewModel
Objectmore details

Registers an event handler on the instance.

more detailsBasemapToggleViewModel
more details

Toggles to the next basemap.

more detailsBasemapToggleViewModel

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:

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns:
Type Description
Object Returns an event handler with a remove() method that should 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.

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