require(["esri/views/BasemapView"], (BasemapView) => { /* code goes here */ });
import BasemapView from "@arcgis/core/views/BasemapView.js";
esri/views/BasemapView
Represents the view for a single basemap after it has been added to either a MapView or a SceneView.
Property Overview
| Name | 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 | BasemapView | |
| MapView|SceneView | BasemapView |
Property Details
-
baseLayerViews
PropertybaseLayerViews Collection<LayerView>readonly -
A collection containing a hierarchical list of all the created LayerViews of the base layers in the map.
-
referenceLayerViews
PropertyreferenceLayerViews Collection<LayerView>readonly -
A collection containing a hierarchical list of all the created LayerViews of the reference layers in the map.
-
updating
Propertyupdating Booleanreadonly -
Value is
truewhen the basemap is updating; for example, if it is in the process of fetching data.- Default Value:false
Method Overview
| Name | 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
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");