Search
    Preparing search index...

    Interface GroupTableProps<RowRecord, GroupRecord, ColumnRecord>

    Пропсы таблицы с группировкой

    interface GroupTableProps<
        RowRecord extends Record<string, any> = Record<string, any>,
        GroupRecord extends GroupRecordType = GroupRecordType,
        ColumnRecord = void,
    > {
        addText: ReactNode;
        canAdd?: boolean;
        canCollapseLocked?: boolean;
        canDelete?: boolean;
        cellRenderer?: (
            props: GroupTableCellRendererProps<RowRecord, ColumnRecord>,
        ) => ReactNode;
        cellViewType?:
            | CELL_VIEW_TYPE
            | (
                (
                    column: TableColumn<RowRecord, ColumnRecord>,
                    rowData: RowRecord,
                    index: number,
                ) => CELL_VIEW_TYPE
            );
        checkedGroups: string[];
        collapsedRowsText?: string;
        collapseText?: string;
        columnHeights?: { [key: string]: number };
        columns: TableColumn<RowRecord, ColumnRecord>[];
        columnWidths?: { [key: string]: number };
        customHeaderCheckbox?: ReactNode;
        data: TableGroupData<RowRecord, GroupRecord, ColumnRecord>[];
        deleteText: ReactNode;
        disabledForCheckLockedRows?: number[];
        emptyTableRenderer?: (
            isLoading: boolean,
            emptyTableText: string,
        ) => ReactNode;
        emptyTableText?: string;
        expandedGroups: string[];
        expandText?: string;
        filterValues?: { [key: string]: any };
        getRowType?: (rowIndex: number) => ROW_TYPE;
        groupRenderer?: (
            props: TableGroupData<RowRecord, GroupRecord, ColumnRecord>,
            defaultRenderer: (
                props: TableGroupData<RowRecord, GroupRecord, ColumnRecord>,
            ) => ReactNode,
            tableRenderer: (
                props: TableGroupData<RowRecord, GroupRecord, ColumnRecord>,
            ) => ReactNode,
        ) => ReactNode;
        hasCellPadding?: boolean;
        hasChecked?: boolean;
        hasHeader?: boolean;
        hasHeaderBg?: boolean;
        hasNavigation?: boolean;
        hasPagination?: boolean;
        hideLastRowBorder?: boolean;
        isAutoHeightFill?: boolean;
        isAutoScrollToSelected?: boolean;
        isChangedAxes?: boolean;
        isEditable?: boolean;
        isGroupCheckable?: boolean;
        isGroupCompact?: boolean;
        isGrouped?: boolean;
        isHeaderCheckable?: boolean;
        isLoading?: boolean;
        isLockedCollapsed?: boolean;
        isLockedRowsCheckable?: boolean;
        isMultiselect?: boolean;
        isResizable?: boolean;
        isRowsCheckable?: boolean;
        isRowsSelectable?: boolean;
        isScrollOverflowAuto?: boolean;
        isSortable?: boolean;
        isStriped?: boolean;
        loadingGroups: string[];
        loadingText: string;
        loadMoreText?: string;
        lockedRowActions?: (
            props: GroupTableRowActionsProps<RowRecord, ColumnRecord>,
        ) => ReactNode;
        maxRowsBeforeOverflow?: number;
        noLockedLimit?: boolean;
        onAllCheck?: (isCheck: boolean) => void;
        onChangeColumnHeight?: (columnId: string, newHeight: number) => void;
        onChangeColumnWidth?: (columnId: string, newWidth: number) => void;
        onCollapseLocked?: (groupName: string) => void;
        onCopy?: (e: ClipboardEvent<HTMLDivElement>) => void;
        onFilter?: (columnId: string, isClear?: boolean) => void;
        onGroupCheck?: (groupName: string, checked: boolean) => void;
        onGroupCollapse?: (groupName: string) => void;
        onGroupExpand?: (groupName: string) => void;
        onLockedRowCheck?: (rowIndex: GroupTableIndex) => void;
        onLockedRowClick?: (rowIndex: GroupTableIndex) => void;
        onPaste?: (
            e: ClipboardEvent<HTMLDivElement>,
            pastedData: TableOptionalData<string>,
        ) => void;
        onPasteError?: () => void;
        onResetFilter?: (columnId: string) => void;
        onRowAdd?: (groupName: string) => void;
        onRowCheck?: (
            rowIndex: GroupTableIndex,
            checked: boolean,
            isShiftPressed?: boolean,
        ) => void;
        onRowClick?: (rowIndex: GroupTableIndex) => void;
        onRowDoubleClick?: (rowIndex: GroupTableIndex) => void;
        onRowMouseEnter?: (rowIndex: GroupTableIndex) => void;
        onRowMouseLeave?: (rowIndex: GroupTableIndex) => void;
        onRowsDelete?: (rowIndexes: GroupTableIndex[]) => void;
        onSelectedDataChange?: (selectedData: TableNormalizedSelectedData) => void;
        onSelectedDataClear?: (selectedData: TableNormalizedSelectedData) => void;
        onSort?: (
            columnId: string,
            newSortDirection: TableSortDirection,
            currentSortDirection: TableSortDirection,
            columnData?: ColumnRecord,
        ) => void;
        rowActions?: (
            props: GroupTableRowActionsProps<RowRecord, ColumnRecord>,
        ) => ReactNode;
        selectedData?: TableSelectedData;
        selectMode?: MULTIPLE_CELLS;
        sortDirection?: { [key: string]: TableSortDirection };
        unsetText: string;
    }

    Type Parameters

    Hierarchy

    • Omit<
          TableProps<RowRecord, ColumnRecord>,

              | "data"
              | "lockedData"
              | "onRowClick"
              | "onRowDoubleClick"
              | "onRowMouseEnter"
              | "onRowMouseLeave"
              | "onRowAdd"
              | "onRowsDelete"
              | "onLockedRowClick"
              | "rowWidths"
              | "rowHeights"
              | "getRowKey"
              | "selectedRows"
              | "disabledForCheckRows"
              | "cellRenderer"
              | "onCollapseLocked"
              | "lockedRowActions"
              | "rowActions"
              | "editableCell"
              | "checkedRows"
              | "checkedLockedRows"
              | "highlightedRows"
              | "onCellEdit"
              | "onCellEditStart"
              | "onRowCheck"
              | "onLockedRowCheck"
              | "onMove",
      >
      • GroupTableProps
    Index

    Properties

    addText canAdd? canCollapseLocked? canDelete? cellRenderer? cellViewType? checkedGroups collapsedRowsText? collapseText? columnHeights? columns columnWidths? customHeaderCheckbox? data deleteText disabledForCheckLockedRows? emptyTableRenderer? emptyTableText? expandedGroups expandText? filterValues? getRowType? groupRenderer? hasCellPadding? hasChecked? hasHeader? hasHeaderBg? hasNavigation? hasPagination? hideLastRowBorder? isAutoHeightFill? isAutoScrollToSelected? isChangedAxes? isEditable? isGroupCheckable? isGroupCompact? isGrouped? isHeaderCheckable? isLoading? isLockedCollapsed? isLockedRowsCheckable? isMultiselect? isResizable? isRowsCheckable? isRowsSelectable? isScrollOverflowAuto? isSortable? isStriped? loadingGroups loadingText loadMoreText? lockedRowActions? maxRowsBeforeOverflow? noLockedLimit? onAllCheck? onChangeColumnHeight? onChangeColumnWidth? onCollapseLocked? onCopy? onFilter? onGroupCheck? onGroupCollapse? onGroupExpand? onLockedRowCheck? onLockedRowClick? onPaste? onPasteError? onResetFilter? onRowAdd? onRowCheck? onRowClick? onRowDoubleClick? onRowMouseEnter? onRowMouseLeave? onRowsDelete? onSelectedDataChange? onSelectedDataClear? onSort? rowActions? selectedData? selectMode? sortDirection? unsetText

    Properties

    addText: ReactNode

    Текст кнопки добавления.

    canAdd?: boolean

    Разрешает добавление новых строк.

    canCollapseLocked?: boolean

    Разрешает сворачивать зафиксированные строки.

    canDelete?: boolean

    Разрешает удаление строк.

    cellRenderer?: (
        props: GroupTableCellRendererProps<RowRecord, ColumnRecord>,
    ) => ReactNode

    Рендер ячейки

    Type declaration

    cellViewType?:
        | CELL_VIEW_TYPE
        | (
            (
                column: TableColumn<RowRecord, ColumnRecord>,
                rowData: RowRecord,
                index: number,
            ) => CELL_VIEW_TYPE
        )

    Тип отображения ячеек или функция определения типа.

    Параметры столбца.

    Данные строки.

    Индекс строки.

    checkedGroups: string[]

    Имена групп, которые должны быть отмечены

    collapsedRowsText?: string

    Текст при свернутых строках.

    collapseText?: string

    Текст кнопки сворачивания.

    columnHeights?: { [key: string]: number }

    Текущие высоты столбцов.

    columns: TableColumn<RowRecord, ColumnRecord>[]

    Массив столбцов, определяющих структуру таблицы.

    columnWidths?: { [key: string]: number }

    Текущие ширины столбцов.

    customHeaderCheckbox?: ReactNode

    Свойство для кастомного рендеринга чекбокса в заголовке.

    data: TableGroupData<RowRecord, GroupRecord, ColumnRecord>[]

    Данные для отображения в таблице

    deleteText: ReactNode

    Текст кнопки удаления.

    disabledForCheckLockedRows?: number[]

    Индексы зафиксированных строк, недоступных для отметки.

    emptyTableRenderer?: (isLoading: boolean, emptyTableText: string) => ReactNode

    Функция рендера пустого состояния таблицы.

    Type declaration

      • (isLoading: boolean, emptyTableText: string): ReactNode

      • Parameters

        • isLoading: boolean

          Флаг загрузки.

        • emptyTableText: string

          Текст пустого состояния.

        Returns ReactNode

    emptyTableText?: string

    Текст пустого состояния.

    expandedGroups: string[]

    Имена групп, которые должны быть раскрыты

    expandText?: string

    Текст кнопки разворачивания.

    filterValues?: { [key: string]: any }

    Значения фильтров для столбцов.

    getRowType?: (rowIndex: number) => ROW_TYPE

    Получение типа строки.

    Type declaration

      • (rowIndex: number): ROW_TYPE

      • Parameters

        • rowIndex: number

          Индекс строки.

        Returns ROW_TYPE

    groupRenderer?: (
        props: TableGroupData<RowRecord, GroupRecord, ColumnRecord>,
        defaultRenderer: (
            props: TableGroupData<RowRecord, GroupRecord, ColumnRecord>,
        ) => ReactNode,
        tableRenderer: (
            props: TableGroupData<RowRecord, GroupRecord, ColumnRecord>,
        ) => ReactNode,
    ) => ReactNode

    Рендер-функция группы

    Type declaration

    hasCellPadding?: boolean

    Наличие отступов в ячейках.

    hasChecked?: boolean

    Включает ли таблица механизм отметки строк.

    hasHeader?: boolean

    Наличие заголовка таблицы.

    hasHeaderBg?: boolean

    Фон заголовка таблицы.

    hasNavigation?: boolean

    Наличие навигации.

    hasPagination?: boolean

    Наличие пагинации.

    hideLastRowBorder?: boolean

    Скрывать нижнюю границу последней строки.

    isAutoHeightFill?: boolean

    Автоматическое заполнение высоты контейнера.

    isAutoScrollToSelected?: boolean

    Автопрокрутка к выбранной строке.

    isChangedAxes?: boolean

    Признак изменения осей.

    isEditable?: boolean

    Доступно ли редактирование.

    isGroupCheckable?: boolean

    Возможность выбора группы

    isGroupCompact?: boolean

    Флаг, указывающий на то, что группы должны быть компактными и прижаты к левому краю

    isGrouped?: boolean
    isHeaderCheckable?: boolean

    Разрешает массовую отметку в заголовке.

    isLoading?: boolean

    Состояние загрузки таблицы.

    isLockedCollapsed?: boolean

    Запрет сворачивания при блокировке.

    isLockedRowsCheckable?: boolean

    Разрешает выбор заблокированных строк.

    isMultiselect?: boolean

    Включает режим множественного выбора.

    Если selectMode задан, то текущее свойство игнорируется

    isResizable?: boolean

    Разрешено ли изменение размеров столбцов.

    isRowsCheckable?: boolean

    Разрешает выбор строк.

    isRowsSelectable?: boolean

    Включает выбор строк (для селекта).

    Если selectMode задан, то текущее свойство игнорируется

    isScrollOverflowAuto?: boolean

    Включает автопрокрутку при переполнении.

    isSortable?: boolean

    Доступна ли сортировка.

    isStriped?: boolean

    Полосатое оформление строк.

    loadingGroups: string[]

    Имена групп, которые должны быть загружены

    loadingText: string

    Текст статуса загрузки.

    loadMoreText?: string

    Текст кнопки "Загрузить ещё"

    lockedRowActions?: (
        props: GroupTableRowActionsProps<RowRecord, ColumnRecord>,
    ) => ReactNode

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

    Type declaration

    maxRowsBeforeOverflow?: number

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

    noLockedLimit?: boolean

    Отключает ограничение на количество зафиксированных строк.

    onAllCheck?: (isCheck: boolean) => void

    Отметка всех строк/снятие отметки.

    Type declaration

      • (isCheck: boolean): void

      • Parameters

        • isCheck: boolean

          Флаг отметки.

        Returns void

    onChangeColumnHeight?: (columnId: string, newHeight: number) => void

    Изменение высоты столбца.

    Type declaration

      • (columnId: string, newHeight: number): void

      • Parameters

        • columnId: string

          Идентификатор столбца.

        • newHeight: number

          Новая высота.

        Returns void

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

    Изменение ширины столбца.

    Type declaration

      • (columnId: string, newWidth: number): void

      • Parameters

        • columnId: string

          Идентификатор столбца.

        • newWidth: number

          Новая ширина.

        Returns void

    onCollapseLocked?: (groupName: string) => void

    Обработчик скрытия группы

    Type declaration

      • (groupName: string): void

      • Parameters

        • groupName: string

          Имя группы

        Returns void

    onCopy?: (e: ClipboardEvent<HTMLDivElement>) => void

    Обработчик события копирования данных в буфер

    onFilter?: (columnId: string, isClear?: boolean) => void

    Обработчик фильтрации.

    Type declaration

      • (columnId: string, isClear?: boolean): void

      • Parameters

        • columnId: string

          Идентификатор столбца.

        • OptionalisClear: boolean

          Флаг очистки фильтра.

        Returns void

    onGroupCheck?: (groupName: string, checked: boolean) => void

    Обработчик выбора группы

    Type declaration

      • (groupName: string, checked: boolean): void

      • Parameters

        • groupName: string

          Имя группы

        • checked: boolean

          Флаг, указывающий на то, что группа выбрана

        Returns void

    onGroupCollapse?: (groupName: string) => void

    Обработчик раскрытия группы

    Type declaration

      • (groupName: string): void

      • Parameters

        • groupName: string

          Имя группы

        Returns void

    onGroupExpand?: (groupName: string) => void

    Обработчик раскрытия группы

    Type declaration

      • (groupName: string): void

      • Parameters

        • groupName: string

          Имя группы

        Returns void

    onLockedRowCheck?: (rowIndex: GroupTableIndex) => void

    Обработчик выбора строки в заблокированной области

    Type declaration

    onLockedRowClick?: (rowIndex: GroupTableIndex) => void

    Обработчик клика по строке в заблокированной области

    Type declaration

    onPaste?: (
        e: ClipboardEvent<HTMLDivElement>,
        pastedData: TableOptionalData<string>,
    ) => void

    Обработчик события вставки данных из буфера обмена

    Type declaration

    onPasteError?: () => void

    Обработчик события ошибки вставки данных из буфера обмена

    onResetFilter?: (columnId: string) => void

    Сброс фильтра для столбца.

    Type declaration

      • (columnId: string): void

      • Parameters

        • columnId: string

          Идентификатор столбца.

        Returns void

    onRowAdd?: (groupName: string) => void

    Обработчик добавления строки

    Type declaration

      • (groupName: string): void

      • Parameters

        • groupName: string

          Имя группы

        Returns void

    onRowCheck?: (
        rowIndex: GroupTableIndex,
        checked: boolean,
        isShiftPressed?: boolean,
    ) => void

    Обработчик выбора строки

    Type declaration

      • (rowIndex: GroupTableIndex, checked: boolean, isShiftPressed?: boolean): void

      • Parameters

        • rowIndex: GroupTableIndex

          Индекс строки

        • checked: boolean

          Флаг, указывающий на то, что строка выбрана

        • OptionalisShiftPressed: boolean

          Флаг, указывающий на то, что была нажата клавиша Shift

        Returns void

    onRowClick?: (rowIndex: GroupTableIndex) => void

    Обработчик клика по строке

    Type declaration

    onRowDoubleClick?: (rowIndex: GroupTableIndex) => void

    Обработчик двойного клика по строке

    Type declaration

    onRowMouseEnter?: (rowIndex: GroupTableIndex) => void

    Обработчик наведения курсора на строку

    Type declaration

    onRowMouseLeave?: (rowIndex: GroupTableIndex) => void

    Обработчик ухода курсора с строки

    Type declaration

    onRowsDelete?: (rowIndexes: GroupTableIndex[]) => void

    Обработчик удаления строк

    Type declaration

    onSelectedDataChange?: (selectedData: TableNormalizedSelectedData) => void

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

    Type declaration

    onSelectedDataClear?: (selectedData: TableNormalizedSelectedData) => void

    Обработчик события удаления данных из выбранных ячеек

    Срабатывает при нажатии клавиши "Delete"

    Type declaration

    onSort?: (
        columnId: string,
        newSortDirection: TableSortDirection,
        currentSortDirection: TableSortDirection,
        columnData?: ColumnRecord,
    ) => void

    Обработчик сортировки.

    Type declaration

      • (
            columnId: string,
            newSortDirection: TableSortDirection,
            currentSortDirection: TableSortDirection,
            columnData?: ColumnRecord,
        ): void

      • Parameters

        • columnId: string

          Идентификатор столбца.

        • newSortDirection: TableSortDirection

          Новое направление сортировки.

        • currentSortDirection: TableSortDirection

          Текущее направление сортировки.

        • OptionalcolumnData: ColumnRecord

          Данные столбца.

        Returns void

    rowActions?: (
        props: GroupTableRowActionsProps<RowRecord, ColumnRecord>,
    ) => ReactNode

    Действия для строк

    Type declaration

    selectedData?: TableSelectedData

    Данные о выбранных ячейках таблицы

    Содержит полную информацию по выбранным ячейкам во всей таблице

    Если selectMode не задан или задан как none, то данное свойство игнорируется

    selectMode?: MULTIPLE_CELLS

    Режим выбора ячеек таблицы

    undefined

    sortDirection?: { [key: string]: TableSortDirection }

    Текущее направление сортировки по столбцам.

    unsetText: string

    Текст "не установлено".

    On This Page

    Properties
    addTextcanAddcanCollapseLockedcanDeletecellRenderercellViewTypecheckedGroupscollapsedRowsTextcollapseTextcolumnHeightscolumnscolumnWidthscustomHeaderCheckboxdatadeleteTextdisabledForCheckLockedRowsemptyTableRendereremptyTableTextexpandedGroupsexpandTextfilterValuesgetRowTypegroupRendererhasCellPaddinghasCheckedhasHeaderhasHeaderBghasNavigationhasPaginationhideLastRowBorderisAutoHeightFillisAutoScrollToSelectedisChangedAxesisEditableisGroupCheckableisGroupCompactisGroupedisHeaderCheckableisLoadingisLockedCollapsedisLockedRowsCheckableisMultiselectisResizableisRowsCheckableisRowsSelectableisScrollOverflowAutoisSortableisStripedloadingGroupsloadingTextloadMoreTextlockedRowActionsmaxRowsBeforeOverflownoLockedLimitonAllCheckonChangeColumnHeightonChangeColumnWidthonCollapseLockedonCopyonFilteronGroupCheckonGroupCollapseonGroupExpandonLockedRowCheckonLockedRowClickonPasteonPasteErroronResetFilteronRowAddonRowCheckonRowClickonRowDoubleClickonRowMouseEnteronRowMouseLeaveonRowsDeleteonSelectedDataChangeonSelectedDataClearonSortrowActionsselectedDataselectModesortDirectionunsetText