BasemapView | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Collection<LayerView>	A collection containing a hierarchical list of all the created LayerViews of the base layers in the map.	BasemapView
String	The name of the class.	Accessor
Collection<LayerView>	A collection containing a hierarchical list of all the created LayerViews of the reference layers in the map.	BasemapView
Boolean	Value is `true` when the basemap is updating; for example, if it is in the process of fetching data.	BasemapView
MapView\|SceneView	References the MapView or SceneView.	BasemapView

Property Details

baseLayerViews Property baseLayerViews Collection<LayerView>readonly

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

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

referenceLayerViews Property referenceLayerViews Collection<LayerView>readonly

A collection containing a hierarchical list of all the created LayerViews of the reference layers in the map. The reference layers will be displayed on top of all layers in the map.

updating Property updating Booleanreadonly

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

Default Value:false

view Property view MapView |SceneView

References the MapView or SceneView.

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
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

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.

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

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