Skip to main content

Interface: TreeRef<T>

Type parameters

NameType
Tany

Hierarchy

Properties

abortRenamingItem

abortRenamingItem: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.abortRenamingItem

Defined in

types.ts:392


abortSearch

abortSearch: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.abortSearch

Defined in

types.ts:404


areItemsSelected

areItemsSelected: boolean

Inherited from

TreeInformation.areItemsSelected

Defined in

types.ts:65


collapseAll

collapseAll: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.collapseAll

Defined in

types.ts:406


collapseItem

collapseItem: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters
NameType
itemIdTreeItemIndex
Returns

void

Inherited from

TreeChangeActions.collapseItem

Defined in

types.ts:394


completeRenamingItem

completeRenamingItem: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.completeRenamingItem

Defined in

types.ts:391


dragAndDropContext

dragAndDropContext: DragAndDropContextProps<T>

Defined in

types.ts:415


expandAll

expandAll: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.expandAll

Defined in

types.ts:405


expandItem

expandItem: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters
NameType
itemIdTreeItemIndex
Returns

void

Inherited from

TreeChangeActions.expandItem

Defined in

types.ts:395


expandSubsequently

expandSubsequently: (itemIds: TreeItemIndex[]) => Promise<void>

Type declaration

▸ (itemIds): Promise<void>

Parameters
NameType
itemIdsTreeItemIndex[]
Returns

Promise<void>

Inherited from

TreeChangeActions.expandSubsequently

Defined in

types.ts:407


focusItem

focusItem: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters
NameType
itemIdTreeItemIndex
Returns

void

Inherited from

TreeChangeActions.focusItem

Defined in

types.ts:399


focusTree

focusTree: (autoFocus?: boolean) => void

Type declaration

▸ (autoFocus?): void

Parameters
NameType
autoFocus?boolean
Returns

void

Inherited from

TreeChangeActions.focusTree

Defined in

types.ts:388


invokePrimaryAction

invokePrimaryAction: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters
NameType
itemIdTreeItemIndex
Returns

void

Inherited from

TreeChangeActions.invokePrimaryAction

Defined in

types.ts:402


isFocused

isFocused: boolean

Inherited from

TreeInformation.isFocused

Defined in

types.ts:67


isProgrammaticallyDragging

isProgrammaticallyDragging: boolean

Inherited from

TreeInformation.isProgrammaticallyDragging

Defined in

types.ts:70


isRenaming

isRenaming: boolean

Inherited from

TreeInformation.isRenaming

Defined in

types.ts:66


isSearching

isSearching: boolean

Inherited from

TreeInformation.isSearching

Defined in

types.ts:68


moveFocusDown

moveFocusDown: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.moveFocusDown

Defined in

types.ts:401


moveFocusUp

moveFocusUp: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.moveFocusUp

Defined in

types.ts:400


renameItem

renameItem: (itemId: TreeItemIndex, name: string) => void

Type declaration

▸ (itemId, name): void

Parameters
NameType
itemIdTreeItemIndex
namestring
Returns

void

Inherited from

TreeChangeActions.renameItem

Defined in

types.ts:393


rootItem

rootItem: string

Inherited from

TreeInformation.rootItem

Defined in

types.ts:368


search: null | string

Overrides

TreeInformation.search

Defined in

types.ts:416


selectItems

selectItems: (itemsIds: TreeItemIndex[]) => void

Type declaration

▸ (itemsIds): void

Parameters
NameType
itemsIdsTreeItemIndex[]
Returns

void

Inherited from

TreeChangeActions.selectItems

Defined in

types.ts:397


setSearch

setSearch: (search: null | string) => void

Type declaration

▸ (search): void

Parameters
NameType
searchnull | string
Returns

void

Inherited from

TreeChangeActions.setSearch

Defined in

types.ts:403


startRenamingItem

startRenamingItem: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters
NameType
itemIdTreeItemIndex
Returns

void

Inherited from

TreeChangeActions.startRenamingItem

Defined in

types.ts:389


stopRenamingItem

stopRenamingItem: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.stopRenamingItem

Defined in

types.ts:390


toggleItemExpandedState

toggleItemExpandedState: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters
NameType
itemIdTreeItemIndex
Returns

void

Inherited from

TreeChangeActions.toggleItemExpandedState

Defined in

types.ts:396


toggleItemSelectStatus

toggleItemSelectStatus: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters
NameType
itemIdTreeItemIndex
Returns

void

Inherited from

TreeChangeActions.toggleItemSelectStatus

Defined in

types.ts:398


treeContext

treeContext: TreeContextProps

Defined in

types.ts:413


treeEnvironmentContext

treeEnvironmentContext: TreeEnvironmentContextProps<T, never>

Defined in

types.ts:414


treeId

treeId: string

Inherited from

TreeInformation.treeId

Defined in

types.ts:367


treeLabel

Optional treeLabel: string

Inherited from

TreeInformation.treeLabel

Defined in

types.ts:369


treeLabelledBy

Optional treeLabelledBy: string

Inherited from

TreeInformation.treeLabelledBy

Defined in

types.ts:370