Angular PivotGrid Events

This section describes events fired by this widget.

cellClick

Fires when a user clicks a pivot grid cell.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	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.

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.

cellPrepared

Fires after a cell has been rendered.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	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.

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.

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name

Type

Description

component

Object

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 when using Knockout.

Main article: onContentReady.

contextMenuPreparing

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

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	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.

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.

disposing

Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name

Type

Description

component

Object

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 you use Knockout.

exported

Fires after the exporting of grid data is completed.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name

Type

Description

component

Object

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.

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

exporting

Fires before exporting grid data.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	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.

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

fileSaving

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

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name	Type	Description
component	Object	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.

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

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:

e:

Object

Information about the event.

Object structure:

Name

Type

Description

component

Object

The widget's instance.

element

HTMLElement | jQuery

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:

Object

Information about the event.

Object structure:

Name	Type	Description
name	String	The option's short name.
model	Object	The model data. Available only if you use Knockout.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Object	The widget's instance.
fullName	String	The option's full name.
value	any	The option's new value.

Angular PivotGrid Events

See Also

cellClick

See Also

cellPrepared

See Also

contentReady

See Also

contextMenuPreparing

See Also

disposing

See Also

exported

See Also

exporting

See Also

fileSaving

See Also

initialized

See Also

optionChanged

See Also