Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TableInstance<D>

Type Parameters

  • D extends object = {}

Hierarchy

Index

Properties

Methods

Properties

allColumns

allColumns: ColumnInstance<D>[]

allColumnsHidden

allColumnsHidden: boolean

Optional autoResetHiddenColumns

autoResetHiddenColumns?: boolean

columns

columns: ColumnInstance<D>[]

data

data: readonly D[]

Optional defaultColumn

defaultColumn?: Partial<Column<D>>

dispatch

dispatch: TableDispatch<any>

flatHeaders

flatHeaders: ColumnInstance<D>[]

flatRows

flatRows: Row<D>[]

footerGroups

footerGroups: HeaderGroup<D>[]

headerGroups

headerGroups: HeaderGroup<D>[]

headers

headers: ColumnInstance<D>[]

Optional initialState

initialState?: Partial<TableState<D>>

plugins

plugins: PluginHook<D>[]

rows

rows: Row<D>[]

rowsById

rowsById: Record<string, Row<D>>

state

state: TableState<D>

totalColumnsWidth

totalColumnsWidth: number

visibleColumns

visibleColumns: ColumnInstance<D>[]

Methods

getHooks

  • getHooks(): Hooks<D>

  • Returns Hooks<D>

Optional getRowId

  • getRowId(originalRow: D, relativeIndex: number, parent?: Row<D>): string

  • Parameters

    • originalRow: D
    • relativeIndex: number
    • Optional parent: Row<D>

    Returns string

Optional getSubRows

  • getSubRows(originalRow: D, relativeIndex: number): D[]

  • Parameters

    • originalRow: D
    • relativeIndex: number

    Returns D[]

getTableBodyProps

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

  • Parameters

    • Optional propGetter: TableBodyPropGetter<D>

    Returns TableBodyProps

getTableProps

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

  • Parameters

    • Optional propGetter: TablePropGetter<D>

    Returns TableProps

getToggleHideAllColumnsProps

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

  • Parameters

    • Optional props: Partial<TableToggleHideAllColumnProps>

    Returns TableToggleHideAllColumnProps

prepareRow

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

  • Parameters

    Returns void

setHiddenColumns

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

  • Parameters

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

    Returns void

Optional stateReducer

  • stateReducer(newState: TableState<D>, action: ActionType, previousState: TableState<D>, instance?: TableInstance<D>): TableState<D>

  • Parameters

    • newState: TableState<D>
    • action: ActionType
    • previousState: TableState<D>
    • Optional instance: TableInstance<D>

    Returns TableState<D>

toggleHideAllColumns

  • toggleHideAllColumns(value?: boolean): void

  • Parameters

    • Optional value: boolean

    Returns void

toggleHideColumn

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

  • Parameters

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

    Returns void

Optional useControlledState

  • useControlledState(state: TableState<D>, meta: MetaBase<D>): TableState<D>

  • Parameters

    • state: TableState<D>
    • meta: MetaBase<D>

    Returns TableState<D>

Generated using TypeDoc