Events

This section describes events fired by this widget.

cellClick

Fires when a user clicks a pivot grid cell.

Event Handler Argument:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
area: String
The area to which the clicked cell belongs.
cellElement: jQuery
The jQuery element of the clicked cell.
The clicked cell object.
rowIndex: Number
The index of the row to which the clicked cell belongs.
columnIndex: Number
The index of the column to which the clicked cell belongs.
columnFields: Array
Fields of the column area.
rowFields: Array
Fields of the row area.
dataFields: Array
Fields of the data area.
jQueryEvent: jQuery.Event
The jQuery 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

cellPrepared

Fires after a cell has been rendered.

Event Handler Argument:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
area: String
The area to which the prepared cell belongs.
cellElement: jQuery
The container of the prepared cell.
The cell object.
rowIndex: Number
The position of a cell's row.
columnIndex: Number
The position of a cell's column.

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

contentReady

Fires when widget content is ready.

Event Handler Argument:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

contextMenuPreparing

Fires before displaying a context menu that is invoked on one of the pivot grid's header or row cells.

Event Handler Argument:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
items: Array
An array of items to be displayed by the context menu. The item objects must have the fields that are used by the dxContextMenu default item template.
area: String
The clicked area type.
The cell that has been clicked to invoke the context menu.
cellElement: jQuery
The clicked cell's container.
columnIndex: Number
The index of the column to which the clicked cell belongs.
rowIndex: Number
The index of the row to which the clicked cell belongs.
dataFields: Array
Fields in the 'data' area.
rowFields: Array
Fields in the 'row' area.
columnFields: Array
Fields in the 'column' area.

Handle this event to change the set of items in a context menu before it is displayed.

See Also

disposing

Fires when the widget is being removed.

Event Handler Argument:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

NOTE: This event fires only if the widget is removed using the remove(), empty(), or html() jQuery methods.

See Also

exported

Fires after the exporting of grid data is completed.

Event Handler Argument:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.

exporting

Fires before exporting grid data.

Event Handler Argument:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
model: Object
Data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
fileName: String
The name of the file to which grid data is about to be exported.
cancel: Boolean
Indicates whether or not to cancel exporting.

fileSaving

Fires before the grid saves an Excel file with exported data on the user's local storage.

Event Handler Argument:
e: Object
Information about the event.
Object structure:
component: Object
The widget instance.
element: jQuery
The widget's container.
fileName: String
The name of the file to be saved.
format: String
The format of the file to be saved. Equals to 'EXCEL' for an Excel file.
data: BLOB
Exported data as a BLOB.
cancel: Boolean
To cancel file saving, assign true to this parameter.

initialized

Fires when the widget is initialized.

Event Handler Argument:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.

optionChanged

Fires after an option of the component is changed.

Event Handler Argument:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
name: String
Specifies the name of the option whose value is changed.
fullName: String
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
value: any
Specifies a new value for the option.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.