Pivot Layout Wizard

Summary

  • The Layout Wizard provides full run-time ability for creating and editing Pivot Layouts

The Pivot Layout Wizard enables run-time users to create and edit Pivot Layouts (if their Entitlements allow).

It leverages the AdapTable Wizard to provide full run-time control to users.

UI Step by Step Guide

Creating and Editing Pivot Layouts in the Layout Wizard

These are the steps required in the Layout Wizard to create a Pivot Layout

1
Layout Settings

This step is used to set the mandatory Name property - how the Layout will be referenced in the dropdowns in Toolbar, ToolPanel and StatusBar.

Hint

The Name needs to be unique but also ideally easy to identify

The wizard will automatically set the Grid Type radio button to Pivot

2
Create Row Groups

Select which Columns should be Row Grouped in the Pivot Layout.

Drag to set the order of the Row Grouping.

Caution

Only Groupable Columns with enableRowGroup set to true in the Grid Options definition are listed

3
Set Pivot Columns

Configure the Pivot Columns:

  • Select Pivot Column visibility by clicking the checkbox next to the Column name
  • Set Pivot Column order by dragging Columns up and down (using dotted icon)

AG Grid will dynamically create a column for each unique value in the Pivot Column.

Caution

Only Pivotable Columns are displayed (where enableValue is set to true in the AG Grid Column definition)

4
Set Pivot Aggregations

Configure which Columns in the Pivot Layout will display aggregations

Check the checkbox to set visibility and drag the item to set order.

Caution

Only Aggregatable Columns with enableValue set to true in the Grid Options definition are listed

5
Specify any Column Sorts

Select which Columns will have Column Sorts applied to them.

Click the sorting icon to select ascending or descending sort order.

Hint

If you have set a Custom Sort for that Column, AdapTable will use that automatically

6
Set Filters

Define which Filters should be applied to the Layout. These can be:

  • Column Filters
  • the Grid Filter

Hint

This is particularly useful if you wish to define filtering for a Layout which is not currently selected

Note

The final stage of the Wizard displays a Summary of all that was chosen in the above steps

FAQ

I do not see any Columns I can pivot on in Pivot Columns section of Layout Wizard? AdapTable follows the same rules as AG Grid for what can be set as Pivotable in the UI. This is any Column where enableValue is set to true in the Column's definition in AG Grid GridOptions.