require(["esri/widgets/BasemapToggle"], function(BasemapToggle) { /* code goes here */ });
Class: esri/widgets/BasemapToggle
Inheritance: BasemapToggle Widget Accessor
Since: ArcGIS API for JavaScript 4.0

The 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.

basemap-toggle

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
// 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 Object
optional

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

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

The map's basemap.

more details
more detailsBasemapToggle
String | HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
Boolean

When true, this property indicates whether the widget has been destroyed.

more details
more detailsWidget
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
Basemap | String

The next basemap for toggling.

more details
more detailsBasemapToggle
Boolean

Indicates if the title of the basemap is visible in the widget.

more details
more detailsBasemapToggle
MapView | SceneView

A reference to the MapView or SceneView.

more details
more detailsBasemapToggle
BasemapToggleViewModel

The view model for this widget.

more details
more detailsBasemapToggle

Property Details

activeBasemapBasemapreadonly

The map's basemap.

The ID or node representing the DOM element containing the widget. This property can only be set once.

declaredClassStringreadonly inherited

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

When true, this property indicates whether the widget has been destroyed.

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.

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. Since this property may be autocast, the Basemap module does not need to be included in the require() function in most applications.

titleVisibleBoolean

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.

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.

Method Overview

NameReturn TypeSummaryClass

Destroys the widget instance.

more details
more detailsWidget

Emits an event on the instance.

more details
more detailsWidget
Boolean

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

more details
more detailsWidget
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Finalizes the creation of the widget.

more details
more detailsWidget

Toggles to the next basemap.

more details
more detailsBasemapToggle

Method Details

destroy()inherited

Destroys the widget instance.

emit(type, event)protectedinherited

Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses that inherit from Evented.

Parameters:
type String

The name of the event.

event Object

The event payload.

hasEventListener(type){Boolean}inherited

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:
TypeDescription
BooleanReturns true if the class supports the input event.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.

Parameters:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
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 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.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
TypeDescription
ObjectThe 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.

startup()inherited

Deprecated
  • since version 4.2.

Finalizes the creation of the widget.

toggle()

Toggles to the next basemap.

Event Overview

NameTypeSummaryClass
{current: Basemap,previous: Basemap}

Fires after the toggle() method is called.

more details
more detailsBasemapToggle

Event Details

toggle

Fires after the toggle() method is called.

Properties:
current Basemap

The map's current basemap.

previous Basemap

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

API Reference search results

NameTypeModule

There were no match results from your search criteria.