# ColumnDef · Column settings

Find 53 sy-grid ColumnDef · Column settings entries by name and open their descriptions, types, and examples.

Canonical: https://grid.syidax.com/docs/columns/

<a id="index"></a>

## Complete list

- [field](https://grid.syidax.com/docs/columns/field.md) — Required field path for reading a value from source rows. Use the data key, not a display heading.
- [colId](https://grid.syidax.com/docs/columns/colId.md) — Stable column ID for APIs and state persistence. Keep it unchanged when headings change.
- [headerName](https://grid.syidax.com/docs/columns/headerName.md) — User-facing column heading. Can differ from the source data key.
- [headerTooltip](https://grid.syidax.com/docs/columns/headerTooltip.md) — Supporting description for the header.
- [sortable](https://grid.syidax.com/docs/columns/sortable.md) — Determines whether users can sort this column.
- [sort](https://grid.syidax.com/docs/columns/sort.md) — Initial ascending/descending sort or cleared sort for this column.
- [sortIndex](https://grid.syidax.com/docs/columns/sortIndex.md) — This column's priority among multiple initial sort criteria.
- [filter](https://grid.syidax.com/docs/columns/filter.md) — Built-in filter type or custom filter definition for this column.
- [valueGetter](https://grid.syidax.com/docs/columns/valueGetter.md) — Returns a cell value calculated from the source row. Use valueFormatter for display-text changes only.
- [formula](https://grid.syidax.com/docs/columns/formula.md) — Formula string applied to this column. Review formula support and original-coordinate rules.
- [valueFormatter](https://grid.syidax.com/docs/columns/valueFormatter.md) — Displays values as readable currency, dates, or other strings without changing the stored source type.
- [tooltipField](https://grid.syidax.com/docs/columns/tooltipField.md) — Source data field used for tooltips.
- [tooltipValueGetter](https://grid.syidax.com/docs/columns/tooltipValueGetter.md) — Calculates tooltip content from the current cell context. Do not expose unauthorized values indirectly.
- [cellRenderer](https://grid.syidax.com/docs/columns/cellRenderer.md) — Displays cells through text, html, vnode, or a registered custom renderer.
- [cellRendererMeta](https://grid.syidax.com/docs/columns/cellRendererMeta.md) — Additional metadata passed to the cell renderer.
- [cellEditor](https://grid.syidax.com/docs/columns/cellEditor.md) — Declares a custom cell editor. Use editor to select a built-in editor type.
- [floatingFilterComponent](https://grid.syidax.com/docs/columns/floatingFilterComponent.md) — Custom filter input component displayed below the header.
- [cellClass](https://grid.syidax.com/docs/columns/cellClass.md) — CSS classes for the cell or a callback returning classes.
- [cellClassRules](https://grid.syidax.com/docs/columns/cellClassRules.md) — Rules for applying CSS classes conditionally.
- [cellStyle](https://grid.syidax.com/docs/columns/cellStyle.md) — Inline style object, callback, or array of these for the cell.
- [width](https://grid.syidax.com/docs/columns/width.md) — Initial column width in pixels.
- [minWidth](https://grid.syidax.com/docs/columns/minWidth.md) — Minimum width allowed during user resizing and autosizing.
- [maxWidth](https://grid.syidax.com/docs/columns/maxWidth.md) — Maximum column width.
- [flex](https://grid.syidax.com/docs/columns/flex.md) — Relative share of remaining space. Review alongside fixed, minimum, and maximum widths.
- [resizable](https://grid.syidax.com/docs/columns/resizable.md) — Whether users can resize this column.
- [reorderable](https://grid.syidax.com/docs/columns/reorderable.md) — Whether users can move this column.
- [pinned](https://grid.syidax.com/docs/columns/pinned.md) — Pins the column left/right, or unpins it with null.
- [columnGroupShow](https://grid.syidax.com/docs/columns/columnGroupShow.md) — Chooses whether the column appears when its parent group is expanded or collapsed.
- [aggFunc](https://grid.syidax.com/docs/columns/aggFunc.md) — Built-in or registered custom aggregate function name for grouping and analysis.
- [hidden](https://grid.syidax.com/docs/columns/hidden.md) — Whether the column starts hidden. Does not revoke read permission.
- [hide](https://grid.syidax.com/docs/columns/hide.md) — Compatibility alias for column hiding. Do not assign conflicting values to hidden.
- [editable](https://grid.syidax.com/docs/columns/editable.md) — Allows editing this column. Row permissions and validation still apply.
- [editor](https://grid.syidax.com/docs/columns/editor.md) — Built-in editor type, such as text, number, date, select, or checkbox.
- [valueParser](https://grid.syidax.com/docs/columns/valueParser.md) — Converts input text to the stored type, for example by normalizing numbers or dates.
- [valueSetter](https://grid.syidax.com/docs/columns/valueSetter.md) — Custom logic for writing a converted value into the source row. Follow the return contract indicating whether a change occurred.
- [comparator](https://grid.syidax.com/docs/columns/comparator.md) — Compares two values and rows for sorting. Negative, zero, and positive results mean before, equal, and after.
- [options](https://grid.syidax.com/docs/columns/options.md) — Values and display labels for select editors. Individual options can be disabled.
- [min](https://grid.syidax.com/docs/columns/min.md) — Minimum allowed value for number or date editing.
- [max](https://grid.syidax.com/docs/columns/max.md) — Maximum allowed value for number or date editing.
- [step](https://grid.syidax.com/docs/columns/step.md) — Increment/decrement step for numeric input.
- [decimals](https://grid.syidax.com/docs/columns/decimals.md) — Decimal precision for numeric editing.
- [nullable](https://grid.syidax.com/docs/columns/nullable.md) — Whether null is accepted as an edited value.
- [allowEmpty](https://grid.syidax.com/docs/columns/allowEmpty.md) — Whether empty values are allowed while editing. Review together with required-value validation.
- [storeAs](https://grid.syidax.com/docs/columns/storeAs.md) — Whether date edits are stored as Date objects or ISO strings.
- [rows](https://grid.syidax.com/docs/columns/rows.md) — Default visible line count for a multiline text editor.
- [maxRows](https://grid.syidax.com/docs/columns/maxRows.md) — Maximum line count to which a multiline editor can grow.
- [cols](https://grid.syidax.com/docs/columns/cols.md) — Display width basis for a multiline text editor.
- [maxLength](https://grid.syidax.com/docs/columns/maxLength.md) — Maximum text editing length.
- [rowDrag](https://grid.syidax.com/docs/columns/rowDrag.md) — Provides a row drag handle in this column. Use with the Grid's drag policy.
- [wrapText](https://grid.syidax.com/docs/columns/wrapText.md) — Allows cell text wrapping. Content may clip without sufficient height.
- [autoHeight](https://grid.syidax.com/docs/columns/autoHeight.md) — Calculates row height from cell content. Review costs with virtualization and large data sets.
- [rowSpan](https://grid.syidax.com/docs/columns/rowSpan.md) — Returns the vertical row span from cell context. Inspect span reports for conflicts and display-model restrictions.
- [colSpan](https://grid.syidax.com/docs/columns/colSpan.md) — Returns the horizontal column span from cell context. Account for pinned boundaries and hidden columns.