JavaScript/jQuery PivotGrid Events

Information about the event.

Object structure:

Name	Type	Description
component	PivotGrid	The widget instance.
element	HTMLElement \| jQuery	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.
area	String	The area to which the clicked cell belongs.
cellElement	HTMLElement \| jQuery	The cell's container. It is an HTML Element or a jQuery Element when you use jQuery.
cell	PivotGrid Cell	The cell properties.
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<PivotGrid Field>	The column area's fields.
rowFields	Array<PivotGrid Field>	The row area's fields.
dataFields	Array<PivotGrid Field>	The data area's fields.
jQueryEvent	jQuery.Event	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	Boolean	Allows you to cancel field expansion.

Main article: onCellClick

cellPrepared

Raised after a pivot grid cell is created.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PivotGrid	The widget instance.
element	HTMLElement \| jQuery	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.
area	String	The area to which the prepared cell belongs.
cellElement	HTMLElement \| jQuery	The prepared cell's container. It is an HTML Element or a jQuery Element when you use jQuery.
cell	PivotGrid Cell	The cell properties.
rowIndex	Number	The position of a cell's row.
columnIndex	Number	The position of a cell's column.

Main article: onCellPrepared

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

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.

contextMenuPreparing

Raised before the context menu is rendered.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PivotGrid	The widget's instance.
element	HTMLElement \| jQuery	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.
items	Array<Object>	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's type.
cell	PivotGrid Cell	The cell that has been clicked to invoke the context menu. Unavailable for fields in the field panel.
cellElement	HTMLElement \| jQuery	The clicked cell's container. It is an HTML Element or a jQuery Element when you use jQuery. Unavailable for fields in the field panel.
columnIndex	Number	The index of the column to which the clicked cell belongs. Unavailable for fields in the field panel.
rowIndex	Number	The index of the row to which the clicked cell belongs. Unavailable for fields in the field panel.
dataFields	Array<PivotGrid Field>	Fields in the "data" area.
rowFields	Array<PivotGrid Field>	Fields in the "row" area.
columnFields	Array<PivotGrid Field>	Fields in the "column" area.
field	PivotGrid Field	This field's configuration. Available for fields in the field panel only.

Main article: onContextMenuPreparing

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

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

exported

Raised after data is exported.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

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

exporting

Raised before data is exported.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PivotGrid	The widget's instance.
element	HTMLElement \| jQuery	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.
fileName	String	The name of the file to which data is about to be exported.
cancel	Boolean	Allows you to cancel exporting.

Main article: onExporting

fileSaving

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

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	PivotGrid	The widget's instance.
element	HTMLElement \| jQuery	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 the file to be saved. Equals "EXCEL" for an Excel file.
data	BLOB	Exported data as a BLOB.
cancel	Boolean	Allows you to cancel file saving.

Main article: onFileSaving

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:

e:

Information about the event.

Object structure:

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

optionChanged

Raised after a widget option is changed.

Type:

Event

Function parameters:

e: