GroupingBarSettings

16 Mar 20263 minutes to read

Allows a set of options for customizing the grouping bar UI with a variety of settings such as UI visibility to a specific view port,
customizing the pivot button features such as filtering, sorting, changing aggregate types, removing any fields.
The options available to customize the grouping bar UI are:

• showFilterIcon: Allows to show or hide the filter icon that used to be displayed on the pivot button of the grouping bar UI.
  This filter icon is used to filter the members of a particular field at runtime in the pivot table.
• showSortIcon: Allows to show or hide the sort icon that used to be displayed in the pivot button of the grouping bar UI.
  This sort icon is used to order members of a particular fields either in ascending or descending at runtime.
• showRemoveIcon: Allows to show or hide the remove icon that used to be displayed in the pivot button of the grouping bar UI.
  This remove icon is used to remove any field during runtime.
• showValueTypeIcon: Allows to show or hide the value type icon that used to be displayed in the pivot button of the grouping bar UI.
  This value type icon helps to select the appropriate aggregation type to value fields at runtime.
• displayMode: Allow options to show the grouping bar UI to specific view port such as either pivot table or pivot chart or both table and chart.
  For example, to show the grouping bar UI to pivot table on its own, set the property displayMode to Table.
• allowDragAndDrop: Allows to restrict the pivot buttons that were used to drag on runtime in the grouping bar UI. This will prevent modifying the current report.
  Learn more about the grouping bar feature in Pivot Table.

Properties

allowDragAndDrop boolean

Allows to restrict the pivot buttons that were used to drag on runtime in the Grouping Bar UI.
This will prevent modifying the current report.

By default, all fields are available for drag-and-drop operation in the Grouping Bar.

Defaults to true

displayMode View

Allow options to show the Grouping Bar UI to specific view port such as either pivot table or pivot chart or both table and chart.
For example, to show the Grouping Bar UI to pivot table on its own, set the property displayMode to Table.

By default, the Grouping Bar UI will be shown to both pivot table as well as pivot chart.

Defaults to Both

showFieldsPanel boolean

Allows to show an additional UI along with the Grouping Bar UI, which contains the fields that aren’t bound in the current report.
It allows modifying the report by re-arranging the pivot buttons through drag-and-drop operation between axes (row, column, value and filter)
that are used to update the pivot table during runtime.

This property is applicable only for relational data source.

Defaults to false

showFilterIcon boolean

Allows to show or hide the filter icon that used to be displayed on the pivot button of the Grouping Bar UI.
This filter icon is used to filter the members of a particular field at runtime in the pivot table.

By default, the filter icon is enabled in the Grouping Bar.

Defaults to true

showRemoveIcon boolean

Allows to show or hide the remove icon that used to be displayed in the pivot button of the Grouping Bar UI. This remove icon is used to remove any field during runtime.

By default, the remove icon is enabled in the Grouping Bar.

Defaults to true

showSortIcon boolean

Allows to show or hide the sort icon that used to be displayed in the pivot button of the Grouping Bar UI.
This sort icon is used to order members of a particular fields either in ascending or descending at runtime.

By default, the sort icon is enabled in the Grouping Bar.

Defaults to true

showValueTypeIcon boolean

Allows to show or hide the value type icon that used to be displayed in the pivot button of the Grouping Bar UI.
This value type icon helps to select the appropriate aggregation type to value fields at runtime.

By default, the icon to set aggregate types is enabled in the Grouping Bar.

Defaults to true