TableLayout
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.
export interface TableLayout extendsExtends
Properties
| Property | Type | Description |
|---|---|---|
| ColumnVisibility | ColumnBooleanFalseMap | Columns to hide. Each entry is a column id set to false. Columns absent from the map stay visible. |
| 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[] | Column ids in this layout, in display order. Required. |
| IsReadOnly | boolean | Sets 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.
ColumnVisibility?: ColumnBooleanFalseMap;Property Value
RowGroupedColumns
Columns which are row-grouped when the Layout is applied
RowGroupedColumns?: string[];Property Value
string[]
RowSummaries
Pinned Rows that display Aggregation Info for a whole Column
RowSummaries?: RowSummary[];Property Value
TableAggregationColumns
Columns showing aggregated values in Grouped Rows; a record of ColumnId and aggfunc (e.g. sum) or 'true' (to use default aggfunc)
TableAggregationColumns?: TableAggregationColumns;Property Value
TableColumns
Column ids in this layout, in display order. Required.
TableColumns: string[];Property Value
string[]
IsReadOnly
Inherited from AdaptableObject
Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
IsReadOnly?: boolean;Property Value
boolean