PivotActionBeginEventArgs API in Vue Pivot Table API component

The action begins event arguments provide information about the current UI action, such as the action name, current datasource settings, and the selected field information which are configured based on the UI actions like drill down/up, value sorting, built-in toolbar options, grouping bar and field list buttons actions such as sorting, filtering, editing, aggregate type change and so on, CRUD operation in editing in the Pivot Table.

Properties

actionName

string

Defines name of the current UI action when it begins. The following are the UI actions and their names: Pivot Table

• Drill down and drill up - Drill down/up.
• Value sorting - Sort value.

Toolbar

• New report - Add new report.
• Save report - Save current report.
• Save as report - Save as current report.
• Rename report - Rename current report.
• Remove report - Remove current report.
• Load report - Load report.
• Conditional Formatting - Open conditional formatting dialog.
• Number Formatting - Open number formatting dialog.
• Show Fieldlist - Open field list.
• Show Table - Show table view.
• Chart menu - Show chart view.
• Export menu - PDF/Excel/CSV export.
• Sub-totals menu - Show/hide sub-totals.
• Grand totals menu - Show/hide grand totals.
• MDX - Open MDX dialog.

Grouping bar and Field List buttons

• Editing - Edit calculated field.
• Remove - Remove field.
• Sorting - Sort field.
• Filtering - Filter field.
• Aggregation - Aggregate field.

Field List UI

• Field list tree - Sort field tree.
• Calculated field button - Open calculated field dialog.

Editing

• Edit - Edit record.
• Save - Save edited records.
• Add - Add new record.
• Delete - Remove record.

cancel

boolean

Allow to restrict the current UI action.

dataSourceSettings

IDataOptions

Defines the current data source settings information such as rows, columns, values, filters, etc., that are used to render the pivot table and field list.

fieldInfo

FieldItemInfo

Defines the current field information on which field the action takes.

This option is applicable only when the field-based UI actions are performed such as filtering, sorting, field remove, editing and aggregation change.