ESM: import CatalogLayerList from "@arcgis/core/widgets/CatalogLayerList.js";
CDN: const CatalogLayerList = await $arcgis.import("@arcgis/core/widgets/CatalogLayerList.js");
Class: @arcgis/core/widgets/CatalogLayerList
Since: ArcGIS Maps SDK for JavaScript 4.30
The CatalogLayerList widget provides a way to display and interact with CatalogLayers. The widget displays a list of layers in the dynamicGroupLayer and allows you to toggle their visibility.
The ListItem API provides access to each layer's properties, allows the developer to configure actions related to the layer, and allows the developer to add content to the item related to the layer.
Example
const catalogLayerList = new CatalogLayerList({
catalogLayer,
view
});
view.ui.add(catalogLayerList, "top-right"); new CatalogLayerList(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Example
// typical usage
const catalogLayerList = new CatalogLayerList({
catalogLayer,
view
});
view.ui.add(catalogLayerList, "top-right");Show inherited properties Hide inherited properties
Property DetailsThe CatalogLayer to display in the widget.
Example
catalogLayerList.catalogLayer = new CatalogLayer({ url }); collapsed Boolean
Indicates whether the widget is collapsed. When collapsed, only the collapse button and the heading are displayed.
Example
catalogLayerList.collapsed = true;The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use case when working with widgets.
Examples
// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
view: view,
container: document.createElement("div")
});
// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
position: "top-right"
});// Specify an already-defined HTML div element in the widget's container
const basemapGallery = new BasemapGallery({
view: view,
container: basemapGalleryDiv
});
// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
position: "top-right"
});
// HTML markup
<body>
<div id="viewDiv"></div>
<div id="basemapGalleryDiv"></div>
</body>// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
view: view
});
// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
position: "top-right"
});Inherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className.
filterPlaceholder String
Placeholder text used in the filter input if visibleElements.filter is true.
Example
catalogLayerList.filterPlaceholder = "Filter layers";Since: ArcGIS Maps SDK for JavaScript 4.32 CatalogLayerList since 4.30, filterPredicate added at 4.32.
Specifies a function to handle filtering list items.
Example
layerList.filterPredicate = (item) => item.title.toLowerCase().includes("streets"); filterText String
The value of the filter input if visibleElements.filter is true.
Example
reactiveUtils.watch(
() => catalogLayerList.filterText,
(filterText) => console.log(filterText)
); headingLevel Number
Indicates the heading level to use for the heading of the widget. By default, the heading is rendered as a level 2 heading (e.g., <h2>Catalog Layer List</h2>). Depending on the widget's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.
Example
catalogLayerList.headingLevel = 3;Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).
Inherited
Property id String
The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.
The widget's default label.
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.
Example
// Create a new CatalogLayerList with a listItemCreatedFunction
// that adds an "add-layer" action to each catalog layer list item
const catalogLayerList = new CatalogLayerList({
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.
catalogLayerList.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);
}
}); minFilterItems Number
The minimum number of list items required to display the visibleElements.filter input box.
Example
layerList.visibleElements.filter = true;
layerList.minFilterItems = 5; selectionMode String
Specifies the selection mode. Selected items are available in the selectedItems property.
Value Description multiple Allows any number of items to be selected at once. This is useful when you want to apply an operation to multiple items at the same time. none Disables selection. Use this when you want to prevent selecting items. single Allows only one item to be selected at a time. If another item is selected, the previous selection is cleared. This is useful when you want to ensure that a maximum of one item is selected at a time. single-persist Allows only one item to be selected at a time and prevents de-selection. Once an item is selected, it remains selected until another item is selected. This is useful when you want to ensure that there is always exactly one selected item.Possible Values:"multiple" |"none" |"single" |"single-persist"
Example
catalogLayerList.selectionMode = "multiple";The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the CatalogLayerListViewModel class to access all properties and methods on the widget.
visibilityAppearance String
Determines the icons used to indicate visibility.
Possible Values:"default" |"checkbox"
Example
catalogLayerList.visibilityAppearance = "checkbox";Inherited
Property visible Boolean
Indicates whether the widget is visible.
If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of "none".
Example
// Hides the widget in the view
widget.visible = false;The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.
Example
catalogLayerList.visibleElements = {
closeButton: false,
collapseButton: true,
errors: true,
filter: true,
heading: true,
statusIndicators: true
};Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
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.
Inherited
Method classes(classNames){String}
A utility method used for building the value for a widget's class property. This aids in simplifying css class setup.
Returns
Type Description String The computed class name.Example
// .tsx syntax showing how to set css classes while rendering the widget
render() {
const dynamicClasses = {
[css.flip]: this.flip,
[css.primary]: this.primary
};
return (
<div class={classes(css.root, css.mixin, dynamicClasses)} />
);
}Inherited
Method destroy()
Destroys the widget instance.
Inherited
Method emit(type, event){Boolean}
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameters
The name of the event.
optionalThe event payload.
Returns
Type Description Booleantrue if a listener was notified
Inherited
Method hasEventListener(type){Boolean}
Indicates whether there is an event listener on the instance that matches the provided event name.
Returns
Type Description Boolean Returns true if the class supports the input event.Inherited
Method hasHandles(groupKey){Boolean}
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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");
}Inherited
Method isFulfilled(){Boolean}
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).Inherited
Method isRejected(){Boolean}
isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been rejected.Inherited
Method isResolved(){Boolean}
isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.
Returns
Type Description Boolean Indicates whether creating an instance of the class has been resolved.Inherited
Method on(type, listener){Object}
Registers an event handler on the instance. Call this method to hook an event with a listener.
Returns
Type Description Object Returns an event handler with aremove() 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);
});Inherited
Method postInitialize()
Executes after widget is ready for rendering.
Inherited
Method removeHandles(groupKey)
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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");Inherited
Method render(){Object}
This method is implemented by subclasses for rendering.
Returns
Type Description Object The rendered virtual node.Inherited
Method renderNow()
Renders widget to the DOM immediately.
Inherited
Method scheduleRender()
Schedules widget rendering. This method is useful for changes affecting the UI.
Inherited
Method when(callback, errback){Promise}
when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.
Parameters
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new Promise for the result ofcallback.
Example
// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
// This function will execute once the promise is resolved
}, function(error){
// This function will execute if the promise is rejected due to an error
}); FilterPredicate(item)
Specifies a function to handle filtering list items.
Parameter
A list item created by the CatalogLayerList.
ListItemCreatedHandler(event)
Function definition for the listItemCreatedFunction property. See the example snippet in the listItemCreatedFunction documentation for more details.
Parameters
An object containing a list item created by the LayerList.
Specification
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.
VisibleElements Accessor
The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.
Default Value:false
Indicates whether to display a close button in the header.
Default Value:false
Indicates whether to display a collapse button in the header.
Default Value:false
Indicates whether to display layers with load errors.
Default Value:false
Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in minFilterItems, allowing users to filter layers by their title.
Default Value:true
Determines whether the widget should be shown within its built-in flow component or if the flow component should be excluded. The widget will be displayed within its original flow component if set to true. The flow component will be omitted from the widget if set to false. To place the widget into an existing Calcite flow component, set this property to false.
Default Value:false
Indicates whether to display the widget heading. The heading text is "Layer List". The heading level can be set with the headingLevel.
Default Value:true
Indicates whether the status indicators will be displayed.
Default Value:false
Indicates whether temporary layer indicators will be displayed. A temporary icon will be displayed on the near side of the layer title.
trigger-action
Fires after the user clicks on an action or action toggle inside the CatalogLayerList widget. This event may be used to define a custom function to execute when particular actions are clicked.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4