GridAIState

Updated on Dec 11, 2025

Represents the grid state that can be controlled externally. This interface contains all the stateful properties that can be modified through AI commands.

tsx

const [gridState, setGridState] = useState<GridAIState>({
  sort: [],
  filter: undefined,
  group: [],
  columnsState: initialColumns,
  skip: 0,
  take: 20
});

Name	Type	Default	Description
columnsState?	GridColumnState[]		The current column state including visibility, width, order, and lock status. Array of column state objects.
filter?	CompositeFilterDescriptor		The current filter descriptor applied to the grid. Composite filter defining logic and filter array.
group?	GroupDescriptor[]		The current group descriptors applied to the grid. Array of group objects defining field and aggregates.
highlight?	any		The highlight descriptor for highlighting cells/rows in the grid. Object with dataItemKey as keys, values can be boolean (whole row) or number array (specific cells). tsx highlight: { '1': true, // Highlight entire row with dataItemKey = 1 '2': [0, 1, 2] // Highlight cells at column indices 0, 1, 2 in row with dataItemKey = 2 }
select?	any		The select descriptor for selecting cells/rows in the grid. Object with dataItemKey as keys, values can be boolean (whole row) or number array (specific cells). tsx select: { '1': true, // Select entire row with dataItemKey = 1 '2': [0, 1] // Select cells at column indices 0 and 1 in row with dataItemKey = 2 }
skip?	number		The number of items to skip for pagination. Zero-based index for the first item to display.
sort?	SortDescriptor[]		The current sort descriptors applied to the grid. Array of sort objects defining field and direction.
take?	number		The number of items to take (page size) for pagination. Number of items to display per page.