DevExtreme Angular - ODataStore Methods
byKey(key)
A Promise that is resolved after the data item is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
- // The key consists of a single data field
- var singleKeyStore = new DevExpress.data.ODataStore({
- key: "field1",
- // ...
- });
- // Gets the data item with "field1" being equal to 1
- singleKeyStore.byKey(1)
- .done(function (dataItem) {
- // Process the "dataItem" here
- })
- .fail(function (error) {
- // Handle the "error" here
- });
- // The key consists of several data fields
- var compositeKeyStore = new DevExpress.data.ODataStore({
- key: [ "field1", "field2" ],
- // ...
- });
- // Gets the data item with both "field1" and "field2" being equal to 1
- compositeKeyStore.byKey({
- field1: 1,
- field2: 1
- }).done(function (dataItem) {
- // Process the "dataItem" here
- })
- .fail(function (error) {
- // Handle the "error" here
- });
byKey(key, extraOptions)
A Promise that is resolved after the entity is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
In the following code, the byKey method loads the product with ID 1
along with the "Category"
navigation property:
- var store = new DevExpress.data.ODataStore({
- // ...
- key: "Product_ID"
- });
- store.byKey(1, { expand: "Category" })
- .done(function (dataItem) {
- // Process the "dataItem" here
- })
- .fail(function (error) {
- // Handle the "error" here
- });
createQuery(loadOptions)
An object containing the expand, requireTotalCount, and customQueryParams properties.
- var store = new DevExpress.data.ODataStore({
- // ODataStore is configured here
- });
- var query = store.createQuery({ expand: "propertyName" });
See Also
insert(values)
A Promise that is resolved after a data item is added. It is a native Promise or a jQuery.Promise when you use jQuery.
In the following code, dataObj is a data object added to the database and returned from the server. If the server returns nothing or the store works with local data, dataObj contains the data object passed to the insert method.
- var store = new DevExpress.data.ODataStore({
- // ODataStore is configured here
- });
- store.insert({ id: 1, name: "John Doe" })
- .done(function (dataObj, key) {
- // Process the key and data object here
- })
- .fail(function (error) {
- // Handle the "error" here
- });
load()
A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
load(options)
A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
off(eventName)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
off(eventName, eventHandler)
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(eventName, eventHandler)
Use this method to subscribe to one of the events listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
on(events)
Use this method to subscribe to several events with one method call. Available events are listed in the Events section.
See Also
- Handle Events: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
push(changes)
Pushes data changes to the store and notifies the DataSource.
Array<any>
There are three possible data change types:
- var store = new DevExpress.data.ODataStore({
- // ODataStore is configured here
- });
- store.push([{ type: "insert", data: data }]);
- store.push([{ type: "update", data: data, key: key }]);
- store.push([{ type: "remove", key: key }]);
The DataSource does not automatically sort, group, filter, or otherwise shape pushed data. If it should, enable the reshapeOnPush option. We also recommend specifying the pushAggregationTimeout to reduce the number of updates and recalculations.
When data is grouped or paginated, the widget bound to the DataSource ignores inserted data items until data is reshaped. Disable grouping and paging or enable reshapeOnPush for the inserted data items to appear immediately after they are pushed. The DataGrid and TreeList widgets have individual grouping and paging options. Use them instead of the corresponding DataSource options.
DataGrid Real-Time Updates Demo DataGrid SignalR Demo Chart SignalR Demo DataGrid Collaborative Editing Demo
See Also
- Integration with Push Services
- API Reference.WidgetName.repaintChangesOnly, for example, API Reference.DataGrid.repaintChangesOnly
remove(key)
A Promise that is resolved after the data item is removed. It is a native Promise or a jQuery.Promise when you use jQuery.
- // The key consists of a single data field
- var singleKeyStore = new DevExpress.data.ODataStore({
- key: "field1",
- // ...
- });
- // Removes the data item with "field1" being equal to 1
- singleKeyStore.remove(1)
- .done(function (key) {
- // Process the "key" here
- })
- .fail(function (error) {
- // Handle the "error" here
- });
- // The key consists of several data fields
- var compositeKeyStore = new DevExpress.data.ODataStore({
- key: [ "field1", "field2" ],
- // ...
- });
- // Removes the data item with both "field1" and "field2" being equal to 1
- compositeKeyStore.remove({
- field1: 1,
- field2: 1
- }).done(function (key) {
- // Process the "key" here
- })
- .fail(function (error) {
- // Handle the "error" here
- });
totalCount(options)
Gets the total count of items the load() function returns.
A Promise that is resolved after the total item count is obtained. It is a native Promise or a jQuery.Promise when you use jQuery.
update(key, values)
A Promise that is resolved after the data item is updated. It is a native Promise or a jQuery.Promise when you use jQuery.
In the following code, dataObj is a data object updated in the database and returned from the server. If the server returns nothing or the store works with local data, dataObj contains the data object passed to the update method.
- // The key consists of a single data field
- var singleKeyStore = new DevExpress.data.ODataStore({
- key: "field1",
- // ...
- });
- // Updates the data item with "field1" being equal to 1
- singleKeyStore.update(1, { name: "John Smith" })
- .done(function (dataObj, key) {
- // Process the key and data object here
- })
- .fail(function (error) {
- // Handle the "error" here
- });
- // The key consists of several data fields
- var compositeKeyStore = new DevExpress.data.ODataStore({
- key: [ "field1", "field2" ],
- // ...
- });
- // Updates the data item with both "field1" and "field2" being equal to 1
- compositeKeyStore.update(
- { field1: 1, field2: 1 },
- { name: "John Smith" }
- ).done(function (dataObj, key) {
- // Process the key and data object here
- })
- .fail(function (error) {
- // Handle the "error" here
- });
If you have technical questions, please create a support ticket in the DevExpress Support Center.