RevoGrid Documentation v4.21.7 / ColumnTemplateProp

Interface: ColumnTemplateProp<P>

Column template property. Contains extended properties for column.

Extends

• ColumnRegular<P>

Type Parameters

Type Parameter	Default type
P extends ColumnProp	ColumnProp

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:238
cellCompare?	CellCompareFunc	Represents the cell compare function for custom sorting.	ColumnRegular.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.	ColumnRegular.cellParser	src/types/interfaces.ts:210
cellProperties?	PropertiesFunc	Represents cell properties for custom styling, classes, and events.	ColumnRegular.cellProperties	src/types/interfaces.ts:196
cellTemplate?	CellTemplate	Represents the cell template for custom rendering.	ColumnRegular.cellTemplate	src/types/interfaces.ts:200
columnProperties?	ColPropertiesFunc	Header Cell properties Custom function/component to render header properties	ColumnRegular.columnProperties	src/types/interfaces.ts:139
columnTemplate?	ColumnTemplateFunc	Header inner template Function/component to render custom header content	ColumnRegular.columnTemplate	src/types/interfaces.ts:134
columnType?	string	Represents type defined in columnTypes property through grid config.	ColumnRegular.columnType	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.	ColumnRegular.editor	src/types/interfaces.ts:192
filter?	string | boolean | string[]	Filter. Require filter plugin to be installed and activated through grid config filter.	ColumnRegular.filter	src/types/interfaces.ts:242
index	number	Index of the column, used for mapping value to cell from data source model/row.	-	src/types/interfaces.ts:282
maxSize?	number	Represents the maximum column size.	ColumnRegular.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.	ColumnRegular.minSize	src/types/interfaces.ts:183
name?	any	Column header text.	ColumnRegular.name	src/types/interfaces.ts:234
order?	Order	Sort order.	ColumnRegular.order	src/types/interfaces.ts:250
pin?	DimensionColPin	Column pin 'colPinStart'	'colPinEnd'.	ColumnRegular.pin
prop	P	Column prop used for mapping value to cell from data source model/row, used for indexing.	ColumnRegular.prop	src/types/interfaces.ts:226
providers	ProvidersColumns<DimensionCols | "rowHeaders">	Providers injected into the template.	-	src/types/interfaces.ts:278
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.	ColumnRegular.readonly	src/types/interfaces.ts:173
rowDrag?	RowDrag<DataType<any, ColumnProp>, ColumnRegular<ColumnProp>>	Is cell in column or individual can be dragged.	ColumnRegular.rowDrag	src/types/interfaces.ts:254
size?	number	Represents the default column size.	ColumnRegular.size	src/types/interfaces.ts:177
sortable?	boolean	Is column can be sorted, check cellCompare function for custom sorting.	ColumnRegular.sortable	src/types/interfaces.ts:246

Methods

beforeSetup()?

optional beforeSetup(rgCol: ColumnRegular<ColumnProp>): void

Function called before column applied to the store.

Parameters

Parameter	Type
rgCol	ColumnRegular<ColumnProp>

Returns

void

Inherited from

ColumnRegular.beforeSetup

Defined in

src/types/interfaces.ts:262