Юниверс DG SDK UI
v2.15.0

Интерфейс IVirtualTreeStore<N, T, K, DS>

interface IVirtualTreeStore<
    N extends VirtualTreeNodeModel<T, K>,
    T,
    K extends NodeKeyType = NodeKeyType,
    DS extends IDraftStore = never,
> {
    actions: TreeNodeActionItem<VirtualItem<N>, K>[];
    childrenLoadingKeys: Set<K | null>;
    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): Promise<void>;
    filterNodes(
        cfg?: {
            exclude?: Set<K>;
            filterFn?: (node: VirtualItem<N>) => boolean;
            include?: Set<K>;
        },
    ): void;
    getItem(name: K): N;
    getItemsCount(): number;
    getKey?(node: VirtualItem<N>): K;
    getLevel(nodeKey: K): number;
    getNodeChildren(nodeKey?: K | null): K[];
    getParentKey?(node: VirtualItem<N>): K | null;
    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: K | null): 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(): Promise<void>;
    loadMore(parentKey: K | null): Promise<void>;
    loadNodes(nodeKeys: K[]): Promise<void>;
    loadParentNode(node: VirtualItem<N>): Promise<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: VirtualItem<N> | undefined): void;
    updateScroll(scrollPosition: number): void;
}

Параметры типа

Иерархия (Просмотр сводки)

Индекс

Свойства

childrenLoadingKeys: Set<K | null>
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

    Геттер флага загружаются ли данные

    Возвращает boolean

Методы

  • Параметры

    Возвращает void

  • Возвращает void

  • Возвращает void

  • Параметры

    • nodeKey: K

    Возвращает void

  • Параметры

    Возвращает void

  • Параметры

    • key: K

    Возвращает void

  • Параметры

    Возвращает void

  • Параметры

    • nodeKey: K

    Возвращает Promise<void>

  • Параметры

    • Optionalcfg: {
          exclude?: Set<K>;
          filterFn?: (node: VirtualItem<N>) => boolean;
          include?: Set<K>;
      }

    Возвращает void

  • Параметры

    • name: K

    Возвращает N

  • Возвращает number

  • Параметры

    • nodeKey: K

    Возвращает number

  • Параметры

    • OptionalnodeKey: K | null

    Возвращает K[]

  • Параметры

    • nodeKey: K
    • OptionalincludeCurrentNode: boolean

    Возвращает K[]

  • Параметры

    • nodeKey: K
    • OptionalincludeCurrentNode: boolean

    Возвращает string

  • Параметры

    • nodeKey: K | null

    Возвращает boolean

  • Возвращает boolean

  • Возвращает boolean

  • Параметры

    • nodeKey: K

    Возвращает boolean

  • Параметры

    • nodeKey: K

    Возвращает boolean

  • Параметры

    • nodeKey: K

    Возвращает boolean

  • Параметры

    • nodeKey: K

    Возвращает boolean

  • Параметры

    • nodeKey: K
    • OptionalbyFilter: boolean
    • OptionalignoreCollapse: boolean

    Возвращает boolean

  • Параметры

    • nodeKey: K

    Возвращает boolean

  • Возвращает Promise<void>

  • Параметры

    • parentKey: K | null

    Возвращает Promise<void>

  • Параметры

    • nodeKeys: K[]

    Возвращает Promise<void>

  • Параметры

    Возвращает Promise<void>

  • Параметры

    • nodeKey: K

    Возвращает boolean

  • Параметры

    Возвращает void

  • Параметры

    • key: K

    Возвращает void

  • Метод установки нового значения загрузки

    Параметры

    • loading: boolean

      новое значение

    Возвращает void

  • Параметры

    • text: string

    Возвращает void

  • Параметры

    Возвращает void

  • Параметры

    • scrollPosition: number

    Возвращает void