var layerList = new LayerList({
  view: view
});
// Adds widget below other elements in the top left corner of the view
view.ui.add(layerList, {
  position: "top-left"
});

// typical usage
var layerlist = new LayerList({
  view: view
});

Property Overview

Property Details

containerString|HTMLElement

The ID or node representing the DOM element containing the widget. This property can only be set once.

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. This function must return a two-dimensional array of Actions.

See also:

• Sample - LayerList widget with actions

declaredClassStringreadonly

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

destroyedBoolean

When true, this property indicates whether the widget has been destroyed.

idString

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

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.

See also:

• Sample - LayerList widget with actions

Example:

var layerList = new LayerList({
  view: view,
  // executes for each ListItem in the LayerList
  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"
     }]];
   }
});

operationalItemsCollection

A collection of ListItems representing operational layers.

viewMapView|SceneView

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

viewModelLayerListViewModel

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the LayerListViewModel class to access all properties and methods on the widget.

Method Overview

Method Details

destroy()inherited

Destroys the widget instance.

hasEventListener(type){Boolean}inherited

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.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener. See the Events summary table for a list of listened events.

Parameters:

type String The name of event to listen for.

listener Function The function to call when the event is fired.

Returns:

Type	Description
Object	Returns an event handler with a remove() method that can be called to stop listening for the event. Property Type Description remove Function When called, removes the listener from the event.

See also:

• dojo/on

Example:

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

handles Handle[] @type - handles to remove when destroyed

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:

Type	Description
Object	The rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

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.