BasemapView

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

Represents the view for a single basemap after it has been added to either a MapView or a SceneView.

See also

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
Collection<LayerView>

A collection containing a hierarchical list of all the created LayerViews of the base layers in the map.

more details
BasemapView
String

The name of the class.

more details
Accessor
Collection<LayerView>

A collection containing a hierarchical list of all the created LayerViews of the reference layers in the map.

more details
BasemapView
Boolean

Value is true when the basemap is updating; for example, if it is in the process of fetching data.

more details
BasemapView
MapView|SceneView

References the MapView or SceneView.

more details
BasemapView

Property Details

baseLayerViews Collection<LayerView>readonly

A collection containing a hierarchical list of all the created LayerViews of the base layers in the map.

declaredClass Stringreadonly inherited

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

referenceLayerViews Collection<LayerView>readonly

A collection containing a hierarchical list of all the created LayerViews of the reference layers in the map.

updating Booleanreadonly

Value is true when the basemap is updating; for example, if it is in the process of fetching data.

Default Value:false

References the MapView or SceneView.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 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");

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