Vue

Events

This section describes events fired by this widget.

See Also

adaptiveDetailRowPreparing

Raised before an adaptive detail row is rendered.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

formOptions:

Object

The options of the Form widget.

model:

Object

The model data. Available only if you use Knockout.

Main article: onAdaptiveDetailRowPreparing

See Also

cellClick

Raised when a cell is clicked or tapped.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cellElement:

Element (jQuery or HTML)

The cell's container. It is an HTML Element or a jQuery Element when you use jQuery.

column:

Object

This column's configuration.

columnIndex:

Number

The index of the column to which the cell belongs. For details on indexes, see the Column and Row Indexes topic.

component:

DataGrid

The widget's instance.

data:

Object

The data of the row to which the cell belongs.

displayValue: any

The cell's displayed value. Differs from the value field only when the column to which the clicked cell belongs uses lookup.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event:

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

jQueryEvent:

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

key: any

The row's key. If a field providing keys is not specified in the data source, the whole data object is considered the key.

model:

Object

The model data. Available only if you use Knockout.

The row properties.

rowIndex:

Number

The index of the row to which the cell belongs. Refer to Column and Row Indexes for more information.

rowType:

String

The type of the row to which the clicked cell belongs.

text:

String

The cell's formatted value converted to a string.

value: any

The cell's raw value.

Main article: onCellClick

See Also

cellDblClick

Raised when a cell is double-clicked or double-tapped.

Type:

Event

Function parameters:
e:

Object

Information about the event that caused the function's execution.

Object structure:
cellElement:

Element (jQuery or HTML)

The cell's container. It is an HTML Element or a jQuery Element when you use jQuery.

column:

DataGrid Column

The column's configuration.

columnIndex:

Number

The index of the column the cell belongs to. For details on indexes, see the Column and Row Indexes topic.

component:

DataGrid

The widget's instance.

data:

Object

The data of the row the cell belongs to. Available if the rowType is "data", "detail", or "detailAdaptive".

displayValue: any

The value displayed in the cell. Available if the rowType is "data" or "group".
Differs from the value field only when the cell belongs to a lookup column.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event:

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

key: any

The row's key or a group's key. Available if the rowType is "data", "detail", "detailAdaptive", or "group".

model:

Object

The model data. Available only if you use Knockout.

The row's properties. Available if the rowType is "data", "detail", "detailAdaptive", or "group".

rowIndex:

Number

The index of the row the cell belongs to.

rowType:

String

The row's type.

text:

String

The cell's formatted value converted to a string. Available if the rowType is "data" or "group".

value: any

The cell's raw value. Available if the rowType is "data" or "group".

Main article: onCellDblClick

See Also

cellHoverChanged

Raised after the pointer enters or leaves a cell.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cellElement:

Element (jQuery or HTML)

The cell's container. It is an HTML Element or a jQuery Element when you use jQuery.

column:

DataGrid Column

This column's configuration.

columnIndex:

Number

The index of the column to which the cell belongs. For details on indexes, see the Column and Row Indexes topic.

component:

DataGrid

The widget's instance.

data:

Object

The data of the row to which the cell belongs.

displayValue: any

The cell's displayed value. Differs from the value field only when the column to which the current cell belongs uses lookup.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

eventType:

String

Indicates whether the pointer entered or left the cell. Can be either "mouseover" or "mouseout".

key: any

The row's key. If a field providing keys is not specified in the data source, the whole data object is considered the key.

model:

Object

The model data. Available only if you use Knockout.

The row properties.

rowIndex:

Number

The row's index. Refer to Column and Row Indexes for more information.

rowType:

String

The row's type.

text:

String

The cell's formatted value converted to a string.

value: any

The cell's raw value.

Main article: onCellHoverChanged

See Also

cellPrepared

Raised after a cell is created.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cellElement:

Element (jQuery or HTML)

The cell's container. It is an HTML Element or a jQuery Element when you use jQuery.

column:

DataGrid Column

This column's configuration.

columnIndex:

Number

The index of the column to which the cell belongs. For details on indexes, see the Column and Row Indexes topic.

component:

DataGrid

The widget's instance.

data:

Object

The data of the row to which the cell belongs. Unavailable if rowType is "header", "filter" or "totalFooter".

displayValue: any

The cell's displayed value. Differs from the value field only when the column to which the prepared cell belongs uses lookup.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

isExpanded:

Boolean

Indicates whether the row is expanded or collapsed. Unavailable if rowType is "header", "filter" or "totalFooter".

isSelected:

Boolean

Indicates whether the row is selected.

key: any

The row's key. Unavailable if rowType is "header", "filter" or "totalFooter".
If a field providing keys is not specified in the data source, the whole data object is considered the key.

model:

Object

The model data. Available only if you use Knockout.

oldValue: any

The cell's previous raw value.

The row properties.

rowIndex:

Number

The row's index. Refer to Column and Row Indexes for more information.

rowType:

String

The row's type.

text:

String

The cell's formatted value converted to a string.

value: any

The cell's raw value.

watch:

Function

Allows tracking a variable and performing actions when it changes. Applies when repaintChangesOnly is true.
This function has the following parameters:

  • getter(data): Function
    A function that returns the variable that should be tracked.

  • handler(newValue): Function
    A function called when this variable changes.

Main article: onCellPrepared

See Also

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only when using Knockout.

Main article: onContentReady.

See Also

contextMenuPreparing

Raised before the context menu is rendered.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
column:

DataGrid Column

This column's configuration.

columnIndex:

Number

The index of the column on which the context menu is invoked. For details on indexes, see the Column and Row Indexes topic.

component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

items:

Array<Object>

Items to be displayed in the context menu. Their structure is described in the Default Item Template section.

model:

Object

The model data. Available only if you use Knockout.

The row properties.

rowIndex:

Number

The index of the row on which the context menu is invoked. Refer to Column and Row Indexes for more information.

target:

String

The name of the element on which the context menu is invoked: "headerPanel", "header", "content", or "footer". This field is read-only.

targetElement:

Element (jQuery or HTML)

The grid element's container. It is an HTML Element or a jQuery Element when you use jQuery.

Main article: onContextMenuPreparing

See Also

dataErrorOccurred

Raised when an error occurs in the data source.

Type:

Event

Function parameters:
e:

Object

Information on the occurred error.

Object structure:
component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

The standard Error object that defines the error.

model:

Object

The model data. Available only if you use Knockout.

Main article: onDataErrorOccurred

See Also

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Main article: onDisposing

See Also

editingStart

Raised before a cell or row switches to the editing state.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cancel:

Boolean

Allows you to cancel row editing.

column:

Object

The configuration of the column whose cell is switching to the editing state. Available in the "batch" editing mode.

component:

DataGrid

The widget's instance.

data:

Object

The data of a row to be edited.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key: any

The row's key. The key of an added but not yet saved row is undefined.
If a field providing keys is not specified in the data source, the whole data object is considered the key.

model:

Object

The model data. Available only if Knockout is used.

Main article: onEditingStart

See Also

editorPrepared

Raised after an editor is created.

Type:

Event

Function parameters:
options:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

dataField:

String

The name of the field that provides data for the column the editor belongs to.

disabled:

Boolean

Indicates whether the editor is disabled.

editorElement:

Element (jQuery or HTML)

The editor's container. It is an HTML Element or a jQuery Element when you use jQuery.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

parentType:

String

The editor's location. One of "dataRow", "filterRow", "headerRow" or "searchPanel".
Options passed to the function depend on this value.

readOnly:

Boolean

Indicates whether the editor is read-only.

The properties of the row the editor belongs to.

rtlEnabled:

Boolean

Indicates whether the editor uses a right-to-left representation.

setValue(newValue, newText): any

A method that you should call to change the cell value and, optionally, the displayed value after the editor's value is changed.

updateValueTimeout:

Number

Gets and sets the delay between the moment a user stops typing a filter value and the moment it is applied. Available if parentType is "filterRow" or "searchPanel".

value: any

The editor's value.

width:

Number

The editor's width; equals null for all editors except for those whose parentType equals "searchPanel".

Main article: onEditorPrepared

See Also

editorPreparing

Raised before an editor is created.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cancel:

Boolean

Allows you to cancel creating the editor.
Set it to true and implement a custom editor if your scenario requires it.

component:

DataGrid

The widget's instance.

dataField:

String

The name of the field that provides data for the column the editor belongs to.

disabled:

Boolean

Indicates whether the editor is disabled.

editorElement:

Element (jQuery or HTML)

The editor's container. It is an HTML Element or a jQuery Element when you use jQuery.

editorName:

String

Allows you to change the editor. Accepts names of DevExtreme widgets only, for example, "dxTextBox".
Import a new editor's module when using DevExtreme modules.

editorOptions:

Object

Gets and sets the editor configuration.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

parentType:

String

The editor's location. One of "dataRow", "filterRow", "headerRow" or "searchPanel".
Options passed to the function depend on this value.

readOnly:

Boolean

Indicates whether the editor is read-only.

The properties of the row the editor belongs to.

rtlEnabled:

Boolean

Indicates whether the editor uses a right-to-left representation.

setValue(newValue, newText): any

A method that you should call to change the cell value and, optionally, the displayed value after the editor's value is changed.

updateValueTimeout:

Number

Gets and sets the delay between the moment a user stops typing a filter value and the moment it is applied. Available if parentType is "filterRow" or "searchPanel".

value: any

The editor's value.

width:

Number

The editor's width; equals null for all editors except for those whose parentType equals "searchPanel".

Main article: onEditorPreparing

See Also

exported

Raised after data is exported.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if Knockout is used.

Main article: onExported

See Also

exporting

Raised before data is exported.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cancel:

Boolean

Allows you to cancel exporting.

component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

fileName:

String

The name of the file to which grid data is about to be exported.

model:

Object

The model data. Available only if Knockout is used.

Main article: onExporting

See Also

fileSaving

Raised before a file with exported data is saved to the user's local storage.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cancel:

Boolean

Allows you to cancel file saving.

component:

DataGrid

The widget's instance.

data:

BLOB

Exported data as a BLOB.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

fileName:

String

The name of the file to be saved.

format:

String

The format of this file. Equals "EXCEL" for an Excel file.

Main article: onFileSaving

See Also

focusedCellChanged

Raised after the focused cell changes.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cellElement:

Element (jQuery or HTML)

The focused cell's container. It is an HTML Element or a jQuery Element when you use jQuery.

column:

DataGrid Column

The column's properties.

columnIndex:

Number

The index of the cell's column.

component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

The row's properties.

rowIndex:

Number

The index of the cell's row.

Main article: onFocusedCellChanged

See Also

focusedCellChanging

Raised before the focused cell changes.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cancel:

Boolean

Allows you to cancel focusing a new cell.

cellElement:

Element (jQuery or HTML)

The to-be-focused cell's container. It is an HTML Element or a jQuery Element when you use jQuery.

The visible columns' properties.

component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event:

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

isHighlighted:

Boolean

true if the cell is highlighted; otherwise false, even if the cell's row is highlighted.

model:

Object

The model data. Available only if you use Knockout.

newColumnIndex:

Number

The index of the column the cell that should be focused belongs to.

newRowIndex:

Number

The index of the column the row that should be focused belongs to.

prevColumnIndex:

Number

The index of the previously focused cell's column.

prevRowIndex:

Number

The index of the previously focused cell's row.

The visible rows' properties.

Main article: onFocusedCellChanging

See Also

focusedRowChanged

Raised after the focused row changes. Applies only when focusedRowEnabled is true.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

The row's properties.

rowElement:

Element (jQuery or HTML)

The focused row's container. It is an HTML Element or a jQuery Element when you use jQuery.

rowIndex:

Number

The row's index.

Main article: onFocusedRowChanged

See Also

focusedRowChanging

Raised before the focused row changes. Applies only when focusedRowEnabled is true.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cancel:

Boolean

Allows you to cancel focusing a new row.

component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event:

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

newRowIndex:

Number

The index of the row to be focused.

prevRowIndex:

Number

The index of the previously focused row.

rowElement:

Element (jQuery or HTML)

The to-be-focused row's container. It is an HTML Element or a jQuery Element when you use jQuery.

The visible rows' properties.

Main article: onFocusedRowChanging

See Also

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Main article: onInitialized

See Also

initNewRow

Raised before a new row is added to the widget.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

data:

Object

The data of the inserted row; initially empty.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Main article: onInitNewRow

See Also

keyDown

Raised when the widget is in focus and a key has been pressed down.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event:

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

handled:

Boolean

Indicates whether the widget has already handled this event.

jQueryEvent:

jQuery.Event

Use 'event' instead.

The jQuery event that caused the function's execution. Deprecated in favor of the event field.

model:

Object

The model data. Available only if you use Knockout.

Main article: onKeyDown

See Also

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

fullName:

String

The path to the modified option that includes all parent options.

name:

String

The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into.

value: any

The modified option's new value.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Main article: onOptionChanged

See Also

rowClick

Raised when a row is clicked or tapped.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
columns:

Array<Object>

All column configurations.

component:

DataGrid

The widget's instance.

data:

Object

The row's data.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event:

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

groupIndex:

Number

The row's group index. Available if rowType is "group".

handled:

Boolean

Indicates whether internal widget handlers have already handled the event.

isExpanded:

Boolean

Indicates whether or not the group row is expanded. Available if rowType is "group".

isSelected:

Boolean

Indicates whether the row is selected.

jQueryEvent:

jQuery.Event

Use 'event' instead.

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

key: any

The row's key.

model:

Object

The model data. Available only if Knockout is used.

rowElement:

Element (jQuery or HTML)

The row's container. It is an HTML Element or a jQuery Element when you use jQuery.

rowIndex:

Number

The row's index. Refer to Column and Row Indexes for more information.

rowType:

String

The row's type.

values:

Array<any>

Values displayed in the row cells.

Main article: onRowClick

See Also

rowCollapsed

Raised after a row is collapsed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key: any

The key of the row.

model:

Object

The model data. Available only if you use Knockout.

Main article: onRowCollapsed

See Also

rowCollapsing

Raised before a row is collapsed.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cancel:

Boolean

Allows you to cancel row collapsing.

component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key: any

The key of the row.

model:

Object

The model data. Available only if you use Knockout.

Main article: onRowCollapsing

See Also

rowDblClick

Raised when a row is double-clicked or double-tapped.

Type:

Event

Function parameters:
e:

Object

Information about the event that caused the function's execution.

Object structure:

The configurations of visible columns.

component:

DataGrid

The widget's instance.

data:

Object

The row's data.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

event:

Event (jQuery or dxEvent)

The event that caused the function to execute. It is a dxEvent or a jQuery.Event when you use jQuery.

groupIndex:

Number

The row's group index. Available if rowType is "group".

isExpanded:

Boolean

Indicates whether the row is expanded or collapsed. Available if rowType is "data", "detail", or "group".

isSelected:

Boolean

Indicates whether the row is selected. Available if rowType is "data" or "detail".

key: any

The row's key or a group row's key. Available if the rowType is "data", "detail", "detailAdaptive", or "group".

model:

Object

The model data. Available only if you use Knockout.

rowElement:

Element (jQuery or HTML)

The row's container. It is an HTML Element or a jQuery Element when you use jQuery.

rowIndex:

Number

The row's index. Refer to Column and Row Indexes for more information.

rowType:

String

The row's type.

values:

Array<any>

Raw values displayed in the row's cells.

Main article: onRowDblClick

See Also

rowExpanded

Raised after a row is expanded.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key: any

The key of the row.

model:

Object

The model data. Available only if you use Knockout.

Main article: onRowExpanded

See Also

rowExpanding

Raised before a row is expanded.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cancel:

Boolean

Allows you to cancel row expansion.

component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key: any

The key of the group or master row.

model:

Object

The model data. Available only if you use Knockout.

Main article: onRowExpanding

See Also

rowInserted

Raised after a new row has been inserted into the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

data:

Object

The data of the row.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

The standard Error object defining an error that may occur during insertion.

key: any

The key of the row. If a field providing keys is not specified in the data source, the whole data object is considered the key.

model:

Object

The model data. Available only if you use Knockout.

Main article: onRowInserted

See Also

rowInserting

Raised before a new row is inserted into the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cancel:

Boolean

|

Promise<void> (jQuery or native)

true, a Promise resolved with true, or a rejected Promise stops row insertion.
false or a Promise resolved with false or undefined continues row insertion.

component:

DataGrid

The widget's instance.

data:

Object

The data of the row that should be inserted.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

Main article: onRowInserting

See Also

rowPrepared

Raised after a row is created.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:

All column configurations.

component:

DataGrid

The widget's instance.

data:

Object

The row's raw data. Unavailable if rowType is "header", "filter" or "totalFooter".

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

groupIndex:

Number

The row's group index. Available if rowType is "group".

isExpanded:

Boolean

Indicates whether the row is expanded or collapsed. Unavailable if rowType is "header", "filter", or "totalFooter".

isSelected:

Boolean

Indicates whether the prepared row is selected. Available only if rowType is "data".

key: any

The row's key.
If a field providing keys is not specified in the data source, the whole data object is considered the key.

model:

Object

The model data. Available only if Knockout is used.

rowElement:

Element (jQuery or HTML)

The row's container. It is an HTML Element or a jQuery Element when you use jQuery.

rowIndex:

Number

The row's index. Refer to Column and Row Indexes for more information.

rowType:

String

The row's type.

values:

Array<any>

Values displayed in the row cells.

Main article: onRowPrepared

See Also

rowRemoved

Raised after a row has been removed from the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

data:

Object

The data of the row.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

The standard Error object defining an error that may occur during removal.

key: any

The key of the row. If a field providing keys is not specified in the data source, the whole data object is considered the key.

model:

Object

The model data. Available only if you use Knockout.

Main article: onRowRemoved

See Also

rowRemoving

Raised before a row is removed from the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cancel:

Boolean

|

Promise<void> (jQuery or native)

true, a Promise resolved with true, or a rejected Promise stops row removal.
false or a Promise resolved with false or undefined continues row removal.

component:

DataGrid

The widget's instance.

data:

Object

The data of the row that should be removed.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key: any

The row's key.

model:

Object

The model data. Available only if you use Knockout.

Main article: onRowRemoving

See Also

rowUpdated

Raised after a row has been updated in the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

data:

Object

The updated data of the row.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

The standard Error object defining an error that may occur during updating.

key: any

The key of the row. If a field providing keys is not specified in the data source, the whole data object is considered the key.

model:

Object

The model data. Available only if you use Knockout.

Main article: onRowUpdated

See Also

rowUpdating

Raised before a row is updated in the data source.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
cancel:

Boolean

|

Promise<void> (jQuery or native)

true, a Promise resolved with true, or a rejected Promise stops row updating.
false or a Promise resolved with false or undefined continues row updating.

component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

key: any

The row's key.

model:

Object

The model data. Available only if you use Knockout.

newData:

Object

The row's updated data.

oldData:

Object

The row's old data.

Main article: onRowUpdating

See Also

rowValidating

Raised after cells in a row are validated against validation rules.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:

An array of broken rules. The structure of rule objects is described in the Validation Rules section.

component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

errorText:

String

An error message to be displayed.

isValid:

Boolean

Indicates whether data in all cells of the row satisfies the validation rules.

key: any

The key of the row. If a field providing keys is not specified in the data source, the whole data object is considered the key.

model:

Object

The model data. Available only if you use Knockout.

newData:

Object

The data of the validated row after changes.

oldData:

Object

The data of the validated row before changes.

Main article: onRowValidating

See Also

selectionChanged

Raised after selecting a row or clearing its selection.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

currentDeselectedRowKeys:

Array<any>

The keys of the rows whose selection has been cleared.

currentSelectedRowKeys:

Array<any>

The keys of the rows that have been selected.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

selectedRowKeys:

Array<any>

The keys of all selected rows.

selectedRowsData:

Array<Object>

The data of all selected rows.
Does not include calculated values.

Main article: onSelectionChanged

See Also

toolbarPreparing

Raised before the toolbar is created.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

DataGrid

The widget's instance.

element:

Element (jQuery or HTML)

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model:

Object

The model data. Available only if you use Knockout.

toolbarOptions:

Toolbar Configuration

Main article: onToolbarPreparing

See Also