DevExtreme jQuery - Local Array
NOTE
This article describes how to bind a DevExtreme widget to a local array in jQuery, Angular, Vue, and React. For information on data binding in ASP.NET MVC Controls, refer to docs.devexpress.com.
To bind a widget to a local array, pass this array to the widget's dataSource option. We recommend that you also use the keyExpr option (if the widget has it) to specify the key field.
jQuery
index.js
$(function() {
var employees = [
{ ID: 1, FirstName: "Sandra", LastName: "Johnson" },
{ ID: 2, FirstName: "James", LastName: "Scott" },
{ ID: 3, FirstName: "Nancy", LastName: "Smith" }
];
$("#dataGridContainer").dxDataGrid({
dataSource: employees,
keyExpr: "ID"
});
});Angular
app.component.html
app.component.ts
app.service.ts
app.module.ts
<dx-data-grid
[dataSource]="employees"
keyExpr="ID">
</dx-data-grid>
import { Component } from '@angular/core';
import { Employee, Service } from './app.service';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {
employees: Employee[];
constructor(service: Service) {
this.employees = service.getEmployees();
}
}
import { Injectable } from '@angular/core';
export class Employee {
ID: Number,
FirstName: String,
LastName: String
}
let employees: Employee[] = [
{ ID: 1, FirstName: 'Sandra', LastName: 'Johnson' },
{ ID: 2, FirstName: 'James', LastName: 'Scott' },
{ ID: 3, FirstName: 'Nancy', LastName: 'Smith' }
];
@Injectable()
export class Service {
getEmployees(): Employee[] {
return employees;
}
}
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { DxDataGridModule } from 'devextreme-angular';
import { Service } from './app.service';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
DxDataGridModule
],
providers: [
Service
],
bootstrap: [AppComponent]
})
export class AppModule { }Vue
App.vue
data.js
<template>
<dx-data-grid
:data-source="employees"
key-expr="ID"
/>
</template>
<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import DxDataGrid from 'devextreme-vue/data-grid';
import service from './data.js';
export default {
components: {
DxDataGrid
},
data() {
const employees = service.getEmployees();
return {
employees
}
}
}
</script>
const employees = [
{ ID: 1, FirstName: 'Sandra', LastName: 'Johnson' },
{ ID: 2, FirstName: 'James', LastName: 'Scott' },
{ ID: 3, FirstName: 'Nancy', LastName: 'Smith' }
];
export default {
getEmployees() {
return employees;
}
}React
App.js
data.js
import React from 'react';
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import DataGrid from 'devextreme-react/data-grid';
import service from './data.js';
class App extends React.Component {
constructor(props) {
super(props);
this.employees = service.getEmployees();
}
render() {
return (
<DataGrid
dataSource={this.employees}
keyExpr="ID"
/>
);
}
}
export default App;
const employees = [
{ ID: 1, FirstName: 'Sandra', LastName: 'Johnson' },
{ ID: 2, FirstName: 'James', LastName: 'Scott' },
{ ID: 3, FirstName: 'Nancy', LastName: 'Smith' }
];
export default {
getEmployees() {
return employees;
}
}If you plan to update the data or need to handle data-related events, wrap the array in an ArrayStore. You can use the store's key option instead of the widget's keyExpr to specify the key field. You can further wrap the ArrayStore in a DataSource if you need to filter, sort, group, and otherwise shape the data.
The following example declares an ArrayStore, wraps it in a DataSource, and binds the DataGrid widget to this DataSource:
jQuery
index.js
$(function() {
// ...
var employeesStore = new DevExpress.data.ArrayStore({
data: employees,
key: "ID",
onLoaded: function() {
// ...
}
});
var employeesDataSource = new DevExpress.data.DataSource({
store: employeesStore,
sort: "LastName"
});
$("#dataGridContainer").dxDataGrid({
dataSource: employeesDataSource
});
});Angular
app.component.html
app.component.ts
<dx-data-grid
[dataSource]="employeesDataSource">
</dx-data-grid>
import { Component } from '@angular/core';
import { Service } from './app.service';
import ArrayStore from 'devextreme/data/array_store';
import DataSource from 'devextreme/data/data_source';
@Component({
selector: 'app-root',
templateUrl: './app.component.html',
styleUrls: ['./app.component.css']
})
export class AppComponent {
constructor(service: Service) {
const employeesStore = new ArrayStore({
data: service.getEmployees(),
key: 'ID',
onLoaded: function() {
// ...
}
});
this.employeesDataSource = new DataSource({
store: employeesStore,
sort: 'LastName'
});
}
employeesStore: ArrayStore;
employeesDataSource: DataSource;
}Vue
App.vue
<template>
<dx-data-grid
:data-source="employeesDataSource"
/>
</template>
<script>
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import DxDataGrid from 'devextreme-vue/data-grid';
import ArrayStore from 'devextreme/data/array_store';
import DataSource from 'devextreme/data/data_source';
import service from './data.js';
const employeesStore = new ArrayStore({
data: service.getEmployees(),
key: 'ID',
onLoaded: function() {
// ...
}
});
const employeesDataSource = new DataSource({
store: employeesStore,
sort: 'LastName'
});
export default {
components: {
DxDataGrid
},
data() {
return {
employeesDataSource
}
}
}
</script>React
App.js
import React from 'react';
import 'devextreme/dist/css/dx.common.css';
import 'devextreme/dist/css/dx.light.css';
import DataGrid from 'devextreme-react/data-grid';
import ArrayStore from 'devextreme/data/array_store';
import DataSource from 'devextreme/data/data_source';
import service from './data.js';
const employeesStore = new ArrayStore({
data: service.getEmployees(),
key: 'ID',
onLoaded: function() {
// ...
}
});
const employeesDataSource = new DataSource({
store: employeesStore,
sort: 'LastName'
});
class App extends React.Component {
render() {
return (
<DataGrid
dataSource={employeesDataSource}
/>
);
}
}
export default App;NOTE
If you pass a JavaScript array to a widget's dataSource option, the widget automatically places it in an ArrayStore that is wrapped in a DataSource. You can then call the getDataSource() method to get this DataSource.
Feedback