React PivotGrid Events
This section describes events fired by this widget.
cellClick
Raised when a pivot grid cell is clicked or tapped.
Event
Information about the 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. |
Main article: onCellClick
See Also
cellPrepared
Raised after a pivot grid cell is created.
Event
Information about the 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. |
Main article: onCellPrepared
See Also
contentReady
Raised when the widget's content is ready.
Event
Information about the 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
contextMenuPreparing
Raised before the context menu is rendered.
Event
Information about the 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. |
Main article: onContextMenuPreparing
See Also
disposing
Raised before the widget is disposed of.
Event
Information about the 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. |
Main article: onDisposing
See Also
exported
Raised after data is exported.
Event
Information about the 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. |
Main article: onExported
See Also
exporting
Raised before data is exported.
Event
Information about the 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. |
Main article: onExporting
See Also
fileSaving
Raised before a file with exported data is saved to the user's local storage.
Event
Information about the 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. |
Main article: onFileSaving
See Also
initialized
Raised only once, after the widget is initialized.
Event
Information about the 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
optionChanged
Raised after a widget option is changed.
Event
Information about the event.
Name | Type | Description |
---|---|---|
name |
The modified option if it belongs to the first level. Otherwise, the first-level option it is nested into. |
|
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 path to the modified option that includes all parent options. |
|
value | any |
The modified option's new value. |
Main article: onOptionChanged
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.