DevExtreme React - ODataStore Props

This section describes the ODataStore's configuration options.

beforeSend

Specifies a function that customizes the request before it is sent to the server.

Type:

Function

Function parameters:
options:

Object

The request parameters.

Object structure:
Name Type Description
url

String

The request URL.

async

Boolean

Indicates whether the request is asynchronous or synchronous.

method

String

The request method ("GET", "POST", "PATCH", or "MERGE").

timeout

Number

The request timeout.

params

Object

Additional request parameters.

payload

Object

The request body; for example, when updating an item, this property holds an object with new values.
Unavailable if the request method is "GET".

headers

Object

The request headers.

deserializeDates

Specifies whether the store serializes/parses date-time values.

Type:

Boolean

ODataStore can parse date-time values in ISO8601 format (for example, "2016-07-13T16:05:00.000Z") or Microsoft format (for instance, "/Date(1198908717056)/"). In the first case, the store ignores the timezone modifier (usually Z) when parsing the value. In the second case, the store adds the time-zone offset to the value according to the client's time-zone.

NOTE

Disabling deserialization may cause filtering issues in widgets bound to the ODataStore. When deserialization is disabled in the store, date-time strings are converted to Date objects at the widget level. When filtering, the widget reverts an entered date-time value to a string based on the dateSerializationFormat option's value and passes the string to the ODataStore for further processing. OData does not support strings which cause filtering to fail.

To prevent these issues, the store's deserializeDates option should be set to true or set the widget's dateSerializationFormat option to null.

errorHandler

Specifies a function that is executed when the ODataStore throws an error.

Type:

Function

Function parameters:
e:

Object

A JavaScript Error object extended with the following fields:

Object structure:
Name Type Description
httpStatus

Number

The error code.

errorDetails

Object

Error details. It is an OData error response object for OData-specific errors or a jqXHR object for other errors when you use jQuery.

requestOptions

Object

Request details. Contains the following fields:

  • accepts: Object
    The data types that the client accepts mapped to their MIME types.

  • async: Boolean
    Indicates whether the request was asynchronous or synchronous.

  • contentType: String | Boolean
    The content type; false if no content type was specified.

  • data: Object
    Query options.

  • dataType: String
    The expected data type.

  • headers: Object
    The request headers.

  • jsonp: Boolean
    Indicates whether the request was sent using JSONP.

  • method: String
    The request method ("GET", "POST", "PATCH", or "MERGE").

  • timeout: Number
    The request timeout.

  • url: String
    The request URL.

  • xhrFields: Object
    Native XMLHttpRequest object properties that were sent in the request.

fieldTypes

Specifies the data field types. Accepts the following types: "String", "Int32", "Int64", "Boolean", "Single", "Decimal" and "Guid".

Type:

Object

Default Value: {}

Set this option if you are going to filter data. An object assigned to it should list data fields and their types as field-value pairs. You can also use this option instead of the keyType to specify the key property's type.

filterToLower

Specifies whether to convert string values to lowercase in filter and search requests. Applies to the following operations: "startswith", "endswith", "contains", and "notcontains".

Type:

Boolean

Defaults to the global oDataFilterToLower setting.

When this option is true, the filter expression sent to the server contains a tolower() function call and a lowercase filter value.

jsonp

Specifies whether data should be sent using JSONP.

Type:

Boolean

Default Value: false

key

Specifies the key property (or properties) used to access data items.

Type:

String

|

Array<String>

In the following example, the ProductID and ProductCode properties are specified as key properties:

keyType

Specifies the type of the key property or properties.

Type:

String

|

Object

Accepted Values: 'String' | 'Int32' | 'Int64' | 'Guid' | 'Boolean' | 'Single' | 'Decimal'

Set this option if you do not need to filter data. Otherwise, use the fieldTypes option. In the following code, the Product_ID and Product_Code key properties are Guid and Int32, respectively:

When specifying this option in an ASP.NET MVC Control, use the EdmType enum that has the following values: Int32, Int64, Guid, String, Boolean, Single and Decimal.

onInserted

A function that is executed after a data item is added to the store.

Type:

Function

Function parameters:
values:

Object

The added data item.

key:

Object

|

String

|

Number

The item's key.

onInserting

A function that is executed before a data item is added to the store.

Type:

Function

Function parameters:
values:

Object

The data item to be added.

onLoaded

A function that is executed after data is loaded to the store.

Type:

Function

Function parameters:
result:

Array<any>

The loaded data.

onLoading

A function that is executed before data is loaded to the store.

Type:

Function

Function parameters:
loadOptions:

LoadOptions

Data processing settings.

onModified

A function that is executed after a data item is added, updated, or removed from the store.

Type:

Function

onModifying

A function that is executed before a data item is added, updated, or removed from the store.

Type:

Function

onPush

The function executed before changes are pushed to the store.

Type:

Function

Function parameters:
changes:

Array<any>

Changes passed in the push(changes) method.

onRemoved

A function that is executed after a data item is removed from the store.

Type:

Function

Function parameters:
key:

Object

|

String

|

Number

The removed data item's key.

onRemoving

A function that is executed before a data item is removed from the store.

Type:

Function

Function parameters:
key:

Object

|

String

|

Number

The key of the data item to be removed.

onUpdated

A function that is executed after a data item is updated in the store.

Type:

Function

Function parameters:
key:

Object

|

String

|

Number

The updated data item's key.

values:

Object

Updated values.

onUpdating

A function that is executed before a data item is updated in the store.

Type:

Function

Function parameters:
key:

Object

|

String

|

Number

The key of the data item to be updated.

values:

Object

New values for the data item fields.

url

Specifies the URL of an OData entity collection.

Type:

String

version

Specifies the OData version.

Type:

Number

Default Value: 2
Accepted Values: 2 | 3 | 4

If the version is 2, the ODataContext uses the "MERGE" method to send requests; otherwise, it uses "PATCH". Set the method field of the beforeSend function's parameter to override this behavior.

withCredentials

Specifies whether to send cookies, authorization headers, and client certificates in a cross-origin request.

Type:

Boolean

Default Value: false

This option's value is passed to the underlying jqXHR object.

Use the beforeSend function to set custom authorization headers.