DevExtreme React - DataSource Props
The DataSource allows specifying CustomStore properties in its configuration object, as shown in the following code:
- // ...
- import DataSource from 'devextreme/data/data_source';
- const infiniteList = new DataSource({
- load: (loadOptions) => {
- // Loading data objects
- },
- byKey: (key) => {
- // Retrieving a data object by key
- }
- });
- class App extends React.Component {
- // ...
- }
- export default App;
customQueryParams
Custom parameters that should be passed to an OData service with the load query. Available only for the ODataStore.
- // ...
- import DataSource from 'devextreme/data/data_source';
- import ODataStore from 'devextreme/data/odata/store';
- const ds = new DataSource({
- store: new ODataStore({
- // ODataStore is configured here
- }),
- customQueryParams: {
- param: 'value'
- }
- });
- class App extends React.Component {
- // ...
- }
- export default App;
See Also
expand
Specifies the navigation properties to be loaded with the OData entity. Available only for the ODataStore.
- // ...
- import DataSource from 'devextreme/data/data_source';
- import ODataStore from 'devextreme/data/odata/store';
- const ds = new DataSource({
- store: new ODataStore({
- // ODataStore is configured here
- }),
- expand: ['PropertyName1', 'PropertyName2']
- });
- class App extends React.Component {
- // ...
- }
- export default App;
See Also
filter
Possible variants:
Binary filter
- [ "field", "=", 3 ]
Unary filter
- [ "!", [ "field", "=", 3 ] ]
Complex filter
- [
- [ "field", "=", 10 ],
- "and",
- [
- [ "otherField", "<", 3 ],
- "or",
- [ "otherField", ">", 11 ]
- ]
- ]
- // ...
- import DataSource from 'devextreme/data/data_source';
- const ds = new DataSource({
- // ...
- filter: [ 'count', '<', '10' ]
- });
- class App extends React.Component {
- // ...
- }
- export default App;
See Also
group
This property accepts one of the following:
String
The field name to group by.Object
An object with the following fields:- selector: String
The field name to group by. - desc: Boolean
Sorts the selector field in descending order.
- selector: String
Array
An array of strings and objects described above.Function
A function that returns the value to group by.
- // ...
- import DataSource from 'devextreme/data/data_source';
- const ds = new DataSource({
- // ...
- group: { selector: 'LastName', desc: true },
- /* or as a function
- group: function(e) {
- // creates two custom groups
- return e.BirthYear < 1990 ? 'Born before 1990' : 'Born after 1990';
- } */
- });
- class App extends React.Component {
- // ...
- }
- export default App;
See Also
map
- // ...
- import DataSource from 'devextreme/data/data_source';
- import ArrayStore from 'devextreme/data/array_store';
- const ds = new DataSource({
- store: new ArrayStore({
- data: [{
- firstName: 'John',
- lastName: 'Smith'
- }]
- }),
- map: (dataItem) => {
- return {
- fullName: dataItem.firstName + ' ' + dataItem.lastName
- }
- }
- });
- class App extends React.Component {
- // ...
- }
- export default App;
See Also
onChanged
Information about changes.
Appears only when the push(changes) method is called and the reshapeOnPush property is false.
Name | Type | Description |
---|---|---|
changes | Array<any> |
The received changes. |
pageSize
Specifies the maximum number of data items per page. Applies only if paginate is true.
When data is grouped, this property specifies the number of groups per page. However, in the DataGrid and TreeList, it specifies the number of rows per page including group rows.
paginate
Specifies whether the DataSource loads data items by pages or all at once. Defaults to false if group is set; otherwise, true.
postProcess
- // ...
- import DataSource from 'devextreme/data/data_source';
- const ds = new DataSource({
- // ...
- postProcess: (data) => {
- // Your code goes here
- }
- });
- class App extends React.Component {
- // ...
- }
- export default App;
See Also
pushAggregationTimeout
Specifies the period (in milliseconds) when changes are aggregated before pushing them to the DataSource.
When this property is undefined, the aggregation period is calculated automatically based on the rendering speed's measurements.
See Also
- push(changes) in: ArrayStore | CustomStore | LocalStore | ODataStore
- reshapeOnPush
requireTotalCount
If this property is set to true, the Promise that the load() method returns is resolved with a second argument that contains the totalCount field:
- var ds = new DevExpress.data.DataSource({
- // ...
- requireTotalCount: true
- });
- ds.load()
- .done(function (data, extra) {
- // "data" contains the loaded data
- // "extra" contains the "totalCount" field
- });
reshapeOnPush
Specifies whether to reapply sorting, filtering, grouping, and other data processing operations after receiving a push.
See Also
- pushAggregationTimeout
- push(changes) in: ArrayStore | CustomStore | LocalStore | ODataStore
searchExpr
In most cases, you should pass the name of a field by whose value data items are searched. Assign an array of field names to this property if you need to search elements by several field values.
- // ...
- import DataSource from 'devextreme/data/data_source';
- const ds = new DataSource({
- // ...
- searchExpr: ['firstName', 'lastName']
- });
- class App extends React.Component {
- // ...
- }
- export default App;
You can use this property along with searchOperation and searchValue to specify a simple filter. Use the filter property for more complex filtering conditions. Filters are combined if you specify them in both ways.
See Also
searchOperation
Specifies the comparison operation used in searching. The following values are accepted: "=", "<>", ">", ">=", "<", "<=", "startswith", "endswith", "contains", "notcontains".
You can use this property with searchExpr and searchValue to specify a simple filter. Use the filter property for more complex filtering conditions. Filters are combined if you specify them in both ways.
In an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control, specify this property using the FilterOperations
enum that accepts the following values: Equal
, NotEqual
, LessThan
, LessThanOrEqual
, GreaterThan
, GreaterThanOrEqual
, NotContains
, Contains
, StartsWith
, EndsWith
and Between
.
See Also
searchValue
You can use this property along with searchExpr and searchOperation to specify a simple filter. Use the filter property for more complex filtering conditions. Filters are combined if you specify them in both ways.
See Also
select
This property accepts one of the following:
String
A field name to select.Array of strings
Several field names to select.Function
A function implementing custom selection logic.
- // ...
- import DataSource from 'devextreme/data/data_source';
- const ds = new DataSource({
- // ...
- select: ['firstName', 'lastName', 'birthDate']
- });
- class App extends React.Component {
- // ...
- }
- export default App;
See Also
sort
This property accepts one of the following:
String
The field name to sort by.Object
An object with the following fields:- selector: String
The field name to sort by. - desc: Boolean
Sorts the selector field in descending order.
- selector: String
Array
An array of strings and objects described above.Function
A function that returns the value to sort by.
- // ...
- import DataSource from 'devextreme/data/data_source';
- const ds = new DataSource({
- // ...
- sort: [
- 'Position',
- { selector: 'Last_Name', desc: true }
- ],
- /* or as a function
- sort: function(e) {
- // CEOs are always displayed at the top
- if(e.Position == 'CEO')
- return '!';
- else
- return e.Position;
- } */
- });
- class App extends React.Component {
- // ...
- }
- export default App;
See Also
store
This property accepts one of the following:
Store instance
An ArrayStore, LocalStore, ODataStore, or CustomStore instance.Store configuration object
An ArrayStore, LocalStore, or ODataStore configuration object. Make sure to set the type property.Array
Assigning an array to the store property automatically creates an ArrayStore in the DataSource.
- // ...
- import DataSource from 'devextreme/data/data_source';
- import ArrayStore from 'devextreme/data/array_store';
- const ds = new DataSource({
- store: new ArrayStore({
- // ArrayStore instance
- })
- // ===== or =====
- store: {
- type: 'array',
- // ArrayStore configuration object
- }
- // ===== or =====
- store: [
- { id: 1, name: 'John Doe' }
- ]
- });
- class App extends React.Component {
- // ...
- }
- export default App;
If you have technical questions, please create a support ticket in the DevExpress Support Center.