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

# IDashboardRichTextProps

- 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/richText/types.ts

Rich text widget props.

**Signature:**

```typescript
export interface IDashboardRichTextProps 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [backend?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardrichtextprops/index.md#idashboardrichtextpropsbackend) |  | [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. |
| [clientHeight?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardrichtextprops/index.md#idashboardrichtextpropsclientheight) |  | number | **_(ALPHA)_** _(Optional)_ Height of the rich text widget container. |
| [clientWidth?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardrichtextprops/index.md#idashboardrichtextpropsclientwidth) |  | number | **_(ALPHA)_** _(Optional)_ Width of the rich text widget container. |
| [exportData?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardrichtextprops/index.md#idashboardrichtextpropsexportdata) |  | [WidgetExportDataAttributes](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.widgetexportdataattributes/index.md) | **_(ALPHA)_** _(Optional)_ Data for export in export mode. |
| [onError?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardrichtextprops/index.md#idashboardrichtextpropsonerror) |  | [OnError](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.onerror/index.md) | **_(ALPHA)_** _(Optional)_ |
| [onLoadingChanged?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardrichtextprops/index.md#idashboardrichtextpropsonloadingchanged) |  | [OnLoadingChanged](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.onloadingchanged/index.md) | _(Optional)_ Callback to receive notifications about loading state of the widget. |
| [richTextExportData?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardrichtextprops/index.md#idashboardrichtextpropsrichtextexportdata) |  | [RichTextExportData](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.richtextexportdata/index.md) | **_(ALPHA)_** _(Optional)_ Data for export in export mode. |
| [widget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardrichtextprops/index.md#idashboardrichtextpropswidget) |  | [IRichTextWidget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.irichtextwidget/index.md) | Definition of insight widget to render. |
| [workspace?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardrichtextprops/index.md#idashboardrichtextpropsworkspace) |  | string | **_(ALPHA)_** _(Optional)_ Workspace where the Insight widget exists. |

## Property details

### IDashboardRichTextProps.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.

### IDashboardRichTextProps.clientHeight

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

Height of the rich text widget container.

**Signature:**

```typescript
clientHeight?: number;
```

### IDashboardRichTextProps.clientWidth

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

Width of the rich text widget container.

**Signature:**

```typescript
clientWidth?: number;
```

### IDashboardRichTextProps.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 for export in export mode.

**Signature:**

```typescript
exportData?: WidgetExportDataAttributes;
```

### IDashboardRichTextProps.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;
```

### IDashboardRichTextProps.onLoadingChanged

Callback to receive notifications about loading state of the widget.

**Signature:**

```typescript
onLoadingChanged?: OnLoadingChanged;
```

### IDashboardRichTextProps.richTextExportData

> **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 for export in export mode.

**Signature:**

```typescript
richTextExportData?: RichTextExportData;
```

### IDashboardRichTextProps.widget

Definition of insight widget to render.

**Signature:**

```typescript
widget: IRichTextWidget;
```

### IDashboardRichTextProps.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 Insight 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.