BasemapGalleryViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.32

Provides the logic for the BasemapGallery widget and component.

See also

BasemapGallery widget - Deprecated since 4.32. Use the Basemap Gallery component instead.
Programming patterns: Widget viewModel pattern

Constructors

BasemapGalleryViewModel Constructor new BasemapGalleryViewModel(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

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
Basemap\|null\|undefined	The map's basemap.	BasemapGalleryViewModel
Number	The current index of the active basemap in the BasemapGallery.	BasemapGalleryViewModel
String	The name of the class.	Accessor
Collection<BasemapGalleryItem>	A collection of BasemapGalleryItems representing basemaps.	BasemapGalleryViewModel
LocalBasemapsSource\|PortalBasemapsSource	The source for basemaps that the Basemap Gallery will display.	BasemapGalleryViewModel
String	The view model's state.	BasemapGalleryViewModel
MapView\|SceneView\|null\|undefined	The view from which the Basemap Gallery will operate.	BasemapGalleryViewModel

Property Details

activeBasemap Property activeBasemap Basemap |null |undefinedautocast Autocasts from Object|String

The map's basemap.

activeBasemapIndex Property activeBasemapIndex Numberreadonly Since: ArcGIS Maps SDK for JavaScript 4.32 BasemapGalleryViewModel since 4.3, activeBasemapIndex added at 4.32.

The current index of the active basemap in the BasemapGallery.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

items Property items Collection<BasemapGalleryItem>readonly

A collection of BasemapGalleryItems representing basemaps.

source Property source LocalBasemapsSource |PortalBasemapsSourceautocast Autocasts from Collection<Basemap>|Basemap []|Portal|Object

The source for basemaps that the Basemap Gallery 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 Property state Stringreadonly

The view model's state.

Possible Values:"ready" |"disabled" |"loading" |"unsupported"

Default Value:"disabled"

view Property view MapView |SceneView |null |undefined

The view from which the Basemap Gallery will operate. This view provides access to the active basemap via the view's map property.

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	A convenience function to check basemap equality.	BasemapGalleryViewModel
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.

basemapEquals Method basemapEquals(basemap1, basemap2){Boolean}

A convenience function to check basemap equality.

Parameters

basemap1 Basemap|null|undefined

The basemap to compare against basemap2.

basemap2 Basemap|null|undefined

The basemap to compare against basemap1.

Returns

Type	Description
Boolean	Returns `true` if both basemaps are equal, `false` otherwise.

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