Provides logic for the BasemapLayerList widget.
Constructors
-
new BasemapLayerListViewModel(properties)
-
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 |
---|---|---|---|
Collection<ListItem> | A collection of ListItems representing the baseLayers. more details | BasemapLayerListViewModel | |
ListItemCreatedHandler | Specifies a function that accesses each ListItem. more details | BasemapLayerListViewModel | |
String | The current basemap's title. more details | BasemapLayerListViewModel | |
Boolean | Whether to provide an indication if a layer is being published in the BasemapLayerList. more details | BasemapLayerListViewModel | |
String | The name of the class. more details | Accessor | |
Collection<ListItem> | A collection of ListItems representing the referenceLayers. more details | BasemapLayerListViewModel | |
ListItemCreatedHandler | Specifies a function that accesses each ListItem representing reference layers. more details | BasemapLayerListViewModel | |
String | The view model's state. more details | BasemapLayerListViewModel | |
MapView|SceneView | A reference to the MapView or SceneView. more details | BasemapLayerListViewModel |
Property Details
-
baseItems Collection<ListItem>readonly
-
A collection of ListItems representing the baseLayers.
-
baseListItemCreatedFunction ListItemCreatedHandler
-
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.
-
checkPublishStatusEnabled BooleanSince: 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
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
referenceItems Collection<ListItem>readonly
-
A collection of ListItems representing the referenceLayers.
-
referenceListItemCreatedFunction ListItemCreatedHandler
-
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 |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Triggers the trigger-action event and executes the given action or action toggle. more details | BasemapLayerListViewModel |
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.
-
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"); }
-
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");
-
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.