CatalogLayerListViewModel

AMD: require(["esri/widgets/CatalogLayerList/CatalogLayerListViewModel"], (CatalogLayerListVM) => { /* code goes here */ });
ESM: import CatalogLayerListVM from "@arcgis/core/widgets/CatalogLayerList/CatalogLayerListViewModel.js";
Class: esri/widgets/CatalogLayerList/CatalogLayerListViewModel
Inheritance: CatalogLayerListViewModelAccessor
Since: ArcGIS Maps SDK for JavaScript 4.30

Provides the logic for the CatalogLayerList widget.

See also

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
Name Type Summary Class

The collection of ListItems representing the catalogLayer's dynamicGroupLayer.

CatalogLayerListViewModel

The CatalogLayer to display in the widget.

CatalogLayerListViewModel

Whether to provide an indication if a layer is being published in the CatalogLayerList.

CatalogLayerListViewModel

The name of the class.

Accessor

A function that executes each time a ListItem is created.

CatalogLayerListViewModel

Specifies whether to ignore the listMode property of the layers to display all layers.

CatalogLayerListViewModel

The view model's state.

CatalogLayerListViewModel

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

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

listModeDisabled

Property
listModeDisabled Boolean
Since: ArcGIS Maps SDK for JavaScript 4.32

Specifies whether to ignore the listMode property of the layers to display all layers.

Default Value:false
See also

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
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.

CatalogLayerListViewModel

Indicates whether there is an event listener on the instance that matches the provided event name.

CatalogLayerListViewModel

Returns true if a named group of handles exist.

Accessor

Registers an event handler on the instance.

CatalogLayerListViewModel

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.

emit

Method
emit(type, event){Boolean}

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters
type String

The name of the event.

event Object
optional

The event payload.

Returns
Type Description
Boolean true if a listener was notified

hasEventListener

Method
hasEventListener(type){Boolean}

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter
type String

The name of the event.

Returns
Type Description
Boolean Returns true if the class supports the input event.

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");
}

on

Method
on(type, listener){Object}

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns
Type 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.
Example
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

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

The action to execute.

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

The action clicked by the user.

item ListItem

The ListItem associated with the action.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close