UseGridPdfExportOptions

Configuration options required by the useGridPdfExport hook. Provides references to grid instance and data retrieval functions for PDF export operations. Used to establish the data pipeline from grid to PDF generation.

Props

The following table outlines the props for the UseGridPdfExportOptions:

NameTypeDefaultDescription
getAllData
(state: object) => Promise<T[]>
undefined

Asynchronous function that retrieves all data required for exporting All rows. * Receives the current grid state or query parameters for server-side operations. Returns a promise that resolves to an array of data items of type T.

getColumns
( ) => ColumnProps[]
undefined

Function that returns the complete column definitions from the grid. * Returns column metadata including hidden columns and field mappings.

gridRef
RefObject<GridRef<T>>
-

Reference to the grid component instance. Used to access grid state, methods, and column definitions.