BasemapLayerListViewModel
require(["esri/widgets/BasemapLayerList/BasemapLayerListViewModel"], function(BasemapLayerListVM) { /* code goes here */ });esri/widgets/BasemapLayerList/BasemapLayerListViewModelProvides logic for the BasemapLayerList widget.
Constructors
- new BasemapLayerListViewModel(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Collection<ListItem> | A collection of ListItems representing the baseLayers. more details | more details | BasemapLayerListViewModel | |
| Function | Specifies a function that accesses each ListItem. more details | more details | BasemapLayerListViewModel | |
| String | The current basemap's title. more details | more details | BasemapLayerListViewModel | |
| String | The name of the class. more details | more details | Accessor | |
| Collection<ListItem> | A collection of ListItems representing the referenceLayers. more details | more details | BasemapLayerListViewModel | |
| Function | Specifies a function that accesses each ListItem representing reference layers. more details | more details | BasemapLayerListViewModel | |
| String | The view model's state. more details | more details | BasemapLayerListViewModel | |
| MapView|SceneView | A reference to the MapView or SceneView. more details | more details | BasemapLayerListViewModel |
Property Details
- baseItems Collection<ListItem>
A collection of ListItems representing the baseLayers.
- baseListItemCreatedFunction Function
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.
- basemapTitle String
The current basemap's title.
The name of the class. The declared class name is formatted as
esri.folder.className.
- referenceItems Collection<ListItem>
A collection of ListItems representing the referenceLayers.
- referenceListItemCreatedFunction Function
Specifies a function that accesses each ListItem representing reference layers.
- state Stringreadonly
The view model's state.
Possible Values:"ready"|"loading"|"disabled"
- Default Value:disabled
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
Triggers the trigger-action event and executes the given action or action toggle. more details | more details | BasemapLayerListViewModel |
Method Details
- triggerAction(action, item)
Triggers the trigger-action event and executes the given action or action toggle.
Parameters:action ActionButton|ActionToggleThe action to execute.
item ListItemAn item associated with the action.