`ColDefPrime` type

Tip

This API reference is automatically generated from the source code of the @jsoc/react-grid-prime package.

View Declaration


export type ColDefPrime = ColumnProps;

Fields

Name	Type	Default
`align`	`"left" \| "right" \| "center" \| null \| undefined` Aligns the content of the column, valid values are left, right and center.
`alignFrozen`	`"left" \| "right" \| undefined` Position of a frozen column, valid values are left and right.
`alignHeader`	`"left" \| "right" \| "center" \| null \| undefined` Aligns the header of the column, valid values are left, right and center.
`body`	`ReactNode \| ((data: any, options: ColumnBodyOptions) => ReactNode)` Body content of the column.
`bodyClassName`	`string \| ((data: any, options: ColumnBodyOptions) => string)` Style class of the body. If using a function must return a string.
`bodyStyle`	`CSSProperties \| undefined` Inline style of the body.
`cellEditValidateOnClose`	`boolean \| undefined` When enabled and cellEditorValidator is set, force to call cellEditorValidator before cell editor is closed. If cellEditorValidator returns false, editor stays open.	`false`
`cellEditValidatorEvent`	`string \| undefined` Event to trigger the validation, possible values are “click” and “blur”.	`click`
`children`	`ReactNode` Used to get the child elements of the component.
`pt`	`ColumnPassThroughOptions` Uses to pass attributes to DOM elements inside the component.
`ptOptions`	`PassThroughOptions` Used to configure passthrough(pt) options of the component.
`unstyled`	`boolean` When enabled, it removes component related styles in the core.	`false`
`className`	`string \| undefined` Style class of the component.
`colSpan`	`number \| undefined` Number of columns to span for grouping.
`columnKey`	`string \| undefined` Identifier of a column if field property is not defined. Only utilized by reorderableColumns feature at the moment.
`dataType`	`string \| undefined` Depending on the dataType of the column, suitable match modes are displayed.
`editor`	`ReactNode \| ((options: ColumnEditorOptions) => ReactNode)` Function to provide the cell editor input.
`excludeGlobalFilter`	`boolean \| undefined` Whether to exclude from global filtering or not.	`false`
`expander`	`boolean \| ((data: any, options: ColumnBodyOptions) => boolean)` Displays an icon to toggle row expansion.	`false`
`exportable`	`boolean \| undefined` Defines whether the column is exported or not.	`true`
`exportField`	`string \| undefined` Property of a row data used for exporting, defaults to field.
`exportHeader`	`string \| undefined` Custom export header of the column to be exported.
`field`	`string \| undefined` Property of a row data.
`filter`	`boolean \| undefined` Defines if a column can be filtered.	`false`
`filterApply`	`ReactNode \| ((options: ColumnFilterApplyTemplateOptions) => ReactNode)` Template of apply element in menu.
`filterClear`	`ReactNode \| ((options: ColumnFilterClearTemplateOptions) => ReactNode)` Template of clear element in menu.
`filterElement`	`ReactNode \| ((options: ColumnFilterElementTemplateOptions) => ReactNode)` Element for custom filtering.
`filterField`	`string \| undefined` Property of a row data used for filtering, defaults to field.
`filterFooter`	`ReactNode \| ((options: ColumnFilterFooterTemplateOptions) => ReactNode)` Template of footer element in menu.
`filterHeader`	`ReactNode \| ((options: ColumnFilterHeaderTemplateOptions) => ReactNode)` Template of header element in menu.
`filterHeaderClassName`	`string \| undefined` Style class of the filter header.
`filterHeaderStyle`	`CSSProperties \| undefined` Inline style of the filter header.
`filterMatchMode`	`string \| undefined` Defines filterMatchMode; “startsWith”, “contains”, “endsWith”, “equals”, “notEquals”, “in”, “notIn”, “lt”, “lte”, “gt”, “gte” and “custom”.
`filterMatchModeOptions`	`ColumnFilterMatchModeOptions[]` An array of label-value pairs to override the global match mode options.
`filterMaxLength`	`number \| undefined` Specifies the maximum number of characters allowed in the filter element.
`filterMenuClassName`	`string \| undefined` Style class of the column filter overlay.
`filterMenuStyle`	`CSSProperties \| undefined` Inline style of the column filter overlay.
`filterPlaceholder`	`string \| undefined` Defines placeholder of the input fields.
`filterType`	`string \| undefined` Type of the filter input field.	`text`
`footer`	`ReactNode \| ((options: ColumnFooterOptions) => ReactNode)` Footer content of the table.
`footerClassName`	`string \| undefined` Style class of the footer.
`footerStyle`	`CSSProperties \| undefined` Inline style of the footer.
`frozen`	`boolean \| undefined` Whether the column is fixed in horizontal scrolling or not.	`false`
`header`	`ReactNode \| ((options: ColumnHeaderOptions) => ReactNode)` Header content of the table.
`headerClassName`	`string \| undefined` Style class of the header.
`headerStyle`	`CSSProperties \| undefined` Inline style of the header.
`headerTooltip`	`string \| undefined` Content of the header tooltip.
`headerTooltipOptions`	`TooltipOptions \| undefined` Configuration of the header tooltip, refer to the tooltip documentation for more information.
`hidden`	`boolean \| undefined` Whether the column is rendered.	`false`
`maxConstraints`	`number \| undefined` Maximum number of constraints for a column filter.	`2`
`reorderable`	`boolean \| undefined` Used to defined reorderableColumns per column when reorderableColumns of table is enabled, defaults to value of reorderableColumns.
`resizeable`	`boolean \| undefined` Used to defined resizeableColumns per column when resizeableColumns of table is enabled, defaults to value of resizeableColumns.
`rowEditor`	`boolean \| ((data: any, options: ColumnBodyOptions) => boolean)` Displays icons to edit row.	`false`
`rowReorder`	`boolean \| undefined` Whether this column displays an icon to reorder the rows.	`false`
`rowReorderIcon`	`IconType<ColumnProps>` Icon of the drag handle to reorder rows.
`rowSpan`	`number \| undefined` Number of rows to span for grouping.
`selectionMode`	`"single" \| "multiple" \| undefined` Specifies the selection mode, valid values are “single”, “multiple”, “radiobutton” and “checkbox”.
`showAddButton`	`boolean \| undefined` When enabled, a button is displayed to add more rules.	`true`
`showApplyButton`	`boolean \| undefined` Displays a button to apply the column filtering.	`true`
`showClearButton`	`boolean \| undefined` Displays a button to clear the column filtering.	`true`
`showFilterMatchModes`	`boolean \| undefined` Whether to show the match modes selector.	`true`
`showFilterMenu`	`boolean \| undefined` Whether to display the filter overlay.	`true`
`showFilterMenuOptions`	`boolean \| undefined` Whether to show the match modes selector and match operator selector.	`true`
`showFilterOperator`	`boolean \| undefined` When enabled, match all and match any operator selector is displayed.	`true`
`sortField`	`string \| undefined` Name of the field to sort data by default.
`sortable`	`boolean \| undefined` Defines if a column is sortable.	`false`
`sortableDisabled`	`boolean \| undefined` When enabled, the data of columns with this property cannot be sorted or changed by the user.	`false`
`style`	`CSSProperties \| undefined` Inline style of the component.
`cellEditValidator`	`(event: ColumnEvent) => boolean` Validator function to validate the cell input value.
`filterFunction`	`(value: any, filter: any, filterLocale: string, params: ColumnFilterEvent) => void` Custom filter function.
`onBeforeCellEditHide`	`(event: ColumnEvent) => void` Callback to invoke before the cell editor is hidden.
`onBeforeCellEditShow`	`(event: ColumnEvent) => void` Callback to invoke before the cell editor is shown. To prevent editor from showing return false or originalEvent.preventDefault().
`onCellEditCancel`	`(event: ColumnEvent) => void` Callback to execute when editor is cancelled.
`onCellEditComplete`	`(event: ColumnEvent) => void` Callback to execute when editor is submitted.
`onCellEditInit`	`(event: ColumnEvent) => void` Callback to invoke when cell edit is initiated. To prevent editor from showing return false or originalEvent.preventDefault().
`onFilterApplyClick`	`(event: ColumnFilterApplyClickEvent) => void` Callback to invoke when the apply button is clicked.
`onFilterClear`	`() => void` Callback to invoke when the filter meta is cleared.
`onFilterConstraintAdd`	`(event: ColumnFilterConstraintAddEvent) => void` Callback to invoke when a new constraint is added.
`onFilterConstraintRemove`	`(event: ColumnFilterConstraintRemoveEvent) => void` Callback to invoke when a constraint is removed.
`onFilterMatchModeChange`	`(event: ColumnFilterMatchModeChangeEvent) => void` Callback to invoke when the match mode option is changed.
`onFilterOperatorChange`	`(event: ColumnFilterOperatorChangeEvent) => void` Callback to invoke when the filter operator option is changed.
`sortFunction`	`(event: ColumnSortEvent) => void` Sort function for custom sorting.

ColDefPrime type

View Declaration

Fields

`ColDefPrime` type