ColumnDef · Column settings

Complete list

• field

  Required field path for reading a value from source rows. Use the data key, not a display heading.

• colId

  Stable column ID for APIs and state persistence. Keep it unchanged when headings change.

• headerName

  User-facing column heading. Can differ from the source data key.

• headerTooltip

  Supporting description for the header.

• sortable

  Determines whether users can sort this column.

• sort

  Initial ascending/descending sort or cleared sort for this column.

• sortIndex

  This column's priority among multiple initial sort criteria.

• filter

  Built-in filter type or custom filter definition for this column.

• valueGetter

  Returns a cell value calculated from the source row. Use valueFormatter for display-text changes only.

• formula

  Formula string applied to this column. Review formula support and original-coordinate rules.

• valueFormatter

  Displays values as readable currency, dates, or other strings without changing the stored source type.

• tooltipField

  Source data field used for tooltips.

• tooltipValueGetter

  Calculates tooltip content from the current cell context. Do not expose unauthorized values indirectly.

• cellRenderer

  Displays cells through text, html, vnode, or a registered custom renderer.

• cellRendererMeta

  Additional metadata passed to the cell renderer.

• cellEditor

  Declares a custom cell editor. Use editor to select a built-in editor type.

• floatingFilterComponent

  Custom filter input component displayed below the header.

• cellClass

  CSS classes for the cell or a callback returning classes.

• cellClassRules

  Rules for applying CSS classes conditionally.

• cellStyle

  Inline style object, callback, or array of these for the cell.

• width

  Initial column width in pixels.

• minWidth

  Minimum width allowed during user resizing and autosizing.

• maxWidth

  Maximum column width.

• flex

  Relative share of remaining space. Review alongside fixed, minimum, and maximum widths.

• resizable

  Whether users can resize this column.

• reorderable

  Whether users can move this column.

• pinned

  Pins the column left/right, or unpins it with null.

• columnGroupShow

  Chooses whether the column appears when its parent group is expanded or collapsed.

• aggFunc

  Built-in or registered custom aggregate function name for grouping and analysis.

• hidden

  Whether the column starts hidden. Does not revoke read permission.

• hide

  Compatibility alias for column hiding. Do not assign conflicting values to hidden.

• editable

  Allows editing this column. Row permissions and validation still apply.

• editor

  Built-in editor type, such as text, number, date, select, or checkbox.

• valueParser

  Converts input text to the stored type, for example by normalizing numbers or dates.

• valueSetter

  Custom logic for writing a converted value into the source row. Follow the return contract indicating whether a change occurred.

• comparator

  Compares two values and rows for sorting. Negative, zero, and positive results mean before, equal, and after.

• options

  Values and display labels for select editors. Individual options can be disabled.

• min

  Minimum allowed value for number or date editing.

• max

  Maximum allowed value for number or date editing.

• step

  Increment/decrement step for numeric input.

• decimals

  Decimal precision for numeric editing.

• nullable

  Whether null is accepted as an edited value.

• allowEmpty

  Whether empty values are allowed while editing. Review together with required-value validation.

• storeAs

  Whether date edits are stored as Date objects or ISO strings.

• rows

  Default visible line count for a multiline text editor.

• maxRows

  Maximum line count to which a multiline editor can grow.

• cols

  Display width basis for a multiline text editor.

• maxLength

  Maximum text editing length.

• rowDrag

  Provides a row drag handle in this column. Use with the Grid's drag policy.

• wrapText

  Allows cell text wrapping. Content may clip without sufficient height.

• autoHeight

  Calculates row height from cell content. Review costs with virtualization and large data sets.

• rowSpan

  Returns the vertical row span from cell context. Inspect span reports for conflicts and display-model restrictions.

• colSpan

  Returns the horizontal column span from cell context. Account for pinned boundaries and hidden columns.