Interface ColumnInstance<D>

Type Parameters

  • D extends object = {}

Hierarchy

Properties

Aggregated? Cell? Filter? Footer? Header? aggregate? align? canFilter canGroupBy canResize canSort clearSortBy columns? defaultCanFilter? defaultCanGroupBy? defaultCanSort? depth disableFilters? disableGlobalFilter? disableGroupBy? disableResizing? disableSortBy? filter? filterValue filteredRows getFooterProps getGroupByToggleProps getHeaderProps getResizerProps getSortByToggleProps getToggleHiddenProps groupedIndex id isGrouped isResizing isSorted isSortedDesc isVisible maxWidth? minWidth? parent? placeholderOf? preFilteredRows render setFilter sortDescFirst? sortInverted? sortType? sortedIndex sticky? toggleGroupBy toggleHidden toggleSortBy totalLeft totalWidth width?

Properties

Optional Aggregated

Aggregated?: Renderer<CellProps<D, any>>

Optional Cell

Cell?: Renderer<CellProps<D, any>>

Optional Filter

Filter?: Renderer<FilterProps<D>>

Optional Footer

Footer?: ReactNode

Optional Header

Header?: Renderer<HeaderProps<D>>

Optional aggregate

aggregate?: Aggregator<D>

Optional align

align?: "left" | "right" | "center"

canFilter

canFilter: boolean

canGroupBy

canGroupBy: boolean

canResize

canResize: boolean

canSort

canSort: boolean

clearSortBy

clearSortBy: (() => void)

Type declaration

    • (): void

    • Returns void

Optional columns

columns?: ColumnInstance<D>[]

Optional defaultCanFilter

defaultCanFilter?: boolean

Optional defaultCanGroupBy

defaultCanGroupBy?: boolean

Optional defaultCanSort

defaultCanSort?: boolean

depth

depth: number

Optional disableFilters

disableFilters?: boolean

Optional disableGlobalFilter

disableGlobalFilter?: boolean

Optional disableGroupBy

disableGroupBy?: boolean

Optional disableResizing

disableResizing?: boolean

Optional disableSortBy

disableSortBy?: boolean

Optional filter

filter?: string | FilterType<D>

filterValue

filterValue: any

filteredRows

filteredRows: Row<D>[]

getFooterProps

getFooterProps: ((propGetter?: FooterPropGetter<D>) => TableFooterProps)

Type declaration

getGroupByToggleProps

getGroupByToggleProps: ((props?: Partial<TableGroupByToggleProps>) => TableGroupByToggleProps)

Type declaration

    • (props?: Partial<TableGroupByToggleProps>): TableGroupByToggleProps

    • Parameters

      • Optional props: Partial<TableGroupByToggleProps>

      Returns TableGroupByToggleProps

getHeaderProps

getHeaderProps: ((propGetter?: HeaderPropGetter<D>) => TableHeaderProps)

Type declaration

getResizerProps

getResizerProps: ((props?: Partial<TableResizerProps>) => TableResizerProps)

Type declaration

getSortByToggleProps

getSortByToggleProps: ((props?: Partial<TableSortByToggleProps>) => TableSortByToggleProps)

Type declaration

getToggleHiddenProps

getToggleHiddenProps: ((userProps?: any) => any)

Type declaration

    • (userProps?: any): any

    • Parameters

      • Optional userProps: any

      Returns any

groupedIndex

groupedIndex: number

id

id: IdType<D>

isGrouped

isGrouped: boolean

isResizing

isResizing: boolean

isSorted

isSorted: boolean

isSortedDesc

isSortedDesc: undefined | boolean

isVisible

isVisible: boolean

Optional maxWidth

maxWidth?: number

Optional minWidth

minWidth?: number

Optional parent

parent?: ColumnInstance<D>

Optional placeholderOf

placeholderOf?: ColumnInstance<{}>

preFilteredRows

preFilteredRows: Row<D>[]

render

render: ((type: string, props?: object) => ReactNode)

Type declaration

    • (type: string, props?: object): ReactNode

    • Parameters

      • type: string
      • Optional props: object

      Returns ReactNode

setFilter

setFilter: ((updater: any) => void)

Type declaration

    • (updater: any): void

    • Parameters

      • updater: any

      Returns void

Optional sortDescFirst

sortDescFirst?: boolean

Optional sortInverted

sortInverted?: boolean

Optional sortType

sortType?: string | SortByFn<D>

sortedIndex

sortedIndex: number

Optional sticky

sticky?: "left" | "right"

toggleGroupBy

toggleGroupBy: (() => void)

Type declaration

    • (): void

    • Returns void

toggleHidden

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

Type declaration

    • (value?: boolean): void

    • Parameters

      • Optional value: boolean

      Returns void

toggleSortBy

toggleSortBy: ((descending?: boolean, multi?: boolean) => void)

Type declaration

    • (descending?: boolean, multi?: boolean): void

    • Parameters

      • Optional descending: boolean
      • Optional multi: boolean

      Returns void

totalLeft

totalLeft: number

totalWidth

totalWidth: number

Optional width

width?: string | number

Settings

Member Visibility

Theme

Generated using TypeDoc