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

# ITableTotalHeaderValue

- Package: [@gooddata/sdk-ui](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui/src/base/results/tableData/interfaces/cells.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).
> 

Cell that represents total header. Each cell corresponds to one `IResultTotalHeader` and labels the total for that specific row / column.

\*\*Visual example\*\*

```tsx
 Attribute | Value |
-----------+-------+
 USA       |  100  |
 Sum A     |   80  | <- "Sum A" is totalHeader
```

**Signature:**

```typescript
export interface ITableTotalHeaderValue 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [columnDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itabletotalheadervalue/index.md#itabletotalheadervaluecolumndefinition) |  | [ITableValueColumnDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablevaluecolumndefinition/index.md) \| [ITableSubtotalColumnDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablesubtotalcolumndefinition/index.md) \| [ITableMeasureGroupHeaderColumnDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablemeasuregroupheadercolumndefinition/index.md) \| [ITableAttributeColumnDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itableattributecolumndefinition/index.md) | **_(ALPHA)_** Column context - value column, subtotal column, measure group header column, or attribute column. |
| [columnIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itabletotalheadervalue/index.md#itabletotalheadervaluecolumnindex) |  | number | **_(ALPHA)_** Zero-based column position in the `data` matrix. Points to the measure header column when measures are transposed. |
| [formattedValue](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itabletotalheadervalue/index.md#itabletotalheadervalueformattedvalue) |  | string \| null | **_(ALPHA)_** Display text for the total header (e.g., "Sum", "Avg", "Max"). |
| [rowDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itabletotalheadervalue/index.md#itabletotalheadervaluerowdefinition) |  | [ITableValueRowDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablevaluerowdefinition/index.md) \| [ITableSubtotalRowDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablesubtotalrowdefinition/index.md) | **_(ALPHA)_** Row context - subtotal or value row. |
| [rowIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itabletotalheadervalue/index.md#itabletotalheadervaluerowindex) |  | number | **_(ALPHA)_** Zero-based row position in the `data` matrix. Usually points to a subtotal or grand-total row. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itabletotalheadervalue/index.md#itabletotalheadervaluetype) |  | "totalHeader" | **_(ALPHA)_** Discriminator literal for narrowing the `ITableDataValue` union. |
| [value](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itabletotalheadervalue/index.md#itabletotalheadervaluevalue) |  | [IResultTotalHeader](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iresulttotalheader/index.md) | **_(ALPHA)_** The raw `IResultTotalHeader` object containing total metadata like totalType, measureIndex, etc. |

## Property details

### ITableTotalHeaderValue.columnDefinition

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

Column context - value column, subtotal column, measure group header column, or attribute column.

**Signature:**

```typescript
columnDefinition: ITableValueColumnDefinition | ITableSubtotalColumnDefinition | ITableMeasureGroupHeaderColumnDefinition | ITableAttributeColumnDefinition;
```

### ITableTotalHeaderValue.columnIndex

> **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 column position in the `data` matrix. Points to the measure header column when measures are transposed.

**Signature:**

```typescript
columnIndex: number;
```

### ITableTotalHeaderValue.formattedValue

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

Display text for the total header (e.g., "Sum", "Avg", "Max").

**Signature:**

```typescript
formattedValue: string | null;
```

### ITableTotalHeaderValue.rowDefinition

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

Row context - subtotal or value row.

**Signature:**

```typescript
rowDefinition: ITableValueRowDefinition | ITableSubtotalRowDefinition;
```

### ITableTotalHeaderValue.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 row position in the `data` matrix. Usually points to a subtotal or grand-total row.

**Signature:**

```typescript
rowIndex: number;
```

### ITableTotalHeaderValue.type

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

Discriminator literal for narrowing the `ITableDataValue` union.

**Signature:**

```typescript
type: "totalHeader";
```

### ITableTotalHeaderValue.value

> **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 raw `IResultTotalHeader` object containing total metadata like totalType, measureIndex, etc.

**Signature:**

```typescript
value: IResultTotalHeader;
```