Tree API Reference

Properties

Name Type Default Value
allowDrag boolean false
allowDrop boolean false
animation string 'advanced'
autoHideToggleElement boolean false
autoLoadState boolean false
autoSaveState boolean false
autoSort boolean true
dataSource {label: string, selected: boolean, items: []}[] null
disabled boolean false
displayLoadingIndicator boolean false
displayMember string 'label'
dragFeedbackFormatFunction function | null null
dragOffset number[] 10,10
editable boolean false
filterable boolean false
filterInputPlaceholder string ''
filterMode string 'containsIgnoreCase'
hasThreeStates boolean false
itemsMember string 'items'
loadingIndicatorPlaceholder string 'Loading...'
loadingIndicatorPosition string 'center'
locale string 'en'
localizeFormatFunction function | null null
messages object Please expand entry to see value
overflow string 'auto'
readonly boolean false
rightToLeft boolean false
scrollMode string 'scrollbar'
selectedIndexes string[]
selectionDisplayMode string 'row'
selectionMode string 'one'
showLines boolean false
showRootLines boolean false
sort function | null null
sortDirection string 'asc'
sorted boolean false
theme string ''
toggleElementPosition string 'near'
toggleMode string 'dblclick'
unfocusable boolean false
valueMember string 'value'

Events

Name Type
change Event
collapse Event
collapsing Event
dragEnd Event
dragging Event
dragStart Event
expand Event
expanding Event
scrollBottomReached Event
scrollTopReached Event

Methods

Name Type Return Type
addAfter(item: HTMLElement, sibling: string | HTMLElement): void Method void
addBefore(item: HTMLElement, sibling: string | HTMLElement): void Method void
addTo(item: HTMLElement, parent?: string | HTMLElement): void Method void
clearSelection(): void Method void
collapseAll(animation?: boolean): void Method void
collapseItem(item: HTMLElement | string, animation?: boolean): void Method void
ensureVisible(item: HTMLElement | string): void Method void
expandAll(animation?: string): void Method void
expandItem(item: HTMLElement | string, animation?: boolean): void Method void
filter(filterQuery: string): void Method void
getItem(id: string): smart-tree-item/smart-tree-items-group Method smart-tree-item/smart-tree-items-group
getState(): object Method object
insert(item: HTMLElement | object, path?: string): void Method void
loadState(state?: object): void Method void
moveDown(item: HTMLElement | string): void Method void
moveUp(item: HTMLElement | string): void Method void
removeItem(item: HTMLElement | string): void Method void
saveState(): object Method object
select(item: HTMLElement | string): void Method void
unselect(item: HTMLElement | string): void Method void
updateItem(item: HTMLElement | string, newItem: object): void Method void