Interface: TreeRef<T>

Type parameters

Name	Type
T	any

Hierarchy

• TreeChangeActions

• TreeInformation

  ↳ TreeRef

Properties

abortRenamingItem

• abortRenamingItem: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.abortRenamingItem

Defined in

types.ts:415

---

abortSearch

• abortSearch: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.abortSearch

Defined in

types.ts:430

---

areItemsSelected

• areItemsSelected: boolean

Inherited from

TreeInformation.areItemsSelected

Defined in

types.ts:67

---

collapseAll

• collapseAll: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.collapseAll

Defined in

types.ts:432

---

collapseItem

• collapseItem: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters

Name	Type
itemId	TreeItemIndex

Returns

void

Inherited from

TreeChangeActions.collapseItem

Defined in

types.ts:417

---

completeRenamingItem

• completeRenamingItem: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.completeRenamingItem

Defined in

types.ts:414

---

dragAndDropContext

• dragAndDropContext: DragAndDropContextProps<T>

Defined in

types.ts:441

---

expandAll

• expandAll: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.expandAll

Defined in

types.ts:431

---

expandItem

• expandItem: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters

Name	Type
itemId	TreeItemIndex

Returns

void

Inherited from

TreeChangeActions.expandItem

Defined in

types.ts:418

---

expandSubsequently

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

Type declaration

▸ (itemIds): Promise<void>

Parameters

Name	Type
itemIds	TreeItemIndex[]

Returns

Promise<void>

Inherited from

TreeChangeActions.expandSubsequently

Defined in

types.ts:433

---

focusItem

• focusItem: (itemId: TreeItemIndex, setDomFocus?: boolean) => void

Type declaration

▸ (itemId, setDomFocus?): void

Parameters

Name	Type	Description
itemId	TreeItemIndex	-
setDomFocus?	boolean	Defaults to true.

Returns

void

Inherited from

TreeChangeActions.focusItem

Defined in

types.ts:424

---

focusTree

• focusTree: (autoFocus?: boolean) => void

Type declaration

▸ (autoFocus?): void

Parameters

Name	Type
autoFocus?	boolean

Returns

void

Inherited from

TreeChangeActions.focusTree

Defined in

types.ts:411

---

invokePrimaryAction

• invokePrimaryAction: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters

Name	Type
itemId	TreeItemIndex

Returns

void

Inherited from

TreeChangeActions.invokePrimaryAction

Defined in

types.ts:428

---

isFocused

• isFocused: boolean

Inherited from

TreeInformation.isFocused

Defined in

types.ts:69

---

isProgrammaticallyDragging

• isProgrammaticallyDragging: boolean

Inherited from

TreeInformation.isProgrammaticallyDragging

Defined in

types.ts:72

---

isRenaming

• isRenaming: boolean

Inherited from

TreeInformation.isRenaming

Defined in

types.ts:68

---

isSearching

• isSearching: boolean

Inherited from

TreeInformation.isSearching

Defined in

types.ts:70

---

moveFocusDown

• moveFocusDown: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.moveFocusDown

Defined in

types.ts:427

---

moveFocusUp

• moveFocusUp: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.moveFocusUp

Defined in

types.ts:426

---

renameItem

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

Type declaration

▸ (itemId, name): void

Parameters

Name	Type
itemId	TreeItemIndex
name	string

Returns

void

Inherited from

TreeChangeActions.renameItem

Defined in

types.ts:416

---

rootItem

• rootItem: string

Inherited from

TreeInformation.rootItem

Defined in

types.ts:391

---

search

• search: null | string

Overrides

TreeInformation.search

Defined in

types.ts:442

---

selectItems

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

Type declaration

▸ (itemsIds): void

Parameters

Name	Type
itemsIds	TreeItemIndex[]

Returns

void

Inherited from

TreeChangeActions.selectItems

Defined in

types.ts:420

---

setSearch

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

Type declaration

▸ (search): void

Parameters

Name	Type
search	null | string

Returns

void

Inherited from

TreeChangeActions.setSearch

Defined in

types.ts:429

---

startRenamingItem

• startRenamingItem: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters

Name	Type
itemId	TreeItemIndex

Returns

void

Inherited from

TreeChangeActions.startRenamingItem

Defined in

types.ts:412

---

stopRenamingItem

• stopRenamingItem: () => void

Type declaration

▸ (): void

Returns

void

Inherited from

TreeChangeActions.stopRenamingItem

Defined in

types.ts:413

---

toggleItemExpandedState

• toggleItemExpandedState: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters

Name	Type
itemId	TreeItemIndex

Returns

void

Inherited from

TreeChangeActions.toggleItemExpandedState

Defined in

types.ts:419

---

toggleItemSelectStatus

• toggleItemSelectStatus: (itemId: TreeItemIndex) => void

Type declaration

▸ (itemId): void

Parameters

Name	Type
itemId	TreeItemIndex

Returns

void

Inherited from

TreeChangeActions.toggleItemSelectStatus

Defined in

types.ts:421

---

treeContext

• treeContext: TreeContextProps

Defined in

types.ts:439

---

treeEnvironmentContext

• treeEnvironmentContext: TreeEnvironmentContextProps<T, never>

Defined in

types.ts:440

---

treeId

• treeId: string

Inherited from

TreeInformation.treeId

Defined in

types.ts:390

---

treeLabel

• Optional treeLabel: string

Inherited from

TreeInformation.treeLabel

Defined in

types.ts:392

---

treeLabelledBy

• Optional treeLabelledBy: string

Inherited from

TreeInformation.treeLabelledBy

Defined in

types.ts:393