Skip to content

@revolist/revogrid / ColumnRegular

Interface: ColumnRegular

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

Extends

Extended by

Indexable

[key: string]: any

Properties

PropertyTypeDescriptionInherited fromDefined in
autoSize?booleanColumn size would be changed based on space left.-src/types/interfaces.ts:219
cellCompare?CellCompareFuncRepresents the cell compare function for custom sorting.ColumnType.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.ColumnType.cellParsersrc/types/interfaces.ts:191
cellProperties?PropertiesFuncRepresents cell properties for custom styling, classes, and events.ColumnType.cellPropertiessrc/types/interfaces.ts:177
cellTemplate?CellTemplateRepresents the cell template for custom rendering.ColumnType.cellTemplatesrc/types/interfaces.ts:181
columnProperties?ColPropertiesFuncHeader Cell properties Custom function/component to render header propertiesColumnType.columnPropertiessrc/types/interfaces.ts:120
columnTemplate?ColumnTemplateFuncHeader inner template Function/component to render custom header contentColumnType.columnTemplatesrc/types/interfaces.ts:115
columnType?stringRepresents type defined in columnTypes property through grid config.-src/types/interfaces.ts:239
editor?string | EditorCtrRepresents a custom editor defined in editors property. Can be a string or an editor constructor function.ColumnType.editorsrc/types/interfaces.ts:173
filter?string | boolean | string[]Filter. Require filter plugin to be installed and activated through grid config filter.-src/types/interfaces.ts:223
maxSize?numberRepresents the maximum column size.ColumnType.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.ColumnType.minSizesrc/types/interfaces.ts:164
name?anyColumn header text.-src/types/interfaces.ts:215
order?OrderSort order.-src/types/interfaces.ts:231
pin?DimensionColPinColumn pin 'colPinStart''colPinEnd'.-
propColumnPropColumn prop used for mapping value to cell from data source model/row, used for indexing.-src/types/interfaces.ts:207
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.ColumnType.readonlysrc/types/interfaces.ts:154
rowDrag?RowDragIs cell in column or individual can be dragged.-src/types/interfaces.ts:235
size?numberRepresents the default column size.ColumnType.sizesrc/types/interfaces.ts:158
sortable?booleanIs column can be sorted, check cellCompare function for custom sorting.-src/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

Defined in

src/types/interfaces.ts:243

Revogrid is a MIT-licensed open source library made by Revolist OU.