DataRequestEvent

Defines event arguments for custom data service requests in the Data Grid component. Provides parameters for querying data from a remote or custom data source, including pagination, filtering, sorting, and searching. Used to configure and execute data retrieval operations for the grid.

Props

The following table outlines the props for the DataRequestEvent:

Name	Type	Default	Description
action	FilterEvent \| SortEvent \| SearchEvent \| PageEvent	null	Contains details about the grid action (e.g., paging, grouping, filtering, sorting, searching) that triggered the request. Provides context about the user or programmatic action driving the data query. Used to handle specific action-related logic in the data service.
aggregates	Aggregates[]	[ ]	Contains an array of aggregation criteria for summarizing data in the grid. Specifies functions like sum, average, min, max, or count to be applied on specific fields. Used to compute and display aggregated values in the grid.
name	string	-	Specifies the name of the action associated with the data request.
requiresCounts	boolean	false	Indicates whether the data service should return both records and the total record count. When true, requires the service to include the total count for pagination.
search	SearchSettings[]	[ ]	Contains an array of search criteria for full-text or field-specific searches. Specifies search terms or conditions to filter data across one or more fields. Used to implement search functionality within the grid.
skip	number	0	Specifies the number of records to skip in the data source for pagination. Used to navigate to specific pages or subsets of data.
sort	SortDescriptor[]	[ ]	Contains an array of sort criteria defining the fields and directions for sorting. Specifies how data should be ordered, such as ascending or descending by column. Used to apply sorting to the grid’s data based on user or programmatic input.
take	number	12	Specifies the number of records to retrieve per page from the data source. Used to limit the data fetched in a single request.
where	Predicate[]	[ ]	Contains an array of filter criteria for querying the data source. Specifies conditions to filter data, such as equality or range checks on specific fields. Used to apply user-defined or programmatic filters to the grid’s data.