---
title: "SSRM API Reference"
enterprise: true
framework: angular
version: "36.1.0"
---

# SSRM API Reference

The section lists the available Server-Side Row Model (SSRM) options.

## SSRM Grid Options

| Property | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `serverSideDatasource` | [`IServerSideDatasource`](https://www.ag-grid.com/angular-data-grid/server-side-model-datasource/#registering-the-datasource) |  |  | Provide the `serverSideDatasource` for server side row model. See [Registering the Datasource](https://www.ag-grid.com/angular-data-grid/server-side-model-datasource/#registering-the-datasource) for more information. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `cacheBlockSize` | `number` |  | `100` | How many rows for each block in the cache, i.e. how many rows returned from the server at a time. Default: `100` See [Server-Side Cache](https://www.ag-grid.com/angular-data-grid/server-side-model-configuration/#server-side-cache) for more information. Modules (any of): [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `maxBlocksInCache` | `number` |  |  | How many blocks to keep in the cache. Default is no limit, so every requested block is kept. Use this if you have memory concerns, and blocks that were least recently viewed will be purged when the limit is hit. The grid will additionally make sure it has all the blocks needed to display what is currently visible, in case this property is set to a low value. See [Server-Side Cache](https://www.ag-grid.com/angular-data-grid/server-side-model-configuration/#server-side-cache) for more information. Modules (any of): [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). [Initial](https://www.ag-grid.com/angular-data-grid/grid-interface/#initial-grid-options). |
| `maxConcurrentDatasourceRequests` | `number` |  | `2` | How many requests to hit the server with concurrently. If the max is reached, requests are queued. Set to `-1` for no maximum restriction on requests. See [Providing Additional Data](https://www.ag-grid.com/angular-data-grid/server-side-model-configuration/#providing-additional-data) for more information. Modules (any of): [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). [Initial](https://www.ag-grid.com/angular-data-grid/grid-interface/#initial-grid-options). |
| `blockLoadDebounceMillis` | `number` |  |  | How many milliseconds to wait before loading a block. Useful when scrolling over many blocks, as it prevents blocks loading until scrolling has settled. See [Block Loading Debounce](https://www.ag-grid.com/angular-data-grid/server-side-model-configuration/#block-loading-debounce) for more information. Modules (any of): [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/), [`InfiniteRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). [Initial](https://www.ag-grid.com/angular-data-grid/grid-interface/#initial-grid-options). |
| `suppressServerSideFullWidthLoadingRow` | `boolean` |  |  | When `true`, the Server-side Row Model will not use a full width loading renderer, instead using the colDef `loadingCellRenderer` if present. See [Cell Loading](https://www.ag-grid.com/angular-data-grid/component-loading-cell-renderer/#skeleton-loading) for more information. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `purgeClosedRowNodes` | `boolean` |  | `false` | When enabled, closing group rows will remove children of that row. Next time the row is opened, child rows will be read from the datasource again. This property only applies when there is [Row Grouping](https://www.ag-grid.com/angular-data-grid/server-side-model-grouping/). Default: `false` Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `serverSidePivotResultFieldSeparator` | `string` |  | `'_'` | Used to split pivot field strings for generating pivot result columns when `pivotResultFields` is provided as part of a `getRows` success. See [Supplying Pivot Result Fields](https://www.ag-grid.com/angular-data-grid/server-side-model-pivoting/#supplying-pivot-result-fields-simple) for more information. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). [Initial](https://www.ag-grid.com/angular-data-grid/grid-interface/#initial-grid-options). |
| `serverSideSortAllLevels` | `boolean` |  | `false` | When enabled, always refreshes top level groups regardless of which column was sorted. This property only applies when there is Row Grouping & sorting is handled on the server. See [Sorting All Levels](https://www.ag-grid.com/angular-data-grid/server-side-model-sorting/#sorting-all-levels) for more information. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `serverSideEnableClientSideSort` | `boolean` |  | `false` | When enabled, sorts fully loaded groups in the browser instead of requesting from the server. See [Client-side Sorting](https://www.ag-grid.com/angular-data-grid/server-side-model-sorting/#client-side-sorting) for more information. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `serverSideOnlyRefreshFilteredGroups` | `boolean` |  | `false` | When enabled, only refresh groups directly impacted by a filter. This property only applies when there is Row Grouping & filtering is handled on the server. See [Filters](https://www.ag-grid.com/angular-data-grid/server-side-model-grouping/#filters) for more information. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). [Initial](https://www.ag-grid.com/angular-data-grid/grid-interface/#initial-grid-options). |
| `serverSideInitialRowCount` | `number` |  | `1` | Set how many loading rows to display to the user for the root level group. See [Initial Scroll Position](https://www.ag-grid.com/angular-data-grid/server-side-model-configuration/#initial-scroll-position) for more information. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). [Initial](https://www.ag-grid.com/angular-data-grid/grid-interface/#initial-grid-options). |
| `getChildCount` | `GetChildCount` |  |  | Allows setting the child count for a group row. See [Providing Child Counts](https://www.ag-grid.com/angular-data-grid/server-side-model-grouping/#providing-child-counts) for more information. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). [Initial](https://www.ag-grid.com/angular-data-grid/grid-interface/#initial-grid-options). |
| `getServerSideGroupLevelParams` | `GetServerSideGroupLevelParams` |  |  | Allows providing different params for different levels of grouping. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). [Initial](https://www.ag-grid.com/angular-data-grid/grid-interface/#initial-grid-options). |
| `isServerSideGroupOpenByDefault` | `IsServerSideGroupOpenByDefault` |  |  | Allows groups to be open by default. See [Open by Default](https://www.ag-grid.com/angular-data-grid/server-side-model-grouping/#open-by-default) for more information. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isApplyServerSideTransaction` | `IsApplyServerSideTransaction` |  |  | Allows cancelling transactions. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `isServerSideGroup` | `IsServerSideGroup` |  |  | SSRM Tree Data: Allows specifying which rows are expandable. See [SSRM Tree Data](https://www.ag-grid.com/angular-data-grid/server-side-model-tree-data/) for more information. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |
| `getServerSideGroupKey` | `GetServerSideGroupKey` |  |  | SSRM Tree Data: Allows specifying group keys. See [SSRM Tree Data](https://www.ag-grid.com/angular-data-grid/server-side-model-tree-data/) for more information. Module: [`ServerSideRowModelModule`](https://www.ag-grid.com/angular-data-grid/modules/). |