DevExtreme jQuery - CustomStore Options
byKey
Specifies a custom implementation of the byKey(key) method.
Type:
Function parameters:
A Promise that is resolved after the data item is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
// ...
byKey: function (key) {
var d = new $.Deferred();
$.get("http://mydomain.com/MyDataService?id=" + key)
.done(function (dataItem) {
d.resolve(dataItem);
});
return d.promise();
}
});Angular
TypeScript
import { ..., Inject } from "@angular/core";
import CustomStore from "devextreme/data/custom_store";
import { HttpClient, HttpClientModule } from "@angular/common/http";
import { lastValueFrom } from 'rxjs';
// ...
export class AppComponent {
store: CustomStore;
constructor(@Inject(HttpClient) httpClient: HttpClient) {
this.store = new CustomStore({
// ...
byKey: (key) => {
return lastValueFrom(httpClient.get("http://mydomain.com/MyDataService?id=" + key));
}
});
}
}
@NgModule({
imports: [
// ...
HttpClientModule
],
// ...
})Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
import DataSource from 'devextreme/data/data_source';
import 'whatwg-fetch';
const store = new CustomStore({
// ...
byKey: (key) => {
return fetch("http://mydomain.com/MyDataService?id=" + key);
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
import DataSource from 'devextreme/data/data_source';
import 'whatwg-fetch';
const store = new CustomStore({
// ...
byKey: (key) => {
return fetch("http://mydomain.com/MyDataService?id=" + key);
}
});
class App extends React.Component {
// ...
}
export default App;cacheRawData
Specifies whether raw data should be saved in the cache. Applies only if loadMode is "raw".
Type:
Default Value: true
Data caching allows the CustomStore to decrease the number of data requests. On the downside, cached data and data in your source may become out of sync. If keeping them synchronized is crucial in your scenario, disable data caching by setting the cacheRawData property to false. In this case, the CustomStore will send a request for data on every call of the load, byKey and totalCount functions.
See Also
errorHandler
Type:
This function accepts a JavaScript Error object as the parameter.
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
// ...
errorHandler: function (error) {
console.log(error.message);
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
// ...
errorHandler: function (error) {
console.log(error.message);
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
errorHandler: (error) => {
console.log(error.message);
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
errorHandler: (error) => {
console.log(error.message);
}
});
class App extends React.Component {
// ...
}
export default App;insert
Specifies a custom implementation of the insert(values) method.
Type:
Function parameters:
values:
A Promise that is resolved after the data item is inserted. It is a native Promise or a jQuery.Promise when you use jQuery.
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
// ...
insert: function (values) {
return $.ajax({
url: "http://mydomain.com/MyDataService/myEntity",
method: "POST",
data: values
})
}
});Angular
TypeScript
import { ..., Inject } from "@angular/core";
import CustomStore from "devextreme/data/custom_store";
import { HttpClient, HttpClientModule } from "@angular/common/http";
import { lastValueFrom } from 'rxjs';
// ...
export class AppComponent {
store: CustomStore;
constructor(@Inject(HttpClient) httpClient: HttpClient) {
this.store = new CustomStore({
// ...
insert: (values) => {
return lastValueFrom(httpClient.post("http://mydomain.com/MyDataService/myEntity", values));
}
});
}
}
@NgModule({
imports: [
// ...
HttpClientModule
],
// ...
})Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
import DataSource from 'devextreme/data/data_source';
import 'whatwg-fetch';
function handleErrors(response) {
if (!response.ok) {
throw Error(response.statusText);
}
return response;
}
const store = new CustomStore({
// ...
insert: (values) => {
return fetch("https://mydomain.com/MyDataService/myEntity", {
method: "POST",
body: JSON.stringify(values),
headers: {
'Content-Type': 'application/json'
}
})
.then(handleErrors);
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
import DataSource from 'devextreme/data/data_source';
import 'whatwg-fetch';
function handleErrors(response) {
if (!response.ok)
throw Error(response.statusText);
return response;
}
const store = new CustomStore({
// ...
insert: (values) => {
return fetch("https://mydomain.com/MyDataService/myEntity", {
method: "POST",
body: JSON.stringify(values),
headers: {
'Content-Type': 'application/json'
}
})
.then(handleErrors);
}
});
class App extends React.Component {
// ...
}
export default App;key
Specifies the key property (or properties) that provide(s) key values to access data items. Each key value must be unique.
In the following example, the ProductID and ProductCode properties are specified as key properties:
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
// ...
key: ["ProductID", "ProductCode"]
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
// ...
key: ["ProductID", "ProductCode"]
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
key: ['ProductID', 'ProductCode']
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
key: ['ProductID', 'ProductCode']
});
class App extends React.Component {
// ...
}
export default App;load
Specifies a custom implementation of the load(options) method.
Type:
Function parameters:
options:
An array with data or a Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
Refer to the following help topic for information on how to implement the load function: Custom Data Sources.
See Also
loadMode
Specifies how data returned by the load function is treated.
Specify this property depending on the behavior you implemented for the load function. If this function sends data shaping properties to the server and fetches processed data, then loadMode should be set to "processed". If the load function simply fetches raw, unprocessed data from the server, set loadMode to "raw". In this case, the raw data will be processed on the client automatically.
NOTE
The default load mode is set to "raw" for DataGrid, TreeList, PivotGrid, and Scheduler.
See Also
onInserted
Type:
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
onInserted: function (values, key) {
// Your code goes here
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
onInserted: function (values, key) {
// Your code goes here
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onInserted: function (values, key) {
// Your code goes here
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onInserted: function (values, key) {
// Your code goes here
}
});
class App extends React.Component {
// ...
}
export default App;onInserting
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
onInserting: function (values) {
// Your code goes here
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
onInserting: function (values) {
// Your code goes here
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onInserting: function (values, key) {
// Your code goes here
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onInserting: function (values, key) {
// Your code goes here
}
});
class App extends React.Component {
// ...
}
export default App;onLoaded
Type:
Function parameters:
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
onLoaded: function (result) {
// Your code goes here
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
onLoaded: function (result) {
// Your code goes here
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onLoaded: function (result) {
// Your code goes here
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onLoaded: function (result) {
// Your code goes here
}
});
class App extends React.Component {
// ...
}
export default App;onLoading
Type:
Function parameters:
loadOptions:
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
onLoading: function (loadOptions) {
// Your code goes here
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
onLoading: function (loadOptions) {
// Your code goes here
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onLoading: function (loadOptions) {
// Your code goes here
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onLoading: function (loadOptions) {
// Your code goes here
}
});
class App extends React.Component {
// ...
}
export default App;onModified
Type:
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
onModified: function () {
// Your code goes here
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
onModified: function () {
// Your code goes here
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onModified: function () {
// Your code goes here
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onModified: function () {
// Your code goes here
}
});
class App extends React.Component {
// ...
}
export default App;onModifying
Type:
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
onModifying: function () {
// Your code goes here
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
onModifying: function () {
// Your code goes here
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onModifying: function () {
// Your code goes here
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onModifying: function () {
// Your code goes here
}
});
class App extends React.Component {
// ...
}
export default App;onPush
Type:
Function parameters:
changes:
Array<any>
Changes passed in the push(changes) method.
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
onPush: function(changes) {
// Your code goes here
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
onPush: (changes) => {
// Your code goes here
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onPush: (changes) => {
// Your code goes here
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onPush: (changes) => {
// Your code goes here
}
});
class App extends React.Component {
// ...
}
export default App;onRemoved
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
onRemoved: function (key) {
// Your code goes here
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
onRemoved: function (key) {
// Your code goes here
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onRemoved: function (key) {
// Your code goes here
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onRemoved: function (key) {
// Your code goes here
}
});
class App extends React.Component {
// ...
}
export default App;onRemoving
Type:
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
onRemoving: function (key) {
// Your code goes here
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
onRemoving: function (key) {
// Your code goes here
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onRemoving: function (key) {
// Your code goes here
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onRemoving: function (key) {
// Your code goes here
}
});
class App extends React.Component {
// ...
}
export default App;onUpdated
Type:
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
onUpdated: function (key, values) {
// Your code goes here
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
onUpdated: function (key, values) {
// Your code goes here
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onUpdated: function (key, values) {
// Your code goes here
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onUpdated: function (key, values) {
// Your code goes here
}
});
class App extends React.Component {
// ...
}
export default App;onUpdating
Type:
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
onUpdating: function (key, values) {
// Your code goes here
}
});Angular
TypeScript
import CustomStore from "devextreme/data/custom_store";
// ...
export class AppComponent {
store: CustomStore;
constructor() {
this.store = new CustomStore({
onUpdating: function (key, values) {
// Your code goes here
}
})
}
}Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onUpdating: function (key, values) {
// Your code goes here
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
const store = new CustomStore({
// ...
onUpdating: function (key, values) {
// Your code goes here
}
});
class App extends React.Component {
// ...
}
export default App;remove
Specifies a custom implementation of the remove(key) method.
Type:
A Promise that is resolved after the data item is removed. It is a native Promise or a jQuery.Promise when you use jQuery.
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
// ...
remove: function (key) {
return $.ajax({
url: "http://mydomain.com/MyDataService/myEntity/" + encodeURIComponent(key),
method: "DELETE",
})
}
});Angular
TypeScript
import { ..., Inject } from "@angular/core";
import CustomStore from "devextreme/data/custom_store";
import { HttpClient, HttpClientModule } from "@angular/common/http";
import { lastValueFrom } from 'rxjs';
// ...
export class AppComponent {
store: CustomStore;
constructor(@Inject(HttpClient) httpClient: HttpClient) {
this.store = new CustomStore({
// ...
remove: (key) => {
return lastValueFrom(httpClient.delete("http://mydomain.com/MyDataService/myEntity/" + encodeURIComponent(key)));
}
});
}
}
@NgModule({
imports: [
// ...
HttpClientModule
],
// ...
})Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
import DataSource from 'devextreme/data/data_source';
import 'whatwg-fetch';
function handleErrors(response) {
if (!response.ok) {
throw Error(response.statusText);
}
return response;
}
const store = new CustomStore({
// ...
remove: (key) => {
return fetch(`https://mydomain.com/MyDataService/${encodeURIComponent(key)}`, {
method: "DELETE"
})
.then(handleErrors);
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
import DataSource from 'devextreme/data/data_source';
import 'whatwg-fetch';
function handleErrors(response) {
if (!response.ok)
throw Error(response.statusText);
return response;
}
const store = new CustomStore({
// ...
remove: (key) => {
return fetch(`https://mydomain.com/MyDataService/${encodeURIComponent(key)}`, {
method: "DELETE"
})
.then(handleErrors);
});
});
class App extends React.Component {
// ...
}
export default App;totalCount
Specifies a custom implementation of the totalCount(options) method.
Type:
A Promise that is resolved after data is loaded. It is a native Promise or a jQuery.Promise when you use jQuery.
update
Specifies a custom implementation of the update(key, values) method.
Type:
A Promise that is resolved after the data item is updated. It is a native Promise or a jQuery.Promise when you use jQuery.
jQuery
JavaScript
var store = new DevExpress.data.CustomStore({
// ...
update: function (key, values) {
return $.ajax({
url: "http://mydomain.com/MyDataService/myEntity/" + encodeURIComponent(key),
method: "PUT",
data: values
})
}
});Angular
TypeScript
import { ..., Inject } from "@angular/core";
import CustomStore from "devextreme/data/custom_store";
import { HttpClient, HttpClientModule } from "@angular/common/http";
import { lastValueFrom } from 'rxjs';
// ...
export class AppComponent {
store: CustomStore;
constructor(@Inject(HttpClient) httpClient: HttpClient) {
this.store = new CustomStore({
// ...
update: (key, values) => {
return lastValueFrom(httpClient.put("http://mydomain.com/MyDataService/myEntity/" + encodeURIComponent(key), values));
}
});
}
}
@NgModule({
imports: [
// ...
HttpClientModule
],
// ...
})Vue
App.vue
<script>
import CustomStore from 'devextreme/data/custom_store';
import DataSource from 'devextreme/data/data_source';
import 'whatwg-fetch';
function handleErrors(response) {
if (!response.ok) {
throw Error(response.statusText);
}
return response;
}
const store = new CustomStore({
// ...
update: (key, values) => {
return fetch(`https://mydomain.com/MyDataService/${encodeURIComponent(key)}`, {
method: "PUT",
body: JSON.stringify(values),
headers: {
'Content-Type': 'application/json'
}
}).then(handleErrors);
}
});
export default {
// ...
data() {
return {
store
}
}
}
</script>React
App.js
// ...
import CustomStore from 'devextreme/data/custom_store';
import DataSource from 'devextreme/data/data_source';
import 'whatwg-fetch';
function handleErrors(response) {
if (!response.ok)
throw Error(response.statusText);
return response;
}
const store = new CustomStore({
// ...
update: (key, values) => {
return fetch(`https://mydomain.com/MyDataService/${encodeURIComponent(key)}`, {
method: "PUT",
body: JSON.stringify(values),
headers: {
'Content-Type': 'application/json'
}
})
.then(handleErrors);
}
});
class App extends React.Component {
// ...
}
export default App;useDefaultSearch
Specifies whether the store combines the search and filter expressions. Defaults to true if the loadMode is "raw" and false if it is "processed".
Type:
Default Value: undefined
Feedback