CatalogLayerListViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Provides the logic for the CatalogLayerList widget.

See also

CatalogLayerList

Constructors

CatalogLayerListViewModel Constructor new CatalogLayerListViewModel(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
Collection<ListItem>	The collection of ListItems representing the catalogLayer's dynamicGroupLayer.	CatalogLayerListViewModel
CatalogLayer\|null\|undefined	The CatalogLayer to display in the widget.	CatalogLayerListViewModel
Boolean	Whether to provide an indication if a layer is being published in the CatalogLayerList.	CatalogLayerListViewModel
String	The name of the class.	Accessor
ListItemCreatedHandler\|null\|undefined	A function that executes each time a ListItem is created.	CatalogLayerListViewModel
String	The view model's state.	CatalogLayerListViewModel
MapView\|SceneView\|null\|undefined	The view from which the widget will operate.	CatalogLayerListViewModel

Property Details

catalogItems Property catalogItems Collection<ListItem>readonly

The collection of ListItems representing the catalogLayer's dynamicGroupLayer.

See also

selectedItems

catalogLayer Property catalogLayer CatalogLayer |null |undefined

The CatalogLayer to display in the widget.

Default Value:null

Example

catalogLayerList.catalogLayer = new CatalogLayer({ url });

checkPublishStatusEnabled Property checkPublishStatusEnabled Boolean

Whether to provide an indication if a layer is being published in the CatalogLayerList. 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 if checkPublishStatusEnabled is false.

Default Value:false

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

listItemCreatedFunction Property listItemCreatedFunction ListItemCreatedHandler |null |undefined

A function that executes each time a ListItem is created. Use this function to add actions and panels to list items, and to override the default settings of a list item. Actions can be added to list items using the actionsSections property of the ListItem.

Default Value:null

Example

// Create a new CatalogLayerListViewModel with a listItemCreatedFunction
// that adds an "add-layer" action to each catalog layer list item
const catalogLayerListViewModel = new CatalogLayerListViewModel({
 catalogLayer,
 listItemCreatedFunction: (event) => {
   const { item } = event;
   const { layer } = item;

   if (isLayerFromCatalog(layer)) {
     item.actionsSections = [
       [
         {
           title: "Add layer to map",
           icon: "add-layer",
           id: "add-layer"
         }
       ]
     ];
   }
 },
 view
});

// Listen for the trigger-action event on the CatalogLayerListViewModel
// and add layers from the catalog to the map when the "add-layer" action is triggered.
// To correctly add a layer to the map, you must create a footprint from the layer
// and then create a new layer from the footprint.
catalogLayerListViewModel.on("trigger-action", async (event) => {
  const { id } = event.action;
  const { layer } = event.item;

  if (id === "add-layer") {
    const parentCatalogLayer = catalogUtils.getCatalogLayerForLayer(layer);
    const footprint = parentCatalogLayer.createFootprintFromLayer(layer);
    const layerFromFootprint = await parentCatalogLayer.createLayerFromFootprint(footprint);
    map.add(layerFromFootprint);
  }
});

state Property state Stringreadonly

The view model's state.

Possible Values:"loading" |"ready" |"disabled"

Default Value:"disabled"

view Property view MapView |SceneView |null |undefined

The view from which the widget will operate.

Default Value:null

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
	Triggers the trigger-action event and executes the given action or action toggle.	CatalogLayerListViewModel

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	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 Inherited Method removeHandles(groupKey) Inherited from Accessor

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

triggerAction Method triggerAction()

Triggers the trigger-action event and executes the given action or action toggle.

Parameters

ActionButton|ActionToggle

The action to execute.

ListItem

An item associated with the action.

Type Definitions

ListItemCreatedHandler Type Definition ListItemCreatedHandler(event)

Function definition for the listItemCreatedFunction property. See the example snippet in the listItemCreatedFunction documentation for more details.

Parameters

event Object

An object containing a list item created by the LayerList.

Specification

item ListItem

A list item created by the CatalogLayerList. 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.

Event Overview

Name	Type	Summary	Class
	{action: ActionButton\|ActionToggle,item: ListItem}	Fires after the user clicks on an action or action toggle inside the CatalogLayerListViewModel.	CatalogLayerListViewModel

Event Details

trigger-action Event trigger-action

Fires after the user clicks on an action or action toggle inside the CatalogLayerListViewModel. 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 ListItem

The ListItem associated with the action.