# pivotGrandTotal

Hides pivot grand totals or positions them at the top or bottom.

Canonical: https://grid.syidax.com/docs/options/pivotGrandTotal/

<a id="meaning"></a>

## What does this API do?

Hides pivot grand totals or positions them at the top or bottom.

API for Pro features: Pivot

<a id="contract"></a>

## Exact input and result types

```typescript
pivotGrandTotal: 'off' | 'top' | 'bottom'
```

| Item | Value |
| --- | --- |
| JavaScript name | pivotGrandTotal |
| HTML attribute | pivot-grand-total |
| Default | 'bottom' |
| Input type | 'off' \| 'top' \| 'bottom' |

<a id="usage"></a>

## Usage flow

Set this on a property of the Grid element. In HTML, you can also use the pivot-grand-total attribute. Pass arrays, objects, and callbacks through JavaScript, and use new arrays or objects when applying changes.

<a id="recipes"></a>

## Feature explanations and examples

- [Pivot analysis](https://grid.syidax.com/docs/features/pivot.md) — Pivoting divides source orders into row, column, and value axes to create a cross-tabulation. Unlike collapsible row groups, unique values such as statuses become new result columns.