TreeInstance <T>

Hierarchy

• TreeInstanceType<T>
  • TreeInstance

Index

Properties

• abortRenaming
• closeSearch
• collapseAll
• collapseItem
• completeRenaming
• expandAll
• expandItem
• focusItem
• focusNextItem
• focusPreviousItem
• getConfig
• getContainerProps
• getDragLineData
• getDropTarget
• getElement
• getFocusedItem
• getHotkeyPresets
• getItemInstance
• getItems
• getRenamingItem
• getRenamingValue
• getSearchInputElement
• getSearchInputElementProps
• getSearchMatchingItems
• getSearchValue
• getSelectedItems
• getState
• invalidateChildrenIds
• invalidateItemData
• isItemExpanded
• isRenamingItem
• isSearchOpen
• openSearch
• rebuildTree
• registerElement
• registerSearchInputElement
• retrieveChildrenIds
• retrieveItemData
• setConfig
• setSearch
• setSelectedItems
• setState
• startRenamingItem
• updateDomFocus

Properties

abortRenaming

abortRenaming: () => void

Inherited from TreeInstanceType.abortRenaming

Type declaration

• • (): void

  • Returns void

closeSearch

closeSearch: () => void

Inherited from TreeInstanceType.closeSearch

Type declaration

• • (): void

  • Returns void

collapseAll

collapseAll: () => void

Inherited from TreeInstanceType.collapseAll

Type declaration

• • (): void

  • Returns void

collapseItem

collapseItem: (itemId: string) => void

Inherited from TreeInstanceType.collapseItem

Type declaration

• • (itemId: string): void

  • Parameters

    • itemId: string

    Returns void

completeRenaming

completeRenaming: () => void

Inherited from TreeInstanceType.completeRenaming

Type declaration

• • (): void

  • Returns void

expandAll

expandAll: (cancelToken?: { current: boolean }) => Promise<void>

Inherited from TreeInstanceType.expandAll

Type declaration

• • (cancelToken?: { current: boolean }): Promise<void>

  • Parameters

    • optionalcancelToken: { current: boolean }

    Returns Promise<void>

expandItem

expandItem: (itemId: string) => void

Inherited from TreeInstanceType.expandItem

Type declaration

• • (itemId: string): void

  • Parameters

    • itemId: string

    Returns void

focusItem

focusItem: (itemId: string) => void

Inherited from TreeInstanceType.focusItem

Type declaration

• • (itemId: string): void

  • Parameters

    • itemId: string

    Returns void

focusNextItem

focusNextItem: () => void

Inherited from TreeInstanceType.focusNextItem

Type declaration

• • (): void

  • Returns void

focusPreviousItem

focusPreviousItem: () => void

Inherited from TreeInstanceType.focusPreviousItem

Type declaration

• • (): void

  • Returns void

getConfig

getConfig: () => TreeConfig<any>

Inherited from TreeInstanceType.getConfig

Type declaration

• • (): TreeConfig<any>

  • Returns TreeConfig<any>

getContainerProps

getContainerProps: () => Record<string, any>

Inherited from TreeInstanceType.getContainerProps

Type declaration

• • (): Record<string, any>

  • Returns Record<string, any>

getDragLineData

getDragLineData: () => null | DragLineData

Inherited from TreeInstanceType.getDragLineData

Type declaration

• • (): null | DragLineData

  • Returns null | DragLineData

getDropTarget

getDropTarget: () => null | DropTarget<T>

Inherited from TreeInstanceType.getDropTarget

Type declaration

• • (): null | DropTarget<T>

  • Returns null | DropTarget<T>

getElement

getElement: () => undefined | null | HTMLElement

Inherited from TreeInstanceType.getElement

Type declaration

• • (): undefined | null | HTMLElement

  • Returns undefined | null | HTMLElement

getFocusedItem

getFocusedItem: () => ItemInstance<any>

Inherited from TreeInstanceType.getFocusedItem

Type declaration

• • (): ItemInstance<any>

  • Returns ItemInstance<any>

getHotkeyPresets

getHotkeyPresets: () => HotkeysConfig<any>

Inherited from TreeInstanceType.getHotkeyPresets

Type declaration

• • (): HotkeysConfig<any>

  • Returns HotkeysConfig<any>

getItemInstance

getItemInstance: (itemId: string) => ItemInstance<any>

Inherited from TreeInstanceType.getItemInstance

Type declaration

• • (itemId: string): ItemInstance<any>

  • Parameters

    • itemId: string

    Returns ItemInstance<any>

getItems

getItems: () => ItemInstance<any>[]

Inherited from TreeInstanceType.getItems

Type declaration

• • (): ItemInstance<any>[]

  • Returns ItemInstance<any>[]

getRenamingItem

getRenamingItem: () => null | ItemInstance<T>

Inherited from TreeInstanceType.getRenamingItem

Type declaration

• • (): null | ItemInstance<T>

  • Returns null | ItemInstance<T>

getRenamingValue

getRenamingValue: () => string

Inherited from TreeInstanceType.getRenamingValue

Type declaration

• • (): string

  • Returns string

getSearchInputElement

getSearchInputElement: () => null | HTMLInputElement

Inherited from TreeInstanceType.getSearchInputElement

Type declaration

• • (): null | HTMLInputElement

  • Returns null | HTMLInputElement

getSearchInputElementProps

getSearchInputElementProps: () => any

Inherited from TreeInstanceType.getSearchInputElementProps

Type declaration

• • (): any

  • Returns any

getSearchMatchingItems

getSearchMatchingItems: () => ItemInstance<T>[]

Inherited from TreeInstanceType.getSearchMatchingItems

Type declaration

• • (): ItemInstance<T>[]

  • Returns ItemInstance<T>[]

getSearchValue

getSearchValue: () => string

Inherited from TreeInstanceType.getSearchValue

Type declaration

• • (): string

  • Returns string

getSelectedItems

getSelectedItems: () => ItemInstance<T>[]

Inherited from TreeInstanceType.getSelectedItems

Type declaration

• • (): ItemInstance<T>[]

  • Returns ItemInstance<T>[]

getState

getState: () => TreeState<any>

Inherited from TreeInstanceType.getState

Type declaration

• • (): TreeState<any>

  • Returns TreeState<any>

invalidateChildrenIds

invalidateChildrenIds: (itemId: string) => void

Inherited from TreeInstanceType.invalidateChildrenIds

Type declaration

• • (itemId: string): void

  • Parameters

    • itemId: string

    Returns void

invalidateItemData

invalidateItemData: (itemId: string) => void

Inherited from TreeInstanceType.invalidateItemData

Invalidate fetched data for item, and triggers a refetch and subsequent rerender if the item is visible

---

Type declaration

• • (itemId: string): void

  • Parameters

    • itemId: string

    Returns void

isItemExpanded

isItemExpanded: (itemId: string) => boolean

Inherited from TreeInstanceType.isItemExpanded

Type declaration

• • (itemId: string): boolean

  • Parameters

    • itemId: string

    Returns boolean

isRenamingItem

isRenamingItem: () => boolean

Inherited from TreeInstanceType.isRenamingItem

Type declaration

• • (): boolean

  • Returns boolean

isSearchOpen

isSearchOpen: () => boolean

Inherited from TreeInstanceType.isSearchOpen

Type declaration

• • (): boolean

  • Returns boolean

openSearch

openSearch: (initialValue?: string) => void

Inherited from TreeInstanceType.openSearch

Type declaration

• • (initialValue?: string): void

  • Parameters

    • optionalinitialValue: string

    Returns void

rebuildTree

rebuildTree: () => void

Inherited from TreeInstanceType.rebuildTree

Type declaration

• • (): void

  • Returns void

registerElement

registerElement: (element: null | HTMLElement) => void

Inherited from TreeInstanceType.registerElement

Type declaration

• • (element: null | HTMLElement): void

  • Parameters

    • element: null | HTMLElement

    Returns void

registerSearchInputElement

registerSearchInputElement: (element: null | HTMLInputElement) => void

Inherited from TreeInstanceType.registerSearchInputElement

Type declaration

• • (element: null | HTMLInputElement): void

  • Parameters

    • element: null | HTMLInputElement

    Returns void

retrieveChildrenIds

retrieveChildrenIds: (itemId: string) => string[]

Inherited from TreeInstanceType.retrieveChildrenIds

Type declaration

• • (itemId: string): string[]

  • Parameters

    • itemId: string

    Returns string[]

retrieveItemData

retrieveItemData: (itemId: string) => T

Inherited from TreeInstanceType.retrieveItemData

Type declaration

• • (itemId: string): T

  • Parameters

    • itemId: string

    Returns T

setConfig

setConfig: SetStateFn<TreeConfig<any>>

Inherited from TreeInstanceType.setConfig

setSearch

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

Inherited from TreeInstanceType.setSearch

Type declaration

• • (search: null | string): void

  • Parameters

    • search: null | string

    Returns void

setSelectedItems

setSelectedItems: (selectedItems: string[]) => void

Inherited from TreeInstanceType.setSelectedItems

Type declaration

• • (selectedItems: string[]): void

  • Parameters

    • selectedItems: string[]

    Returns void

setState

setState: SetStateFn<TreeState<any>>

Inherited from TreeInstanceType.setState

startRenamingItem

startRenamingItem: (itemId: string) => void

Inherited from TreeInstanceType.startRenamingItem

Type declaration

• • (itemId: string): void

  • Parameters

    • itemId: string

    Returns void

updateDomFocus

updateDomFocus: () => void

Inherited from TreeInstanceType.updateDomFocus

Type declaration

• • (): void

  • Returns void