Column
The API reference for the column functionality in LyteNyte Grid.
AutosizeCellFn
Prop
AutosizeCellParams
Parameters passed to the AutosizeCellFn function.
These provide context about the cell and grid configuration so that the function can determine the optimal column width based on cell content.
Prop
AutosizeHeaderFn
Prop
AutosizeHeaderParams
Parameters passed to the AutosizeHeaderFn function.
These are used by LyteNyte Grid to calculate the ideal column width based on the header content.
Prop
Column
Describes a column definition in LyteNyte Grid.
Columns define how data is presented and interacted with in the grid. They control rendering, grouping, sorting, filtering, editing, and more.
A grid must define at least one column to display meaningful data. Columns are essential for determining:
- How rows are visualized
- What each cell renders
- How rows are grouped and sorted
- How filters are evaluated
Prop
ColumnBase
Represents the default column configuration used by LyteNyte Grid.
This serves as a base template that provides fallback values for various column properties. Rather than merging, LyteNyte Grid looks up configuration properties on the column first, then on the default.
This allows you to set column-wide defaults that apply retroactively to all applicable columns without rewriting each one.
Prop
ColumnMarker
Defines the structure of a marker column.
The marker column is a grid managed column used to support features like selection checkboxes or row drag handles.
Prop
ColumnMeta
Represents runtime metadata for the current column configuration in LyteNyte Grid.
This metadata is primarily useful for programmatic interaction with the grid. The values
are derived from the grid's internal column state and may change depending on modes
like pivoting. For example, when pivot mode is enabled, columnsVisible refers to
visible pivot columns instead of the regular ones.
Prop
ColumnPin
Prop
ColumnPivotUIHints
Describes UI hints related to column pivot functionality.
These hints indicate whether a column is eligible to act as a value, row group, or column pivot in a pivot table configuration. External components can use these values to determine pivot-related capabilities.
Prop
ColumnUIHints
UI hints describing column capabilities in LyteNyte Grid.
These hints can be used by external components to drive UI decisions (e.g. enabling/disabling sort or resize handles). They are not enforced by LyteNyte Grid and can be bypassed by modifying grid state directly.
Includes support for pivot-specific behaviors via ColumnPivotUIHints .
Prop
RowGroupColumn
The internal definition used by LyteNyte Grid to automatically generate group columns when row grouping is enabled.
These columns are created behind the scenes to represent group headers and aggregations and can be configured via this interface.
Prop