#Interface: ICollectionTreePropertyItem experimental

Beta

A property item which supports creating nested folders of collection items

#Extends

• IPropertyItemBase

#Properties

#canDragDropEntries

readonly canDragDropEntries: boolean

Beta

#Remarks

Drag and drop support for the entries

---

#enable

enable: boolean

Beta

#Remarks

If the item is enabled in the UI.

#Inherited from

IPropertyItemBase.enable

---

#folderCount

readonly folderCount: number

Beta

#Remarks

Count of the child folders

---

#id

readonly id: string

Beta

#Remarks

Unique ID for the property item.

#Inherited from

IPropertyItemBase.id

---

#paneId

readonly paneId: string

Beta

#Remarks

The parent pane id.

#Inherited from

IPropertyItemBase.paneId

---

#typeName

readonly typeName: PropertyItemType

Beta

#Remarks

The type name of the target property.

#Inherited from

IPropertyItemBase.typeName

---

#viewControlPane

readonly viewControlPane: IListViewControlPane | undefined

Beta

#Remarks

View control pane for the collection tree

---

#viewSortType

readonly viewSortType: CollectionTreeSortType

Beta

#Remarks

Sort type for the folders.

---

#visible

visible: boolean

Beta

#Remarks

If the item should be visible in the UI.

#Inherited from

IPropertyItemBase.visible

#Methods

#addFolder()

addFolder(options): ICollectionTreeFolder

Beta

#Parameters

#options

ICollectionTreeFolderOptions

Options to create a folder

#Returns

ICollectionTreeFolder

#Remarks

Creates a new folder at the root of the collection

---

#buildViewControl()

buildViewControl(options): IListViewControlPane

Beta

#Parameters

#options

ICollectionTreeViewControlPaneOptions

#Returns

IListViewControlPane

#Remarks

Creates a pane that displays view and filtering configurations for the collection tree if the parent container supports it.

---

#forEachFolder()

forEachFolder(callback): void

Beta

#Parameters

#callback

(folder) => boolean

Returning false will stop the iteration

#Returns

void

#Remarks

Iterates over the first layer of folders

---

#getFolder()

getFolder(id): ICollectionTreeFolder | undefined

Beta

#Parameters

#id

string

Identifier of the folder

#Returns

ICollectionTreeFolder | undefined

#Remarks

Find the folder with the id if it exists at the root

---

#removeFolder()

removeFolder(id): boolean

Beta

#Parameters

#id

string

Identifier of the folder

#Returns

boolean

#Remarks

Removes the folder with the id if it exists at the root

---

#setCanDragDropEntries()

setCanDragDropEntries(enabled): void

Beta

#Parameters

#enabled

boolean

Whether to enable drag and drop

#Returns

void

#Remarks

Toggles drag and drop support for the entries

---

#setViewSortType()

setViewSortType(sortType): void

Beta

#Parameters

#sortType

CollectionTreeSortType | undefined

New sort type

#Returns

void

#Remarks

Updates the folder sort type for the whole view