require(["esri/widgets/BasemapLayerList"], (BasemapLayerList) => { /* code goes here */ });
import BasemapLayerList from "@arcgis/core/widgets/BasemapLayerList.js";
esri/widgets/BasemapLayerList
The BasemapLayerList widget provides a way to display a list of Basemap layers and switch on/off their visibility. Base layers and reference layers are divided into separate sections. When editing is enabled, layers can be reordered by dragging and dropping between the lists and the title can be edited.
BasemapLayerList is very similar to our LayerList widget. See below samples for code inspiration:
Sample - LayerList widget
Sample - LayerList widget with actions
let basemapLayerList = new BasemapLayerList({
view: view
});
// Adds the widget below other elements in the top left corner of the view
view.ui.add(basemapLayerList, {
position: "top-left"
});
Constructors
-
new BasemapLayerList(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example// typical usage let BasemapLayerList = new BasemapLayerList({ view: view });
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Collection<ListItem> | A collection of ListItems representing the baseLayers. more details | BasemapLayerList | |
ListItemCreatedHandler | Specifies a function that accesses each ListItem representing a base layer. more details | BasemapLayerList | |
String | The current basemap's title. more details | BasemapLayerList | |
String|HTMLElement | The ID or node representing the DOM element containing the widget. more details | Widget | |
String | The name of the class. more details | Accessor | |
Boolean | Indicates whether the basemap’s title, layer order and layer grouping can be edited by the user. more details | BasemapLayerList | |
Number | Indicates the heading level to use for the widget title (i.e. more details | BasemapLayerList | |
String | Icon which represents the widget. more details | Widget | |
String | The widget's default CSS icon class. more details | BasemapLayerList | |
String | The unique ID assigned to the widget when the widget is created. more details | Widget | |
String | The widget's default label. more details | BasemapLayerList | |
Boolean | Indicates whether more than one list item may be selected by the user at a single time. more details | BasemapLayerList | |
Collection<ListItem> | A collection of ListItems representing the referenceLayers. more details | BasemapLayerList | |
ListItemCreatedHandler | Specifies a function that accesses each ListItem representing a reference layer. more details | BasemapLayerList | |
Collection<ListItem> | A collection of selected ListItems representing basemap layers selected by the user. more details | BasemapLayerList | |
MapView|SceneView | A reference to the MapView or SceneView. more details | BasemapLayerList | |
BasemapLayerListViewModel | The view model for this widget. more details | BasemapLayerList | |
Boolean | Indicates whether the widget is visible. more details | Widget | |
VisibleElements | The visible elements that are displayed within the widget. more details | BasemapLayerList |
Property Details
-
baseItems Collection<ListItem>readonly
-
A collection of ListItems representing the baseLayers.
-
baseListItemCreatedFunction ListItemCreatedHandler
-
Specifies a function that accesses each ListItem representing a base layer. Each list item's modifiable properties can be updated within. Actions can be added to list items using the actionsSections property of the ListItem.
Exampleconst bmLayerList = new BasemapLayerList({ view: view, editingEnabled: true, baseListItemCreatedFunction: function(event){ const baseListItem = event.item; if(baseListItem.title === "World Imagery_01"){ // clean up title baseListItem.title = "World Imagery"; // open the baseList item baseListItem.open = true; } } })
-
basemapTitle String
-
The current basemap's title.
-
-
The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.
Examples// Create the HTML div element programmatically at runtime and set to the widget's container const basemapGallery = new BasemapGallery({ view: view, container: document.createElement("div") }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
// Specify an already-defined HTML div element in the widget's container const basemapGallery = new BasemapGallery({ view: view, container: basemapGalleryDiv }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" }); // HTML markup <body> <div id="viewDiv"></div> <div id="basemapGalleryDiv"></div> </body>
// Specify the widget while adding to the view's UI const basemapGallery = new BasemapGallery({ view: view }); // Add the widget to the top-right corner of the view view.ui.add(basemapGallery, { position: "top-right" });
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
editingEnabled Boolean
-
Indicates whether the basemap’s title, layer order and layer grouping can be edited by the user. Any edits made will only be shown locally and will not be saved.
- Default Value:false
Example// to enable editing basemapLayerList.editingEnabled = true;
-
headingLevel NumberSince: ArcGIS Maps SDK for JavaScript 4.20
-
Indicates the heading level to use for the widget title (i.e. "Basemap"). By default, this is rendered as a level 2 heading (e.g.
<h2>Basemap</h2>
). Depending on the widget's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.- Default Value:2
- See also
Example// the widget title will render as an <h3> basemapLayerList.headingLevel = 3;
-
Since: ArcGIS Maps SDK for JavaScript 4.27
-
Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).
- Default Value:null
- See also
-
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.
-
label String
-
The widget's default label.
-
multipleSelectionEnabled Boolean
-
Indicates whether more than one list item may be selected by the user at a single time. Selected items are available in the selectedItems property.
- Default Value:false
- See also
ExamplebasemapLayerList.multipleSelectionEnabled = true;
-
referenceItems Collection<ListItem>readonly
-
A collection of ListItems representing the referenceLayers.
-
referenceListItemCreatedFunction ListItemCreatedHandler
-
Specifies a function that accesses each ListItem representing a reference layer. Each list item's modifiable properties can be updated within. Actions can be added to list items using the actionsSections property of the ListItem.
Examplelet bmLayerList = new BasemapLayerList({ view: view, editingEnabled: true, referenceListItemCreatedFunction: function(event){ referenceListItem = event.item; if(referenceListItem.title === "World Imagery_01_reference_layer"){ // clean up title referenceListItem.title = "Reference layer"; // open the baseList item referenceListItem.open = true; } } })
-
selectedItems Collection<ListItem>
-
A collection of selected ListItems representing basemap layers selected by the user.
-
viewModel BasemapLayerListViewModel
-
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 BasemapLayerListViewModel class to access all properties and methods on the widget.
-
Indicates whether the widget is visible.
If
false
, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of"none"
.- Default Value:true
Example// Hides the widget in the view widget.visible = false;
-
visibleElements VisibleElementsSince: ArcGIS Maps SDK for JavaScript 4.15
-
The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.
ExamplebasemapLayerList.visibleElements = { statusIndicators: false, baseLayers: false, referenceLayers: false, errors: true };
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
String | A utility method used for building the value for a widget's | Widget | |
Destroys the widget instance. more details | Widget | ||
Boolean | Emits an event on the instance. more details | Widget | |
Boolean | Indicates whether there is an event listener on the instance that matches the provided event name. more details | Widget | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Boolean |
| Widget | |
Boolean |
| Widget | |
Boolean |
| Widget | |
Object | Registers an event handler on the instance. more details | Widget | |
Adds one or more handles which are to be tied to the lifecycle of the widget. more details | Widget | ||
This method is primarily used by developers when implementing custom widgets. more details | Widget | ||
Removes a group of handles owned by the object. more details | Accessor | ||
Object | This method is primarily used by developers when implementing custom widgets. more details | Widget | |
Renders widget to the DOM immediately. more details | Widget | ||
This method is primarily used by developers when implementing custom widgets. more details | Widget | ||
Triggers the trigger-action event and executes the given action or action toggle. more details | BasemapLayerList | ||
Promise |
| Widget |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
A utility method used for building the value for a widget's
class
property. This aids in simplifying css class setup.Parameterrepeatable The class names.
ReturnsType Description String The computed class name. Example// .tsx syntax showing how to set css classes while rendering the widget render() { const dynamicIconClasses = { [css.myIcon]: this.showIcon, [css.greyIcon]: !this.showIcon }; return ( <div class={classes(css.root, css.mixin, dynamicIconClasses)} /> ); }
-
destroy()inherited
-
Destroys the widget instance.
-
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameterstype StringThe name of the event.
event ObjectoptionalThe event payload.
ReturnsType Description Boolean true
if a listener was notified
-
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Since: ArcGIS Maps SDK for JavaScript 4.19
-
isFulfilled()
may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
Since: ArcGIS Maps SDK for JavaScript 4.19
-
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
Since: ArcGIS Maps SDK for JavaScript 4.19
-
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersAn event or an array of events to listen for.
listener FunctionThe function to call when the event fires.
ReturnsType Description Object Returns an event handler with a remove()
method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
own(handleOrHandles)inheritedSince: ArcGIS Maps SDK for JavaScript 4.24Deprecated since 4.28 Use addHandles() instead.
-
Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.
const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true} ); this.own(handle); // Handle gets removed when the widget is destroyed.
ParameterhandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
-
postInitialize()inherited
-
This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.
ReturnsType 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 or action toggle.
Parametersaction ActionButton|ActionToggleThe action to execute.
item ListItemAn item associated with the action.
-
Since: ArcGIS Maps SDK for JavaScript 4.19
-
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameterscallback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
ReturnsType Description Promise Returns a new promise for the result of callback
.Example// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way let bmGallery = new BasemapGallery(); bmGallery.when(function(){ // This function will execute once the promise is resolved }, function(error){ // This function will execute if the promise is rejected due to an error });
Type Definitions
-
ListItemCreatedHandler(event)
-
Function definition for the baseListItemCreatedFunction and referenceListItemCreatedFunction properties. See the example snippets in the documentations for those properties for more details.
Parametersevent ObjectAn object containing a list item created by the LayerList.
Specificationitem ListItemA list item created by the LayerList. You can modify the properties of this item to customize the text, actions, panel content, and visibility of the list item. See the documentation for the listItemCreatedFunction for more details.
-
VisibleElements
-
The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.
- Properties
-
statusIndicators Boolean
Indicates whether to the status indicators will be displayed. Default is
true
.baseLayers BooleanIndicates whether to the base layers will be displayed. Default is
true
.referenceLayers BooleanIndicates whether to the reference layers will be displayed. Default is
true
.errors BooleanSince 4.25 Indicates whether layer load errors will be displayed. Default is
false
.
Event Overview
Name | Type | Summary | Class |
---|---|---|---|
{action: ActionButton|ActionToggle,item: ListItem} |
Fires after the user clicks on an action or action toggle inside the BasemapLayerList widget. more details |
BasemapLayerList |
Event Details
-
trigger-action
-
Fires after the user clicks on an action or action toggle inside the BasemapLayerList widget. This event may be used to define a custom function to execute when particular actions are clicked.
- Properties
-
action ActionButton|ActionToggle
The action clicked by the user.
item ListItemThe ListItem associated with the action.