BasemapToggle | API Reference | ArcGIS Maps SDK for JavaScript 4.30

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

Starting with version 4.23, the BasemapToggle widget can have two basemaps with different spatial references. Set the MapView.spatialReferenceLocked property to true to disable basemaps in different spatial references and prevent users from changing the view's spatial reference at runtime.

See also

Example

// Create a map with an initial basemap
let map = new Map({
  basemap: "streets-vector",  // The initial basemap to toggle from
  ground: "world-elevation"
});

// Reference the map in the view instance
let view = new SceneView({
  container: "viewDiv",
  map: map
});

let basemapToggle = new BasemapToggle({
  view: view,  // The view that provides access to the map's "streets-vector" basemap
  nextBasemap: "hybrid"  // Allows for toggling to the "hybrid" basemap
});

Constructors

BasemapToggle Constructor 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
let basemapToggle = new BasemapToggle({
  view: view,
  nextBasemap: "satellite"
});

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
Basemap	The map's basemap.	BasemapToggle
String\|HTMLElement	The ID or node representing the DOM element containing the widget.	Widget
String	The name of the class.	Accessor
String	Icon which represents the widget.	BasemapToggle
String	The unique ID assigned to the widget when the widget is created.	Widget
String	The widget's default label.	BasemapToggle
Basemap	The next basemap for toggling.	BasemapToggle
MapView\|SceneView	A reference to the MapView or SceneView.	BasemapToggle
BasemapToggleViewModel	The view model for this widget.	BasemapToggle
Boolean	Indicates whether the widget is visible.	Widget
VisibleElements	The visible elements that are displayed within the widget.	BasemapToggle

Property Details

activeBasemap Property activeBasemap Basemapreadonly

The map's basemap.

container Inherited Property container String |HTMLElement Inherited from Widget

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 case 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"
});

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

icon Property icon String Since: ArcGIS Maps SDK for JavaScript 4.27 BasemapToggle since 4.0, icon added at 4.27.

Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).

Default Value:"layer-basemap"

See also

Calcite Icon Search

id Inherited Property id String Inherited from Widget

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 Property label String

The widget's default label.

nextBasemap Property 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.

view Property view MapView |SceneView

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

visible Inherited Property visible Boolean Inherited from Widget

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of "none".

Default Value:true

Example

// Hides the widget in the view
widget.visible = false;

visibleElements Property visibleElements VisibleElements Since: ArcGIS Maps SDK for JavaScript 4.15 BasemapToggle since 4.0, visibleElements added at 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

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
String	A utility method used for building the value for a widget's `class` property.	Widget
	Destroys the widget instance.	Widget
Boolean	Emits an event on the instance.	Widget
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name.	Widget
Boolean	Returns true if a named group of handles exist.	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	Widget
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected.	Widget
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved.	Widget
Object	Registers an event handler on the instance.	Widget
	Adds one or more handles which are to be tied to the lifecycle of the widget.	Widget
	Executes after widget is ready for rendering.	Widget
	Removes a group of handles owned by the object.	Accessor
Object	This method is implemented by subclasses for rendering.	Widget
	Renders widget to the DOM immediately.	Widget
	Schedules widget rendering.	Widget
Promise	Toggles to the next basemap.	BasemapToggle
Promise	`when()` may be leveraged once an instance of the class is created.	Widget

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

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

classes Inherited Method classes(classNames){String} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.7 Widget since 4.2, classes added at 4.7.

A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.

Parameter

classNames String|String []|Object

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 dynamicClasses = {
    [css.flip]: this.flip,
    [css.primary]: this.primary
  };

  return (
    <div class={classes(css.root, css.mixin, dynamicClasses)} />
  );
}

destroy Inherited Method destroy() Inherited from Widget

Destroys the widget instance.

emit Inherited Method emit(type, event){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.5 Widget since 4.2, emit added at 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

hasEventListener Inherited Method hasEventListener(type){Boolean} Inherited from Widget

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.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	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");
}

isFulfilled Inherited Method isFulfilled(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isFulfilled added at 4.19.

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected Inherited Method isRejected(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isRejected added at 4.19.

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved Inherited Method isResolved(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isResolved added at 4.19.

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

on Inherited Method on(type, listener){Object} Inherited from Widget

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

Parameters

type String|String []

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

own Inherited Method own(handleOrHandles) Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.24 Widget since 4.2, own added at 4.24. Deprecated since 4.28 Use addHandles() instead.

Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.

const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true}
);

this.own(handle); // Handle gets removed when the widget is destroyed.

Parameter

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize Inherited Method postInitialize() Inherited from Widget

Executes after widget is ready for rendering.

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

render Inherited Method render(){Object} Inherited from Widget

This method is implemented by subclasses for rendering.

Returns

Type	Description
Object	The rendered virtual node.

renderNow Inherited Method renderNow() Inherited from Widget

Renders widget to the DOM immediately.

scheduleRender Inherited Method scheduleRender() Inherited from Widget

Schedules widget rendering. This method is useful for changes affecting the UI.

toggle Method toggle(){Promise}

Toggles to the next basemap.

Returns

Type	Description
Promise	Resolves after the widget has toggled to the next basemap.

when Inherited Method when(callback, errback){Promise} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, when added at 4.19.

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters

callback Function

optional

The function to call when the promise resolves.

errback Function

optional

The function to execute when the promise fails.

Returns

Type	Description
Promise	Returns a new Promise for the result of `callback`.

Example

// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Type Definitions

VisibleElements Type Definition 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: title Boolean

optional
Indicates whether to the title will be displayed. Default is false.