Pivot Layout Technical Reference

Layout State

Layout State contains a collection of Layouts and the Current Layout:

Property	Type	Description
CurrentLayout	string	Layout to be loaded when AdapTable starts (using Name property in Layout); if not provided the first Layout is used
Layouts	LayoutArray	Collection of Layouts - can be Table or Pivot

Base Layout Object

Pivot Layouts derive from the LayoutBase object defined as follows:

Property	Type	Description
AutoSizeColumns	boolean	Whether Columns should autosize when Layout first loads
ColumnFilters	ColumnFilter[]	Collection of Column Filters to apply in Layout
ColumnGroupValues	ColumnGroupValues	Defines which Column Groups are expanded / collapsed
ColumnHeaders	ColumnStringMap	Set of custom header names for some (or all) Columns
ColumnPinning	ColumnDirectionMap	Details of which Columns are pinned
ColumnSizing	ColumnSizingMap	Controls size (width or flex & min/max) for Columns
ColumnSorts	ColumnSort[]	Sorting to apply in the Layout
GrandTotalRow	'top' | 'bottom' | 'pinnedTop' | 'pinnedBottom' | boolean	Position of the Grand Total Row in the Layout
GridFilter	GridFilter	Grid Filter to apply in Layout
Name	string	Name of the Layout as it appears in the Layout toolbar and tool panel
OpenCharts	LayoutOpenChart[]	AG Grid charts to open when this layout is selected (by chart UUID or name)
RowGroupDisplayType	RowGroupDisplayType
RowGroupValues	RowGroupValues	Defines which Row Groups are expanded / collapsed
RowSelection	LayoutRowSelection | false	Defines Row Selection behaviour for Layout; if false, Row Selection is disabled; if undefined, GridOptions is used
SuppressAggFuncInHeader	boolean	Hides the aggFunc in Column header: e.g. 'sum(Price)' becomes 'Price'
IsReadOnly	boolean	Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

Pivot Layout Object

The Pivot Layout additionally has:

Property	Type	Description
PivotAggregationColumns	PivotAggregationColumns	Columns showing aggregated values in Group Rows; 1st value in record is Column name, 2nd is either aggfunc (e.g. sum, avg etc.) or 'true' (to use default aggfunc)
PivotColumns	string[]	Mandatory list of Columns to pivot (provide empty array if just displaying Aggregations)
PivotColumnTotal	PivotTotalPosition	Display automatically calculated Totals within EACH Pivot Column Group, in the position specified
PivotExpandLevel	number	How deep to expand Pivot Columns (0 for none, 1 for 1st level only etc, -1 to expand all)
PivotGrandTotal	PivotTotalPosition	Display automatically calculated Totals of all Pivot Columns, in the position specified
PivotGroupedColumns	string[]	Columns which are row-grouped when the Layout is applied
PivotResultColumnsOrder	string[] | boolean	Ordered list of Pivot Result Columns; set to true to track current display order, or provide custom list
IsReadOnly	boolean	Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

Column Filter

The ColumnFilters property is a collection of ColumnFilter objects defined as follows:

Property	Type	Description	Default
ColumnId	string	Column where Filter should be applied
Predicates	ColumnFilterPredicate[]	AdaptablePredicate which AdaptableQL will evaluate when the Filter is run
PredicatesOperator	PredicatesOperator	Logic used when combining multiple Predicates ('AND'|'OR')	'AND'
IsReadOnly	boolean	Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsSuspended	boolean	Suspends (i.e. turns off) an Adaptable Object

Grid Filter

The GridFilter object is defined as follows:

Property	Type	Description
Expression	string	The (boolean) Expression to run
IsReadOnly	boolean	Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsSuspended	boolean	Suspends (i.e. turns off) an Adaptable Object

Column Sort

The ColumnSort object used for sorting is defined as follows:

Property	Type	Description
ColumnId	string	Id of Column being sorted
SortOrder	'Asc' | 'Desc'	How Column is sorted - either 'Asc' or 'Desc'

Row Selection

The LayoutRowSelection object used for row selection is defined as follows:

Property	Type	Description	Default
Checkboxes	boolean	Whether to display checkboxes in Selection Column	true
CheckboxInGroupColumn	boolean	Renders selection checkboxes in Auto-Group Column (if true) or in dedicated Selection Column (if false)	false
EnableClickSelection	boolean | 'enableDeselection' | 'enableSelection'	Selection behaviour when clicking a row: 'enableSelection' | 'enableDeselection' | true | false	false
GroupSelectMode	GroupSelectionMode	Grouping Select Mode: 'self' | 'descendants' | 'filteredDescendants'	'self'
HeaderCheckbox	boolean	Whether to show checkbox in Header of Selection Column Header ('multiRow' only)	true
Mode	'singleRow' | 'multiRow'	Row Selection Mode: 'singleRow' or 'multiRow'
SelectAllMode	SelectAllMode	Select All Mode: 'all' | 'filtered' | 'currentPage'	'all'

Other Pivot Layout Properties

Property	Type
ColumnPinning	ColumnDirectionMap
ColumnSizing	ColumnSizingMap
ColumnHeaders	ColumnStringMap
RowGroupValues	RowGroupValues
ColumnGroupValues	ColumnGroupValues