require(["esri/widgets/BasemapGallery/BasemapGalleryViewModel"], (BasemapGalleryVM) => { /* code goes here */ });
import BasemapGalleryVM from "@arcgis/core/widgets/BasemapGallery/BasemapGalleryViewModel.js";
esri/widgets/BasemapGallery/BasemapGalleryViewModel
Provides the logic for the BasemapGallery widget.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The map's basemap. | BasemapGalleryViewModel | ||
The name of the class. | Accessor | ||
A collection of BasemapGalleryItems representing basemaps. | BasemapGalleryViewModel | ||
The source for basemaps that the widget will display. | BasemapGalleryViewModel | ||
The view model's state. | BasemapGalleryViewModel | ||
The view from which the widget will operate. | BasemapGalleryViewModel |
Property Details
-
items
items Collection<BasemapGalleryItem>
-
A collection of BasemapGalleryItems representing basemaps.
-
source
source LocalBasemapsSource |PortalBasemapsSourceautocast
-
The source for basemaps that the widget will display. This property can be autocast with an array or Collection of Basemaps, or a Portal instance. The default source is a PortalBasemapsSource that points to the default portal instance set in esriConfig.portalUrl.
-
state
state Stringreadonly
-
The view model's state.
Possible Values:"ready" |"disabled"
- Default Value:disabled
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
A convenience function to check basemap equality. | BasemapGalleryViewModel | ||
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 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"); }
-
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");