# DashboardChangedInfo

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

Payload of the `DashboardChanged` event.

Fires when Dashboard State changes, and once shortly after startup (`actionName` `ADAPTABLE_READY`). It is not fired when the old and new state are equal.

Extends , so `adaptableApi` is included.

```ts title="TypeScript"
export interface DashboardChangedInfo extends BaseContext 
```

###### Extends

[`BaseContext`](https://www.adaptabletools.com/docs/reference/basecontext.md)

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [actionName](https://www.adaptabletools.com/docs/reference/dashboardchangedinfo.md#actionname) | `string` | What changed.<br/><br/>`ADAPTABLE_READY` is the first event, shortly after startup.<br/><br/>Otherwise it is the Redux action type:<br/>`DASHBOARD_SET_IS_COLLAPSED`, `DASHBOARD_SET_IS_HIDDEN`, `DASHBOARD_SET_IS_FLOATING`, `DASHBOARD_SET_FLOATING_POSITION`, `DASHBOARD_SET_MODULE_BUTTONS`, `DASHBOARD_SET_TABS`, `DASHBOARD_ACTIVE_TAB_INDEX_CHANGE`, `DASHBOARD_CLOSE_TOOLBAR`. |
| [newDashboardState](https://www.adaptabletools.com/docs/reference/dashboardchangedinfo.md#newdashboardstate) | [`DashboardState`](https://www.adaptabletools.com/docs/reference/dashboardstate.md) | Dashboard State after this change. |
| [oldDashboardState](https://www.adaptabletools.com/docs/reference/dashboardchangedinfo.md#olddashboardstate) | [`DashboardState`](https://www.adaptabletools.com/docs/reference/dashboardstate.md) | Dashboard State before this change.<br/><br/>`null` when `actionName` is `ADAPTABLE_READY`. |
| [adaptableContext](https://www.adaptabletools.com/docs/reference/dashboardchangedinfo.md#adaptablecontext) | `any` | Custom application Context provided in `AdaptableOptions.adaptableContext` |

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [isToolbarStateChangedToHidden(toolbarName)](https://www.adaptabletools.com/docs/reference/dashboardchangedinfo.md#istoolbarstatechangedtohidden) | `boolean` | Whether `toolbarName` became hidden because of this change.<br/><br/>True when the toolbar left the active tab, or it stayed in the active tab and the Dashboard was collapsed or hidden. |
| [isToolbarStateChangedToVisible(toolbarName)](https://www.adaptabletools.com/docs/reference/dashboardchangedinfo.md#istoolbarstatechangedtovisible) | `boolean` | Whether `toolbarName` became visible because of this change.<br/><br/>True when the toolbar entered the active tab, or it was already in the active tab and the Dashboard was expanded or unhidden. |

## Property Details

### actionName

What changed.

`ADAPTABLE_READY` is the first event, shortly after startup.

Otherwise it is the Redux action type:
`DASHBOARD_SET_IS_COLLAPSED`, `DASHBOARD_SET_IS_HIDDEN`, `DASHBOARD_SET_IS_FLOATING`, `DASHBOARD_SET_FLOATING_POSITION`, `DASHBOARD_SET_MODULE_BUTTONS`, `DASHBOARD_SET_TABS`, `DASHBOARD_ACTIVE_TAB_INDEX_CHANGE`, `DASHBOARD_CLOSE_TOOLBAR`.

```ts title="TypeScript"
actionName: string;
```

###### Property Value

`string`

### newDashboardState

Dashboard State after this change.

```ts title="TypeScript"
newDashboardState: DashboardState;
```

###### Property Value

[`DashboardState`](https://www.adaptabletools.com/docs/reference/dashboardstate.md)

### oldDashboardState

Dashboard State before this change.

`null` when `actionName` is `ADAPTABLE_READY`.

```ts title="TypeScript"
oldDashboardState: DashboardState;
```

###### Property Value

[`DashboardState`](https://www.adaptabletools.com/docs/reference/dashboardstate.md)

### adaptableContext

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

Custom application Context provided in `AdaptableOptions.adaptableContext`

```ts title="TypeScript"
adaptableContext: any;
```

###### Property Value

`any`

## Method Details

### isToolbarStateChangedToHidden

Whether `toolbarName` became hidden because of this change.

True when the toolbar left the active tab, or it stayed in the active tab and the Dashboard was collapsed or hidden.

```ts title="TypeScript"
isToolbarStateChangedToHidden(toolbarName: string): boolean;
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| toolbarName | `string` | Toolbar to test |

###### Returns

 `true` when the toolbar became hidden

`boolean`

### isToolbarStateChangedToVisible

Whether `toolbarName` became visible because of this change.

True when the toolbar entered the active tab, or it was already in the active tab and the Dashboard was expanded or unhidden.

```ts title="TypeScript"
isToolbarStateChangedToVisible(toolbarName: string): boolean;
```

###### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| toolbarName | `string` | Toolbar to test |

###### Returns

 `true` when the toolbar became visible

`boolean`
