require(["esri/widgets/BasemapToggle/BasemapToggleViewModel"], (BasemapToggleVM) => { /* code goes here */ });
import BasemapToggleVM from "@arcgis/core/widgets/BasemapToggle/BasemapToggleViewModel.js";
esri/widgets/BasemapToggle/BasemapToggleViewModel
Provides the logic for the Basemap Toggle component and BasemapToggle widget. Use the nextBasemap property to determining the secondary basemap to toggle to.
- See also
-
Basemap Toggle component
BasemapToggle widget - Deprecated since 4.32. Use the Basemap Toggle component instead.
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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The map's basemap. | BasemapToggleViewModel | ||
The name of the class. | Accessor | ||
The next basemap for toggling. | BasemapToggleViewModel | ||
The view model's state. | BasemapToggleViewModel | ||
The view from which the component or widget will operate. | BasemapToggleViewModel |
Property Details
-
state
state Stringreadonly
-
The view model's state.
Possible Values:"ready" |"incompatible-next-basemap" |"loading" |"disabled"
- Default Value:"disabled"
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Helper method to find a basemap's thumbnail URL. | BasemapToggleViewModel | ||
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
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Since: ArcGIS Maps SDK 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.
Returns
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25 -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Toggles to the next basemap.
ReturnsType Description Promise Resolves after the basemap has been toggled to the next basemap.