UseGridPrintOptions

Configuration options required by the useGridPrint hook. Provides references to grid instance and data retrieval functions for print operations. Used to establish the data pipeline from grid to print window.

Props

The following table outlines the props for the UseGridPrintOptions:

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

Async function to retrieve all data from the data source. Called to fetch complete dataset when printing beyond current page. Receives data request event containing query and filter information.

getColumns
( ) => ColumnProps[]
undefined

Function returning the array of column configurations to print. Called to determine which columns appear in the print output.

gridRef
RefObject<GridRef<T>>
-

Reference to the grid component instance. Provides access to grid methods, state, and data for print operations. Must be passed from the grid's useRef hook.