require(["esri/widgets/LayerList"], function(LayerList) { /* code goes here */ });
Class: esri/widgets/LayerList
Inheritance: LayerList Widget Accessor
Since: ArcGIS API for JavaScript 4.2

The LayerList widget provides a way to display a list of layers, and switching on/off their visibility.

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
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"
});

Constructors

new LayerList(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummary
String | HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more details
Function

Specify the function that will create actions for ListItems.

more details
more details
String

The name of the class.

more details
more details
Boolean

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

more details
more details
String

The unique ID assigned to the widget when the widget is created.

more details
more details
Collection

A collection of ListItems representing operational layers.

more details
more details
MapView | SceneView

A reference to the MapView or SceneView.

more details
more details
LayerListViewModel

The view model for this widget.

more details
more details

Property Details

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

createActionsFunctionFunction

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

See also:

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.

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.

operationalItemsCollection

A collection of ListItems representing operational layers.

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

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

NameReturn TypeSummary

Destroys the widget instance.

more details
more details
Boolean

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

more details
more details
Object

Registers an event handler on the instance.

more details
more details

Widget teardown helper.

more details
more details

This method is primarily used by developers when implementing custom widgets.

more details
more details
Object

This method is primarily used by developers when implementing custom widgets.

more details
more details

Renders widget to the DOM immediately.

more details
more details

This method is primarily used by developers when implementing custom widgets.

more details
more details

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

more details
more details

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:
TypeDescription
BooleanReturns 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:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
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:
TypeDescription
ObjectThe 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.

An item associated with the action.

Event Overview

NameTypeSummary
{action: Action,item: ListItem}

Fires after the user clicks on an action inside the LayerList widget.

more details
more details

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.

An item associated with the action.

API Reference search results

NameTypeModule

There were no match results from your search criteria.