RevoGrid Documentation v4.21.7 / ColumnRegular
Interface: ColumnRegular<P>
ColumnRegular interface represents regular column definition. Regular column can be any column that is not a grouping column.
Extends
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
P extends ColumnProp | ColumnProp |
Indexable
[key: string]: any
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
autoSize? | boolean | Column size would be changed based on space left. | - | src/types/interfaces.ts:238 |
cellCompare? | CellCompareFunc | Represents the cell compare function for custom sorting. | ColumnType.cellCompare | src/types/interfaces.ts:204 |
cellParser? | (model: DataType<any, ColumnProp>, column: ColumnRegular<ColumnProp>) => any | Represents the cell value parse function for custom parsing. Currently only used for filtering. | ColumnType.cellParser | src/types/interfaces.ts:210 |
cellProperties? | PropertiesFunc | Represents cell properties for custom styling, classes, and events. | ColumnType.cellProperties | src/types/interfaces.ts:196 |
cellTemplate? | CellTemplate | Represents the cell template for custom rendering. | ColumnType.cellTemplate | src/types/interfaces.ts:200 |
columnProperties? | ColPropertiesFunc | Header Cell properties Custom function/component to render header properties | ColumnType.columnProperties | src/types/interfaces.ts:139 |
columnTemplate? | ColumnTemplateFunc | Header inner template Function/component to render custom header content | ColumnType.columnTemplate | src/types/interfaces.ts:134 |
columnType? | string | Represents type defined in columnTypes property through grid config. | - | src/types/interfaces.ts:258 |
editor? | string | EditorCtr | Represents a custom editor defined in editors property. Can be a string or an editor constructor function. | ColumnType.editor | src/types/interfaces.ts:192 |
filter? | string | boolean | string[] | Filter. Require filter plugin to be installed and activated through grid config filter. | - | src/types/interfaces.ts:242 |
maxSize? | number | Represents the maximum column size. | ColumnType.maxSize | src/types/interfaces.ts:187 |
minSize? | number | Represents the minimal column size. This property cannot be less than cell padding in order to keep performance on top and minimize DOM elements number. | ColumnType.minSize | src/types/interfaces.ts:183 |
name? | any | Column header text. | - | src/types/interfaces.ts:234 |
order? | Order | Sort order. | - | src/types/interfaces.ts:250 |
pin? | DimensionColPin | Column pin 'colPinStart' | 'colPinEnd'. | - |
prop | P | Column prop used for mapping value to cell from data source model/row, used for indexing. | - | src/types/interfaces.ts:226 |
readonly? | ReadOnlyFormat<DataType<any, ColumnProp>, ColumnRegular<ColumnProp>> | Represents whether the column or cell is read-only. Can be a boolean or a function that returns a boolean. The function receives column data as a parameter. | ColumnType.readonly | src/types/interfaces.ts:173 |
rowDrag? | RowDrag<DataType<any, ColumnProp>, ColumnRegular<ColumnProp>> | Is cell in column or individual can be dragged. | - | src/types/interfaces.ts:254 |
size? | number | Represents the default column size. | ColumnType.size | src/types/interfaces.ts:177 |
sortable? | boolean | Is column can be sorted, check cellCompare function for custom sorting. | - | src/types/interfaces.ts:246 |
Methods
beforeSetup()?
ts
optional beforeSetup(rgCol: ColumnRegular<ColumnProp>): voidFunction called before column applied to the store.
Parameters
| Parameter | Type |
|---|---|
rgCol | ColumnRegular<ColumnProp> |
Returns
void