Skip to content
FireCMS Logo FireCMS

EntityTableController

@firecms/core

@firecms/core / EntityTableController

Type Alias: EntityTableController<M>

Section titled “Type Alias: EntityTableController<M>”

EntityTableController<M> = object

Defined in: types/collections.ts:627

You can use this controller to control the table view of a collection.

Type Parameters

Section titled “Type Parameters”

M

Section titled “M”

M extends Record<string, any> = any

Properties

Section titled “Properties”

checkFilterCombination()?

Section titled “checkFilterCombination()?”

optional checkFilterCombination: (filterValues, sortBy?) => boolean

Defined in: types/collections.ts:649

Parameters

Section titled “Parameters”
filterValues
Section titled “filterValues”

FilterValues<any>

sortBy?
Section titled “sortBy?”

[string, "asc" | "desc"]

Returns

Section titled “Returns”

boolean

clearFilter()?

Section titled “clearFilter()?”

optional clearFilter: () => void

Defined in: types/collections.ts:638

Returns

Section titled “Returns”

void

data

Section titled “data”

data: Entity<M>[]

Defined in: types/collections.ts:628

dataLoading

Section titled “dataLoading”

dataLoading: boolean

Defined in: types/collections.ts:629

dataLoadingError?

Section titled “dataLoadingError?”

optional dataLoadingError: Error

Defined in: types/collections.ts:631

filterValues?

Section titled “filterValues?”

optional filterValues: FilterValues<Extract<keyof M, string>>

Defined in: types/collections.ts:632

initialScroll?

Section titled “initialScroll?”

optional initialScroll: number

Defined in: types/collections.ts:641

itemCount?

Section titled “itemCount?”

optional itemCount: number

Defined in: types/collections.ts:639

noMoreToLoad

Section titled “noMoreToLoad”

noMoreToLoad: boolean

Defined in: types/collections.ts:630

onAddColumn()?

Section titled “onAddColumn()?”

optional onAddColumn: (column) => void

Defined in: types/collections.ts:654

Parameters

Section titled “Parameters”
column
Section titled “column”

string

Returns

Section titled “Returns”

void

onScroll()?

Section titled “onScroll()?”

optional onScroll: (props) => void

Defined in: types/collections.ts:642

Parameters

Section titled “Parameters”
props
Section titled “props”
scrollDirection
Section titled “scrollDirection”

"forward" | "backward"

scrollOffset
Section titled “scrollOffset”

number

scrollUpdateWasRequested
Section titled “scrollUpdateWasRequested”

boolean

Returns

Section titled “Returns”

void

pageSize?

Section titled “pageSize?”

optional pageSize: number

Defined in: types/collections.ts:648

paginationEnabled?

Section titled “paginationEnabled?”

optional paginationEnabled: boolean

Defined in: types/collections.ts:647

popupCell?

Section titled “popupCell?”

optional popupCell: SelectedCellProps<M>

Defined in: types/collections.ts:651

searchString?

Section titled “searchString?”

optional searchString: string

Defined in: types/collections.ts:636

setFilterValues()?

Section titled “setFilterValues()?”

optional setFilterValues: (filterValues) => void

Defined in: types/collections.ts:633

Parameters

Section titled “Parameters”
filterValues
Section titled “filterValues”

FilterValues<Extract<keyof M, string>>

Returns

Section titled “Returns”

void

setItemCount()?

Section titled “setItemCount()?”

optional setItemCount: (itemCount) => void

Defined in: types/collections.ts:640

Parameters

Section titled “Parameters”
itemCount
Section titled “itemCount”

number

Returns

Section titled “Returns”

void

setPopupCell()?

Section titled “setPopupCell()?”

optional setPopupCell: (popupCell?) => void

Defined in: types/collections.ts:652

Parameters

Section titled “Parameters”
popupCell?
Section titled “popupCell?”

SelectedCellProps<M>

Returns

Section titled “Returns”

void

setSearchString()?

Section titled “setSearchString()?”

optional setSearchString: (searchString?) => void

Defined in: types/collections.ts:637

Parameters

Section titled “Parameters”
searchString?
Section titled “searchString?”

string

Returns

Section titled “Returns”

void

setSortBy()?

Section titled “setSortBy()?”

optional setSortBy: (sortBy?) => void

Defined in: types/collections.ts:635

Parameters

Section titled “Parameters”
sortBy?
Section titled “sortBy?”

[Extract<keyof M, string>, "asc" | "desc"]

Returns

Section titled “Returns”

void

sortBy?

Section titled “sortBy?”

optional sortBy: [Extract<keyof M, string>, "asc" | "desc"]

Defined in: types/collections.ts:634