Preparing search index...

    Interface ITreeSyncStore<N, T, K, DS>

    interface ITreeSyncStore<
        N extends ITreeNodeModel<T, K>,
        T,
        K extends NodeKeyType = NodeKeyType,
        DS extends IDraftStore = never,
    > {
        DISPLAY_NAME_COLUMN: "displayName";
        TREE_ROOT_KEY: "ROOT";
        get draftStore(): Optional<DS>;
        get getActionEnabled(): boolean;
        get getFlatTreeMap(): Map<string, N>;
        get isLoading(): boolean;
        get searchText(): string;
        get selectedItem(): undefined | I;
        get selectedItems(): N[];
        addNode(parentNode: N): void;
        collapseNode(node: N): void;
        delete(node: N): Promise<void>;
        editNode(node: N, newValue: string, cellId: string): Promise<void>;
        expandNode(node: N): void;
        getItem(name: K | K[]): undefined | N;
        getPath(nodeName: K, includeCurrentNode?: boolean): K[];
        getStringPath(nodeName: K, includeCurrentNode?: boolean): string;
        getTreeNodes(
            hideEmptyGroups: boolean,
            filter?: (node: N) => boolean,
            searchGroups?: boolean,
        ): TreeNodeType<N, K>[];
        loadData(): Promise<void>;
        moveNode(node: N, parentNode: N, previousNode?: N): Promise<void>;
        setHideRootNode(value: boolean): void;
        setLoading(loading: boolean): void;
        setSearchText(text: string): void;
        setSelectedItem(item: undefined | N): void;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    DISPLAY_NAME_COLUMN TREE_ROOT_KEY

    Accessors

    draftStore getActionEnabled getFlatTreeMap isLoading searchText selectedItem selectedItems

    Methods

    addNode collapseNode delete editNode expandNode getItem getPath getStringPath getTreeNodes loadData moveNode setHideRootNode setLoading setSearchText setSelectedItem

    Properties

    DISPLAY_NAME_COLUMN: "displayName"
    TREE_ROOT_KEY: "ROOT"

    Accessors

    • get draftStore(): Optional<DS>

      Optional DraftStore getter (only for entities with drafts edition)

      Returns Optional<DS>

    • get getActionEnabled(): boolean

      Returns boolean

    • get getFlatTreeMap(): Map<string, N>

      Returns Map<string, N>

    • get isLoading(): boolean

      Returns boolean

    • get searchText(): string

      Getter for search text

      Returns string

    • get selectedItem(): undefined | I

      Model for edit

      Returns undefined | I

    • get selectedItems(): N[]

      Selected models

      Returns N[]

    Methods

    • Parameters

      • parentNode: N

      Returns void

    • Parameters

      • node: N

      Returns void

    • Parameters

      • node: N

      Returns Promise<void>

    • Parameters

      • node: N
      • newValue: string
      • cellId: string

      Returns Promise<void>

    • Parameters

      • node: N

      Returns void

    • Get node by name or path

      Parameters

      • name: K | K[]

      Returns undefined | N

    • Get path to node

      Parameters

      • nodeName: K

        {string}

      • OptionalincludeCurrentNode: boolean

        {boolean} if true, return full path with current nodeName, else - just path to current node

      Returns K[]

    • Get path to node as string

      Parameters

      • nodeName: K

        {string}

      • OptionalincludeCurrentNode: boolean

        {boolean} if true, return full path with current nodeName, else - just path to current node

      Returns string

    • Method for get nodes for render on UI

      Parameters

      • hideEmptyGroups: boolean
      • Optionalfilter: (node: N) => boolean
      • OptionalsearchGroups: boolean

      Returns TreeNodeType<N, K>[]

    • Load data

      Returns Promise<void>

    • Parameters

      • node: N
      • parentNode: N
      • OptionalpreviousNode: N

      Returns Promise<void>

    • Set show or hide rootNode param

      Parameters

      • value: boolean

      Returns void

    • Parameters

      • loading: boolean

      Returns void

    • Set text for search

      Parameters

      • text: string

      Returns void

    • Set selected item in list

      Parameters

      • item: undefined | N

      Returns void

    On This Page

    Properties
    Accessors
    Methods