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

# ITableGrandTotalHeaderValue

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

Header cell labeling a \*\*grand-total row\*\* (usually located in the first columns).

\*\*Visual example:\*\*

```tsx
           |  Q1 |  Q2 | ColSum Σ |
-----------+-----+-----+----------+
 USA       | 100 | 120 |   220    |
 CAN       |  80 |  90 |   170    |
 RowSum Σ  | 180 | 210 |   390    | <- RowSum Σ is grandTotalHeader
```

**Signature:**

```typescript
export interface ITableGrandTotalHeaderValue 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [columnDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablegrandtotalheadervalue/index.md#itablegrandtotalheadervaluecolumndefinition) |  | [ITableAttributeColumnDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itableattributecolumndefinition/index.md) \| [ITableMeasureGroupHeaderColumnDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablemeasuregroupheadercolumndefinition/index.md) | **_(ALPHA)_** Column context - typically an attribute column or measure header column where the grand total label appears. |
| [columnIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablegrandtotalheadervalue/index.md#itablegrandtotalheadervaluecolumnindex) |  | number | **_(ALPHA)_** Zero-based column position in the `data` matrix. Usually points to the first attribute column (leftmost) or measure header column (when measures are transposed). |
| [formattedValue](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablegrandtotalheadervalue/index.md#itablegrandtotalheadervalueformattedvalue) |  | string \| null | **_(ALPHA)_** Display text for the grand total row label (e.g., "Sum", "Total"). Usually shows the aggregation type or a localized "Total" label. |
| [rowDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablegrandtotalheadervalue/index.md#itablegrandtotalheadervaluerowdefinition) |  | [ITableGrandTotalRowDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablegrandtotalrowdefinition/index.md) | **_(ALPHA)_** Row context - grand-total row since this header cell is labeling a grand-total row. |
| [rowIndex](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablegrandtotalheadervalue/index.md#itablegrandtotalheadervaluerowindex) |  | number | **_(ALPHA)_** Zero-based row position in the `data` matrix. Points to a grand-total row that this header cell labels. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui/sdk-ui.itablegrandtotalheadervalue/index.md#itablegrandtotalheadervaluetype) |  | "grandTotalHeader" | **_(ALPHA)_** Discriminator literal for narrowing the `ITableDataValue` union. |

## Property details

### ITableGrandTotalHeaderValue.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 - typically an attribute column or measure header column where the grand total label appears.

**Signature:**

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

### ITableGrandTotalHeaderValue.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. Usually points to the first attribute column (leftmost) or measure header column (when measures are transposed).

**Signature:**

```typescript
columnIndex: number;
```

### ITableGrandTotalHeaderValue.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 grand total row label (e.g., "Sum", "Total"). Usually shows the aggregation type or a localized "Total" label.

**Signature:**

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

### ITableGrandTotalHeaderValue.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 - grand-total row since this header cell is labeling a grand-total row.

**Signature:**

```typescript
rowDefinition: ITableGrandTotalRowDefinition;
```

### ITableGrandTotalHeaderValue.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. Points to a grand-total row that this header cell labels.

**Signature:**

```typescript
rowIndex: number;
```

### ITableGrandTotalHeaderValue.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: "grandTotalHeader";
```