@revolist/revogrid / ColumnTemplateProp
Interface: ColumnTemplateProp
Column template property. Contains extended properties for column.
Extends
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:219 |
cellCompare? | CellCompareFunc | Represents the cell compare function for custom sorting. | ColumnRegular .cellCompare | src/types/interfaces.ts:185 |
cellParser? | (model : DataType <any >, column : ColumnRegular ) => any | Represents the cell value parse function for custom parsing. Currently only used for filtering. | ColumnRegular .cellParser | src/types/interfaces.ts:191 |
cellProperties? | PropertiesFunc | Represents cell properties for custom styling, classes, and events. | ColumnRegular .cellProperties | src/types/interfaces.ts:177 |
cellTemplate? | CellTemplate | Represents the cell template for custom rendering. | ColumnRegular .cellTemplate | src/types/interfaces.ts:181 |
columnProperties? | ColPropertiesFunc | Header Cell properties Custom function/component to render header properties | ColumnRegular .columnProperties | src/types/interfaces.ts:120 |
columnTemplate? | ColumnTemplateFunc | Header inner template Function/component to render custom header content | ColumnRegular .columnTemplate | src/types/interfaces.ts:115 |
columnType? | string | Represents type defined in columnTypes property through grid config. | ColumnRegular .columnType | src/types/interfaces.ts:239 |
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:173 |
filter? | string | boolean | string [] | Filter. Require filter plugin to be installed and activated through grid config filter. | ColumnRegular .filter | src/types/interfaces.ts:223 |
index | number | Index of the column, used for mapping value to cell from data source model/row. | - | src/types/interfaces.ts:263 |
maxSize? | number | Represents the maximum column size. | ColumnRegular .maxSize | src/types/interfaces.ts:168 |
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:164 |
name? | any | Column header text. | ColumnRegular .name | src/types/interfaces.ts:215 |
order? | Order | Sort order. | ColumnRegular .order | src/types/interfaces.ts:231 |
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:207 |
providers | Providers <DimensionCols | "rowHeaders" > | Providers injected into the template. | - | src/types/interfaces.ts:259 |
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. | ColumnRegular .readonly | src/types/interfaces.ts:154 |
rowDrag? | RowDrag | Is cell in column or individual can be dragged. | ColumnRegular .rowDrag | src/types/interfaces.ts:235 |
size? | number | Represents the default column size. | ColumnRegular .size | src/types/interfaces.ts:158 |
sortable? | boolean | Is column can be sorted, check cellCompare function for custom sorting. | ColumnRegular .sortable | src/types/interfaces.ts:227 |
Methods
beforeSetup()?
ts
optional beforeSetup(rgCol: ColumnRegular): void
Function called before column applied to the store.
Parameters
Parameter | Type |
---|---|
rgCol | ColumnRegular |
Returns
void