Skip to content

@revolist/revogrid / ColumnTemplateProp

Interface: ColumnTemplateProp

Column template property. Contains extended properties for column.

Extends

Properties

PropertyTypeDescriptionInherited fromDefined in
autoSize?booleanColumn size would be changed based on space left.ColumnRegular.autoSizesrc/types/interfaces.ts:219
cellCompare?CellCompareFuncRepresents the cell compare function for custom sorting.ColumnRegular.cellComparesrc/types/interfaces.ts:185
cellParser?(model: DataType<any>, column: ColumnRegular) => anyRepresents the cell value parse function for custom parsing. Currently only used for filtering.ColumnRegular.cellParsersrc/types/interfaces.ts:191
cellProperties?PropertiesFuncRepresents cell properties for custom styling, classes, and events.ColumnRegular.cellPropertiessrc/types/interfaces.ts:177
cellTemplate?CellTemplateRepresents the cell template for custom rendering.ColumnRegular.cellTemplatesrc/types/interfaces.ts:181
columnProperties?ColPropertiesFuncHeader Cell properties Custom function/component to render header propertiesColumnRegular.columnPropertiessrc/types/interfaces.ts:120
columnTemplate?ColumnTemplateFuncHeader inner template Function/component to render custom header contentColumnRegular.columnTemplatesrc/types/interfaces.ts:115
columnType?stringRepresents type defined in columnTypes property through grid config.ColumnRegular.columnTypesrc/types/interfaces.ts:239
editor?string | EditorCtrRepresents a custom editor defined in editors property. Can be a string or an editor constructor function.ColumnRegular.editorsrc/types/interfaces.ts:173
filter?string | boolean | string[]Filter. Require filter plugin to be installed and activated through grid config filter.ColumnRegular.filtersrc/types/interfaces.ts:223
indexnumberIndex of the column, used for mapping value to cell from data source model/row.-src/types/interfaces.ts:263
maxSize?numberRepresents the maximum column size.ColumnRegular.maxSizesrc/types/interfaces.ts:168
minSize?numberRepresents 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.minSizesrc/types/interfaces.ts:164
name?anyColumn header text.ColumnRegular.namesrc/types/interfaces.ts:215
order?OrderSort order.ColumnRegular.ordersrc/types/interfaces.ts:231
pin?DimensionColPinColumn pin 'colPinStart''colPinEnd'.ColumnRegular.pin
propColumnPropColumn prop used for mapping value to cell from data source model/row, used for indexing.ColumnRegular.propsrc/types/interfaces.ts:207
providersProviders<DimensionCols | "rowHeaders">Providers injected into the template.-src/types/interfaces.ts:259
readonly?ReadOnlyFormatRepresents 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.readonlysrc/types/interfaces.ts:154
rowDrag?RowDragIs cell in column or individual can be dragged.ColumnRegular.rowDragsrc/types/interfaces.ts:235
size?numberRepresents the default column size.ColumnRegular.sizesrc/types/interfaces.ts:158
sortable?booleanIs column can be sorted, check cellCompare function for custom sorting.ColumnRegular.sortablesrc/types/interfaces.ts:227

Methods

beforeSetup()?

ts
optional beforeSetup(rgCol: ColumnRegular): void

Function called before column applied to the store.

Parameters

ParameterType
rgColColumnRegular

Returns

void

Inherited from

ColumnRegular.beforeSetup

Defined in

src/types/interfaces.ts:243

Revogrid is a powerful data grid library made by Revolist OU.