Box
API
Row
Map

JavaScript/jQuery DataGrid - remoteOperations

Notifies the DataGrid of the server's data processing operations.

Type:

Boolean

|

Object

|

Mode

Default Value: 'auto'

Server-side data processing improves the UI component's performance on large datasets. When the server does not implement particular operations (and/or the corresponding remoteOperations fields are false) they are executed on the client. Note that the UI component may send queries to the server while executing a client-side operation.

The following table lists the possible remoteOperations configurations and the operations the server should implement. The server should also implement additional operations depending on the used UI component functionality.

Setting Required server-side operations Additional server-side operations
remoteOperations: true all operations except group paging -
remoteOperations: { groupPaging: true } all operations including group paging -
remoteOperations: { paging: true } paging filtering1, sorting1, summary calculation1
remoteOperations: { paging: true }
(with grouping used in the UI component)
paging, filtering, sorting grouping3, summary calculation1
remoteOperations: { filtering: true } filtering grouping4
remoteOperations: { sorting: true } sorting filtering1
remoteOperations: { grouping: true } grouping, filtering sorting1, summary calculation1
remoteOperations: { summary: true } summary calculation filtering1, sorting2, grouping2
  1. If this functionality is used in the UI component.
  2. If group summary calculation is used.
  3. If grouping.autoExpandAll is set to false.
  4. If DataGrid contains a lookup column and syncLookupFilterValues is set to true (default value).
NOTE
Paging, filtering, and sorting are performed on the server side for the ODataStore, but you can change them to the client side by setting the corresponding remoteOperations fields to false. Other operations are always client-side.

The following restrictions apply to UI component functionality when operations are remote:

Web API Service Demo Custom Service Demo

See Also

filtering

Specifies whether or not filtering must be performed on the server side.

Type:

Boolean

Default Value: false

grouping

Specifies whether or not grouping must be performed on the server side.

Type:

Boolean

Default Value: false

groupPaging

Specifies whether paging by groups should be performed on the server side.

Type:

Boolean

Default Value: false

Remote group paging allows you to load groups from a remote source in portions. This feature speeds up grouping because the DataGrid transmits less data. However, requests are more frequent because the DataGrid sends several requests each time a user expands a group or sorts/filters data.

Remote group paging has the following specificities:

  • All other operations (filtering, paging, grouping, sorting, and summaries calculation) should also be remote.

  • The following conditions should be met:

  • If you call the expandAll(groupIndex) method, remote group paging does not apply.

View Demo

paging

Specifies whether or not paging must be performed on the server side.

Type:

Boolean

Default Value: false

sorting

Specifies whether or not sorting must be performed on the server side.

Type:

Boolean

Default Value: false

summary

Specifies whether or not summaries summaries are calculated on the server-side.

Type:

Boolean

Default Value: false

NOTE
When summary calculation is remote, custom client-side summaries are not supported.