Configuration options for a grid column
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
string
|
<optional> |
Used to distinguish between multiple columns that have the same key. |
key |
string
|
<optional> |
Name of the property in each row item that will be used for this column's value. |
title |
string
|
<optional> |
Text to display in the column's header. |
allowCellDrag |
RowBoolean
|
<optional> |
- |
allowCellDrop |
CellDropBoolean
|
<optional> |
- |
cellRenderer |
CellRenderer
|
<optional> |
Dynamically determines the data value and display value for a cell. |
viewComponent |
ConstructorOfATypedSvelteComponent
|
<optional> |
Svelte component class to be displayed in the cell regardless of focus. If set, focusComponent will be ignored. |
viewComponentConfig |
object
|
<optional> |
Properties to be passed when creating viewComponent. |
focusComponent |
ConstructorOfATypedSvelteComponent
|
<optional> |
Svelte component class to be displayed in the cell when it has focus. |
focusComponentConfig |
object
|
<optional> |
Properties to be passed when creating focusComponent. |
tdClassAppend |
string
|
<optional> |
Classes to append to existing CSS when not focused. |
tdClassOverride |
string
|
<optional> |
Classes to replace existing CSS with when not focused. |
tdFocusedClassAppend |
string
|
<optional> |
Classes to append to existing CSS when focused. |
tdFocusedClassOverride |
string
|
<optional> |
Classes to replace existing CSS with when focused. |
tdClassGetter |
DataCellClassFunction
|
<optional> |
Dynamically determines CSS classes for a cell. |
thClassAppend |
string
|
<optional> |
Classes to append to existing CSS for header cells. |
thClassOverride |
string
|
<optional> |
Class to replace existing CSS for header cells. |
canFocus |
boolean
|
<optional> |
True if cells in this column can be focused. |
canSort |
boolean
|
<optional> |
If true, clicking the column's header will set sorting to sortFunction or sortKey, or reverse it if already set. |
sortAscendingIcon |
ConstructorOfATypedSvelteComponent
|
<optional> |
Svelte component class to be displayed in the column is sorting ascended (overrides table). |
sortDescendingIcon |
ConstructorOfATypedSvelteComponent
|
<optional> |
Svelte component class to be displayed in the column is sorting descended (overrides table). |
sortFunction |
SortFunction
|
<optional> |
Comparison function for complex sorting. |
sortKey |
string
|
<optional> |
Item property to sort by, if sortFunction is not defined. |