require(["esri/widgets/BasemapLayerList/BasemapLayerListViewModel"], (BasemapLayerListVM) => { /* code goes here */ });
import BasemapLayerListVM from "@arcgis/core/widgets/BasemapLayerList/BasemapLayerListViewModel.js";
esri/widgets/BasemapLayerList/BasemapLayerListViewModel
Provides logic for the BasemapLayerList widget.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
A collection of ListItems representing the baseLayers. | BasemapLayerListViewModel | ||
Specifies a function that accesses each ListItem. | BasemapLayerListViewModel | ||
The current basemap's title. | BasemapLayerListViewModel | ||
Whether to provide an indication if a layer is being published in the BasemapLayerList. | BasemapLayerListViewModel | ||
The name of the class. | Accessor | ||
Specifies whether to ignore the listMode property of the layers to display all layers. | BasemapLayerListViewModel | ||
A collection of ListItems representing the referenceLayers. | BasemapLayerListViewModel | ||
Specifies a function that accesses each ListItem representing reference layers. | BasemapLayerListViewModel | ||
The view model's state. | BasemapLayerListViewModel | ||
BasemapLayerListViewModel |
Property Details
-
baseItems
baseItems Collection<ListItem>readonly
-
A collection of ListItems representing the baseLayers.
-
baseListItemCreatedFunction
baseListItemCreatedFunction ListItemCreatedHandler |null |undefined
-
Specifies a function that accesses each ListItem. Each list item can be modified according to its modifiable properties. Actions can be added to list items using the actionsSections property of the ListItem.
-
checkPublishStatusEnabled
checkPublishStatusEnabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.25 -
Whether to provide an indication if a layer is being published in the BasemapLayerList. When a layer is publishing, a rotating square will appear to the right of the list item title. The list item publishing property will be
false
ifcheckPublishStatusEnabled
isfalse
.- Default Value:false
-
listModeDisabled
listModeDisabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.30 -
Specifies whether to ignore the listMode property of the layers to display all layers. A common use case for
listModeDisabled
is when you want to use the BasemapLayerList to manage and configure a layer'slistMode
value.- Default Value:false
- See also
-
referenceItems
referenceItems Collection<ListItem>readonly
-
A collection of ListItems representing the referenceLayers.
-
referenceListItemCreatedFunction
referenceListItemCreatedFunction ListItemCreatedHandler |null |undefined
-
Specifies a function that accesses each ListItem representing reference layers.
-
state
state Stringreadonly
-
The view model's state.
Possible Values:"ready" |"loading" |"disabled"
- Default Value:"disabled"
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Emits an event on the instance. | BasemapLayerListViewModel | ||
Indicates whether there is an event listener on the instance that matches the provided event name. | BasemapLayerListViewModel | ||
Returns true if a named group of handles exist. | Accessor | ||
Registers an event handler on the instance. | BasemapLayerListViewModel | ||
Removes a group of handles owned by the object. | Accessor | ||
Triggers the trigger-action event and executes the given action or action toggle. | BasemapLayerListViewModel |
Method Details
-
Inherited from Accessor
Since: 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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: 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"); }
-
on
on(type, listener){Object}
-
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersReturnsType 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); });
-
Inherited from Accessor
Since: 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");
-
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.