RevoGrid Documentation v4.26.1 / RowHeaders

Interface: RowHeaders

ColumnRegular interface represents regular column definition. Regular column can be any column that is not a grouping column.

Extends

• ColumnRegular

Properties

Property	Type	Description	Inherited from	Defined in
autoSize?	boolean	Column size would be changed based on space left.	ColumnRegular.autoSize	src/types/interfaces.ts:239
blankSemantics?	BlankSemantics	Partial column override for the grid-level blank filtering policy.	ColumnRegular.blankSemantics	src/types/interfaces.ts:245
cellCompare?	CellCompareFunc<DataType<any, ColumnProp>>	Represents the cell compare function for custom sorting.	ColumnRegular.cellCompare	src/types/interfaces.ts:205
cellParser?	(model: DataType<any, ColumnProp>, column: ColumnRegular<ColumnProp, DataType<any, ColumnProp>>) => any	Represents the cell value parse function for custom parsing. Currently only used for filtering.	ColumnRegular.cellParser	src/types/interfaces.ts:211
cellProperties?	PropertiesFunc<DataType<any, ColumnProp>>	Represents cell properties for custom styling, classes, and events.	ColumnRegular.cellProperties	src/types/interfaces.ts:197
cellTemplate?	CellTemplate<DataType<any, ColumnProp>>	Represents the cell template for custom rendering.	ColumnRegular.cellTemplate	src/types/interfaces.ts:201
columnProperties?	ColPropertiesFunc	Header Cell properties Custom function/component to render header properties	ColumnRegular.columnProperties	src/types/interfaces.ts:140
columnTemplate?	ColumnTemplateFunc	Header inner template Function/component to render custom header content	ColumnRegular.columnTemplate	src/types/interfaces.ts:135
columnType?	string	Represents type defined in columnTypes property through grid config.	ColumnRegular.columnType	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.	ColumnRegular.editor	src/types/interfaces.ts:193
filter?	string | boolean | string[]	Filter. Require filter plugin to be installed and activated through grid config filter.	ColumnRegular.filter	src/types/interfaces.ts:243
maxSize?	number	Represents the maximum column size.	ColumnRegular.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.	ColumnRegular.minSize	src/types/interfaces.ts:184
name?	any	Column header text.	ColumnRegular.name	src/types/interfaces.ts:235
order?	Order	Sort order.	ColumnRegular.order	src/types/interfaces.ts:253
pin?	DimensionColPin	Column pin 'colPinStart'	'colPinEnd'.	ColumnRegular.pin
prop	ColumnProp	Column prop used for mapping value to cell from data source model/row, used for indexing.	ColumnRegular.prop	src/types/interfaces.ts:227
readonly?	ReadOnlyFormat<DataType<any, ColumnProp>, 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.	ColumnRegular.readonly	src/types/interfaces.ts:174
rowDrag?	RowDrag<DataType<any, ColumnProp>, ColumnRegular<ColumnProp, DataType<any, ColumnProp>>>	Is cell in column or individual can be dragged.	ColumnRegular.rowDrag	src/types/interfaces.ts:257
size?	number	Represents the default column size.	ColumnRegular.size	src/types/interfaces.ts:178
sortable?	boolean	Is column can be sorted, check cellCompare function for custom sorting.	ColumnRegular.sortable	src/types/interfaces.ts:249

Methods

beforeSetup()?

optional beforeSetup(rgCol: ColumnRegular<ColumnProp, DataType<any, ColumnProp>>): void

Function called before column applied to the store.

Parameters

Parameter	Type
rgCol	ColumnRegular<ColumnProp, DataType<any, ColumnProp>>

Returns

void

Inherited from

ColumnRegular.beforeSetup

Defined in

src/types/interfaces.ts:265