Search results

CellEditSettings API in React Pivot Grid API component

Allow options for performing CRUD operations, such as add, edit, delete, and update the raw items of any cell from the pivot table. The raw items can be viewed in a data grid that used to be displayed as a dialog by double-clicking the appropriate value cell in the pivot table. CRUD operations can be performed in this data grid either by double-clicking the cells or using toolbar options. The options available are as follows:

  • allowAdding: Allows you to add a new record to the data grid used to update the appropriate cells in the pivot table.
  • allowEditing: Allows you to edit the existing record in the data grid that used to update the appropriate cells in the pivot table.
  • allowDeleting: Allows you to delete the existing record from the data grid that used to update the appropriate cells in the pivot table.
  • allowCommandColumns: Allows an additional column appended in the data grid layout holds the command buttons to perform the CRUD operations to edit, delete, and update the raw items to the data grid that used to update the appropriate cells in the pivot table.
  • mode: Allow options for performing CRUD operations with different modes in the data grid that used to update the appropriate cells in the pivot table. The available modes are normal, batch and dialog. Normal mode is enabled for CRUD operations in the data grid by default.
  • allowEditOnDblClick: Allows you to restrict CRUD operations by double-clicking the appropriate value cell in the pivot table.
  • showConfirmDialog: Allows you to show the confirmation dialog to save and discard CRUD operations performed in the data grid that used to update the appropriate cells in the pivot table.
  • showDeleteConfirmDialog: Allows you to show the confirmation dialog to delete any records from the data grid.

    This feature is applicable only for the relational data source.

Properties

allowAdding

boolean

Allows you to add a new record to the data grid used to update the appropriate cells in the pivot table.

Defaults to false

allowCommandColumns

boolean

Allows an additional column appended in the data grid layout holds the command buttons to perform the CRUD operations to edit, delete, and update the raw items to the data grid that used to update the appropriate cells in the pivot table.

Defaults to false

allowDeleting

boolean

Allows you to delete the existing record from the data grid that used to update the appropriate cells in the pivot table.

Defaults to false

allowEditOnDblClick

boolean

Allows you to restrict CRUD operations by double-clicking the appropriate value cell in the pivot table.

Defaults to true

allowEditing

boolean

Allows you to edit the existing record in the data grid that used to update the appropriate cells in the pivot table.

Defaults to false

allowInlineEditing

boolean

Allows direct editing of a value cell without opening the edit dialog. NOTE: It is applicable only if the value cell is made by a single raw data. Otherwise editing dialog will be shown.

The allowInlineEditing property supports all modes of editing.

Defaults to false

mode

string

Allow options for performing CRUD operations with different modes in the data grid that used to update the appropriate cells in the pivot table. The available modes are as follows:

  • Normal: Allows the currently selected row alone will be completely changed to edit state. You can change the cell values and save it to the data source by clicking “Update” toolbar button.
  • Dialog: Allows the currently selected row data will be shown in an exclusive dialog. You can change the cell values and save it to the data source by clicking “Save” button in the dialog.
  • Batch: Allows you to perform double-click on any data specific cell in the data grid, the state of that selected cell will be changed to edit state. You can perform bulk changes like add, edit and delete data of the cells and finally save to the data source by clicking “Update” toolbar button.

    Normal mode is enabled for CRUD operations in the data grid by default.

Defaults to Normal

showConfirmDialog

boolean

Allows you to show a confirmation dialog to save and discard CRUD operations performed in the data grid that used to update the appropriate cells in the pivot table.

To use this option, it requires the property mode to be Batch, meaning, the showConfirmDialog option is only applicable for batch edit mode.

Defaults to true

showDeleteConfirmDialog

boolean

Allows you to show the confirmation dialog to delete any records from the data grid.

The showDeleteConfirmDialog property supports all modes of editing.

Defaults to false