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

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

interface ITreeStore<
    N extends VirtualTreeNodeModel<T, K>,
    T,
    K extends NodeKeyType = NodeKeyType,
    DS extends IDraftStore = never,
> {
    get draftStore(): Optional<DS>;
    get isLoading(): boolean;
    get searchText(): string;
    get selectedItem(): I | undefined;
    get selectedItems(): N[];
    getItem(name: K | K[]): N | undefined;
    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>;
    setHideRootNode(value: boolean): void;
    setLoading(loading: boolean): void;
    setSearchText(text: string): void;
    setSelectedItem(item: N | undefined): void;
}

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

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

Индекс

Акцессоры

  • get draftStore(): Optional<DS>

    Optional DraftStore getter (only for entities with drafts edition)

    Возвращает Optional<DS>

  • get isLoading(): boolean

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

    Возвращает boolean

  • get searchText(): string

    Getter for search text

    Возвращает string

  • get selectedItem(): I | undefined

    Model for edit

    Возвращает I | undefined

  • get selectedItems(): N[]

    Selected models

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

Методы

  • Get node by name or path

    Параметры

    • name: K | K[]

    Возвращает N | undefined

  • Получить путь к узлу

    Параметры

    • nodeName: K

      Имя узла

    • OptionalincludeCurrentNode: boolean

      Если значение true — вернуть полный путь с текущим nodeName, иначе — только путь до текущего узла.

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

  • Получить путь к узлу как строку

    Параметры

    • nodeName: K

      Имя узла

    • OptionalincludeCurrentNode: boolean

      Если значение true — вернуть полный путь с текущим nodeName, иначе — только путь до текущего узла.

    Возвращает string

  • Method for get nodes for render on UI

    Параметры

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

    Возвращает TreeNodeType<N, K>[]

  • Load data

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

  • Set show or hide rootNode param

    Параметры

    • value: boolean

    Возвращает void

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

    Параметры

    • loading: boolean

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

    Возвращает void

  • Set text for search

    Параметры

    • text: string

    Возвращает void

  • Set selected item in list

    Параметры

    • item: N | undefined

    Возвращает void