Class: ServerSideDataService

Description

The server-side DataService used when DataGridVueGrid.serverSideOptions is specified. This data service will only attempt to deserialize the response body if the HTTP status code is 200 OK and the Content-Type response header is application/json.

Implements

Properties

PropertyType
optionsServerSideDataServiceOptions

Constructors

new ServerSideDataService(options)

new ServerSideDataService(options): ServerSideDataService

Parameters

ParameterType
optionsServerSideDataServiceOptions

Returns

ServerSideDataService

Methods

getPageAsync()

getPageAsync(
   pageNum, 
   pageSize, 
   sort, 
filter): Promise<PageData>

Called to get data for the currently rendered page.

Parameters

ParameterTypeDescription
pageNumnumberThe page number for the page to load starting with 1 for the first page.
If the data grid is not set configured to be pageable with the DataGridVueGrid.paged
prop then this will always be -1.
pageSizenumberThe maximum number of data items to display on each page. If the data grid is
not set configured to be pageable with the DataGridVueGrid.paged prop then this
will always be -1.
sortSort[]The current column sort definitions in the order in which they should be applied.
filterundefined | FilterThe current filter definition or undefined if no filter is set.

Returns

Promiseopen in new window<PageData>

A Promise that returns the PageData for the current page.

Implementation of

DataService.getPageAsync