BasemapLayerListViewModel

Property Overview

Property Details

baseItems Collection<ListItem>readonly

A collection of ListItems representing the baseLayers.

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 String

The current basemap's title.

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 Stringreadonly inherited

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

referenceItems Collection<ListItem>readonly

A collection of ListItems representing the referenceLayers.

referenceListItemCreatedFunction ListItemCreatedHandler

Specifies a function that accesses each ListItem representing reference layers.

state Stringreadonly

The view model's state.

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

Default Value:disabled

view MapView|SceneView

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

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

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.

hasHandles(groupKey){Boolean}inherited

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

removeHandles(groupKey)inherited

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(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.