Vue Data GridSSRM API Reference

Enterprise

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

SSRM Grid Options Copy

serverSideDatasourceCopy
Provide the serverSideDatasource for server side row model.
cacheBlockSizeCopy
number
default: 100
How many rows for each block in the cache, i.e. how many rows returned from the server at a time. Default: 100
maxBlocksInCacheCopy
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.
maxConcurrentDatasourceRequestsCopy
number
default: 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.
blockLoadDebounceMillisCopy
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.
suppressServerSideFullWidthLoadingRowCopy
boolean
When true, the Server-side Row Model will not use a full width loading renderer, instead using the colDef loadingCellRenderer if present.
purgeClosedRowNodesCopy
boolean
default: 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. Default: false
serverSidePivotResultFieldSeparatorCopy
string
default: '_'
Used to split pivot field strings for generating pivot result columns when pivotResultFields is provided as part of a getRows success.
serverSideSortAllLevelsCopy
boolean
default: 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.
serverSideEnableClientSideSortCopy
boolean
default: false
When enabled, sorts fully loaded groups in the browser instead of requesting from the server.
serverSideOnlyRefreshFilteredGroupsCopy
boolean
default: 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.
serverSideInitialRowCountCopy
number
default: 1
Set how many loading rows to display to the user for the root level group.
getChildCountCopy
Function
Allows setting the child count for a group row.
getServerSideGroupLevelParamsCopy
Function
Allows providing different params for different levels of grouping.
isServerSideGroupOpenByDefaultCopy
Function
Allows groups to be open by default.
isApplyServerSideTransactionCopy
Function
Allows cancelling transactions.
isServerSideGroupCopy
Function
SSRM Tree Data: Allows specifying which rows are expandable.
getServerSideGroupKeyCopy
Function
SSRM Tree Data: Allows specifying group keys.

Next Up Copy

Continue to the next section to learn about the Server-Side Datasource.