> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IDashboardSettingsDialogProps

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/presentation/dashboardSettingsDialog/types.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

**Signature:**

```typescript
export interface IDashboardSettingsDialogProps 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [backend](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardsettingsdialogprops/index.md#idashboardsettingsdialogpropsbackend) |  | [IAnalyticalBackend](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalbackend/index.md) | **_(ALPHA)_** Analytical backend from which the dashboard obtains data to render. |
| [isVisible?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardsettingsdialogprops/index.md#idashboardsettingsdialogpropsisvisible) |  | boolean | **_(ALPHA)_** _(Optional)_ Is dashboard setting dialog visible. |
| [onApply](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardsettingsdialogprops/index.md#idashboardsettingsdialogpropsonapply) |  | (payload: [IDashboardSettingsApplyPayload](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardsettingsapplypayload/index.md)) => void | **_(ALPHA)_** Callback to be called when user apply dashboard settings. |
| [onCancel](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardsettingsdialogprops/index.md#idashboardsettingsdialogpropsoncancel) |  | () => void | **_(ALPHA)_** Callback to be called when user closes the dashboard settings dialog. |
| [onError?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardsettingsdialogprops/index.md#idashboardsettingsdialogpropsonerror) |  | (error: [GoodDataSdkError](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.gooddatasdkerror/index.md)) => void | **_(ALPHA)_** _(Optional)_ Callback to be called, when error occurs. |
| [workspace](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardsettingsdialogprops/index.md#idashboardsettingsdialogpropsworkspace) |  | string | **_(ALPHA)_** Identifier of analytical workspace, from which the dashboard obtains data to render. |

## Property details

### IDashboardSettingsDialogProps.backend

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Analytical backend from which the dashboard obtains data to render.

**Signature:**

```typescript
backend: IAnalyticalBackend;
```

### IDashboardSettingsDialogProps.isVisible

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Is dashboard setting dialog visible.

**Signature:**

```typescript
isVisible?: boolean;
```

### IDashboardSettingsDialogProps.onApply

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Callback to be called when user apply dashboard settings.

**Signature:**

```typescript
onApply: (payload: IDashboardSettingsApplyPayload) => void;
```

### IDashboardSettingsDialogProps.onCancel

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Callback to be called when user closes the dashboard settings dialog.

**Signature:**

```typescript
onCancel: () => void;
```

### IDashboardSettingsDialogProps.onError

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Callback to be called, when error occurs.

**Signature:**

```typescript
onError?: (error: GoodDataSdkError) => void;
```

### IDashboardSettingsDialogProps.workspace

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Identifier of analytical workspace, from which the dashboard obtains data to render.

**Signature:**

```typescript
workspace: string;
```