Interface: CategoryColumnRegistration#
Renderer.Component.CategoryColumnRegistration
Hierarchy#
CategoryColumnRegistration
↳ AdditionalCategoryColumnRegistration
Table of contents#
Properties#
Properties#
id#
• id: string
This value MUST to be unique to your extension
priority#
• Optional
priority: number
The sorting order value.
default
50
renderCell#
• renderCell: (entity
: CatalogEntity
<CatalogEntityMetadata
, CatalogEntityStatus
, CatalogEntitySpec
>) => ReactNode
Type declaration#
▸ (entity
): ReactNode
This function will be called to generate the cells (on demand) for the column
Parameters#
Name | Type |
---|---|
entity |
CatalogEntity <CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > |
Returns#
ReactNode
searchFilter#
• Optional
searchFilter: (entity
: CatalogEntity
<CatalogEntityMetadata
, CatalogEntityStatus
, CatalogEntitySpec
>) => string
| string
[]
Type declaration#
▸ (entity
): string
| string
[]
If provided then searching is supported on this column and this function will be called to determine if the current search string matches for this row.
Parameters#
Name | Type |
---|---|
entity |
CatalogEntity <CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > |
Returns#
string
| string
[]
sortCallback#
• Optional
sortCallback: (entity
: CatalogEntity
<CatalogEntityMetadata
, CatalogEntityStatus
, CatalogEntitySpec
>) => string
| number
| (string
| number
)[]
Type declaration#
▸ (entity
): string
| number
| (string
| number
)[]
If provided then the column will support sorting and this function will be called to determine a row's ordering.
strings are sorted ahead of numbers, and arrays determine ordering between equal elements of the previous index.
Parameters#
Name | Type |
---|---|
entity |
CatalogEntity <CatalogEntityMetadata , CatalogEntityStatus , CatalogEntitySpec > |
Returns#
string
| number
| (string
| number
)[]
titleProps#
• titleProps: TitleCellProps
This function will be used to generate the columns title cell.