GridHandle
Represent the ref of the Grid component.
Definition
Package:@progress/kendo-react-grid
Properties
A getter of the current columns. Gets the current column width or current columns, or any other GridColumnProps for each defined column. Can be used on each Grid instance. To obtain the instance of the rendered Grid, use the ref callback. The following example demonstrates how to reorder the columns by dragging their handlers and check the properties afterwards. You can check the result in the browser console.
element
null | HTMLDivElement
Returns the HTML element of the Grid component.
exportAsPdf
() => void
Method to trigger a PDF export of the Grid. The 'pdf' prop of the Grid should be set to true or object of setting that will be applied the exported Grid.
fitColumns
(columnIds: string[]) => void
Method to fit columns according to their content.
Array of column ids to be fitted.
Method to get the CSV export as a Blob without triggering a download. Useful for uploading to a server or custom file handling. The 'csv' prop of the Grid should be set to true or an object of settings.
null | Blob
Gets all leaf-level data items in the grid. Returns actual data rows excluding group headers/footers. Useful for AI operations and data processing.
any[]
Gets the total number of items in the grid data source. Used for pagination calculations and AI operations.
number
Method to trigger a CSV export of the Grid and save the file. The 'csv' prop of the Grid should be set to true or an object of settings. Returns a Promise that resolves when the export is triggered.
Promise<void>
scrollIntoView
(options: { rowIndex: number }) => void
Method to allow the scroll to be set to a specific row index when the Grid is scrollable. It is zero based.
Object, containing the rowIndex to which is going to be scrolled.