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

# IDashboardWidgetProps

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

Dashboard widget props.

**Signature:**

```typescript
export interface IDashboardWidgetProps 
```

## Remarks

IMPORTANT: this interface is marked as public but not all properties in it are suitable for public consumption yet. Please heed the per-property API maturity annotations; the alpha level APIs may change in a breaking way in the next release.

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [backend?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsbackend) |  | [IAnalyticalBackend](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalbackend/index.md) | **_(ALPHA)_** _(Optional)_ Backend to work with. |
| [dateDataset?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsdatedataset) |  | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | _(Optional)_ Specify date data set to use when passing dashboard date filter to rendered visualization. |
| [ErrorComponent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropserrorcomponent) |  | ComponentType<[IErrorProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ierrorprops/index.md)> | **_(ALPHA)_** Error component to use when insight rendering fails for any reason. |
| [exportData?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsexportdata) |  | [WidgetExportData](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.widgetexportdata/index.md) | **_(ALPHA)_** _(Optional)_ Data attributes for export mode to be added to the widget. |
| [ignoredAttributeFilters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsignoredattributefilters) |  | [ObjRefInScope](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objrefinscope/index.md)[] | _(Optional)_ Specify what attribute filters to ignore for this widget. |
| [LoadingComponent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsloadingcomponent) |  | ComponentType<[ILoadingProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iloadingprops/index.md)> | **_(ALPHA)_** Loading component to use while loading and preparing data to render. |
| [onDrill?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsondrill) |  | [OnFiredDashboardDrillEvent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.onfireddashboarddrillevent/index.md) | **_(ALPHA)_** _(Optional)_ |
| [onError?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsonerror) |  | [OnError](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.onerror/index.md) | **_(ALPHA)_** _(Optional)_ |
| [onFiltersChange?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsonfilterschange) |  | (filters: ([IDashboardFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardfilter/index.md) \| [FilterContextItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.filtercontextitem/index.md))[], resetOthers?: boolean) => void | **_(ALPHA)_** _(Optional)_ |
| [onWidgetClicked?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsonwidgetclicked) |  | () => void | **_(ALPHA)_** _(Optional)_ Callback that the component MUST call when the widget is clicked. |
| [parentLayoutItemSize?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsparentlayoutitemsize) |  | [IDashboardLayoutSizeByScreenSize](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.idashboardlayoutsizebyscreensize/index.md) | **_(ALPHA)_** _(Optional)_ The size of layout item in which the item is nested. Undefined, when item is in the root layout. |
| [parentLayoutPath?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsparentlayoutpath) |  | [ILayoutItemPath](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.ilayoutitempath/index.md) | **_(ALPHA)_** _(Optional)_ The path to the layout item in which the section is nested |
| [rowIndex?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsrowindex) |  | number | **_(ALPHA)_** _(Optional)_ Zero-based index of the row in which the item is rendered, |
| [screen](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsscreen) |  | [ScreenSize](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.screensize/index.md) | **_(ALPHA)_** |
| [showHeader?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsshowheader) |  | boolean | **_(ALPHA)_** _(Optional)_ Turn widget header on/off. |
| [showMenu?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsshowmenu) |  | boolean | **_(ALPHA)_** _(Optional)_ Turn visibility of the interactions menu on/off. |
| [widget?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropswidget) |  | [ExtendedDashboardWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.extendeddashboardwidget/index.md) | _(Optional)_ |
| [workspace?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardwidgetprops/index.md#idashboardwidgetpropsworkspace) |  | string | **_(ALPHA)_** _(Optional)_ Workspace where the widget exists. |

## Property details

### IDashboardWidgetProps.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).
> 

Backend to work with.

**Signature:**

```typescript
backend?: IAnalyticalBackend;
```

#### Remarks

Note: the backend must come either from this property or from BackendContext. If you do not specify backend here, then the component MUST be rendered within an existing BackendContext.

### IDashboardWidgetProps.dateDataset

Specify date data set to use when passing dashboard date filter to rendered visualization.

**Signature:**

```typescript
dateDataset?: ObjRef;
```

#### Remarks

If not provided, the date filter will not be applied

### IDashboardWidgetProps.ErrorComponent

> **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).
> 

Error component to use when insight rendering fails for any reason.

**Signature:**

```typescript
ErrorComponent: ComponentType<IErrorProps>;
```

### IDashboardWidgetProps.exportData

> **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).
> 

Data attributes for export mode to be added to the widget.

**Signature:**

```typescript
exportData?: WidgetExportData;
```

### IDashboardWidgetProps.ignoredAttributeFilters

Specify what attribute filters to ignore for this widget.

**Signature:**

```typescript
ignoredAttributeFilters?: ObjRefInScope[];
```

#### Remarks

Those filters will not be passed to the rendered visualization.

### IDashboardWidgetProps.LoadingComponent

> **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).
> 

Loading component to use while loading and preparing data to render.

**Signature:**

```typescript
LoadingComponent: ComponentType<ILoadingProps>;
```

### IDashboardWidgetProps.onDrill

> **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
onDrill?: OnFiredDashboardDrillEvent;
```

### IDashboardWidgetProps.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).
> 

**Signature:**

```typescript
onError?: OnError;
```

### IDashboardWidgetProps.onFiltersChange

> **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
onFiltersChange?: (filters: (IDashboardFilter | FilterContextItem)[], resetOthers?: boolean) => void;
```

### IDashboardWidgetProps.onWidgetClicked

> **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 that the component MUST call when the widget is clicked.

**Signature:**

```typescript
onWidgetClicked?: () => void;
```

### IDashboardWidgetProps.parentLayoutItemSize

> **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).
> 

The size of layout item in which the item is nested. Undefined, when item is in the root layout.

**Signature:**

```typescript
parentLayoutItemSize?: IDashboardLayoutSizeByScreenSize;
```

### IDashboardWidgetProps.parentLayoutPath

> **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).
> 

The path to the layout item in which the section is nested

**Signature:**

```typescript
parentLayoutPath?: ILayoutItemPath;
```

### IDashboardWidgetProps.rowIndex

> **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).
> 

Zero-based index of the row in which the item is rendered,

**Signature:**

```typescript
rowIndex?: number;
```

#### Remarks

Optional only for the compatibility reasons with old fluid layout. Once the flexible layout is the only one supported, it can be set as required.

### IDashboardWidgetProps.screen

> **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
screen: ScreenSize;
```

### IDashboardWidgetProps.showHeader

> **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).
> 

Turn widget header on/off.

**Signature:**

```typescript
showHeader?: boolean;
```

### IDashboardWidgetProps.showMenu

> **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).
> 

Turn visibility of the interactions menu on/off.

**Signature:**

```typescript
showMenu?: boolean;
```

### IDashboardWidgetProps.widget

**Signature:**

```typescript
widget?: ExtendedDashboardWidget;
```

### IDashboardWidgetProps.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).
> 

Workspace where the widget exists.

**Signature:**

```typescript
workspace?: string;
```

#### Remarks

Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify workspace here, then the component MUST be rendered within an existing WorkspaceContext.