DevExtreme React - CustomStore LoadOptions

This object is used to specify settings according to which the server should process data. More often these settings are passed as a parameter to the load function and depend on the operations (paging, filtering, sorting, etc.) that you have enabled in the DataSource or UI component.

See Also

• Custom Sources: Chart | DataGrid | Funnel | List | Lookup | PieChart | Scheduler | SelectBox | TagBox

See Also

• OData - Invoking Service Operations

See Also

• OData - Associations

Defines filtering parameters. Possible variants:

• Binary filter

  [ "field", "=", 3 ]

• Unary filter

  [ "!", [ "field", "=", 3 ] ]

• Complex filter

  [
      [ "field", "=", 10 ],
      "and",
      [
          [ "otherField", "<", 3 ],
          "or",
          [ "otherField", ">", 11 ]
      ]
  ]

See Also

• DataLayer - Filtering

Defines grouping levels to be applied to the data. This object can have the following fields:

• selector: String
  The field name to group by.
• desc: Boolean
  Defines the selector field's descending sort order.
• isExpanded: Boolean
  Defines whether the group's data objects should be returned instead of grouping data. Relevant only for the last group.
• groupInterval: Number or String
  A numeric value groups data in ranges of the given length. A string value applies only to dates and can be "year", "quarter", "month", "day", "dayOfWeek", "hour", "minute" and "second".

Contains group summary definitions with the following structure, where summaryType can be "sum", "avg", "min", "max" or "count":

{ selector: "field", summaryType: "sum" }

When this property is specified, each data object should have a summary array that contains the resulting values in the same order as the summary definitions.

If the TreeList's expandedRowKeys are set, the parentIds array contains them and the root ID. Otherwise, the array contains only the ID of the row being expanded.

When this property is true, the result should contain the groupCount field. This field is the resulting data set's top-level group count.

When this property is true, the store expects the result to contain the totalCount field, which is the total data object count in the resulting data set. This count should reflect the number of data items after filtering but disregard any take parameter used for the query.

Along with searchValue and searchOperation, this property defines a simple filtering condition.

Along with searchValue and searchExpr, this property defines a simple filtering condition.

Along with searchOperation and searchExpr, this property defines a simple filtering condition.

Defines sorting properties. This object can have the following fields:

• selector: String
  The field name to sort by.
• desc: Boolean
  Defines the selector field's descending sort order.

Contains summary definitions with the following structure, where summaryType can be "sum", "avg", "min", "max" or "count":

{ selector: "field", summaryType: "sum" }

When this property is specified, the store expects the result to have the summary array that contains the result values in the same order as the summary definitions.