TableLayout

View as Markdown

A table layout.

TableColumns is required and is the column order. Row groups use RowGroupedColumns. Aggregations in grouped rows use TableAggregationColumns. Leave PivotColumns, PivotGroupedColumns, PivotExpandLevel and PivotAggregationColumns unset.

TypeScript
export interface TableLayout extends
Extends

LayoutBase

Properties

PropertyTypeDescription
ColumnVisibilityColumnBooleanFalseMapColumns to hide. Each entry is a column id set to false. Columns absent from the map stay visible.
RowGroupedColumnsstring[]Columns which are row-grouped when the Layout is applied
RowSummariesRowSummary[]Pinned Rows that display Aggregation Info for a whole Column
TableAggregationColumnsTableAggregationColumnsColumns showing aggregated values in Grouped Rows; a record of ColumnId and aggfunc (e.g. sum) or 'true' (to use default aggfunc)
TableColumnsstring[]Column ids in this layout, in display order. Required.
IsReadOnlybooleanSets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')

Property Details

ColumnVisibility

Columns to hide. Each entry is a column id set to false. Columns absent from the map stay visible.

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

Column ids in this layout, in display order. Required.

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