Interface TableInstance<D>

Type Parameters

  • D extends object = {}

Hierarchy

Properties

allColumns allColumnsHidden canNextPage canPreviousPage columns dispatch expandedDepth expandedRows filteredFlatRows filteredRows filteredRowsById flatHeaders flatRows footerGroups getHooks getTableBodyProps getTableProps getToggleAllPageRowsSelectedProps getToggleAllRowsSelectedProps getToggleHideAllColumnsProps globalFilteredFlatRows globalFilteredRows globalFilteredRowsById gotoPage groupedFlatRows groupedRows groupedRowsById headerGroups headers isAllRowsExpanded isAllRowsSelected nextPage nonGroupedFlatRows nonGroupedRowsById onlyGroupedFlatRows onlyGroupedRowsById page pageCount pageOptions plugins preExpandedRows preFilteredFlatRows preFilteredRows preFilteredRowsById preGlobalFilteredFlatRows preGlobalFilteredRows preGlobalFilteredRowsById preGroupedFlatRows preGroupedRows preGroupedRowsById preSortedRows prepareRow previousPage resetFiltersVisible resetModal rows rowsById selectedFlatRows setAllFilters setCellState setColumnOrder setFilter setFiltersVisible setGlobalFilter setHiddenColumns setModal setPageSize setRowState setSortBy state toggleAllRowsExpanded toggleAllRowsSelected toggleFiltersVisible toggleGroupBy toggleHideAllColumns toggleHideColumn toggleRowExpanded toggleRowSelected toggleSortBy totalColumnsWidth visibleColumns

Properties

allColumns

allColumns: ColumnInstance<D>[]

allColumnsHidden

allColumnsHidden: boolean

canNextPage

canNextPage: boolean

canPreviousPage

canPreviousPage: boolean

columns

columns: ColumnInstance<D>[]

dispatch

dispatch: TableDispatch<any>

expandedDepth

expandedDepth: number

expandedRows

expandedRows: Row<D>[]

filteredFlatRows

filteredFlatRows: Row<D>[]

filteredRows

filteredRows: Row<D>[]

filteredRowsById

filteredRowsById: Record<string, Row<D>>

flatHeaders

flatHeaders: ColumnInstance<D>[]

flatRows

flatRows: Row<D>[]

footerGroups

footerGroups: HeaderGroup<D>[]

getHooks

getHooks: (() => Hooks<D>)

Type declaration

getTableBodyProps

getTableBodyProps: ((propGetter?: TableBodyPropGetter<D>) => TableBodyProps)

Type declaration

    • (propGetter?: TableBodyPropGetter<D>): TableBodyProps

    • Parameters

      • Optional propGetter: TableBodyPropGetter<D>

      Returns TableBodyProps

getTableProps

getTableProps: ((propGetter?: TablePropGetter<D>) => TableProps)

Type declaration

getToggleAllPageRowsSelectedProps

getToggleAllPageRowsSelectedProps: ((props?: Partial<TableToggleAllRowsSelectedProps>) => TableToggleAllRowsSelectedProps)

Type declaration

getToggleAllRowsSelectedProps

getToggleAllRowsSelectedProps: ((props?: Partial<TableToggleAllRowsSelectedProps>) => TableToggleAllRowsSelectedProps)

Type declaration

getToggleHideAllColumnsProps

getToggleHideAllColumnsProps: ((props?: Partial<TableToggleHideAllColumnProps>) => TableToggleHideAllColumnProps)

Type declaration

globalFilteredFlatRows

globalFilteredFlatRows: Row<D>[]

globalFilteredRows

globalFilteredRows: Row<D>[]

globalFilteredRowsById

globalFilteredRowsById: Record<string, Row<D>>

gotoPage

gotoPage: ((updater: number | ((pageIndex: number) => number)) => void)

Type declaration

    • (updater: number | ((pageIndex: number) => number)): void

    • Parameters

      • updater: number | ((pageIndex: number) => number)

      Returns void

groupedFlatRows

groupedFlatRows: Row<D>[]

groupedRows

groupedRows: Row<D>[]

groupedRowsById

groupedRowsById: Record<string, Row<D>>

headerGroups

headerGroups: HeaderGroup<D>[]

headers

headers: ColumnInstance<D>[]

isAllRowsExpanded

isAllRowsExpanded: boolean

isAllRowsSelected

isAllRowsSelected: boolean

nextPage

nextPage: (() => void)

Type declaration

    • (): void

    • Returns void

nonGroupedFlatRows

nonGroupedFlatRows: Row<D>[]

nonGroupedRowsById

nonGroupedRowsById: Record<string, Row<D>>

onlyGroupedFlatRows

onlyGroupedFlatRows: Row<D>[]

onlyGroupedRowsById

onlyGroupedRowsById: Record<string, Row<D>>

page

page: Row<D>[]

pageCount

pageCount: number

pageOptions

pageOptions: number[]

plugins

plugins: PluginHook<D>[]

preExpandedRows

preExpandedRows: Row<D>[]

preFilteredFlatRows

preFilteredFlatRows: Row<D>[]

preFilteredRows

preFilteredRows: Row<D>[]

preFilteredRowsById

preFilteredRowsById: Record<string, Row<D>>

preGlobalFilteredFlatRows

preGlobalFilteredFlatRows: Row<D>[]

preGlobalFilteredRows

preGlobalFilteredRows: Row<D>[]

preGlobalFilteredRowsById

preGlobalFilteredRowsById: Record<string, Row<D>>

preGroupedFlatRows

preGroupedFlatRows: Row<D>[]

preGroupedRows

preGroupedRows: Row<D>[]

preGroupedRowsById

preGroupedRowsById: Record<string, Row<D>>

preSortedRows

preSortedRows: Row<D>[]

prepareRow

prepareRow: ((row: Row<D>) => void)

Type declaration

    • (row: Row<D>): void

    • Parameters

      Returns void

previousPage

previousPage: (() => void)

Type declaration

    • (): void

    • Returns void

resetFiltersVisible

resetFiltersVisible: (() => void)

Type declaration

    • (): void

    • Returns void

resetModal

resetModal: (() => void)

Type declaration

    • (): void

    • Returns void

rows

rows: Row<D>[]

rowsById

rowsById: Record<string, Row<D>>

selectedFlatRows

selectedFlatRows: Row<D>[]

setAllFilters

setAllFilters: ((updater: Filters<D> | ((filters: Filters<D>) => Filters<D>)) => void)

Type declaration

setCellState

setCellState: ((rowPath: string[], columnId: IdType<D>, updater: unknown) => void)

Type declaration

    • (rowPath: string[], columnId: IdType<D>, updater: unknown): void

    • Parameters

      • rowPath: string[]
      • columnId: IdType<D>
      • updater: unknown

      Returns void

setColumnOrder

setColumnOrder: ((updater: IdType<D>[] | ((columnOrder: IdType<D>[]) => IdType<D>[])) => void)

Type declaration

setFilter

setFilter: ((columnId: IdType<D>, updater: any) => void)

Type declaration

    • (columnId: IdType<D>, updater: any): void

    • Parameters

      • columnId: IdType<D>
      • updater: any

      Returns void

setFiltersVisible

setFiltersVisible: ((filtersVisible: boolean) => void)

Type declaration

    • (filtersVisible: boolean): void

    • Parameters

      • filtersVisible: boolean

      Returns void

setGlobalFilter

setGlobalFilter: ((filterValue: any) => void)

Type declaration

    • (filterValue: any): void

    • Parameters

      • filterValue: any

      Returns void

setHiddenColumns

setHiddenColumns: ((param: IdType<D>[] | UpdateHiddenColumns<D>) => void)

Type declaration

    • (param: IdType<D>[] | UpdateHiddenColumns<D>): void

    • Parameters

      • param: IdType<D>[] | UpdateHiddenColumns<D>

      Returns void

setModal

setModal: ((modalProps: ModalProps) => void)

Type declaration

    • (modalProps: ModalProps): void

    • Parameters

      • modalProps: ModalProps

      Returns void

setPageSize

setPageSize: ((pageSize: number) => void)

Type declaration

    • (pageSize: number): void

    • Parameters

      • pageSize: number

      Returns void

setRowState

setRowState: ((rowPath: string[], updater: unknown) => void)

Type declaration

    • (rowPath: string[], updater: unknown): void

    • Parameters

      • rowPath: string[]
      • updater: unknown

      Returns void

setSortBy

setSortBy: ((sortBy: SortingRule<D>[]) => void)

Type declaration

state

state: TableState<D>

toggleAllRowsExpanded

toggleAllRowsExpanded: ((value?: boolean) => void)

Type declaration

    • (value?: boolean): void

    • Parameters

      • Optional value: boolean

      Returns void

toggleAllRowsSelected

toggleAllRowsSelected: ((value?: boolean) => void)

Type declaration

    • (value?: boolean): void

    • Parameters

      • Optional value: boolean

      Returns void

toggleFiltersVisible

toggleFiltersVisible: (() => void)

Type declaration

    • (): void

    • Returns void

toggleGroupBy

toggleGroupBy: ((columnId: IdType<D>, value?: boolean) => void)

Type declaration

    • (columnId: IdType<D>, value?: boolean): void

    • Parameters

      • columnId: IdType<D>
      • Optional value: boolean

      Returns void

toggleHideAllColumns

toggleHideAllColumns: ((value?: boolean) => void)

Type declaration

    • (value?: boolean): void

    • Parameters

      • Optional value: boolean

      Returns void

toggleHideColumn

toggleHideColumn: ((columnId: IdType<D>, value?: boolean) => void)

Type declaration

    • (columnId: IdType<D>, value?: boolean): void

    • Parameters

      • columnId: IdType<D>
      • Optional value: boolean

      Returns void

toggleRowExpanded

toggleRowExpanded: ((id: IdType<D>[], value?: boolean) => void)

Type declaration

    • (id: IdType<D>[], value?: boolean): void

    • Parameters

      • id: IdType<D>[]
      • Optional value: boolean

      Returns void

toggleRowSelected

toggleRowSelected: ((rowId: IdType<D>, set?: boolean) => void)

Type declaration

    • (rowId: IdType<D>, set?: boolean): void

    • Parameters

      • rowId: IdType<D>
      • Optional set: boolean

      Returns void

toggleSortBy

toggleSortBy: ((columnId: IdType<D>, descending?: boolean, isMulti?: boolean) => void)

Type declaration

    • (columnId: IdType<D>, descending?: boolean, isMulti?: boolean): void

    • Parameters

      • columnId: IdType<D>
      • Optional descending: boolean
      • Optional isMulti: boolean

      Returns void

totalColumnsWidth

totalColumnsWidth: number

visibleColumns

visibleColumns: ColumnInstance<D>[]

Settings

Member Visibility

Theme

Generated using TypeDoc