# DashboardState

Canonical page: https://www.adaptabletools.com/docs/reference/dashboardstate

Dashboard section of Adaptable State, including Initial State.

The Dashboard sits above the grid. `Tabs` are named groups of toolbars (the default is an empty list). `PinnedToolbars` sit above the grid and are not inside a tab. `ActiveTabIndex` is the zero-based index of the open tab. `IsCollapsed` leaves the header visible and hides the tab contents. `IsFloating` shows a draggable dashboard; `FloatingPosition` is its pixel position. `IsHidden` removes it until it is shown again from the Column Menu or Tool Panel.

```ts title="TypeScript"
export interface DashboardState extends BaseState 
```

###### Extends

[`BaseState`](https://www.adaptabletools.com/docs/reference/basestate.md)

## Properties

| Property | Type | Description | Default |
| --- | --- | --- | --- |
| [ActiveTabIndex](https://www.adaptabletools.com/docs/reference/dashboardstate.md#activetabindex) | `number` | Zero-based index into `Tabs` of the tab that is open. |   |
| [DashboardTitle](https://www.adaptabletools.com/docs/reference/dashboardstate.md#dashboardtitle) | `string` | Title displayed in Dashboard Header | `adaptableId` in Adaptable Options |
| [FloatingPosition](https://www.adaptabletools.com/docs/reference/dashboardstate.md#floatingposition) | [`AdaptableCoordinate`](https://www.adaptabletools.com/docs/reference/adaptablecoordinate.md) | Pixel position of the Dashboard while `IsFloating` is true. `x` and `y` are offsets in pixels. |   |
| [IsCollapsed](https://www.adaptabletools.com/docs/reference/dashboardstate.md#iscollapsed) | `boolean` | Is Dashboard collapsed; if true, header is visible (but not Tabs&#39; contents) | false |
| [IsFloating](https://www.adaptabletools.com/docs/reference/dashboardstate.md#isfloating) | `boolean` | Is Dashboard floating; if true, it appears in a draggable form (double-click to revert to the default position) | false |
| [IsHidden](https://www.adaptabletools.com/docs/reference/dashboardstate.md#ishidden) | `boolean` | Whether Dashboard is completely hidden - can be made visible again in Column Menu and Tool Panel | false |
| [ModuleButtons](https://www.adaptabletools.com/docs/reference/dashboardstate.md#modulebuttons) | `AdaptableModuleButtons` | Module shortcut buttons in the Dashboard header (actions zone).<br/><br/>Opening the Settings Panel itself is handled by the fixed Home control (application icon or<br/>configuration icon) on the left of the Dashboard — do not include `'SettingsPanel'` here. | `[]` |
| [PinnedToolbars](https://www.adaptabletools.com/docs/reference/dashboardstate.md#pinnedtoolbars) | `AdaptableDashboardToolbars \| string[]` | Toolbars shown above the grid, outside any tab. |   |
| [Tabs](https://www.adaptabletools.com/docs/reference/dashboardstate.md#tabs) | [`DashboardTab`](https://www.adaptabletools.com/docs/reference/dashboardtab.md)`[]` | Named groups of toolbars. Each tab has a `Name` and the `Toolbars` it shows. | Empty Array |

## Property Details

### ActiveTabIndex

Zero-based index into `Tabs` of the tab that is open.

```ts title="TypeScript"
ActiveTabIndex?: number;
```

###### Property Value

`number`

### DashboardTitle

Title displayed in Dashboard Header

```ts title="TypeScript"
DashboardTitle?: string;
```

###### Default Value

`adaptableId` in Adaptable Options

###### Property Value

`string`

### FloatingPosition

Pixel position of the Dashboard while `IsFloating` is true. `x` and `y` are offsets in pixels.

```ts title="TypeScript"
FloatingPosition?: AdaptableCoordinate;
```

###### Property Value

[`AdaptableCoordinate`](https://www.adaptabletools.com/docs/reference/adaptablecoordinate.md)

### IsCollapsed

Is Dashboard collapsed; if true, header is visible (but not Tabs&#39; contents)

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

###### Default Value

false

###### Property Value

`boolean`

### IsFloating

Is Dashboard floating; if true, it appears in a draggable form (double-click to revert to the default position)

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

###### Default Value

false

###### Property Value

`boolean`

### IsHidden

Whether Dashboard is completely hidden - can be made visible again in Column Menu and Tool Panel

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

###### Default Value

false

###### Property Value

`boolean`

### ModuleButtons

Module shortcut buttons in the Dashboard header (actions zone).

Opening the Settings Panel itself is handled by the fixed Home control (application icon or
configuration icon) on the left of the Dashboard — do not include `'SettingsPanel'` here.

```ts title="TypeScript"
ModuleButtons?: AdaptableModuleButtons;
```

###### Default Value

`[]`

###### Property Value

`AdaptableModuleButtons`

### PinnedToolbars

Toolbars shown above the grid, outside any tab.

```ts title="TypeScript"
PinnedToolbars?: AdaptableDashboardToolbars | string[];
```

###### Property Value

`AdaptableDashboardToolbars | string[]`

### Tabs

Named groups of toolbars. Each tab has a `Name` and the `Toolbars` it shows.

```ts title="TypeScript"
Tabs?: DashboardTab[];
```

###### Default Value

Empty Array

###### Property Value

[`DashboardTab`](https://www.adaptabletools.com/docs/reference/dashboardtab.md)`[]`
