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

Интерфейс TreeTableProps<D, K>

Тип свойств компонента TreeTable

interface TreeTableProps<
    D extends Record<string, unknown>,
    K extends TreeNodeKeyType,
> {
    actions?: TreeNodeActionItem<D, K>[];
    canSelectDisabled?: boolean;
    cellContentRenderer?: (
        node: TreeNodeType<D, K>,
        column: TreeColumn<D, K>,
        defaultRenderer: (
            node: TreeNodeType<D, K>,
            column: TreeColumn<D, K>,
        ) => ReactElement,
    ) => ReactElement;
    colorScheme?: ColorScheme;
    columns: TreeColumn<D, K>[];
    disabledNodes?: K[];
    getGridId: (cellID: string) => string;
    gridSettings: { areas: string[]; sizes: string[] };
    hasChecked?: boolean;
    hasHeaderBg?: boolean;
    hideLastRowBorder?: boolean;
    isActionsEnabled?: (node: TreeNodeType<D, K>) => boolean;
    isAllChecked?: boolean;
    isAutoHeightFill?: boolean;
    isHeaderCheckable: boolean;
    isHighlighted?: (node: TreeNodeType<D, K>) => boolean;
    isResizable: boolean;
    isRowsCheckable: boolean;
    isStriped?: boolean;
    maxRowsBeforeOverflow?: number;
    nodes: TreeNodeType<D, K>[];
    onAllCheck?: (type: boolean) => void;
    onBeforeNodeSelect?: (node: TreeNodeType<D, K>) => boolean;
    onChangeColumnWidth?: (columnId: string, newWidth: number) => void;
    onNodeCollapse?: (node: TreeNodeType<D, K>) => void;
    onNodeDoubleClick?: (
        node: TreeNodeType<D, K>,
        event: SyntheticEvent<HTMLDivElement>,
    ) => void;
    onNodeExpand?: (node: TreeNodeType<D, K>) => void;
    onNodeMouseEnter?: (node: TreeNodeType<D, K>) => void;
    onNodeMouseLeave?: (node: TreeNodeType<D, K>) => void;
    onNodeSelect?: (node: TreeNodeType<D, K>) => void;
    rightExtraItem?: (nodeData: D) => ReactNode;
    selectedNodes?: K[];
}

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

Индекс

Свойства

actions?: TreeNodeActionItem<D, K>[]

Массив действий для узлов.

canSelectDisabled?: boolean

Признак возможности выбирать отключенные узлы.

cellContentRenderer?: (
    node: TreeNodeType<D, K>,
    column: TreeColumn<D, K>,
    defaultRenderer: (
        node: TreeNodeType<D, K>,
        column: TreeColumn<D, K>,
    ) => ReactElement,
) => ReactElement

Функция для кастомизации отображения содержимого ячейки в строке

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

colorScheme?: ColorScheme

Цветовая схема дерева.

columns: TreeColumn<D, K>[]

Массив колонок таблицы

disabledNodes?: K[]

Массив ключей отключенных узлов.

getGridId: (cellID: string) => string

Функция для получения уникального ID ячейки сетки для колонки в шапке таблицы

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

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

      • cellID: string

        Идентификатор ячейки

      Возвращает string

gridSettings: { areas: string[]; sizes: string[] }

Настройки сетки таблицы

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

  • areas: string[]

    Области сетки в шапке таблицы

  • sizes: string[]

    Размеры сетки

hasChecked?: boolean

Признак наличия выбранных строк

hasHeaderBg?: boolean

Признак наличия фона у заголовка таблицы

hideLastRowBorder?: boolean

Признак скрытия границы последней строки

isActionsEnabled?: (node: TreeNodeType<D, K>) => boolean

Функция проверки включенных действий для узла.

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

isAllChecked?: boolean

Признак выбора всех строк

isAutoHeightFill?: boolean

Признак автоматической адаптации высоты дерева.

isHeaderCheckable: boolean

Признак возможности выбора всех строк в шапке

isHighlighted?: (node: TreeNodeType<D, K>) => boolean

Функция определения подсветки строки

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

isResizable: boolean

Признак возможности изменения ширины колонок

isRowsCheckable: boolean

Признак возможности выбора строк

isStriped?: boolean

Признак чередующейся раскраски строк.

maxRowsBeforeOverflow?: number

Максимальное количество строк до появления скролла.

nodes: TreeNodeType<D, K>[]

Массив узлов дерева для отображения

onAllCheck?: (type: boolean) => void

Обработчик выбора/снятия выбора со всех строк

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

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

      • type: boolean

        Признак выбора (true - выбрать все, false - снять выбор)

      Возвращает void

onBeforeNodeSelect?: (node: TreeNodeType<D, K>) => boolean

Вызывается перед выбором узла, возвращает разрешение или запрет выбора.

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

onChangeColumnWidth?: (columnId: string, newWidth: number) => void

Обработчик изменения ширины колонки

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

    • (columnId: string, newWidth: number): void
    • Параметры

      • columnId: string

        Идентификатор колонки

      • newWidth: number

        Новая ширина колонки

      Возвращает void

onNodeCollapse?: (node: TreeNodeType<D, K>) => void

Срабатывает при сворачивании узла.

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

onNodeDoubleClick?: (
    node: TreeNodeType<D, K>,
    event: SyntheticEvent<HTMLDivElement>,
) => void

Срабатывает при двойном клике по узлу.

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

onNodeExpand?: (node: TreeNodeType<D, K>) => void

Срабатывает при раскрытии узла.

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

onNodeMouseEnter?: (node: TreeNodeType<D, K>) => void

Срабатывает при наведении курсора на узел.

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

onNodeMouseLeave?: (node: TreeNodeType<D, K>) => void

Срабатывает при уходе курсора с узла.

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

onNodeSelect?: (node: TreeNodeType<D, K>) => void

Срабатывает при выборе узла.

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

rightExtraItem?: (nodeData: D) => ReactNode

Функция рендера дополнительной области справа в узле.

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

    • (nodeData: D): ReactNode
    • Параметры

      • nodeData: D

        Данные узла.

      Возвращает ReactNode

selectedNodes?: K[]

Массив ключей выбранных узлов.