Provides the logic for the BasemapGallery widget.
Constructors
-
new BasemapGalleryViewModel(properties)
-
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 |
---|---|---|---|
Basemap | The map's basemap. more details | BasemapGalleryViewModel | |
String | The name of the class. more details | Accessor | |
Collection<BasemapGalleryItem> | A collection of BasemapGalleryItems representing basemaps. more details | BasemapGalleryViewModel | |
LocalBasemapsSource|PortalBasemapsSource | The source for basemaps that the widget will display. more details | BasemapGalleryViewModel | |
String | The view model's state. more details | BasemapGalleryViewModel | |
MapView|SceneView | The view from which the widget will operate. more details | BasemapGalleryViewModel |
Property Details
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
items Collection<BasemapGalleryItem>
-
A collection of BasemapGalleryItems representing basemaps.
-
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 Stringreadonly
-
The view model's state.
Possible Values:"ready"|"disabled"
- Default Value:disabled
-
The view from which the widget will operate. This view provides access to the active basemap via the view's map property.
Method Overview
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 | A convenience function to check basemap equality. more details | BasemapGalleryViewModel | |
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)inheritedSince: ArcGIS Maps SDK 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 } ); 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.
-
basemapEquals(basemap1, basemap2){Boolean}
-
A convenience function to check basemap equality.
Parametersbasemap1 BasemapThe basemap to compare against
basemap2
.basemap2 BasemapThe basemap to compare against
basemap1
.ReturnsType Description Boolean Returns true
if both basemaps are equal,false
otherwise.
-
Since: ArcGIS Maps SDK for JavaScript 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"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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");