New to KendoReact? Start a free 30-day trial

GridAIState

Interface

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

Definition

Package:@progress/kendo-react-grid

Syntax:

tsx

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

Properties

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).

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).

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.