React PivotGrid Events
cellClick
Event
Name | Type | Description |
---|---|---|
component |
The widget instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
area |
The area to which the clicked cell belongs. |
|
cellElement |
The cell's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
cell |
The cell properties. |
|
rowIndex |
The index of the row to which the clicked cell belongs. |
|
columnIndex |
The index of the column to which the clicked cell belongs. |
|
columnFields |
The column area's fields. |
|
rowFields |
The row area's fields. |
|
dataFields |
The data area's fields. |
|
jQueryEvent |
Use 'event' instead. The jQuery event that caused the handler execution. Deprecated in favor of the event field. |
|
event | Event (jQuery or EventObject) |
The event that caused the handler execution. It is a dxEvent or a jQuery.Event when you use jQuery. |
cancel |
Allows you to cancel field expansion. |
Instead, you can use the onCellClick option to handle the event.
When implementing a handling function for this event, use the object passed to this function as its parameter. Among the fields of this object, you can find data relating to the clicked cell.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
cellPrepared
Event
Name | Type | Description |
---|---|---|
component |
The widget instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
area |
The area to which the prepared cell belongs. |
|
cellElement |
The prepared cell's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
cell |
The cell properties. |
|
rowIndex |
The position of a cell's row. |
|
columnIndex |
The position of a cell's column. |
Instead, you can use the onCellPrepared option to handle the event.
When implementing a handling function for this event, use the object passed to this function as its parameter. Among the fields of this object, you can find data relating to the prepared cell.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
contentReady
Event
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only when using Knockout. |
Main article: onContentReady.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
contextMenuPreparing
Fires before displaying a context menu that is invoked on one of the pivot grid's header or row cells.
Event
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
items |
An array of items to be displayed by the context menu. The item objects must have the fields that are used by the ContextMenu default item template. |
|
area |
The clicked area's type. |
|
cell |
The cell that has been clicked to invoke the context menu. |
|
cellElement |
The clicked cell's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
columnIndex |
The index of the column to which the clicked cell belongs. |
|
rowIndex |
The index of the row to which the clicked cell belongs. |
|
dataFields |
Fields in the 'data' area. |
|
rowFields |
Fields in the 'row' area. |
|
columnFields |
Fields in the 'column' area. |
|
field |
This field's configuration. |
Instead, you can use the onContextMenuPreparing option to handle the event.
Handle this event to change the set of items in a context menu before it is displayed.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
disposing
Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
Event
Name | Type | Description |
---|---|---|
component |
The widget instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if you use Knockout. |
exported
Event
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
Instead, you can use the onExported option to handle the event.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
exporting
Event
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
The model data. Available only if Knockout is used. |
|
fileName |
The name of the file to which data is about to be exported. |
|
cancel |
Allows you to cancel exporting. |
Instead, you can use the onExporting option to handle the event.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
fileSaving
Event
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
fileName |
The name of the file to be saved. |
|
format |
The format of the file to be saved. Equals 'EXCEL' for an Excel file. |
|
data |
Exported data as a BLOB. |
|
cancel |
Allows you to cancel file saving. |
Instead, you can use the onFileSaving option to handle the event.
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
initialized
Event
Name | Type | Description |
---|---|---|
component |
The widget's instance. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
Main article: onInitialized
See Also
- Handle Events: jQuery | Angular | AngularJS | Knockout | ASP.NET MVC
optionChanged
Event
Name | Type | Description |
---|---|---|
name |
The option's short name. |
|
model |
The model data. Available only if you use Knockout. |
|
element |
The widget's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The widget's instance. |
|
fullName |
The option's full name. |
|
value | any |
The option's new value. |
If you have technical questions, please create a support ticket in the DevExpress Support Center.