Search

JavaScript Data GridSSRM Datasource

Enterprise

This section describes the Server-Side Datasource and demonstrates how it is used to load data from a server.

The Server-Side Row Model requires a datasource to fetch rows for the grid. When users scroll or perform grid operations such as sorting or grouping, more data will be requested via the datasource.

Most of the Server-Side Row Model examples include a fake server that generates SQL to imitate how a real server might use the requests sent from the grid. These examples use AlaSQL which is a JavaScript SQL database that works in browsers.

However, note that the Server-Side Row Model does not impose any restrictions on the server-side technologies used.

Enabling Server-Side Row Model

The Client-Side Row Model is the default Row Model. To use the SSRM instead, set the rowModelType as follows:

const gridOptions = {
    rowModelType: 'serverSide',

    // other grid options ...
}

Implementing the Server-Side Datasource

A datasource is used by the SSRM to fetch rows for the grid.

Properties available on the IServerSideDatasource<TData = any> interface.

getRows
Function
Grid calls getRows when it requires more rows as specified in the params. Params object contains callbacks for responding to the request.
destroy
Function
Optional method, if your datasource has state it needs to clean up.

The following snippet shows a simple datasource implementation:

const createDatasource = server => {
    return {
        // called by the grid when more rows are required
        getRows: params => {

            // get data for request from server
            const response = server.getData(params.request);

            if (response.success) {
                // supply rows for requested block to grid
                params.success({
                    rowData: response.rows
                });
            } else {
                // inform grid request failed
                params.fail();
            }
        }
    };
}

Notice that the datasource contains a single method getRows(params) which is called by the grid when more rows are required. A request is supplied in the params object which contains all the information required by the server to fetch data from the server.

Rows fetched from the server are supplied to the grid via params.success(data).

Registering the Datasource

The datasource is registered with the grid via either a) the grid property serverSideDatasource or b) the grid API.

Registering the datasource via grid options is done as follows:

const gridOptions = {
    serverSideDatasource: myDatasource,

    // other grid options ...
}

Alternatively, the datasource can be registered via the grid API:

api.setGridOption('serverSideDatasource', myDatasource);

The example below demonstrates loading rows using a simple SSRM Datasource. Note the following:

  • The Server-Side Row Model is selected using the grid options property: rowModelType = 'serverSide'.
  • The datasource is registered with the grid using: api.setGridOption('serverSideDatasource', datasource).
  • The getRows(params) defines the request parameters, with params containing a startRow and endRow that determines the range of rows to return. For example, if the getRows function is called with startRow: 0 and endRow: 100, then the grid will expect a result with 100 rows (rows 0 to 99).
  • When scrolling down there is a delay as more rows are fetched from the server.
  • Open the browser's dev console to view the contents of the request made by the grid for rows.

Next Up

Continue to the next section to learn about Configuration.