# TableLayout

Canonical page: https://www.adaptabletools.com/docs/reference/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.

```ts title="TypeScript"
export interface TableLayout extends LayoutBase 
```

###### Extends

[`LayoutBase`](https://www.adaptabletools.com/docs/reference/layoutbase.md)

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [ColumnVisibility](https://www.adaptabletools.com/docs/reference/tablelayout.md#columnvisibility) | [`ColumnBooleanFalseMap`](https://www.adaptabletools.com/docs/reference/columnbooleanfalsemap.md) | Columns to hide. Each entry is a column id set to `false`. Columns absent from the map stay visible. |
| [RowGroupedColumns](https://www.adaptabletools.com/docs/reference/tablelayout.md#rowgroupedcolumns) | `string[]` | Columns which are row-grouped when the Layout is applied |
| [RowSummaries](https://www.adaptabletools.com/docs/reference/tablelayout.md#rowsummaries) | [`RowSummary`](https://www.adaptabletools.com/docs/reference/rowsummary.md)`[]` | Pinned Rows that display Aggregation Info for a whole Column |
| [TableAggregationColumns](https://www.adaptabletools.com/docs/reference/tablelayout.md#tableaggregationcolumns) | [`TableAggregationColumns`](https://www.adaptabletools.com/docs/reference/tableaggregationcolumns.md) | Columns showing aggregated values in Grouped Rows; a record of ColumnId and aggfunc (e.g. sum) or &#39;true&#39; (to use default aggfunc) |
| [TableColumns](https://www.adaptabletools.com/docs/reference/tablelayout.md#tablecolumns) | `string[]` | Column ids in this layout, in display order. Required. |
| [IsReadOnly](https://www.adaptabletools.com/docs/reference/tablelayout.md#isreadonly) | `boolean` | Sets Entity to ReadOnly (overwriting a Strategy Entitlement of &#39;Full&#39;) |

## Property Details

### ColumnVisibility

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

```ts title="TypeScript"
ColumnVisibility?: ColumnBooleanFalseMap;
```

###### Property Value

[`ColumnBooleanFalseMap`](https://www.adaptabletools.com/docs/reference/columnbooleanfalsemap.md)

### RowGroupedColumns

Columns which are row-grouped when the Layout is applied

```ts title="TypeScript"
RowGroupedColumns?: string[];
```

###### Property Value

`string[]`

### RowSummaries

Pinned Rows that display Aggregation Info for a whole Column

```ts title="TypeScript"
RowSummaries?: RowSummary[];
```

###### Property Value

[`RowSummary`](https://www.adaptabletools.com/docs/reference/rowsummary.md)`[]`

### TableAggregationColumns

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

```ts title="TypeScript"
TableAggregationColumns?: TableAggregationColumns;
```

###### Property Value

[`TableAggregationColumns`](https://www.adaptabletools.com/docs/reference/tableaggregationcolumns.md)

### TableColumns

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

```ts title="TypeScript"
TableColumns: string[];
```

###### Property Value

`string[]`

### IsReadOnly

> *Inherited from [AdaptableObject](https://www.adaptabletools.com/docs/reference/adaptableobject.md)*

Sets Entity to ReadOnly (overwriting a Strategy Entitlement of &#39;Full&#39;)

```ts title="TypeScript"
IsReadOnly?: boolean;
```

###### Property Value

`boolean`
