RevoGrid Documentation v4.15.1 / ColumnRegular

Interface: ColumnRegular

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

Extends

• ColumnType

Extended by

• ColumnTemplateProp
• RowHeaders

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:221
cellCompare?	CellCompareFunc	Represents the cell compare function for custom sorting.	ColumnType.cellCompare	src/types/interfaces.ts:187
cellParser?	(model: DataType<any>, column: ColumnRegular) => any	Represents the cell value parse function for custom parsing. Currently only used for filtering.	ColumnType.cellParser	src/types/interfaces.ts:193
cellProperties?	PropertiesFunc	Represents cell properties for custom styling, classes, and events.	ColumnType.cellProperties	src/types/interfaces.ts:179
cellTemplate?	CellTemplate	Represents the cell template for custom rendering.	ColumnType.cellTemplate	src/types/interfaces.ts:183
columnProperties?	ColPropertiesFunc	Header Cell properties Custom function/component to render header properties	ColumnType.columnProperties	src/types/interfaces.ts:122
columnTemplate?	ColumnTemplateFunc	Header inner template Function/component to render custom header content	ColumnType.columnTemplate	src/types/interfaces.ts:117
columnType?	string	Represents type defined in columnTypes property through grid config.	-	src/types/interfaces.ts:241
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:175
filter?	string | boolean | string[]	Filter. Require filter plugin to be installed and activated through grid config filter.	-	src/types/interfaces.ts:225
maxSize?	number	Represents the maximum column size.	ColumnType.maxSize	src/types/interfaces.ts:170
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:166
name?	any	Column header text.	-	src/types/interfaces.ts:217
order?	Order	Sort order.	-	src/types/interfaces.ts:233
pin?	DimensionColPin	Column pin 'colPinStart'	'colPinEnd'.	-
prop	ColumnProp	Column prop used for mapping value to cell from data source model/row, used for indexing.	-	src/types/interfaces.ts:209
readonly?	ReadOnlyFormat	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:156
rowDrag?	RowDrag	Is cell in column or individual can be dragged.	-	src/types/interfaces.ts:237
size?	number	Represents the default column size.	ColumnType.size	src/types/interfaces.ts:160
sortable?	boolean	Is column can be sorted, check cellCompare function for custom sorting.	-	src/types/interfaces.ts:229

Methods

beforeSetup()?

optional beforeSetup(rgCol: ColumnRegular): void

Function called before column applied to the store.

Parameters

Parameter	Type
rgCol	ColumnRegular

Returns

void

Defined in

src/types/interfaces.ts:245