Skip to content
import LayerListVisibleElements from "@arcgis/core/widgets/LayerList/LayerListVisibleElements.js";
Inheritance:
LayerListVisibleElementsAccessor

The visible elements that are displayed within the layer list. This provides the ability to turn on/off individual elements of the layer list.

Constructors

Constructor

Constructor
Parameters
ParameterTypeDescriptionRequired
properties
See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

catalogLayerList

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates whether to display the LayerList.catalogLayerList.

Default value
true

closeButton

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates whether to display a close button in the header.

Default value
false

collapseButton

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates whether to display a collapse button in the header.

Default value
false

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor
Since
ArcGIS Maps SDK for JavaScript 4.7

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

errors

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates whether to display layers with load errors.

Default value
false

filter

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in LayerList.minFilterItems, allowing users to filter layers by their title.

Default value
false

flow

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the layer list should be shown within its built-in flow component or if the flow component should be excluded. The layer list will be displayed within its original flow component if set to true. The flow component will be omitted from the layer list if set to false. To place the layer list into an existing Calcite flow component, set this property to false.

Default value
true

heading

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates whether to display the layer list heading. The heading text is "Layer List". The heading level can be set with the LayerList.headingLevel.

Default value
false

statusIndicators

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates whether the status indicators will be displayed.

Default value
true

temporaryLayerIndicators

Property
Type
boolean
Since
ArcGIS Maps SDK for JavaScript 5.0

Indicates whether temporary layer indicators will be displayed for layers with Layer.persistenceEnabled set to false. A temporary icon will be displayed on the near side of the layer title.

Default value
false