Interface ICollectionTreePropertyItem

A property item which supports creating nested folders of collection items

interface ICollectionTreePropertyItem {
    enable: boolean;
    folderCount: number;
    id: string;
    paneId: string;
    typeName: PropertyItemType;
    viewSortType: CollectionTreeSortType;
    visible: boolean;
    addFolder(options: ICollectionTreeFolderOptions): ICollectionTreeFolder;
    forEachFolder(callback: (folder: ICollectionTreeFolder) => boolean): void;
    getFolder(id: string): ICollectionTreeFolder;
    setViewSortType(sortType: CollectionTreeSortType): void;
}

Hierarchy (View Summary)

IPropertyItemBase
- ICollectionTreePropertyItem

Index

Properties

enable folderCount id paneId typeName viewSortType visible

Methods

addFolder forEachFolder getFolder setViewSortType

Properties

enable

enable: boolean

Remarks

If the item is enabled in the UI.

`Readonly`folderCount

folderCount: number

Remarks

Count of the child folders

`Readonly`id

id: string

Remarks

Unique ID for the property item.

`Readonly`paneId

paneId: string

Remarks

The parent pane id.

`Readonly`typeName

typeName: PropertyItemType

Remarks

The type name of the target property.

`Readonly`viewSortType

viewSortType: CollectionTreeSortType

Remarks

Sort type for the folders.

visible

visible: boolean

Remarks

If the item should be visible in the UI.

Methods

addFolder

addFolder(options: ICollectionTreeFolderOptions): ICollectionTreeFolder
Parameters
- options: ICollectionTreeFolderOptions
  Options to create a folder
Returns ICollectionTreeFolder
Remarks
Creates a new folder at the root of the collection

forEachFolder

forEachFolder(callback: (folder: ICollectionTreeFolder) => boolean): void
Parameters
- callback: (folder: ICollectionTreeFolder) => boolean
  Returning false will stop the iteration
Returns void
Remarks
Iterates over the first layer of folders

getFolder

getFolder(id: string): ICollectionTreeFolder
Parameters
- id: string
  Identifier of the folder
Returns ICollectionTreeFolder
Remarks
Find the folder with the id if it exists at the root

setViewSortType

setViewSortType(sortType: CollectionTreeSortType): void
Parameters
- sortType: CollectionTreeSortType
  New sort type
Returns void
Remarks
Updates the folder sort type for the whole view