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

Интерфейс DropDownTreeStoreType<T>

Интерфейс для управления состоянием выпадающего дерева.

interface DropDownTreeStoreType<T> {
    addRootChild: (child: DropDownTreeNode<T>) => void;
    dropDownTreeNodes: DropDownTreeNode<T>[];
    getFilterText: () => string;
    isNodeFiltered: (
        node: DropDownTreeNode<T>,
        text: string,
        defaultFiltering: boolean,
    ) => boolean;
    keyPressed: boolean;
    pathSeparator: string;
    resetNavigation: () => void;
    setFilterText: (text: string) => void;
    setKey: (path: string[], shouldExpand: boolean) => void;
    setKeyPressed: (keyPressed: boolean) => void;
    setRootChildren: (children: DropDownTreeNode<T>[]) => void;
    get key(): string | undefined;
    collapseNode(): void;
    decreaseIndex(): void;
    expandNode(): void;
    increaseIndex(): void;
    isAncestor(key: string): boolean;
    resetIndex(): void;
    setChildIndex(index: number): void;
}

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

  • T

Реализован в

Индекс

Свойства

addRootChild: (child: DropDownTreeNode<T>) => void

Добавляет корневой дочерний узел.

Объявление типа

dropDownTreeNodes: DropDownTreeNode<T>[]

Список узлов выпадающего дерева.

getFilterText: () => string

Возвращает текущий текст фильтра.

isNodeFiltered: (
    node: DropDownTreeNode<T>,
    text: string,
    defaultFiltering: boolean,
) => boolean

Проверяет, фильтруется ли узел.

Объявление типа

    • (node: DropDownTreeNode<T>, text: string, defaultFiltering: boolean): boolean
    • Параметры

      • node: DropDownTreeNode<T>

        Узел для проверки.

      • text: string

        Текст фильтра.

      • defaultFiltering: boolean

        Флаг использования стандартной фильтрации.

      Возвращает boolean

keyPressed: boolean

Флаг, указывающий текущее состояние нажатия клавиши.

pathSeparator: string

Разделитель для путей.

resetNavigation: () => void

Сбрасывает состояние навигации.

setFilterText: (text: string) => void

Устанавливает новый текст фильтра.

Объявление типа

    • (text: string): void
    • Параметры

      • text: string

        Текст фильтра.

      Возвращает void

setKey: (path: string[], shouldExpand: boolean) => void

Устанавливает ключ и опционально разворачивает узел.

Объявление типа

    • (path: string[], shouldExpand: boolean): void
    • Параметры

      • path: string[]

        Путь к узлу.

      • shouldExpand: boolean

        Флаг развертывания.

      Возвращает void

setKeyPressed: (keyPressed: boolean) => void

Устанавливает флаг нажатия клавиши.

Объявление типа

    • (keyPressed: boolean): void
    • Параметры

      • keyPressed: boolean

        Новое состояние.

      Возвращает void

setRootChildren: (children: DropDownTreeNode<T>[]) => void

Устанавливает массив корневых узлов.

Объявление типа

Акцессоры

  • get key(): string | undefined

    Геттер текущий ключа.

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

Методы

  • Метод сворачивает текущий узел.

    Возвращает void

  • Метод уменьшает индекс текущего дочернего элемента.

    Возвращает void

  • Метод разворачивает текущий узел.

    Возвращает void

  • Метод увеличивает индекс текущего дочернего элемента.

    Возвращает void

  • Проверяет, является ли указанный ключ предком.

    Параметры

    • key: string

      Ключ для проверки.

    Возвращает boolean

  • Метод сбрасывает индекс текущего элемента.

    Возвращает void

  • Метод устанавливает индекс дочернего элемента.

    Параметры

    • index: number

      Новый индекс.

    Возвращает void