BasemapLayerListViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Provides logic for the BasemapLayerList widget.

See also

Constructors

BasemapLayerListViewModel Constructor new BasemapLayerListViewModel(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 Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Collection<ListItem>	A collection of ListItems representing the baseLayers.	BasemapLayerListViewModel
ListItemCreatedHandler	Specifies a function that accesses each ListItem.	BasemapLayerListViewModel
String	The current basemap's title.	BasemapLayerListViewModel
Boolean	Whether to provide an indication if a layer is being published in the BasemapLayerList.	BasemapLayerListViewModel
String	The name of the class.	Accessor
Boolean	Specifies whether to ignore the listMode property of the layers to display all layers.	BasemapLayerListViewModel
Collection<ListItem>	A collection of ListItems representing the referenceLayers.	BasemapLayerListViewModel
ListItemCreatedHandler	Specifies a function that accesses each ListItem representing reference layers.	BasemapLayerListViewModel
String	The view model's state.	BasemapLayerListViewModel
MapView\|SceneView	A reference to the MapView or SceneView.	BasemapLayerListViewModel

Property Details

baseItems Property baseItems Collection<ListItem>readonly

A collection of ListItems representing the baseLayers.

baseListItemCreatedFunction Property baseListItemCreatedFunction ListItemCreatedHandler

Specifies a function that accesses each ListItem. Each list item can be modified according to its modifiable properties. Actions can be added to list items using the actionsSections property of the ListItem.

basemapTitle Property basemapTitle String

The current basemap's title.

checkPublishStatusEnabled Property checkPublishStatusEnabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.25 BasemapLayerListViewModel since 4.13, checkPublishStatusEnabled added at 4.25.

Whether to provide an indication if a layer is being published in the BasemapLayerList. When a layer is publishing, a rotating square will appear to the right of the list item title. The list item publishing property will be false if checkPublishStatusEnabled is false.

Default Value:false

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

listModeDisabled Property listModeDisabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.30 BasemapLayerListViewModel since 4.13, listModeDisabled added at 4.30.

Specifies whether to ignore the listMode property of the layers to display all layers. A common use case for listModeDisabled is when you want to use the BasemapLayerList to manage and configure a layer's listMode value.

Default Value:false

See also

Layer.listMode

referenceItems Property referenceItems Collection<ListItem>readonly

A collection of ListItems representing the referenceLayers.

referenceListItemCreatedFunction Property referenceListItemCreatedFunction ListItemCreatedHandler

Specifies a function that accesses each ListItem representing reference layers.

state Property state Stringreadonly

The view model's state.

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

Default Value:"disabled"

view Property view MapView |SceneView

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

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	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
	Triggers the trigger-action event and executes the given action or action toggle.	BasemapLayerListViewModel

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.

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

triggerAction Method triggerAction(action, item)

Triggers the trigger-action event and executes the given action or action toggle.

Parameters

action ActionButton|ActionToggle

The action to execute.

item ListItem

An item associated with the action.