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

Интерфейс SearchTreeStoreType

interface SearchTreeStoreType {
    actions: TreeNodeActionItem<
        VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
        NodeKeyType,
    >[];
    childrenLoadingKeys: Set<NodeKeyType | null>;
    disabledItemsMap: Map<
        NodeKeyType,
        VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
    >;
    draftStore: undefined;
    isAllExpanded: boolean;
    isScrolledOut: boolean;
    renderedNodes: TreeNodeType<
        VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
        NodeKeyType,
    >[];
    scrollContainerStyle: { height: string; paddingTop: string };
    scrollPosition: number;
    searchText?: string;
    selectedItems: TreeNodeModel<unknown, NodeKeyType>[];
    selectedItemsMap: Map<NodeKeyType, TreeNodeModel<unknown, NodeKeyType>>;
    get isLoading(): boolean;
    addNode(
        parentNode?: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
        data?: {},
    ): void;
    applyTreeState(
        state: IVirtualTreeState<
            TreeNodeModel<unknown, NodeKeyType>,
            unknown,
            NodeKeyType,
        >,
    ): void;
    clearAll(): void;
    collapseAll(): void;
    collapseNode(nodeKey: NodeKeyType): void;
    deleteNode(
        node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
        cascade?: boolean,
    ): void;
    disableNode(key: NodeKeyType): void;
    editNode(
        node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
        newValue: string,
        cellId: string,
    ): void;
    expandNode(nodeKey: NodeKeyType): Promise<void>;
    filterNodes(
        cfg?: {
            exclude?: Set<NodeKeyType>;
            filterFn?: (
                node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
            ) => boolean;
            include?: Set<NodeKeyType>;
        },
    ): void;
    getItem(name: NodeKeyType): TreeNodeModel;
    getItemsCount(): number;
    getKey?(
        node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
    ): NodeKeyType;
    getLevel(nodeKey: NodeKeyType): number;
    getNodeChildren(nodeKey?: NodeKeyType | null): NodeKeyType[];
    getParentKey?(
        node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
    ): NodeKeyType | null;
    getPath(nodeKey: NodeKeyType, includeCurrentNode?: boolean): NodeKeyType[];
    getStringPath(nodeKey: NodeKeyType, includeCurrentNode?: boolean): string;
    getTreeState(): IVirtualTreeState<
        TreeNodeModel<unknown, NodeKeyType>,
        unknown,
        NodeKeyType,
    >;
    getUiTreeNode(
        node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
    ): TreeNodeType<
        VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
        NodeKeyType,
    >;
    hasMore(nodeKey: NodeKeyType | null): boolean;
    hasValidationErrors(): boolean;
    init(metaEntity?: IMetaModel): void;
    isFiltered(): boolean;
    isNodeCascadeDeleted(nodeKey: NodeKeyType): boolean;
    isNodeDeletable(
        node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
    ): boolean;
    isNodeDeleted(nodeKey: NodeKeyType): boolean;
    isNodeDisabled(nodeKey: NodeKeyType): boolean;
    isNodeEditable(
        node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
    ): boolean;
    isNodeEdited(
        node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
    ): boolean;
    isNodeExpanded(nodeKey: NodeKeyType): boolean;
    isNodeInTree(
        nodeKey: NodeKeyType,
        byFilter?: boolean,
        ignoreCollapse?: boolean,
    ): boolean;
    isNodeSearched(nodeKey: NodeKeyType): boolean;
    loadData(): Promise<void>;
    loadMore(parentKey: NodeKeyType | null): Promise<void>;
    loadNodes(nodeKeys: NodeKeyType[]): Promise<void>;
    loadParentNode(
        node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
    ): Promise<void>;
    moveNode(
        node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
        newParentNode?: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
        newIndex?: number,
    ): void;
    needHideExpand(nodeKey: NodeKeyType): boolean;
    registerScrollContainer(ref: RefObject<HTMLElement>): void;
    scrollToNode(key: NodeKeyType): void;
    setEditedNode(
        node?: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
    ): void;
    setLoading(loading: boolean): void;
    setSearchText?(text: string): void;
    setSelectedItem(
        node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>> | undefined,
    ): void;
    updateScroll(scrollPosition: number): void;
}

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

Индекс

Свойства

actions: TreeNodeActionItem<
    VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
    NodeKeyType,
>[]
childrenLoadingKeys: Set<NodeKeyType | null>
disabledItemsMap: Map<
    NodeKeyType,
    VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
>
draftStore: undefined
isAllExpanded: boolean
isScrolledOut: boolean
renderedNodes: TreeNodeType<
    VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
    NodeKeyType,
>[]
scrollContainerStyle: { height: string; paddingTop: string }
scrollPosition: number
searchText?: string
selectedItems: TreeNodeModel<unknown, NodeKeyType>[]
selectedItemsMap: Map<NodeKeyType, TreeNodeModel<unknown, NodeKeyType>>

Акцессоры

  • get isLoading(): boolean

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

    Возвращает boolean

Методы

  • Параметры

    Возвращает void

  • Параметры

    • nodeKey: NodeKeyType
    • OptionalbyFilter: boolean
    • OptionalignoreCollapse: boolean

    Возвращает boolean

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

    Параметры

    • loading: boolean

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

    Возвращает void

  • Параметры

    • scrollPosition: number

    Возвращает void