Interface IVirtualTreeStore<N, T, K, DS>

Public

interface IVirtualTreeStore<
    N extends ITreeNodeModel<T, K>,
    T,
    K extends NodeKeyType = NodeKeyType,
    DS extends IDraftStore = never,
> {
    actions: TreeNodeActionItem<VirtualItem<N>, K>[];
    childrenLoadingKeys: Set<K>;
    disabledItemsMap: Map<K, VirtualItem<N>>;
    draftStore: Optional<DS>;
    isScrolledOut: boolean;
    renderedNodes: TreeNodeType<VirtualItem<N>, K>[];
    scrollContainerStyle: { height: string; paddingTop: string };
    scrollPosition: number;
    searchText?: string;
    selectedItems: N[];
    selectedItemsMap: Map<K, N>;
    get isLoading(): boolean;
    addNode(parentNode?: VirtualItem<N>, data?: {}): void;
    applyTreeState(state: IVirtualTreeState<N, T, K>): void;
    clearAll(): void;
    collapseAll(): void;
    collapseNode(nodeKey: K): void;
    deleteNode(node: VirtualItem<N>, cascade?: boolean): void;
    disableNode(key: K): void;
    expandNode(nodeKey: K): void;
    getItem(name: K): N;
    getItemsCount(): number;
    getLevel(nodeKey: K): number;
    getNodeChildren(nodeKey?: K): K[];
    getPath(nodeKey: K, includeCurrentNode?: boolean): K[];
    getStringPath(nodeKey: K, includeCurrentNode?: boolean): string;
    getTreeState(): IVirtualTreeState<N, T, K>;
    getUiTreeNode(node: VirtualItem<N>): TreeNodeType<VirtualItem<N>, K>;
    hasValidationErrors(): boolean;
    isFiltered(): boolean;
    isNodeCascadeDeleted(nodeKey: K): boolean;
    isNodeDeleted(nodeKey: K): boolean;
    isNodeDisabled(nodeKey: K): boolean;
    isNodeExpanded(nodeKey: K): boolean;
    isNodeInTree(nodeKey: K, byFilter?: boolean): boolean;
    isNodeSearched(nodeKey: K): boolean;
    loadData(): void;
    loadNodes(nodeKeys: K[]): void;
    loadParentNode(node: VirtualItem<N>): void;
    moveNode(node: VirtualItem<N>, newParentNode?: VirtualItem<N>): void;
    needHideExpand(nodeKey: K): boolean;
    registerScrollContainer(ref: RefObject<HTMLElement>): void;
    scrollToNode(key: K): void;
    setLoading(loading: boolean): void;
    setSearchText(text: string): void;
    updateScroll(scrollPosition: number): void;
}

Type Parameters

N extends ITreeNodeModel<T, K>
T
K extends NodeKeyType = NodeKeyType
DS extends IDraftStore = never

Hierarchy (View Summary)

ILoadingStore
- IVirtualTreeStore
  - SearchTreeStoreType

Properties

actions

actions: TreeNodeActionItem<VirtualItem<N>, K>[]

childrenLoadingKeys

childrenLoadingKeys: Set<K>

disabledItemsMap

disabledItemsMap: Map<K, VirtualItem<N>>

draftStore

draftStore: Optional<DS>

isScrolledOut

isScrolledOut: boolean

renderedNodes

renderedNodes: TreeNodeType<VirtualItem<N>, K>[]

scrollContainerStyle

scrollContainerStyle: { height: string; paddingTop: string }

scrollPosition

scrollPosition: number

`Optional`searchText

searchText?: string

selectedItems

selectedItems: N[]

selectedItemsMap

selectedItemsMap: Map<K, N>

Accessors

isLoading

get isLoading(): boolean
Returns boolean
Inherited from ILoadingStore.isLoading
- Defined in app-sdk/index.d.ts:10515

Methods

addNode

addNode(parentNode?: VirtualItem<N>, data?: {}): void
Parameters
- OptionalparentNode: VirtualItem<N>
- Optionaldata: {}
Returns void
- Defined in app-sdk/index.d.ts:12096

applyTreeState

applyTreeState(state: IVirtualTreeState<N, T, K>): void
Parameters
- state: IVirtualTreeState<N, T, K>
Returns void
- Defined in app-sdk/index.d.ts:12102

clearAll

clearAll(): void
Returns void
- Defined in app-sdk/index.d.ts:12104

collapseAll

collapseAll(): void
Returns void
- Defined in app-sdk/index.d.ts:12095

collapseNode

collapseNode(nodeKey: K): void
Parameters
- nodeKey: K
Returns void
- Defined in app-sdk/index.d.ts:12094

deleteNode

deleteNode(node: VirtualItem<N>, cascade?: boolean): void
Parameters
- node: VirtualItem<N>
- Optionalcascade: boolean
Returns void
- Defined in app-sdk/index.d.ts:12097

disableNode

disableNode(key: K): void
Parameters
- key: K
Returns void
- Defined in app-sdk/index.d.ts:12099

expandNode

expandNode(nodeKey: K): void
Parameters
- nodeKey: K
Returns void
- Defined in app-sdk/index.d.ts:12093

getItem

getItem(name: K): N
Parameters
- name: K
Returns N
- Defined in app-sdk/index.d.ts:12078

getItemsCount

getItemsCount(): number
Returns number
- Defined in app-sdk/index.d.ts:12080

getLevel

getLevel(nodeKey: K): number
Parameters
- nodeKey: K
Returns number
- Defined in app-sdk/index.d.ts:12076

getNodeChildren

getNodeChildren(nodeKey?: K): K[]
Parameters
- OptionalnodeKey: K
Returns K[]
- Defined in app-sdk/index.d.ts:12081

getPath

getPath(nodeKey: K, includeCurrentNode?: boolean): K[]
Parameters
- nodeKey: K
- OptionalincludeCurrentNode: boolean
Returns K[]
- Defined in app-sdk/index.d.ts:12075

getStringPath

getStringPath(nodeKey: K, includeCurrentNode?: boolean): string
Parameters
- nodeKey: K
- OptionalincludeCurrentNode: boolean
Returns string
- Defined in app-sdk/index.d.ts:12077

getTreeState

getTreeState(): IVirtualTreeState<N, T, K>
Returns IVirtualTreeState<N, T, K>
- Defined in app-sdk/index.d.ts:12103

getUiTreeNode

getUiTreeNode(node: VirtualItem<N>): TreeNodeType<VirtualItem<N>, K>
Parameters
- node: VirtualItem<N>
Returns TreeNodeType<VirtualItem<N>, K>
- Defined in app-sdk/index.d.ts:12079

hasValidationErrors

hasValidationErrors(): boolean
Returns boolean
- Defined in app-sdk/index.d.ts:12100

isFiltered

isFiltered(): boolean
Returns boolean
- Defined in app-sdk/index.d.ts:12089

isNodeCascadeDeleted

isNodeCascadeDeleted(nodeKey: K): boolean
Parameters
- nodeKey: K
Returns boolean
- Defined in app-sdk/index.d.ts:12088

isNodeDeleted

isNodeDeleted(nodeKey: K): boolean
Parameters
- nodeKey: K
Returns boolean
- Defined in app-sdk/index.d.ts:12083

isNodeDisabled

isNodeDisabled(nodeKey: K): boolean
Parameters
- nodeKey: K
Returns boolean
- Defined in app-sdk/index.d.ts:12084

isNodeExpanded

isNodeExpanded(nodeKey: K): boolean
Parameters
- nodeKey: K
Returns boolean
- Defined in app-sdk/index.d.ts:12087

isNodeInTree

isNodeInTree(nodeKey: K, byFilter?: boolean): boolean
Parameters
- nodeKey: K
- OptionalbyFilter: boolean
Returns boolean
- Defined in app-sdk/index.d.ts:12086

isNodeSearched

isNodeSearched(nodeKey: K): boolean
Parameters
- nodeKey: K
Returns boolean
- Defined in app-sdk/index.d.ts:12085

loadData

loadData(): void
Returns void
- Defined in app-sdk/index.d.ts:12074

loadNodes

loadNodes(nodeKeys: K[]): void
Parameters
- nodeKeys: K[]
Returns void
- Defined in app-sdk/index.d.ts:12073

loadParentNode

loadParentNode(node: VirtualItem<N>): void
Parameters
- node: VirtualItem<N>
Returns void
- Defined in app-sdk/index.d.ts:12072

moveNode

moveNode(node: VirtualItem<N>, newParentNode?: VirtualItem<N>): void
Parameters
- node: VirtualItem<N>
- OptionalnewParentNode: VirtualItem<N>
Returns void
- Defined in app-sdk/index.d.ts:12098

needHideExpand

needHideExpand(nodeKey: K): boolean
Parameters
- nodeKey: K
Returns boolean
- Defined in app-sdk/index.d.ts:12082

registerScrollContainer

registerScrollContainer(ref: RefObject<HTMLElement>): void
Parameters
- ref: RefObject<HTMLElement>
Returns void
- Defined in app-sdk/index.d.ts:12090

scrollToNode

scrollToNode(key: K): void
Parameters
- key: K
Returns void
- Defined in app-sdk/index.d.ts:12092

setLoading

setLoading(loading: boolean): void
Parameters
- loading: boolean
Returns void
Inherited from ILoadingStore.setLoading
- Defined in app-sdk/index.d.ts:10516

`Optional`setSearchText

setSearchText(text: string): void
Parameters
- text: string
Returns void
- Defined in app-sdk/index.d.ts:12101

updateScroll

updateScroll(scrollPosition: number): void
Parameters
- scrollPosition: number
Returns void
- Defined in app-sdk/index.d.ts:12091