BasemapLayerListViewModel

AMD: require(["esri/widgets/BasemapLayerList/BasemapLayerListViewModel"], (BasemapLayerListVM) => { /* code goes here */ });
ESM: import BasemapLayerListVM from "@arcgis/core/widgets/BasemapLayerList/BasemapLayerListViewModel.js";
Class: esri/widgets/BasemapLayerList/BasemapLayerListViewModel
Inheritance: BasemapLayerListViewModelAccessor
Since: ArcGIS Maps SDK for JavaScript 4.13

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 Watch for changes topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

A collection of ListItems representing the baseLayers.

BasemapLayerListViewModel

Specifies a function that accesses each ListItem.

BasemapLayerListViewModel

The current basemap's title.

BasemapLayerListViewModel

Whether to provide an indication if a layer is being published in the BasemapLayerList.

BasemapLayerListViewModel

The name of the class.

Accessor

Specifies whether to ignore the listMode property of the layers to display all layers.

BasemapLayerListViewModel

A collection of ListItems representing the referenceLayers.

BasemapLayerListViewModel

Specifies a function that accesses each ListItem representing reference layers.

BasemapLayerListViewModel

The view model's state.

BasemapLayerListViewModel

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 |null |undefined

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 |null |undefined

The current basemap's title.

checkPublishStatusEnabled

Property
checkPublishStatusEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 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

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

referenceItems

Property
referenceItems Collection<ListItem>readonly

A collection of ListItems representing the referenceLayers.

referenceListItemCreatedFunction

Property
referenceListItemCreatedFunction ListItemCreatedHandler |null |undefined

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 |null |undefined

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
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

Emits an event on the instance.

BasemapLayerListViewModel

Indicates whether there is an event listener on the instance that matches the provided event name.

BasemapLayerListViewModel

Returns true if a named group of handles exist.

Accessor

Registers an event handler on the instance.

BasemapLayerListViewModel

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

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.

emit

Method
emit(type, event){Boolean}

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters
type String

The name of the event.

event Object
optional

The event payload.

Returns
Type Description
Boolean true if a listener was notified

hasEventListener

Method
hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter
type String

The name of the event.

Returns
Type Description
Boolean Returns true if the class supports the input event.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 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");
}

on

Method
on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns
Type Description
Object Returns an event handler with a remove() method that should be called to stop listening for the event(s).
Property Type Description
remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 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

The action to execute.

item ListItem

An item associated with the action.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close