Tool Panel

The tool panel is where you can change the state of the columns. This includes show / hide, move and pivot (group).

The tool panel panel can be shown be default by setting 'showToolPanel=true' property, or after the grid is initialised by calling the api function showToolPanel(show). You can query if the tool panel is showing with the api isToolPanelShowing().

Suppress Values

If you don't want to show the values list in the tool panel, set toolPanelSuppressValues=true property. This is useful if you don't want aggregation, or you have provided your own aggregation function (which would then not use the values selected here).

Suppress Pivot

If you don't want to show the pivot, set toolPanelSuppressPivot=true property. This is used if you just want simple column visibility and reordering functionality in the tool panel. Note that hiding the pivot has the impact of also hiding the values, as it doesn't make sense to have values if you are not pivoting.

Tool Panel Actions

Show / Hide Columns

All columns are visible by default. To hide a column when first displaying the grid, mark the column definition with hide = true.

To hide a column using the tool panel, click the icon beside the columns name.

Reorder Columns

To reorder the groups (either the displayed groups, or the pivoted groups), drag the column to a new location in the list.

Pivot (group) by Columns

To pivot by a column, drag the column down to the pivot GUI. The order of the column in the pivot list can be changed by dragging, with the first value been the top most pivot group.

Aggregate Columns

To mark a column as a value (for aggregation), drag the column down to the value GUI. From here you can select the aggregation function (sum, min or max). This aggregation function will only work when you are using the default aggregation (ie you are not providing your own aggregation function).

Example

The example below shows the tool panel in action.