Skip to content

Class: ODataDataSource\<TRow\>

Defined in: src/adapters/odata/odata-data-source.ts:15

DataSource adapter for SAP OData v4 services. Translates grid operations into OData requests.

Type Parameters

TRow

TRow

Implements

Constructors

Constructor

new ODataDataSource<TRow>(config): ODataDataSource<TRow>

Defined in: src/adapters/odata/odata-data-source.ts:19

Parameters

config

ODataDataSourceConfig<TRow>

Returns

ODataDataSource<TRow>

Methods

capabilities()

capabilities(): DataSourceCapabilities

Defined in: src/adapters/odata/odata-data-source.ts:24

Optional. Declares which server-side capabilities are supported. The grid calls this at mount to determine behavior.

Returns

DataSourceCapabilities

Implementation of

DataSource.capabilities


exportAll()

exportAll(query?): Promise<TRow[]>

Defined in: src/adapters/odata/odata-data-source.ts:111

Optional. Export all data bypassing pagination. Used by the export feature when scope is ‘all’.

Parameters

query?

DataQuery

Returns

Promise<TRow[]>

Implementation of

DataSource.exportAll


load()

load(query?): Promise<TRow[]>

Defined in: src/adapters/odata/odata-data-source.ts:35

Returns rows. Accepts an optional query for server-side sort/filter. Synchronous for in-memory; async for server-side sources.

Parameters

query?

DataQuery

Returns

Promise<TRow[]>

Implementation of

DataSource.load


loadChildren()

loadChildren(parentId, query?): Promise<TRow[]>

Defined in: src/adapters/odata/odata-data-source.ts:57

Optional. Load children of a specific node (lazy tree). Called when a user expands a node whose children haven’t been loaded.

Parameters

parentId

string

query?

DataQuery

Returns

Promise<TRow[]>

Implementation of

DataSource.loadChildren


loadPage()

loadPage(params): Promise<PageResult<TRow>>

Defined in: src/adapters/odata/odata-data-source.ts:78

Optional. Load a page of flat data. Used when pagination is enabled.

Parameters

params

PageParams

Returns

Promise<PageResult<TRow>>

Implementation of

DataSource.loadPage