AG Grid Support (Experimental)

Warning: AG Grid support is currently in testing phase. The API may change and some features may not work as expected. Use with caution in production environments.

DEV1.0 Picnic provides experimental support for AG Grid Enterprise’s Server-Side Row Model.

AG Grid Request Format


@PostMapping("/aggrid")
public AGGridResult getEmployees(@RequestBody AGGridLoadOptions loadOptions) {
    return gridDataProvider
        .query(Employee.class)
        .loadOptions(loadOptions)
        .executeAGGrid();
}

AG Grid Request Example:


{
  "startRow": 0,
  "endRow": 100,
  "rowGroupCols": [{"id": "department", "field": "department", "displayName": "Department"}],
  "valueCols": [{"id": "salary", "field": "salary", "aggFunc": "sum"}],
  "pivotCols": [],
  "pivotMode": false,
  "groupKeys": [],
  "filterModel": {
    "name": {"filterType": "text", "type": "contains", "filter": "John"}
  },
  "sortModel": [{"colId": "name", "sort": "asc"}]
}

AG Grid Features (In Testing)

Feature	Status
Server-Side Row Model	In testing
Infinite Scrolling	In testing
Grouping	In testing
Aggregations (sum, avg, count, min, max)	In testing
Filtering	In testing
Sorting	In testing
Pivot Mode	In testing
Hierarchical Pivot Fields	In testing

Pivot Mode (In Testing)


AGGridResult result = gridDataProvider
    .query(Sale.class)
    .loadOptions(agGridOptions)
    .pivotResultFieldSeparator("_")  // Customize pivot column separator
    .executeAGGrid();
 
// Result includes:
// - rowData: List of data rows
// - lastRow: Total count for infinite scrolling
// - pivotResultFields: Pivot column definitions
// - pivotResultFieldsHierarchical: Nested pivot structure for multi-level pivots

Type-Safe Usage


AGGridResult result = gridDataProvider
    .query(Employee.class)
    .loadOptions(agGridOptions)
    .schema("hr")
    .pivotResultFieldSeparator("_")  // Custom separator for pivot columns
    .executeAGGrid();