Provides the logic for the BasemapGallery widget.
Constructors
new BasemapGalleryViewModel(properties)
properties Object See the properties for a list of all the properties that may be passed into the constructor. |
Property Overview
| Name | Type | Summary | |
|---|---|---|---|
| Basemap | The map's basemap. more details | more details | |
| String | The name of the class. more details | more details | |
| Collection | A collection of BasemapGalleryItems representing basemaps. more details | more details | |
| LocalBasemapsSource | PortalBasemapsSource | The source for basemaps that the widget will display. more details | more details | |
| String | The view model's state. more details | more details | |
| MapView | SceneView | The view from which the widget will operate. more details | more details | |
Property Details
activeBasemapBasemap
The map's basemap.
declaredClassStringreadonly
The name of the class. The declared class name is formatted as
esri.folder.className.itemsCollection
A collection of BasemapGalleryItems representing basemaps.
source| autocast
The source for basemaps that the widget will display. This property can be autocast with an array or Collection of Basemaps, a Portal instance or a URL to a portal instance. The default source is a PortalBasemapsSource that points to the default portal instance set in esriConfig.portalUrl.
stateStringreadonly
The view model's state.
Known Values: ready | disabled
Default Value: disabledThe 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 | |
|---|---|---|---|
| Boolean | A convenience function to check basemap equality. more details | more details | |
Method Details
basemapEquals(basemap1, basemap2){Boolean}
A convenience function to check basemap equality.
Parameters:basemap1 BasemapThe basemap to compare against
basemap2.basemap2 BasemapThe basemap to compare against
basemap1.Returns:Type Description Boolean Returns trueif both basemaps are equal,falseotherwise.