LayoutBase

TypeScript

export interface LayoutBase extends

Extends

AdaptableObject

Properties

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

Property Details

AutoSizeColumns

Whether Columns should autosize when Layout first loads

TypeScript

AutoSizeColumns?: boolean;

Property Value

boolean

ColumnFilters

Collection of Column Filters to apply in Layout

TypeScript

ColumnFilters?: ColumnFilter[];

Property Value

ColumnFilter[]

ColumnGroupValues

Defines which Column Groups are expanded / collapsed

TypeScript

ColumnGroupValues?: ColumnGroupValues;

Property Value

ColumnGroupValues

ColumnHeaders

Set of custom header names for some (or all) Columns

TypeScript

ColumnHeaders?: ColumnStringMap;

Property Value

ColumnStringMap

ColumnPinning

Details of which Columns are pinned

TypeScript

ColumnPinning?: ColumnDirectionMap;

Property Value

ColumnDirectionMap

ColumnSizing

Controls size (width or flex & min/max) for Columns

TypeScript

ColumnSizing?: ColumnSizingMap;

Property Value

ColumnSizingMap

ColumnSorts

Sorting to apply in the Layout

TypeScript

ColumnSorts?: ColumnSort[];

Property Value

ColumnSort[]

GrandTotalRow

Position of the Grand Total Row in the Layout

TypeScript

GrandTotalRow?: 'top' | 'bottom' | 'pinnedTop' | 'pinnedBottom' | boolean;

Property Value

'top' | 'bottom' | 'pinnedTop' | 'pinnedBottom' | boolean

GridFilter

Grid Filter to apply in Layout

TypeScript

GridFilter?: GridFilter;

Property Value

GridFilter

Name

Name of the Layout as it appears in the Layout toolbar and tool panel

TypeScript

Name: string;

Property Value

string

OpenCharts

AG Grid charts to open when this layout is selected (by chart UUID or name)

TypeScript

OpenCharts?: LayoutOpenChart[];

Property Value

LayoutOpenChart[]

RowGroupDisplayType

TypeScript

RowGroupDisplayType?: RowGroupDisplayType;

Property Value

RowGroupDisplayType

RowGroupValues

Defines which Row Groups are expanded / collapsed

TypeScript

RowGroupValues?: RowGroupValues;

Property Value

RowGroupValues

RowSelection

Defines Row Selection behaviour for Layout; if false, Row Selection is disabled; if undefined, GridOptions is used

TypeScript

RowSelection?: LayoutRowSelection | false;

Property Value

LayoutRowSelection | false

SuppressAggFuncInHeader

Hides the aggFunc in Column header: e.g. 'sum(Price)' becomes 'Price'

TypeScript

SuppressAggFuncInHeader?: boolean;

Property Value

boolean

IsReadOnly

Inherited from AdaptableObject

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

TypeScript

IsReadOnly?: boolean;

Property Value

boolean

PreviousLayoutArray NextLayoutChangedAction