Search
    Preparing search index...

    Interface SearchTreeStoreType

    interface SearchTreeStoreType {
        actions: TreeNodeActionItem<
            VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
            NodeKeyType,
        >[];
        childrenLoadingKeys: Set<null | NodeKeyType>;
        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): void;
        filterNodes(
            cfg?: {
                exclude?: Set<NodeKeyType>;
                filterFn?: (
                    node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
                ) => boolean;
                include?: Set<NodeKeyType>;
            },
        ): void;
        getItem(name: NodeKeyType): TreeNodeModel;
        getItemsCount(): number;
        getLevel(nodeKey: NodeKeyType): number;
        getNodeChildren(nodeKey?: null | NodeKeyType): NodeKeyType[];
        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: null | NodeKeyType): 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(): void;
        loadMore(parentKey: null | NodeKeyType): void;
        loadNodes(nodeKeys: NodeKeyType[]): void;
        loadParentNode(
            node: VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
        ): 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: undefined | VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
        ): void;
        updateScroll(scrollPosition: number): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    actions childrenLoadingKeys disabledItemsMap draftStore isAllExpanded isScrolledOut renderedNodes scrollContainerStyle scrollPosition searchText? selectedItems selectedItemsMap

    Accessors

    isLoading

    Methods

    addNode applyTreeState clearAll collapseAll collapseNode deleteNode disableNode editNode expandNode filterNodes getItem getItemsCount getLevel getNodeChildren getPath getStringPath getTreeState getUiTreeNode hasMore hasValidationErrors init isFiltered isNodeCascadeDeleted isNodeDeletable isNodeDeleted isNodeDisabled isNodeEditable isNodeEdited isNodeExpanded isNodeInTree isNodeSearched loadData loadMore loadNodes loadParentNode moveNode needHideExpand registerScrollContainer scrollToNode setEditedNode setLoading setSearchText? setSelectedItem updateScroll

    Properties

    actions: TreeNodeActionItem<
        VirtualItem<TreeNodeModel<unknown, NodeKeyType>>,
        NodeKeyType,
    >[]
    childrenLoadingKeys: Set<null | NodeKeyType>
    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>>

    Accessors

    • get isLoading(): boolean

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

      Returns boolean

    Methods

    • Parameters

      Returns void

    • Parameters

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

      Returns boolean

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

      Parameters

      • loading: boolean

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

      Returns void

    • Parameters

      • scrollPosition: number

      Returns void

    On This Page

    Properties
    Accessors
    Methods