GroupLayerItem | References | ArcGIS Maps SDK for JavaScript

import GroupLayerItem from "@arcgis/core/widgets/support/SelectionList/GroupLayerItem.js";

const GroupLayerItem = await $arcgis.import("@arcgis/core/widgets/support/SelectionList/GroupLayerItem.js");

Inheritance: GroupLayerItem→ItemBase→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.2

An item representing a group layer in the selection list.

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	GroupLayerItemProperties	Initial group layer item properties.

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

Properties

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

Property	Type	Class
declaredClass readonly inherited	string	Accessor
expanded	boolean
iconName readonly inherited	Icon["icon"]	ItemBase
isTable readonly	boolean
items readonly	ParentItem[]
key readonly inherited	string	ItemBase
layer readonly	SelectionListParentLayerUnion
layerIsVisible readonly	boolean
layers readonly	Layer[] \| SelectableSublayerUnion[] \| SelectionListParentLayerUnion[]
layerView readonly inherited	SelectableLayerView \| null \| undefined	ItemBase
maxVisibleFeatureCountExceeded readonly	boolean
title readonly inherited	string \| null \| undefined	ItemBase
total readonly	number
view readonly inherited	SelectableViewUnion \| null \| undefined	ItemBase
visible readonly	boolean
visibleTotal readonly	number

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

expanded

Property

Type: boolean

Indicates whether the item is expanded in the selection list.

Default value: true

iconName

readonlyinherited Property

Type: Icon["icon"]

Inherited from: ItemBase

Icon used to represent the item.

isTable

readonly Property

Type: boolean

Indicates this item contains at least one child item representing a table layer.

items

readonly Property

Type: ParentItem[]

Set of child layer items. Can also be another GroupLayerItem in the case of SubtypeGroupLayer or KnowledgeGraphLayer.

key

readonlyinherited Property

Type: string

Inherited from: ItemBase

Unique identifier used for the item.

layer

readonly Property

Type: SelectionListParentLayerUnion

Layer containing the sublayer that contains the selected features.

layerIsVisible

readonly Property

Type: boolean

Indicates the layer and at least one of its child layers are visible on the map.

layers

readonly Property

Type: Layer[] | SelectableSublayerUnion[] | SelectionListParentLayerUnion[]

Convenience property for all child layers and tables on the parent group layer.

layerView

readonlyinherited Property

Type: SelectableLayerView | null | undefined

Inherited from: ItemBase

Companion layer view of the associated layer.

maxVisibleFeatureCountExceeded

readonly Property

Type: boolean

Indicates this group item contains at least one layer item that is displaying a subset of selected features due to an upper maximum limit.

title

readonlyinherited Property

Type: string | null | undefined

Inherited from: ItemBase

Text used in the interface for the item.

total

readonly Property

Type: number

Count representing the number of selected features. This value includes features hidden by local filters, but are still selected according to the associated selection manager.

view

readonlyinherited Property

Type: SelectableViewUnion | null | undefined

Inherited from: ItemBase

Convenience property for the view associated with the view model.

visible

readonly Property

Type: boolean

Indicates this group layer item is visible in the selection list, due to one or more child items being visible.

visibleTotal

readonly Property

Type: number

Total number of visible features accounting for any filters and LayerItem.maxVisibleFeatureCountPerLayer.

Type definitions

RequiredConstructProperties

Type definition

Required properties used to construct a GroupLayerItem instance.

Supertypes: Pick<GroupLayerItem‚ "layer">