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

# IKpiProps

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

Props of the [Kpi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.kpi/index.md) component.

**Signature:**

```typescript
export interface IKpiProps extends IWithLoadingEvents<IRawExecuteProps> 
```
**Extends:** [IWithLoadingEvents](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iwithloadingevents/index.md)&lt;[IRawExecuteProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.irawexecuteprops/index.md)&gt;

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [backend?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ikpiprops/index.md#ikpipropsbackend) |  | [IAnalyticalBackend](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalbackend/index.md) | _(Optional)_ Specify an instance of analytical backend instance to work with. |
| [ErrorComponent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ikpiprops/index.md#ikpipropserrorcomponent) |  | ComponentType&lt;[IErrorProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ierrorprops/index.md)&gt; | _(Optional)_ Specify react component to render if execution fails. |
| [filters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ikpiprops/index.md#ikpipropsfilters) |  | [INullableFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inullablefilter/index.md)[] | _(Optional)_ Specify filters to apply during calculation |
| [LoadingComponent?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ikpiprops/index.md#ikpipropsloadingcomponent) |  | ComponentType&lt;[ILoadingProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.iloadingprops/index.md)&gt; | _(Optional)_ Specify react component to render while the data is loading. |
| [locale?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ikpiprops/index.md#ikpipropslocale) |  | string | _(Optional)_ Specify locale to use for strings that the Kpi component may render (for instance when encountering errors). |
| [measure](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ikpiprops/index.md#ikpipropsmeasure) |  | [IMeasure](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.imeasure/index.md) | Specify measure whose value should be calculated and rendered. |
| [separators?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ikpiprops/index.md#ikpipropsseparators) |  | [ISeparators](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iseparators/index.md) | _(Optional)_ Specify number separators to use when rendering (segment delimiters, decimal point character) |
| [workspace?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.ikpiprops/index.md#ikpipropsworkspace) |  | string | _(Optional)_ Specify workspace to work with. |

## Property details

### IKpiProps.backend

Specify an instance of analytical backend instance to work with.

**Signature:**

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

#### Remarks

Note: if you do not have a BackendProvider above in the component tree, then you MUST specify the backend.

### IKpiProps.ErrorComponent

Specify react component to render if execution fails.

**Signature:**

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

### IKpiProps.filters

Specify filters to apply during calculation

**Signature:**

```typescript
filters?: INullableFilter[];
```

### IKpiProps.LoadingComponent

Specify react component to render while the data is loading.

**Signature:**

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

### IKpiProps.locale

Specify locale to use for strings that the Kpi component may render (for instance when encountering errors).

**Signature:**

```typescript
locale?: string;
```

### IKpiProps.measure

Specify measure whose value should be calculated and rendered.

**Signature:**

```typescript
measure: IMeasure;
```

### IKpiProps.separators

Specify number separators to use when rendering (segment delimiters, decimal point character)

**Signature:**

```typescript
separators?: ISeparators;
```

### IKpiProps.workspace

Specify workspace to work with.

**Signature:**

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

#### Remarks

Note: if you do not have a WorkspaceProvider above in the component tree, then you MUST specify the workspace.