BasemapToggle
require(["esri/widgets/BasemapToggle"], function(BasemapToggle) { /* code goes here */ });esri/widgets/BasemapToggleThe BasemapToggle provides a widget which allows an end-user to switch between two basemaps. The toggled basemap is set inside the view's map object.
- See also:
// Create a map with an initial basemap
var map = new Map({
basemap: "streets", // The initial basemap to toggle from
ground: "world-elevation"
});
// Reference the map in the view instance
var view = new SceneView({
container: "viewDiv",
map: map
});
var basemapToggle = new BasemapToggle({
view: view, // The view that provides access to the map's "streets" basemap
nextBasemap: "hybrid" // Allows for toggling to the "hybrid" basemap
});Constructors
- new BasemapToggle(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example:// typical usage var basemapToggle = new BasemapToggle({ view: view, nextBasemap: "satellite" });
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Basemap | The map's basemap. more details | more details | BasemapToggle | |
| String|HTMLElement | The ID or node representing the DOM element containing the widget. more details | more details | Widget | |
| String | The name of the class. more details | more details | Accessor | |
| String | The unique ID assigned to the widget when the widget is created. more details | more details | Widget | |
| String | The widget's default label. more details | more details | BasemapToggle | |
| Basemap | The next basemap for toggling. more details | more details | BasemapToggle | |
| Boolean | Indicates if the title of the basemap is visible in the widget. more details | more details | BasemapToggle | |
| MapView|SceneView | A reference to the MapView or SceneView. more details | more details | BasemapToggle | |
| BasemapToggleViewModel | The view model for this widget. more details | more details | BasemapToggle | |
| VisibleElements | The visible elements that are displayed within the widget. more details | more details | BasemapToggle |
Property Details
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.
Examples:// Create the HTML div element programmatically at runtime and set to the widget's container const basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div") }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });// Specify an already-defined HTML div element in the widget's container const basemapGallery = new BasemapGallery({ view: view, container: basemapGalleryDiv }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" }); // HTML markup <body> <div id="viewDiv"></div> <div id="basemapGalleryDiv"></div> </body>// Specify the widget while adding to the view's UI const basemapGallery = new BasemapGallery({ view: view }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.
- label String
The widget's default label.
The next basemap for toggling. One of the following values may be set to this property:
- titleVisible BooleanDeprecated since version 4.15. Use BasemapToggle.visibleElements.title instead.
Indicates if the title of the basemap is visible in the widget.
- Default Value:false
A reference to the MapView or SceneView. This view provides the BasemapToggle widget with access to the initial basemap to toggle from via the view's map property.
- viewModel BasemapToggleViewModelautocast
The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the BasemapToggleViewModel class to access all properties and methods on the widget.
- visibleElements VisibleElementsautocastSince: ArcGIS API for JavaScript 4.15
The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.
Example:basemapToggle.visibleElements = { title: false };
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| String | A utility method used for building the value for a widget's | more details | Widget | |
Destroys the widget instance. more details | more details | Widget | ||
| Boolean | Emits an event on the instance. more details | more details | Widget | |
| Boolean | Indicates whether there is an event listener on the instance that matches the provided event name. more details | more details | Widget | |
| Object | Registers an event handler on the instance. more details | more details | Widget | |
Widget teardown helper. more details | more details | Widget | ||
This method is primarily used by developers when implementing custom widgets. more details | more details | Widget | ||
| Object | This method is primarily used by developers when implementing custom widgets. more details | more details | Widget | |
Renders widget to the DOM immediately. more details | more details | Widget | ||
This method is primarily used by developers when implementing custom widgets. more details | more details | Widget | ||
Toggles to the next basemap. more details | more details | BasemapToggle |
Method Details
- Since: ArcGIS API for JavaScript 4.7
A utility method used for building the value for a widget's
classproperty. This aids in simplifying CSS class setup.Parameter:repeatable The class names.
Returns:Type Description String The computed class name. Example:// .tsx syntax showing how to set CSS classes while rendering the widget render() { const dynamicIconClasses = { [CSS.myIcon]: this.showIcon, [CSS.greyIcon]: !this.showIcon }; return ( <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} /> ); }
- destroy()inherited
Destroys the widget instance.
- 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 StringThe name of the event.
event ObjectoptionalThe event payload.
Returns:Type Description Boolean trueif a listener was notified
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameter:type StringThe name of the event.
Returns:Type Description Boolean Returns true if the class supports the input event.
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters:A event type, or an array of event types, to listen for.
listener FunctionThe 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); });
- own(handles)inherited
Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.
Parameter:handles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
- postInitialize()inherited
This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.
This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.
Returns:Type Description Object The rendered virtual node.
- renderNow()inherited
Renders widget to the DOM immediately.
- scheduleRender()inherited
This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.
- toggle()
Toggles to the next basemap.
Type Definitions
- VisibleElements
The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.
- Property:
- optionaltitle Boolean
Indicates whether to the title will be displayed. Default is
false.
Event Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
{current: Basemap,previous: Basemap} | Fires after the toggle() method is called. more details | more details | BasemapToggle |
Event Details
- toggle
Fires after the toggle() method is called.
- Properties:
- current Basemap
The map's current basemap.
previous BasemapThe map's previous basemap.
- See also:
Example:basemapToggle.on('toggle', function(event){ console.log("current basemap title: ", event.current.title); console.log("previous basemap title: ", event.previous.title); });