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

All 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')

Table Layout Object

The Table Layout additionally includes these properties:

Property	Type	Description
ColumnVisibility	ColumnBooleanFalseMap	Map of Table Column Visibility
RowGroupedColumns	string[]	Columns which are row-grouped when the Layout is applied
RowSummaries	RowSummary[]	Pinned Rows that display Aggregation Info for a whole Column
TableAggregationColumns	TableAggregationColumns	Columns showing aggregated values in Grouped Rows; a record of ColumnId and aggfunc (e.g. sum) or 'true' (to use default aggfunc)
TableColumns	string[]	List of Column Ids to include in Table Layout
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 Layout Properties

Property	Type
ColumnPinning	ColumnDirectionMap
ColumnSizing	ColumnSizingMap
ColumnVisibility (Table Layout only)	ColumnBooleanFalseMap
ColumnHeaders	ColumnStringMap
RowGroupValues	RowGroupValues
ColumnGroupValues	ColumnGroupValues

---

Layout Options

The Layout Options section of Adaptable Options contains Layout-related configuration properties:

Property	Type	Description
layoutCreationDefaultProperties	LayoutCreationDefaultProperties| ((context:LayoutCreationDefaultPropertiesContext) =>TableLayoutCreationDefaultProperties|PivotLayoutCreationDefaultProperties)	Default properties to apply when creating a new Layout (Table or Pivot)
layoutTagOptions	LayoutTagOptions	Set of options for leveraging Object Tags to extend Layouts
layoutViewOptions	LayoutViewOptions	Set of options for how Layouts are displayed in Settings Panel
pivotPreviewColumns	string[] | ((context:PivotPreviewColumnsContext) => string[])	Columns to display in Table that opens when viewing Pivot Cell contents

Layout View Options

Layout View Options is used to configure how Layouts are viewed in the Settings Panel:

Property	Type	Description	Default
maxColumnsToDisplay	number	How many Column Names to display in inline Layout preview	10

Layout Tag Options

Layout Tag Options contains properties used when Extending Layouts:

Property	Type	Description	Default
autoCheckTagsForLayouts	boolean	Automatically assumes that any LayoutExtensionObject is available in the current Layout if it has a tag with the Layouts name (or no tags at all)	false
autoGenerateTagsForLayouts	boolean | ((context:AutoGenerateTagsForLayoutsContext) =>AdaptableObjectTag[])	Automatically generate an AdaptableObjectTag for each Layout	false
isObjectExtendedInLayout	(layoutExtendedContext:LayoutExtendedContext) => boolean	Checks if provided Adaptable Object is extended in given Layout

---

Layout API

Full programmatic access to Layouts and related features is available in Layout API section of Adaptable API .

This enables Layouts to be accessed, created, edited, cloned, deleted and shared programmatically.

Method	Returns	Description
addColumnToCurrentLayout(columnId)	void	Adds a Column to Current Table or Pivot Layout
cloneAndSetLayout(layoutToClone, layoutName)	Layout | false	Creates new Layout by cloning a given Layout and then loads it into Grid
cloneExtendedLayout(extendedLayoutToClone, layoutName)	ExtendedLayout | false	Clones an Extended Layout
cloneLayout(layoutToClone, layoutName)	Layout | false	Creates new Layout by cloning a given Layout
createAndSetLayout(layoutToCreate)	Layout | false	Creates new Layout and loads it into Grid
createLayout(layoutToCreate)	Layout | false	Creates a new Layout
createOrUpdateExtendedLayout(extendedLayout)	void	Creates (or Updates) an Extended Layout
createOrUpdateLayout(layout)	void	Creates new Layout into Adaptable State or updates an existing Layout (with same name or id)
deleteLayout(layout)	void	Deletes an existing Layout (if not Default or only existing Layout)
deleteLayoutByName(layoutName)	void	Deletes an existing Layout provided by Name (if not Default or only existing Layout)
doesLayoutExist(layout)	boolean	Checks whether this Layout exists in the Adaptable State (by comparing Uuid property)
getCurrentLayout()	Layout	Retrieves Current Layout from Layout State
getCurrentLayoutColumnSort(columnId)	ColumnSort['SortOrder'] | null	Retrieves the sort order of a column from the current layout
getCurrentLayoutName()	string	Retrieves name of current Layout
getCurrentRowGroupsColumnIds()	string[]	Retrieves array of visible ColumnIds in current Layout
getCurrentVisibleColumnIdsForPivotLayout()	string[]	Retrieves array of visible ColumnIds in current Pivot Layout
getCurrentVisibleColumnIdsForTableLayout()	string[]	Retrieves array of visible ColumnIds in current Table Layout
getCurrentVisibleColumnIdsMapForTableLayout()	\{ [key: string]: boolean; \}	Retrieves map with visible columns in current Table Layout
getExtendedLayoutByName(layoutName)	ExtendedLayout | undefined	Retrieves Layout with the given name
getLayoutById(id)	Layout	Retrieves Layout by by the technical ID (from LayoutState)
getLayoutByName(layoutName)	Layout | null	Retrieves Layout with the given name
getLayouts()	Layout[]	Retrieves all Layouts in Adaptable State
getLayoutState()	LayoutState	Retrieves Layout section from Adaptable State
isCurrentLayoutPivot()	boolean	Returns true if current Layout is a Pivot Layout
openLayoutSettingsPanel()	void	Opens Settings Panel with Layout section selected
removeColumnFromCurrentLayout(columnId)	void	Removes a Column from Current Table or Pivot Layout
saveCurrentLayout()	void	Saves current Layout - using column order, visibility, sorting etc. currently in use in the grid
setColumnCaption(columnId, caption)	void	Sets a new Caption / Header for a Column (only for current Layout)
setExtendedLayout(extendedLayout)	void	Sets (i.e. selects) the Extended Layout
setLayout(layoutName)	void	Sets (i.e. selects) the Layout
showChangeColumnCaption(column)	void	Opens Change Column Caption popup
showLayoutEditor(layoutName, layoutType, action)	void	Opens Layout Editor - for Current or a named Layout
updateCurrentLayout(updateFn)	void	Updates current Layout using the partial Layout props provided in a function