Skip to main content

Column definitions

ColDef, ReactColDef, and NgColDef describe the same column model. Framework types widen component slots to accept their native component classes.

Identity and values

FieldPurpose
colId / key / labelIdentity, data field, and display name
typeString, number, date, boolean, or currency behavior
valueGetterCompute the raw value
valueFormatter / formatterOptionsFormat display and export
valueParserConvert committed text

Layout and capability

width, minWidth, maxWidth, pinned, and hidden describe initial layout. sortable, resizable, movable, hideable, groupable, aggregatable, pivotable, exportable, and editable govern user capabilities. pivotComparator orders a pivoted column's distinct values across the generated header. suppressColumnPanel omits a column only from the management drawer.

Sort and filter

Columns may define sort, sortIndex, sortingOrder, sortIconVisibility, and a custom comparator. filter selects a built-in panel or custom matcher; filterParams configures operators, inputs, values, debounce, and buttons.

Components

FieldContent
cellRenderer / cellEditorCell presentation and editing
headerComponentHeader content while retaining controls
headerCellComponentEntire header cell except resize handle
tooltipComponent / headerTooltipBody and header floating content
actionFrameComponentPersistent cell-attached form content

Each component slot has a companion params field where applicable.

Conditional presentation

cellClass and cellStyle accept static values or callbacks. colSpan returns the number of adjacent columns occupied for each row. actionFrameIndicator marks cells with attached content.

inheritRowPresentation controls whether the column receives cellClass, cellStyle, tooltip, and the row editability gate from getRowPresentation. Set it to false to opt out completely, or use an object such as { tooltip: false }. Column classes compose with row defaults, column inline-style properties override conflicts, and explicit column tooltip fields override the corresponding row defaults.

Groups

A definition with children is a column group. openByDefault sets its initial state; child leaves use columnGroupShow to appear only while open or closed.