A newer version of this page is available.

JavaScript/jQuery DataGrid API

The DataGrid is a widget that represents data from a local or remote source in the form of a grid. This widget offers such basic features as sorting, grouping, filtering, as well as more advanced capabilities, like state storing, export to Excel, master-detail interface, and many others.

import DataGrid from "devextreme/ui/data_grid"

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the DataGrid widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery

JavaScript

HTML

$(function () {
    $("#dataGrid").dxDataGrid({
        dataSource: [{
            ID: 1,
            CompanyName: "Super Mart of the West",
            City: "Bentonville",
            State: "Arkansas"
        }, {
            ID: 2,
            CompanyName: "Electronics Depot",
            City: "Atlanta",
            State: "Georgia"
        }],
        keyExpr: "ID",
        columns: ['CompanyName', 'City', 'State']
    });
});

<div id="dataGrid"></div>

Angular

HTML

TypeScript

<dx-data-grid 
    [dataSource]="customers"
    keyExpr="ID">            
    <dxi-column dataField="CompanyName"></dxi-column>
    <dxi-column dataField="City"></dxi-column>
    <dxi-column dataField="State"></dxi-column>
</dx-data-grid>

import { DxDataGridModule } from 'devextreme-angular';
// ...
export class AppComponent {
    customers = [{
        ID: 1,
        CompanyName: "Super Mart of the West",
        City: "Bentonville",
        State: "Arkansas"
    }, {
        ID: 2,
        CompanyName: "Electronics Depot",
        City: "Atlanta",
        State: "Georgia"
    }];
}
@NgModule({
    imports: [
        // ...
        DxDataGridModule
    ],
    // ...
})

AngularJS

HTML

JavaScript

<div ng-controller="DemoController">
    <div dx-data-grid="{
        dataSource: customers,
        keyExpr: 'ID',
        columns: ['CompanyName', 'City', 'State']
    }"></div>
</div>

angular.module('DemoApp', ['dx'])
    .controller("DemoController", function ($scope) {
        $scope.customers = [{
            ID: 1,
            CompanyName: "Super Mart of the West",
            City: "Bentonville",
            State: "Arkansas"
        }, {
            ID: 2,
            CompanyName: "Electronics Depot",
            City: "Atlanta",
            State: "Georgia"
        }];
    });

Knockout

HTML

JavaScript

<div data-bind="dxDataGrid: {
    dataSource: customers,
    keyExpr: 'ID',
    columns: ['CompanyName', 'City', 'State']
}"></div>

var viewModel = {
    customers: [{
        ID: 1,
        CompanyName: "Super Mart of the West",
        City: "Bentonville",
        State: "Arkansas"
    }, {
        ID: 2,
        CompanyName: "Electronics Depot",
        City: "Atlanta",
        State: "Georgia"
    }]
};
ko.applyBindings(viewModel);

ASP.NET MVC Controls

Razor C#

Razor VB

@(Html.DevExtreme().DataGrid()
    .ID("dataGrid")
    .DataSource(new[] {
        new { 
            ID = 1,
            CompanyName = "Super Mart of the West",
            City = "Bentonville",
            State = "Arkansas" 
        }, 
        new {
            ID = 2,
            CompanyName = "Electronics Depot",
            City = "Atlanta",
            State = "Georgia"
        }
    }, "ID")
    .Columns(columns => {
        columns.Add().DataField("CompanyName");
        columns.Add().DataField("City");
        columns.Add().DataField("State");
    })
)

@(Html.DevExtreme().DataGrid() _
    .ID("dataGrid") _
    .DataSource({
        New With { 
            .ID= 1,
            .CompanyName = "Super Mart of the West",
            .City = "Bentonville",
            .State = "Arkansas" 
        }, 
        New With {
            .ID = 2,
            .CompanyName = "Electronics Depot",
            .City = "Atlanta",
            .State = "Georgia"
        }
    }, "ID") _
    .Columns(Sub(columns)
        columns.Add().DataField("CompanyName")
        columns.Add().DataField("City")
        columns.Add().DataField("State")
    End Sub)
)

Configuration

This section describes the configuration options of the DataGrid widget.

Name	Description
accessKey	Specifies the shortcut key that sets focus on the widget.
activeStateEnabled	Specifies whether or not the widget changes its state when interacting with a user.
allowColumnReordering	Specifies whether a user can reorder columns.
allowColumnResizing	Specifies whether a user can resize columns.
cacheEnabled	Specifies whether data should be cached.
cellHintEnabled	Enables a hint that appears when a user hovers the mouse pointer over a cell with truncated content.
columnAutoWidth	Specifies whether columns should adjust their widths to the content.
columnChooser	Configures the column chooser.
columnFixing	Configures column fixing.
columnHidingEnabled	Specifies whether the widget should hide columns to adapt to the screen or container size. Ignored if allowColumnResizing is true and columnResizingMode is "widget".
columnMinWidth	Specifies the minimum width of columns.
columnResizingMode	Specifies how the widget resizes columns. Applies only if allowColumnResizing is true.
columns	An array of grid columns.
customizeColumns	Specifies a function that customizes grid columns after they are created.
customizeExportData	Customizes data before exporting.
dataSource	Specifies the origin of data for the widget.
dateSerializationFormat	Specifies date-time values' serialization format. Use it only if you do not specify the dataSource at design time.
disabled	Specifies whether the widget responds to user interaction.
editing	Configures editing.
elementAttr	Specifies the attributes to be attached to the widget's root element.
errorRowEnabled	Indicates whether to show the error row.
export	Configures client-side exporting.
filterRow	Configures the filter row.
focusStateEnabled	Specifies whether the widget can be focused using keyboard navigation.
grouping	Configures grouping.
groupPanel	Configures the group panel.
headerFilter	Configures the header filter feature.
height	Specifies the widget's height.
hint	Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled	Specifies whether to highlight rows when a user moves the mouse pointer over them.
keyExpr	Specifies which data field provides data items' keys. Applies only if data is a JavaScript array.
loadPanel	Configures the load panel.
masterDetail	Allows you to build a master-detail interface in the grid.
noDataText	Specifies text shown when the widget does not display any data.
onAdaptiveDetailRowPreparing	A handler for the adaptiveDetailRowPreparing event. Executed before an adaptive detail row is rendered.
onCellClick	A handler for the cellClick event.
onCellHoverChanged	A handler for the cellHoverChanged event.
onCellPrepared	A handler for the cellPrepared event.
onContentReady	A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.
onContextMenuPreparing	A handler for the contextMenuPreparing event.
onDataErrorOccurred	A handler for the dataErrorOccurred event. Executed when an error occurs in the data source.
onDisposing	A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
onEditingStart	A handler for the editingStart event. Executed before a cell or row switches to the editing state.
onEditorPrepared	A function that is executed after an editor is created.
onEditorPreparing	A function that is executed before an editor is created.
onExported	A function that is executed after data is exported.
onExporting	A function that is executed before data is exported.
onFileSaving	A handler for the fileSaving event.
onInitialized	A handler for the initialized event. Executed only once, after the widget is initialized.
onInitNewRow	A handler for the initNewRow event. Executed before a new row is added to the widget.
onKeyDown	A handler for the keyDown event. Executed when the widget is in focus and a key has been pressed down.
onOptionChanged	A handler for the optionChanged event. Executed after an option of the widget is changed.
onRowClick	A handler for the rowClick event.
onRowCollapsed	A handler for the rowCollapsed event. Executed after a row is collapsed.
onRowCollapsing	A handler for the rowCollapsing event. Executed before a row is collapsed.
onRowExpanded	A handler for the rowExpanded event. Executed after a row is expanded.
onRowExpanding	A handler for the rowExpanding event. Executed before a row is expanded.
onRowInserted	A handler for the rowInserted event. Executed after a new row has been inserted into the data source.
onRowInserting	A handler for the rowInserting event. Executed before a new row is inserted into the data source.
onRowPrepared	A handler for the rowPrepared event.
onRowRemoved	A handler for the rowRemoved event. Executed after a row has been removed from the data source.
onRowRemoving	A handler for the rowRemoving event. Executed before a row is removed from the data source.
onRowUpdated	A handler for the rowUpdated event. Executed after a row has been updated in the data source.
onRowUpdating	A handler for the rowUpdating event. Executed before a row is updated in the data source.
onRowValidating	A handler for the rowValidating event. Executed after cells in a row are validated against validation rules.
onSelectionChanged	A handler for the selectionChanged event. Executed after selecting a row or clearing its selection.
onToolbarPreparing	A handler for the toolbarPreparing event. Executed before the toolbar is created.
pager	Specifies the options of a grid pager.
paging	Specifies paging options.
remoteOperations	Specifies the operations that must be performed on the server side.
rowAlternationEnabled	Specifies whether rows should be shaded differently.
rowTemplate	Specifies a custom template for rows.
rtlEnabled	Switches the widget to a right-to-left representation.
scrolling	Configures scrolling.
searchPanel	Configures the search panel.
selectedRowKeys	Allows you to select rows or learn which rows are selected. Applies only if selection.deferred is false.
selection	Configures runtime selection.
selectionFilter	Specifies filters for the rows that must be selected initially. Applies only if selection.deferred is true.
showBorders	Specifies whether the outer borders of the widget are visible.
showColumnHeaders	Specifies whether column headers are visible.
showColumnLines	Specifies whether vertical lines that separate one column from another are visible.
showRowLines	Specifies whether horizontal lines that separate one row from another are visible.
sortByGroupSummaryInfo	Allows you to sort groups according to the values of group summary items.
sorting	Configures runtime sorting.
stateStoring	Configures state storing.
summary	Specifies the options of the grid summary.
tabIndex	Specifies the number of the element when the Tab key is used for navigating.
twoWayBindingEnabled	Specifies whether to enable two-way data binding.
visible	Specifies whether the widget is visible.
width	Specifies the widget's width.
wordWrapEnabled	Specifies whether text that does not fit into a column should be wrapped.

Methods

This section describes the methods that can be used to manipulate the DataGrid widget.

Name	Description
addColumn(columnOptions)	Adds a new column.
addRow()	Adds an empty data row.
beginCustomLoading(messageText)	Shows the load panel.
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
byKey(key)	Gets a data object with a specific key.
cancelEditData()	Discards changes that a user made to data.
cellValue(rowIndex, dataField)	Gets the value of a cell with a specific row index and a data field.
cellValue(rowIndex, dataField, value)	Sets a new value to a cell with a specific row index and a data field.
cellValue(rowIndex, visibleColumnIndex)	Gets the value of a cell with specific row and column indexes.
cellValue(rowIndex, visibleColumnIndex, value)	Sets a new value to a cell with specific row and column indexes.
clearFilter()	Clears all filters applied to widget rows.
clearFilter(filterName)	Clears all row filters of a specific type.
clearGrouping()	Ungroups grid records.
clearSelection()	Clears selection of all rows on all pages.
clearSorting()	Clears sorting settings of all columns at once.
closeEditCell()	Switches the cell being edited back to the normal state. Takes effect only if editing.mode is batch and showEditorAlways is false.
collapseAdaptiveDetailRow()	Collapses the currently expanded adaptive detail row (if there is one).
collapseAll(groupIndex)	Collapses master rows or groups of a specific level.
collapseRow(key)	Collapses a group or a master row with a specific key.
columnCount()	Gets the data column count. Includes visible and hidden columns, excludes command columns.
columnOption(id)	Gets all options of a column with a specific identifier.
columnOption(id, optionName)	Gets the value of a single column option.
columnOption(id, optionName, optionValue)	Updates the value of a single column option.
columnOption(id, options)	Updates the values of several column options.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
deleteColumn(id)	Removes a column.
deleteRow(rowIndex)	Removes a row with a specific index.
deselectAll()	Clears the selection of all rows on all pages or the currently rendered page only.
deselectRows(keys)	Cancels the selection of rows with specific keys.
dispose()	Disposes of all the resources allocated to the DataGrid instance.
editCell(rowIndex, dataField)	Switches a cell with a specific row index and a data field to the editing state. Takes effect only if the editing mode is 'batch' or 'cell'.
editCell(rowIndex, visibleColumnIndex)	Switches a cell with specific row and column indexes to the editing state. Takes effect only if the editing mode is 'batch' or 'cell'.
editRow(rowIndex)	Switches a row with a specific index to the editing state. Takes effect only if the editing mode is 'row', 'popup' or 'form'.
element()	Gets the root widget element.
endCustomLoading()	Hides the load panel.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
expandAdaptiveDetailRow(key)	Expands an adaptive detail row.
expandAll(groupIndex)	Expands master rows or groups of a specific level.
expandRow(key)	Expands a group or a master row with a specific key.
exportToExcel(selectionOnly)	Exports grid data to Excel.
filter()	Gets a filter expression applied to the widget's data source using the filter(filterExpr) method.
filter(filterExpr)	Applies a filter to the widget's data source.
focus()	Sets focus on the widget.
focus(element)	Sets focus on a specific cell.
getCellElement(rowIndex, dataField)	Gets a cell with a specific row index and a data field.
getCellElement(rowIndex, visibleColumnIndex)	Gets a cell with specific row and column indexes.
getCombinedFilter()	Gets the total filter that combines all the filters applied.
getCombinedFilter(returnDataField)	Gets the total filter that combines all the filters applied.
getDataSource()	Gets the DataSource instance.
getInstance(element)	Gets the instance of a widget found using its DOM node.
getKeyByRowIndex(rowIndex)	Gets the key of a row with a specific index.
getRowElement(rowIndex)	Gets the container of a row with a specific index.
getRowIndexByKey(key)	Gets the index of a row with a specific key.
getScrollable()	Gets the instance of the widget's scrollable part.
getSelectedRowKeys()	Gets the currently selected rows' keys.
getSelectedRowsData()	Gets data objects of currently selected rows.
getTotalSummaryValue(summaryItemName)	Gets the value of a total summary item.
getVisibleColumns()	Gets all visible columns.
getVisibleColumns(headerLevel)	Gets all visible columns at a specific hierarchical level of column headers. Use it to access banded columns.
getVisibleRows()	Gets currently rendered rows.
hasEditData()	Checks whether the widget has unsaved changes.
hideColumnChooser()	Hides the column chooser.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
isAdaptiveDetailRowExpanded(key)	Checks whether an adaptive detail row is expanded or collapsed.
isRowExpanded(key)	Checks whether a specific group or master row is expanded or collapsed.
isRowSelected(data)	Checks whether a row found using its data object is selected. Takes effect only if selection.deferred is true.
isRowSelected(key)	Checks whether a row with a specific key is selected. Takes effect only if selection.deferred is false.
keyOf(obj)	Gets a data object's key.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
option()	Gets all widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
pageCount()	Gets the total page count.
pageIndex()	The current page index.
pageIndex(newIndex)	Switches a grid to a specified page.
pageSize()	Gets the current page size.
pageSize(value)	Sets the page size.
refresh()	Reloads data in the widget.
repaint()	Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.
repaintRows(rowIndexes)	Repaints specific rows.
saveEditData()	Saves changes that a user made to data.
searchByText(text)	Seeks a search string in the columns whose allowSearch option is true.
selectAll()	Selects all rows.
selectRows(keys, preserve)	Selects rows with specific keys.
selectRowsByIndexes(indexes)	Selects rows with specific indexes.
showColumnChooser()	Shows the column chooser.
state()	Gets the current DataGrid state.
state(state)	Sets the DataGrid state.
totalCount()	Gets the total row count.
undeleteRow(rowIndex)	Recovers a row deleted in batch editing mode.
updateDimensions()	Updates the widget's content after resizing.

Events

This section describes events fired by this widget.

Name	Description
adaptiveDetailRowPreparing	Raised before an adaptive detail row is rendered.
cellClick	Fires when a user clicks a grid cell.
cellHoverChanged	Fires when the hover state of a cell is changed.
cellPrepared	Fires after a cell has been rendered.
contentReady	Raised when the widget's content is ready.
contextMenuPreparing	Fires before displaying a context menu that is invoked on one of the grid's header or row cells.
dataErrorOccurred	Raised when an error occurs in the data source.
disposing	Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
editingStart	Raised before a cell or row switches to the editing state.
editorPrepared	Raised after an editor is created.
editorPreparing	Raised before an editor is created.
exported	Raised after data is exported.
exporting	Raised before data is exported.
fileSaving	Fires before the grid saves an Excel file with exported data on the user's local storage.
initialized	Raised only once, after the widget is initialized.
initNewRow	Raised before a new row is added to the widget.
keyDown	Raised when the widget is in focus and a key has been pressed down.
optionChanged	Raised after a widget option is changed.
rowClick	Fires when a user clicks a grid row.
rowCollapsed	Raised after a row is collapsed.
rowCollapsing	Raised before a row is collapsed.
rowExpanded	Raised after a row is expanded.
rowExpanding	Raised before a row is expanded.
rowInserted	Raised after a new row has been inserted into the data source.
rowInserting	Raised before a new row is inserted into the data source.
rowPrepared	Fires after a row has been rendered.
rowRemoved	Raised after a row has been removed from the data source.
rowRemoving	Raised before a row is removed from the data source.
rowUpdated	Raised after a row has been updated in the data source.
rowUpdating	Raised before a row is updated in the data source.
rowValidating	Raised after cells in a row are validated against validation rules.
selectionChanged	Raised after selecting a row or clearing its selection.
toolbarPreparing	Raised before the toolbar is created.

Row

This section describes the properties of a grid row. An object containing these properties comes to certain event-handling functions.

Type:

Object

Was this topic helpful?

Thank you!

Feel free to share topic-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

JavaScript/jQuery DataGrid API

jQuery

Angular

AngularJS

Knockout

ASP.NET MVC Controls

See Also

Configuration

Methods

Events

See Also

Row