RevoGrid Documentation v4.26.2 / ColumnRegular
Interface: ColumnRegular<P, TModel>
ColumnRegular interface represents regular column definition. Regular column can be any column that is not a grouping column.
Extends
ColumnType<TModel>
Extended by
Type Parameters
| Type Parameter | Default type |
|---|---|
P extends ColumnProp | ColumnProp |
TModel extends DataType | DataType |
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:239 |
blankSemantics? | BlankSemantics | Partial column override for the grid-level blank filtering policy. | - | src/types/interfaces.ts:245 |
cellCompare? | CellCompareFunc<TModel> | Represents the cell compare function for custom sorting. | ColumnType.cellCompare | src/types/interfaces.ts:205 |
cellParser? | (model: TModel, column: ColumnRegular<ColumnProp, TModel>) => any | Represents the cell value parse function for custom parsing. Currently only used for filtering. | ColumnType.cellParser | src/types/interfaces.ts:211 |
cellProperties? | PropertiesFunc<TModel> | Represents cell properties for custom styling, classes, and events. | ColumnType.cellProperties | src/types/interfaces.ts:197 |
cellTemplate? | CellTemplate<TModel> | Represents the cell template for custom rendering. | ColumnType.cellTemplate | src/types/interfaces.ts:201 |
columnProperties? | ColPropertiesFunc | Header Cell properties Custom function/component to render header properties | ColumnType.columnProperties | src/types/interfaces.ts:140 |
columnTemplate? | ColumnTemplateFunc | Header inner template Function/component to render custom header content | ColumnType.columnTemplate | src/types/interfaces.ts:135 |
columnType? | string | Represents type defined in columnTypes property through grid config. | - | src/types/interfaces.ts:261 |
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:193 |
filter? | string | boolean | string[] | Filter. Require filter plugin to be installed and activated through grid config filter. | - | src/types/interfaces.ts:243 |
maxSize? | number | Represents the maximum column size. | ColumnType.maxSize | src/types/interfaces.ts:188 |
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:184 |
name? | any | Column header text. | - | src/types/interfaces.ts:235 |
order? | Order | Sort order. | - | src/types/interfaces.ts:253 |
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:227 |
readonly? | ReadOnlyFormat<TModel, ColumnRegular<ColumnProp, DataType<any, 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:174 |
rowDrag? | RowDrag<TModel, ColumnRegular<ColumnProp, DataType<any, ColumnProp>>> | Is cell in column or individual can be dragged. | - | src/types/interfaces.ts:257 |
size? | number | Represents the default column size. | ColumnType.size | src/types/interfaces.ts:178 |
sortable? | boolean | Is column can be sorted, check cellCompare function for custom sorting. | - | src/types/interfaces.ts:249 |
Methods
beforeSetup()?
ts
optional beforeSetup(rgCol: ColumnRegular<P, TModel>): voidFunction called before column applied to the store.
Parameters
| Parameter | Type |
|---|---|
rgCol | ColumnRegular<P, TModel> |
Returns
void