Search results

PivotSelectionSettings API in React Pivot Grid API component

Interface for a class SelectionSettings

Properties

cellSelectionMode

string

Allow options to customize the mode of selection to highlight either row wise or column wise or specific cell in the pivot table. For example, to apply the selection that includes in between cells of rows within the range, set the property cellSelectionMode to Box. The modes available are:

  • Flow: Allows the range of cells to be selected between the start index and the end index, which also includes the other cells of the selected rows in the pivot table.
  • Box: Allows you to select a range of cells within the starting and ending column indexes that are included in the range between row cells in the pivot table.
  • BoxWithBorder: Allows the range of cells to be selected as the box mode, but along with the borders in the pivot table.

Defaults to Flow

checkboxMode

CheckboxSelectionType

Allow options to customize the checkbox selection mode in the pivot table. For example, to select multiple rows one by one through simple clicking on rows, set the property checkboxMode to Default. The modes available are:

  • Default: Allows multiple rows to be selected by clicking rows one by one.
  • ResetOnRowClick: Allows you to reset the previously selected row while clicking on a specific row. You can also select multiple rows by clicking on rows along with the CTRL or SHIFT key in the pivot table.

Defaults to Default

checkboxOnly

boolean

Allows the selection options to highlight the rows in the pivot table using checkbox selection on their own.

To enable checkboxOnly selection, should specify the column type as checkbox.

Defaults to false

enableSimpleMultiRowSelection

boolean

Allows to perform multiple selection in rows with single clicks without using SHIFT or CTRL keys.

Defaults to false

mode

string

Allow options to highlight either row wise or column wise or specific cells in the pivot table. For expample, to highlight the columns, set the property mode to Column. The modes available are:

  • Cell: Allows specific cells to be highlighted in the pivot table.
  • Row: Allows the rows to be highlighted in the pivot table.
  • Column: Allows the columns to be highlighted in the pivot table.
  • Both: Allows both rows, columns and cells to be highlighted in the pivot table.

Defaults to Row

persistSelection

boolean

Allows you to keep selections in rows or columns or cells while performing all operations in the pivot table.

For persisting selection, any one of the column should be enabled as a primary key using the columns.isPrimaryKey property in the grid instance.

Defaults to false

type

SelectionType

Allow options to customize the selection type to highlight either row wise or column wise or specific cell in the pivot table. For example, to highlight multiple rows or columns or cells, set the property type to Multiple. The types available are:

  • Single: Allows the user to select a row or cell on their own in the pivot table.
  • Multiple: Allows the user to select multiple rows or columns or cells in the pivot table.

Defaults to Single