@slickgrid-universal/odata

Grid OData Service

@slickgrid-universal/odata

OData Service to sync a grid with an OData backend server, the service will consider any Filter/Sort and automatically build the necessary OData query string that is sent to your OData backend server.

Internal Dependencies

• @slickgrid-universal/common
• @slickgrid-universal/utils

External Dependencies

No external dependency

Installation

Follow the instruction provided in the main README, you can see a demo by looking at the GitHub Demo page.

Usage

Simply use pass the Service into the backendServiceApi Grid Option.

ViewModel

import { GridOdataService, OdataServiceApi } from '@slickgrid-universal/odata';

export class MyExample {
  initializeGrid {
    this.gridOptions = {
      backendServiceApi: {
        service: new GridOdataService(),
        options: {
          version: 4 // OData v2 or v4
        },
        preProcess: () => this.displaySpinner(true),
        process: (query) => this.getCustomerApiCall(query),
        postProcess: (response) => {
          this.displaySpinner(false);
          this.getCustomerCallback(response);
        }
      } as OdataServiceApi
    }
  }
}