LayoutBase
Base object for both Table and Pivot Layouts
export interface LayoutBase extendsExtends
Properties
| Property | Description |
|---|---|
| AutoSizeColumns | Whether Columns should autosize when Layout first loads |
| ColumnFilters | Collection of Column Filters to apply in Layout |
| ColumnGroupValues | Defines which Column Groups are expanded / collapsed |
| ColumnHeaders | Set of custom header names for some (or all) Columns |
| ColumnPinning | Details of which Columns are pinned |
| ColumnSizing | Controls size (width or flex & min/max) for Columns |
| ColumnSorts | Sorting to apply in the Layout |
| GrandTotalRow | Position of the Grand Total Row in the Layout |
| GridFilter | Grid Filter to apply in Layout |
| Name | Name of the Layout as it appears in the Layout toolbar and tool panel |
| RowGroupDisplayType | Display Row Grouped Columns as 'single' or 'multi' column |
| RowGroupValues | Defines which Row Groups are expanded / collapsed |
| SuppressAggFuncInHeader | Hides the aggFunc in Column header: e.g. 'sum(Price)' becomes 'Price' |
| IsReadOnly | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full') |
Property Details
AutoSizeColumns
Whether Columns should autosize when Layout first loads
AutoSizeColumns?: boolean;Property Value
boolean
ColumnFilters
Collection of Column Filters to apply in Layout
ColumnFilters?: ColumnFilter[];Property Value
ColumnGroupValues
Defines which Column Groups are expanded / collapsed
ColumnGroupValues?: ColumnGroupValues;Property Value
ColumnHeaders
Set of custom header names for some (or all) Columns
ColumnHeaders?: ColumnStringMap;Property Value
ColumnPinning
Details of which Columns are pinned
ColumnPinning?: ColumnDirectionMap;Property Value
ColumnSizing
Controls size (width or flex & min/max) for Columns
ColumnSizing?: ColumnSizingMap;Property Value
ColumnSorts
Sorting to apply in the Layout
ColumnSorts?: ColumnSort[];Property Value
GrandTotalRow
Position of the Grand Total Row in the Layout
GrandTotalRow?: 'top' | 'bottom' | 'pinnedTop' | 'pinnedBottom' | boolean;Property Value
'top' | 'bottom' | 'pinnedTop' | 'pinnedBottom' | boolean
GridFilter
Grid Filter to apply in Layout
GridFilter?: GridFilter;Property Value
Name
Name of the Layout as it appears in the Layout toolbar and tool panel
Name: string;Property Value
string
RowGroupDisplayType
Display Row Grouped Columns as 'single' or 'multi' column
RowGroupDisplayType?: 'single' | 'multi';Property Value
'single' | 'multi'
RowGroupValues
Defines which Row Groups are expanded / collapsed
RowGroupValues?: RowGroupValues;Property Value
SuppressAggFuncInHeader
Hides the aggFunc in Column header: e.g. 'sum(Price)' becomes 'Price'
SuppressAggFuncInHeader?: boolean;Property Value
boolean
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsReadOnly?: boolean;Property Value
boolean