Defines a Table-based Layout

TypeScript
export interface TableLayout extends
Extends

LayoutBase

Properties

PropertyDescription
ColumnVisibilityMap of Table Column Visibility
RowGroupedColumnsColumns which are row-grouped when the Layout is applied
RowSummariesPinned Rows that display Aggregation Info for a whole Column
TableAggregationColumnsColumns showing aggregated values in Grouped Rows; a record of ColumnId and aggfunc (e.g. sum) or 'true' (to use default aggfunc)
TableColumnsList of Column Ids to include in Table Layout
IsReadOnlySets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

Property Details

ColumnVisibility

Map of Table Column Visibility

TypeScript
ColumnVisibility?: ColumnBooleanFalseMap;
Property Value

ColumnBooleanFalseMap

RowGroupedColumns

Columns which are row-grouped when the Layout is applied

TypeScript
RowGroupedColumns?: string[];
Property Value

string[]

RowSummaries

Pinned Rows that display Aggregation Info for a whole Column

TypeScript
RowSummaries?: RowSummary[];
Property Value

RowSummary[]

TableAggregationColumns

Columns showing aggregated values in Grouped Rows; a record of ColumnId and aggfunc (e.g. sum) or 'true' (to use default aggfunc)

TypeScript
TableAggregationColumns?: TableAggregationColumns;
Property Value

TableAggregationColumns

TableColumns

List of Column Ids to include in Table Layout

TypeScript
TableColumns: string[];
Property Value

string[]

IsReadOnly

Inherited from AdaptableObject

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

TypeScript
IsReadOnly?: boolean;
Property Value

boolean