Property Overview

Property Details

createActionsFunctionFunction

Deprecated

• Since version 4.4.

Use listItemCreatedFunction instead.

Specify the function that will create actions for ListItems. Actions are defined with the properties listed in the Action class.

declaredClassStringreadonly

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

listItemCreatedFunctionFunction

Since: ArcGIS API for JavaScript 4.4

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

Example:

layerListViewModel.listItemCreatedFunction = function (event) {

   // The event object contains properties of the
   // layer in the LayerList widget.

   var item = event.item;

   if (item.title === "US Demographics") {
     // open the list item in the LayerList
     item.open = true;
     // change the title to something more descriptive
     item.title = "Population by county";
     // set an action for zooming to the full extent of the layer
     item.actionsSections = [[{
       title: "Go to full extent",
       className: "esri-icon-zoom-out-fixed",
       id: "full-extent"
     }]];
   }
});

operationalItemsCollectionreadonly

A collection of ListItems representing operational layers.

stateStringreadonly

The view model's state.

Known Values: ready | disabled

Default Value: disabled

viewMapView|SceneView

The view from which the widget will operate.

Method Overview

Method Details

triggerAction(action, item)

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

Parameters:

action Action The action to execute.

item ListItem An item associated with the action.

Event Overview

{action: Action,item: ListItem}

Event Details

trigger-action

Fires after the user clicks on an action inside the LayerList widget. This event may be used to define a custom function to execute when particular actions are clicked.

Properties:

action Action The action clicked by the user.

item ListItem An item associated with the action.