Events

This section describes events fired by this widget.

See Also

cellClick

Raised when a pivot grid cell is clicked or tapped.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

Element (jQuery or HTML)

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:

Element (jQuery or HTML)

The cell's container. It is an HTML Element or a jQuery Element when you use jQuery.

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

The jQuery event that caused the handler execution. Deprecated in favor of the event field.

event:

Event (jQuery or dxEvent)

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

See Also

cellPrepared

Raised after a pivot grid cell is created.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

Element (jQuery or HTML)

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:

Element (jQuery or HTML)

The prepared cell's container. It is an HTML Element or a jQuery Element when you use jQuery.

The cell properties.

rowIndex:

Number

The position of a cell's row.

columnIndex:

Number

The position of a cell's column.

Main article: onCellPrepared

See Also

contentReady

Raised when the widget's content is ready.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

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.

See Also

contextMenuPreparing

Raised before the context menu is rendered.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

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.

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

cellElement:

Element (jQuery or HTML)

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.

This field's configuration.
Available for fields in the field panel only.

Main article: onContextMenuPreparing

See Also

disposing

Raised before the widget is disposed of.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget instance.

element:

Element (jQuery or HTML)

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.

Main article: onDisposing

See Also

exported

Raised after data is exported.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

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.

Main article: onExported

See Also

exporting

Raised before data is exported.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

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

See Also

fileSaving

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

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

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

See Also

initialized

Raised only once, after the widget is initialized.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

element:

Element (jQuery or HTML)

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.

Type:

Event

Function parameters:
e:

Object

Information about the event.

Object structure:
component:

Object

The widget's instance.

name:

String

The option's short name.

fullName:

String

The option's full name.

value: any

The option's new value.

element:

Element (jQuery or HTML)

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.

Main article: onOptionChanged

See Also