GridAIAssistantCommand

Updated on Nov 7, 2025

Represents a command structure returned by AI services for grid operations. Each command contains the operation type and relevant configuration data.

tsx

// Sort command example
const sortCommand: GridAIAssistantCommand = {
  type: 'GridSort',
  sort: { field: 'productName', dir: 'asc' },
  message: 'Sorted by Product Name ascending'
};

// Filter command example
const filterCommand: GridAIAssistantCommand = {
  type: 'GridFilter',
  filter: {
    logic: 'and',
    filters: [{ field: 'price', operator: 'gte', value: 100 }]
  },
  message: 'Filtered products with price >= 100'
};

Name	Type	Default	Description
fileName?	string		The filename for export operations, including the file extension. Used when the AI assistant performs export commands such as PDF generation. Expected data type: string ending with file extension (e.g., '.pdf', '.xlsx').
filter?	CompositeFilterDescriptor		The filter descriptor for filtering operations.
group?	GroupDescriptor | GroupDescriptor[]		The group descriptor for grouping operations.
highlight?	any		The highlight descriptor for highlight operations.
id?	string		The unique identifier of the column to resize. Used when type is 'GridColumnResize' to specify which column should be resized.
message?	string		The message describing the operation.
messages?	string[]		The messages describing the operation (alternative to message).
position?	number		The target position for column reordering operations. Used when type is 'GridColumnReorder' to specify the new column index.
select?	CompositeHighlightDescriptor		The select descriptor for selection operations. Used when type is 'GridSelect' to define cell or row selection criteria. tsx select: { cells: { 'Age': true }, filters: [{ field: 'Age', operator: 'gt', value: 60 }], logic: 'and' }
size?	string		The new size value for column resize operations. Specifies the width dimension when resizing grid columns.
sort?	SortDescriptor | SortDescriptor[]		The sort descriptor for sorting operations.
type	GridAICommands		The type of grid operation to perform. Possible values: 'GridSort', 'GridFilter', 'GridGroup', 'GridHighlight', 'GridClearSort', 'GridClearFilter', 'GridClearGroup', 'GridClearHighlight'