#Interface: ICollectionTreeFolder experimental

Beta

Container for collection items

#Properties

#entryCount

readonly entryCount: number

Beta

#Remarks

Count of the entries

---

#expanded

readonly expanded: boolean

Beta

#Remarks

Expanded state of the folder

---

#folderCount

readonly folderCount: number

Beta

#Remarks

Count of the child folders

---

#id

readonly id: string

Beta

#Remarks

Unique identifier of the folder

---

#parent

readonly parent: ICollectionTreeFolder | undefined

Beta

#Remarks

Parent folder

---

#selected

readonly selected: boolean

Beta

#Remarks

Selected state of the folder

---

#title

readonly title: LocalizedString

Beta

#Remarks

Title of the folder

---

#userData

readonly userData: unknown

Beta

#Remarks

User data associated with the folder

#Methods

#addEntry()

addEntry(options): ICollectionTreeEntry

Beta

#Parameters

#options

ICollectionTreeEntryOptions

Options to create a folder

#Returns

ICollectionTreeEntry

#Remarks

Adds a new entry to the folder

---

#addFolder()

addFolder(options): ICollectionTreeFolder

Beta

#Parameters

#options

ICollectionTreeFolderOptions

Options to create a folder

#Returns

ICollectionTreeFolder

#Remarks

Creates a new child folder

---

#forEachEntry()

forEachEntry(callback): void

Beta

#Parameters

#callback

(entry, index) => boolean

Returning false will stop the iteration

#Returns

void

#Remarks

Iterates over entries within the folder

---

#forEachFolder()

#Call Signature

forEachFolder(callback): void

Beta

#Parameters

#callback

(folder) => boolean

Returning false will stop the iteration

#Returns

void

#Remarks

Iterates over the first layer of folders

#Call Signature

forEachFolder(callback): void

Beta

#Parameters

#callback

(folder) => boolean

Returning false will stop the iteration

#Returns

void

#Remarks

Iterates over the first layer of folders

---

#getEntryById()

getEntryById(id): ICollectionTreeEntry | undefined

Beta

#Parameters

#id

string

Identifier of the folder

#Returns

ICollectionTreeEntry | undefined

#Remarks

Gets the entry by its unique identifier

---

#getEntryByIndex()

getEntryByIndex(index): ICollectionTreeEntry | undefined

Beta

#Parameters

#index

number

Index of the entry

#Returns

ICollectionTreeEntry | undefined

#Remarks

Gets the entry at the index

---

#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

---

#removeEntryById()

removeEntryById(id): boolean

Beta

#Parameters

#id

string

Identifier of the folder

#Returns

boolean

#Remarks

Removes the entry by its unique identifier if it exists

---

#removeEntryByIndex()

removeEntryByIndex(index): boolean

Beta

#Parameters

#index

number

Index of the entry

#Returns

boolean

#Remarks

Removes the entry at the index if it exists

---

#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

---

#setColor()

setColor(color): void

Beta

#Parameters

#color

any

New color state

#Returns

void

#Remarks

Set color of the entry.

---

#setExpanded()

setExpanded(expanded): void

Beta

#Parameters

#expanded

boolean

New expanded state

#Returns

void

#Remarks

Set expanded state of the entry.

---

#setHeaderAction()

setHeaderAction(actionParams): void

Beta

#Parameters

#actionParams

ICollectionTreeFolderHeaderActionParams | undefined

#Returns

void

#Remarks

Updates the header action for the folder

---

#setMenu()

setMenu(menu): void

Beta

#Parameters

#menu

IMenuCreationParams[] | undefined

New menu items

#Returns

void

#Remarks

Updates menu items for the folder

---

#setSelected()

setSelected(selected): void

Beta

#Parameters

#selected

boolean

New selected state

#Returns

void

#Remarks

Set selected state of the entry.

---

#setTitle()

setTitle(title): void

Beta

#Parameters

#title

LocalizedString

New title state

#Returns

void

#Remarks

Set title of the entry.