Interface IVirtualTreeStore<N, T, K, DS>

Public

interface IVirtualTreeStore<
    N extends VirtualTreeNodeModel<T, K>,
    T,
    K extends NodeKeyType = NodeKeyType,
    DS extends IDraftStore = never,
> {
    actions: TreeNodeActionItem<VirtualItem<N>, K>[];
    childrenLoadingKeys: Set<null | K>;
    disabledItemsMap: Map<K, VirtualItem<N>>;
    draftStore: Optional<DS>;
    isAllExpanded: boolean;
    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;
    editNode(node: VirtualItem<N>, newValue: string, cellId: string): void;
    expandNode(nodeKey: K): void;
    filterNodes(
        cfg?: {
            exclude?: Set<K>;
            filterFn?: (node: VirtualItem<N>) => boolean;
            include?: Set<K>;
        },
    ): void;
    getItem(name: K): N;
    getItemsCount(): number;
    getLevel(nodeKey: K): number;
    getNodeChildren(nodeKey?: null | 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>;
    hasMore(nodeKey: null | K): boolean;
    hasValidationErrors(): boolean;
    isFiltered(): boolean;
    isNodeCascadeDeleted(nodeKey: K): boolean;
    isNodeDeletable(node: VirtualItem<N>): boolean;
    isNodeDeleted(nodeKey: K): boolean;
    isNodeDisabled(nodeKey: K): boolean;
    isNodeEditable(node: VirtualItem<N>): boolean;
    isNodeEdited(node: VirtualItem<N>): boolean;
    isNodeExpanded(nodeKey: K): boolean;
    isNodeInTree(
        nodeKey: K,
        byFilter?: boolean,
        ignoreCollapse?: boolean,
    ): boolean;
    isNodeSearched(nodeKey: K): boolean;
    loadData(): void;
    loadMore(parentKey: null | K): void;
    loadNodes(nodeKeys: K[]): void;
    loadParentNode(node: VirtualItem<N>): void;
    moveNode(
        node: VirtualItem<N>,
        newParentNode?: VirtualItem<N>,
        newIndex?: number,
    ): void;
    needHideExpand(nodeKey: K): boolean;
    registerScrollContainer(ref: RefObject<HTMLElement>): void;
    scrollToNode(key: K): void;
    setEditedNode(node?: VirtualItem<N>): void;
    setLoading(loading: boolean): void;
    setSearchText(text: string): void;
    setSelectedItem(node: undefined | VirtualItem<N>): void;
    updateScroll(scrollPosition: number): void;
}

Type Parameters

N extends VirtualTreeNodeModel<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<null | K>

disabledItemsMap

disabledItemsMap: Map<K, VirtualItem<N>>

draftStore

draftStore: Optional<DS>

`Readonly`isAllExpanded

isAllExpanded: boolean

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:14783

Methods

addNode

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

applyTreeState

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

clearAll

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

collapseAll

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

collapseNode

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

deleteNode

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

disableNode

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

editNode

editNode(node: VirtualItem<N>, newValue: string, cellId: string): void
Parameters
- node: VirtualItem<N>
- newValue: string
- cellId: string
Returns void
- Defined in app-sdk/index.d.ts:17352

expandNode

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

filterNodes

filterNodes(
    cfg?: {
        exclude?: Set<K>;
        filterFn?: (node: VirtualItem<N>) => boolean;
        include?: Set<K>;
    },
): void
Parameters
- Optionalcfg: {
      exclude?: Set<K>;
      filterFn?: (node: VirtualItem<N>) => boolean;
      include?: Set<K>;
  }
Returns void
- Defined in app-sdk/index.d.ts:17333

getItem

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

getItemsCount

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

getLevel

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

getNodeChildren

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

getPath

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

getStringPath

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

getTreeState

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

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:17321

hasMore

hasMore(nodeKey: null | K): boolean
Parameters
- nodeKey: null | K
Returns boolean
- Defined in app-sdk/index.d.ts:17331

hasValidationErrors

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

isFiltered

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

isNodeCascadeDeleted

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

isNodeDeletable

isNodeDeletable(node: VirtualItem<N>): boolean
Parameters
- node: VirtualItem<N>
Returns boolean
- Defined in app-sdk/index.d.ts:17339

isNodeDeleted

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

isNodeDisabled

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

isNodeEditable

isNodeEditable(node: VirtualItem<N>): boolean
Parameters
- node: VirtualItem<N>
Returns boolean
- Defined in app-sdk/index.d.ts:17338

isNodeEdited

isNodeEdited(node: VirtualItem<N>): boolean
Parameters
- node: VirtualItem<N>
Returns boolean
- Defined in app-sdk/index.d.ts:17340

isNodeExpanded

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

isNodeInTree

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

isNodeSearched

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

loadData

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

loadMore

loadMore(parentKey: null | K): void
Parameters
- parentKey: null | K
Returns void
- Defined in app-sdk/index.d.ts:17316

loadNodes

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

loadParentNode

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

moveNode

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

needHideExpand

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

registerScrollContainer

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

scrollToNode

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

setEditedNode

setEditedNode(node?: VirtualItem<N>): void
Parameters
- Optionalnode: VirtualItem<N>
Returns void
- Defined in app-sdk/index.d.ts:17341

setLoading

setLoading(loading: boolean): void
Метод установки нового значения загрузки
Parameters
- loading: boolean
  новое значение
Returns void
Inherited from ILoadingStore.setLoading
- Defined in app-sdk/index.d.ts:14788

`Optional`setSearchText

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

setSelectedItem

setSelectedItem(node: undefined | VirtualItem<N>): void
Parameters
- node: undefined | VirtualItem<N>
Returns void
- Defined in app-sdk/index.d.ts:17353

updateScroll

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

Interface IVirtualTreeStore<N, T, K, DS>

Public

Type Parameters

Hierarchy (View Summary)

Index

Properties

Accessors

Methods

Properties

actions

childrenLoadingKeys

disabledItemsMap

draftStore

ReadonlyisAllExpanded

isScrolledOut

renderedNodes

scrollContainerStyle

scrollPosition

OptionalsearchText

selectedItems

selectedItemsMap

Accessors

isLoading

Returns boolean

Methods

addNode

Parameters

Returns void

applyTreeState

Parameters

Returns void

clearAll

Returns void

collapseAll

Returns void

collapseNode

Parameters

Returns void

deleteNode

Parameters

Returns void

disableNode

Parameters

Returns void

editNode

Parameters

Returns void

expandNode

Parameters

Returns void

filterNodes

Parameters

Returns void

getItem

Parameters

Returns N

getItemsCount

Returns number

getLevel

Parameters

Returns number

getNodeChildren

Parameters

Returns K[]

getPath

Parameters

Returns K[]

getStringPath

Parameters

Returns string

getTreeState

Returns IVirtualTreeState<N, T, K>

getUiTreeNode

Parameters

Returns TreeNodeType<VirtualItem<N>, K>

hasMore

Parameters

Returns boolean

hasValidationErrors

Returns boolean

`Readonly`isAllExpanded

`Optional`searchText

`Optional`setSearchText