Events

This section describes events fired by this widget.

cellClick

Fires when a user clicks a pivot grid cell.

Event Handler Argument:

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 approach.

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.

cancel: Boolean

Set this field to true if you need to prevent the clicked field from 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

cellPrepared

Fires after a cell has been rendered.

Event Handler Argument:

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 approach.

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.

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

contentReady

Fires when widget content is ready.

Event Handler Argument:

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 approach.

Instead, you can use the onContentReady option to handle the event.

See Also

contextMenuPreparing

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

Event Handler Argument:

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 approach.

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 ContextMenu default item template.

area: String

The clicked area type.

The cell that has been clicked to invoke the context menu.
NOTE: Unavailable for fields in the field panel.

cellElement: jQuery

The clicked cell's container.
NOTE: Unavailable for fields in the field panel.

columnIndex: Number

The index of the column to which the clicked cell belongs.
NOTE: Unavailable for fields in the field panel.

rowIndex: Number

The index of the row to which the clicked cell belongs.
NOTE: Unavailable for fields in the field panel.

dataFields: Array

Fields in the 'data' area.

rowFields: Array

Fields in the 'row' area.

columnFields: Array

Fields in the 'column' area.

field: Object

Options of the clicked field.
NOTE: Available for fields in the field panel only.

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

disposing

Fires when the widget is being removed.

Event Handler Argument:

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 approach.

Instead, you can use the onDisposing option to handle the event.

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

exported

Fires after the exporting of grid data is completed.

Event Handler Argument:

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 approach.

Instead, you can use the onExported option to handle the event.

See Also

exporting

Fires before exporting grid data.

Event Handler Argument:

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 approach.

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.

Instead, you can use the onExporting option to handle the event.

See Also

fileSaving

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

Event Handler Argument:

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.

Instead, you can use the onFileSaving option to handle the event.

See Also

initialized

Fires when the widget is initialized.

Event Handler Argument:

Provides function parameters.

Object structure:
component: Object

Provides access to the widget instance.

element: jQuery

An HTML element of the widget.

Instead, you can use the onInitialized option to handle the event.

See Also

optionChanged

Fires after an option of the component is changed.

Event Handler Argument:

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 approach.

Instead, you can use the onOptionChanged option to handle the event.

See Also