# GC.Spread.Pivot

## Content

# Namespace: Pivot

[GC](GC).[Spread](GC.Spread).Pivot

## Table of contents

### Namespaces

- [PivotTable](GC.Spread.Pivot.PivotTable)

### Enumerations

- [CalcItemAggregation](../enums/GC.Spread.Pivot.CalcItemAggregation)
- [DisplayFields](../enums/GC.Spread.Pivot.DisplayFields)
- [GrandTotalPosition](../enums/GC.Spread.Pivot.GrandTotalPosition)
- [PivotAreaAxisType](../enums/GC.Spread.Pivot.PivotAreaAxisType)
- [PivotAreaType](../enums/GC.Spread.Pivot.PivotAreaType)
- [PivotPanelLayoutType](../enums/GC.Spread.Pivot.PivotPanelLayoutType)
- [PivotPanelSection](../enums/GC.Spread.Pivot.PivotPanelSection)
- [PivotTableFieldType](../enums/GC.Spread.Pivot.PivotTableFieldType)
- [PivotTableLayoutType](../enums/GC.Spread.Pivot.PivotTableLayoutType)
- [SubtotalsPosition](../enums/GC.Spread.Pivot.SubtotalsPosition)

### Classes

- [PivotPanel](../classes/GC.Spread.Pivot.PivotPanel)
- [PivotTable](../classes/GC.Spread.Pivot.PivotTable-1)
- [PivotTableItemSlicer](../classes/GC.Spread.Pivot.PivotTableItemSlicer)
- [PivotTableStyle](../classes/GC.Spread.Pivot.PivotTableStyle)
- [PivotTableTheme](../classes/GC.Spread.Pivot.PivotTableTheme)
- [PivotTableThemes](../classes/GC.Spread.Pivot.PivotTableThemes)
- [PivotTableTimelineSlicer](../classes/GC.Spread.Pivot.PivotTableTimelineSlicer)

### Interfaces

- [IPivotItemInfo](../interfaces/GC.Spread.Pivot.IPivotItemInfo)
- [IPivotTableViewManager](../interfaces/GC.Spread.Pivot.IPivotTableViewManager)

### Type aliases

- [ICalcFieldInfo](GC.Spread.Pivot#icalcfieldinfo)
- [ICalcItemInfo](GC.Spread.Pivot#icalciteminfo)
- [IDateGroupInfo](GC.Spread.Pivot#idategroupinfo)
- [IDateGroupsInfo](GC.Spread.Pivot#idategroupsinfo)
- [IFieldInfo](GC.Spread.Pivot#ifieldinfo)
- [INumberGroupInfo](GC.Spread.Pivot#inumbergroupinfo)
- [IPivotArea](GC.Spread.Pivot#ipivotarea)
- [IPivotAreasCollection](GC.Spread.Pivot#ipivotareascollection)
- [IPivotConditionFilterInfo](GC.Spread.Pivot#ipivotconditionfilterinfo)
- [IPivotNodeInfo](GC.Spread.Pivot#ipivotnodeinfo)
- [IPivotOverwriteNodeInfo](GC.Spread.Pivot#ipivotoverwritenodeinfo)
- [IPivotReference](GC.Spread.Pivot#ipivotreference)
- [IPivotShowDataAsInfo](GC.Spread.Pivot#ipivotshowdataasinfo)
- [IPivotStyle](GC.Spread.Pivot#ipivotstyle)
- [IPivotTableOption](GC.Spread.Pivot#ipivottableoption)
- [IPivotTablePosition](GC.Spread.Pivot#ipivottableposition)
- [IPivotTableRange](GC.Spread.Pivot#ipivottablerange)
- [IPivotTableView](GC.Spread.Pivot#ipivottableview)
- [IPivotTextFilterInfo](GC.Spread.Pivot#ipivottextfilterinfo)
- [ISerializeFieldInfo](GC.Spread.Pivot#iserializefieldinfo)
- [ISerializeInfo](GC.Spread.Pivot#iserializeinfo)
- [ISerializeShowDataAsInfo](GC.Spread.Pivot#iserializeshowdataasinfo)
- [ISourceFieldInfo](GC.Spread.Pivot#isourcefieldinfo)
- [ITextCollectionCondition](GC.Spread.Pivot#itextcollectioncondition)
- [ITextGroupInfo](GC.Spread.Pivot#itextgroupinfo)

## Type aliases

### <a id="icalcfieldinfo" name="icalcfieldinfo"></a> ICalcFieldInfo

Ƭ **ICalcFieldInfo**: `Object`

**`property`** {string} fieldName  the field name of calc field

**`property`** {string} formula  the formula of calc field

#### Type declaration

| Name | Type |
| :------ | :------ |
| `fieldName` | `string` |
| `formula` | `string` |

___

### <a id="icalciteminfo" name="icalciteminfo"></a> ICalcItemInfo

Ƭ **ICalcItemInfo**: `Object`

**`property`** {string} sourceName The name of PivotTable sourceField name

**`property`** {string} calcItemName The name of PivotTable sourceField calcItem name

**`property`** {string} formula The formula of PivotTable sourceField calcItem formula

**`property`** {number} priority The priority of PivotTable sourceField calcItem priority

#### Type declaration

| Name | Type |
| :------ | :------ |
| `calcItemName` | `string` |
| `formula` | `string` |
| `priority` | `number` |
| `sourceName` | `string` |

___

### <a id="idategroupinfo" name="idategroupinfo"></a> IDateGroupInfo

Ƭ **IDateGroupInfo**: `Object`

**`property`** {GC.Pivot.DateGroupType} by The date unit of date group info.

**`property`** {Date} [start]  The start date of group.

**`property`** {Date} [end] The end date of group.

#### Type declaration

| Name | Type |
| :------ | :------ |
| `by` | [`DateGroupType`](../enums/GC.Pivot.DateGroupType) |
| `end?` | `Date` |
| `start?` | `Date` |

___

### <a id="idategroupsinfo" name="idategroupsinfo"></a> IDateGroupsInfo

Ƭ **IDateGroupsInfo**: `Object`

**`property`** {string} originFieldName The source field name.

**`property`** {GC.Spread.Pivot.IDateGroupInfo[]} dateGroups The date group info.

#### Type declaration

| Name | Type |
| :------ | :------ |
| `dateGroups` | [`IDateGroupInfo`](GC.Spread.Pivot#idategroupinfo)[] |
| `originFieldName` | `string` |

___

### <a id="ifieldinfo" name="ifieldinfo"></a> IFieldInfo

Ƭ **IFieldInfo**: `Object`

**`property`** {string} fieldName the field name

**`property`** {string} sourceName the source name

**`property`** {GC.Pivot.PivotDataType} dataType  the field correspondence source data type

**`property`** {GC.Spread.Pivot.PivotTableFieldType} pivotArea the field type, which effect the field in different area

**`property`** {number} pivotIndex the index in the field area

**`property`** {Date|number} [start] the min value of number type data field or the oldest of date type field

**`property`** {Date|number} [end]  the max value of number type data field or the newest of date type field

#### Type declaration

| Name | Type |
| :------ | :------ |
| `dataType` | [`PivotDataType`](../enums/GC.Pivot.PivotDataType) |
| `end?` | `Date` \| `number` |
| `fieldName` | `string` |
| `pivotArea` | [`PivotTableFieldType`](../enums/GC.Spread.Pivot.PivotTableFieldType) |
| `pivotIndex` | `number` |
| `sourceName` | `string` |
| `start?` | `Date` \| `number` |

___

### <a id="inumbergroupinfo" name="inumbergroupinfo"></a> INumberGroupInfo

Ƭ **INumberGroupInfo**: `Object`

**`property`** {string} originFieldName The source field name.

**`property`** {object}  numberGroup The number group info

**`property`** {number}  [numberGroup.start]  The start number of number group info.

**`property`** {number}  [numberGroup.end]  The end number of number group info.

**`property`** {number}  numberGroup.by   The step of number group info.

#### Type declaration

| Name | Type |
| :------ | :------ |
| `numberGroup` | { `by`: `number` ; `end?`: `number` ; `start?`: `number`  } |
| `numberGroup.by` | `number` |
| `numberGroup.end?` | `number` |
| `numberGroup.start?` | `number` |
| `originFieldName` | `string` |

___

### <a id="ipivotarea" name="ipivotarea"></a> IPivotArea

Ƭ **IPivotArea**: `Object`

**`property`** {GC.Spread.Pivot.PivotAreaType} [type]

**`property`** {string} [fieldName]

**`property`** {boolean} [labelOnly]

**`property`** {boolean} [dataOnly]

**`property`** {boolean} [grandRow]

**`property`** {boolean} [grandCol]

**`property`** {GC.Spread.Pivot.IPivotReference[]} [references]

#### Type declaration

| Name | Type |
| :------ | :------ |
| `dataOnly?` | `boolean` |
| `fieldName?` | `string` |
| `grandCol?` | `boolean` |
| `grandRow?` | `boolean` |
| `labelOnly?` | `boolean` |
| `references?` | [`IPivotReference`](GC.Spread.Pivot#ipivotreference)[] |
| `type?` | [`PivotAreaType`](../enums/GC.Spread.Pivot.PivotAreaType) |

___

### <a id="ipivotareascollection" name="ipivotareascollection"></a> IPivotAreasCollection

Ƭ **IPivotAreasCollection**: `Object`

**`property`** {Object.<string, GC.Spread.Pivot.IPivotArea[]>} - key indicates pivot table name, value indicates selected pivot areas.

#### Index signature

▪ [pivotTableName: `string`]: [`IPivotArea`](GC.Spread.Pivot#ipivotarea)[]

___

### <a id="ipivotconditionfilterinfo" name="ipivotconditionfilterinfo"></a> IPivotConditionFilterInfo

Ƭ **IPivotConditionFilterInfo**: `Object`

**`property`** {string} conditionByName

**`property`** {GC.Pivot.IPivotCaptionConditionFilterInfo | GC.Pivot.IPivotDateConditionFilterInfo | GC.Pivot.IPivotTop10ConditionFilterInfo | GC.Pivot.IPivotValueConditionInfo} condition

#### Type declaration

| Name | Type |
| :------ | :------ |
| `condition` | [`IPivotCaptionConditionFilterInfo`](GC.Pivot#ipivotcaptionconditionfilterinfo) \| [`IPivotDateConditionFilterInfo`](GC.Pivot#ipivotdateconditionfilterinfo) \| [`IPivotTop10ConditionFilterInfo`](GC.Pivot#ipivottop10conditionfilterinfo) \| [`IPivotValueConditionInfo`](GC.Pivot#ipivotvalueconditioninfo) |
| `conditionByName` | `string` |

___

### <a id="ipivotnodeinfo" name="ipivotnodeinfo"></a> IPivotNodeInfo

Ƭ **IPivotNodeInfo**: `Object`

**`property`** {GC.Spread.Pivot.IPivotItemInfo[]} fieldInfos the label field infos of node info.

**`property`** {GC.Pivot.IValueInfo} valueInfo the value field info of node info.

#### Type declaration

| Name | Type |
| :------ | :------ |
| `fieldInfos` | [`IPivotItemInfo`](../interfaces/GC.Spread.Pivot.IPivotItemInfo)[] |
| `valueInfo` | [`IValueInfo`](GC.Pivot#ivalueinfo) |

___

### <a id="ipivotoverwritenodeinfo" name="ipivotoverwritenodeinfo"></a> IPivotOverwriteNodeInfo

Ƭ **IPivotOverwriteNodeInfo**: `Object`

**`property`** {GC.Spread.Pivot.IPivotItemInfo[]} fieldInfos the label field infos of node info.

**`property`** {GC.Pivot.IValueInfo} valueInfo the value field info of node info.

**`property`** {number} value the value of node info.

#### Type declaration

| Name | Type |
| :------ | :------ |
| `fieldInfos` | [`IPivotItemInfo`](../interfaces/GC.Spread.Pivot.IPivotItemInfo)[] |
| `value` | `number` |
| `valueInfo` | [`IValueInfo`](GC.Pivot#ivalueinfo) |

___

### <a id="ipivotreference" name="ipivotreference"></a> IPivotReference

Ƭ **IPivotReference**: `Object`

**`property`** {string} fieldName

**`property`** {boolean} [subtotal]

**`property`** {string[]} [items]

#### Type declaration

| Name | Type |
| :------ | :------ |
| `fieldName` | `string` |
| `items?` | `string`[] |
| `subtotal?` | `boolean` |

___

### <a id="ipivotshowdataasinfo" name="ipivotshowdataasinfo"></a> IPivotShowDataAsInfo

Ƭ **IPivotShowDataAsInfo**: `Object`

**`property`** {string} baseFieldName

**`property`** {GC.Pivot.PivotShowDataAsBaseItemType} baseFieldItemType

**`property`** {string} baseFieldItem

#### Type declaration

| Name | Type |
| :------ | :------ |
| `baseFieldItem?` | `string` |
| `baseFieldItemType?` | [`PivotShowDataAsBaseItemType`](../enums/GC.Pivot.PivotShowDataAsBaseItemType) |
| `baseFieldName?` | `string` |
| `showDataAs` | [`PivotShowDataAs`](../enums/GC.Pivot.PivotShowDataAs) |

___

### <a id="ipivotstyle" name="ipivotstyle"></a> IPivotStyle

Ƭ **IPivotStyle**: `Object`

**`property`** {GC.Spread.Pivot.IPivotArea} pivotArea The pivotArea in pivot table.

**`property`** {GC.Spread.Sheets.Style}  style The style use for pivotArea.

#### Type declaration

| Name | Type |
| :------ | :------ |
| `pivotArea?` | [`IPivotArea`](GC.Spread.Pivot#ipivotarea) |
| `style?` | [`Style`](../classes/GC.Spread.Sheets.Style) |

___

### <a id="ipivottableoption" name="ipivottableoption"></a> IPivotTableOption

Ƭ **IPivotTableOption**: `Object`

**`property`** {boolean} [allowMultipleFiltersPerField]

**`property`** {boolean} [fillDownLabels]

**`property`** {boolean} [insertBlankLineAfterEachItem]

**`property`** {GC.Spread.Pivot.GrandTotalPosition} grandTotalPosition

**`property`** {GC.Spread.Pivot.SubtotalsPosition} subtotalsPosition

**`property`** {GC.Spread.Pivot.SubtotalsPosition} subTotalsPosition

**`property`** {GC.Spread.Pivot.DisplayFields} displayFieldsInPageFilterArea

**`property`** {number} reportFilterFieldsPerColumn

**`property`** {boolean} [bandRows]

**`property`** {boolean} [bandColumns]

**`property`** {boolean} [showRowHeader]

**`property`** {boolean} [showColumnHeader]

**`property`** {boolean} [showDrill]

**`property`** {boolean} [showMissing]

**`property`** {string | number} missingCaption

**`property`** {number} rowLabelIndent

**`property`** {boolean} [printDrill]

**`property`** {boolean} [itemPrintTitles]

**`property`** {boolean} [fieldPrintTitles]

**`property`** {boolean} [showFilter]

**`property`** {boolean} [showToolTip]

**`property`** {boolean} [mergeItem]

**`property`** {boolean} [isShowErrorValue]

**`property`** {string} [errorValueInfo]

**`property`** {string} [rowHeaderCaption]

**`property`** {string} [colHeaderCaption]

**`property`** {string} [showHeaders]

**`property`** {GC.Spread.Pivot.CalcItemAggregation} [calcItemAggregation]

**`property`** {boolean} [enableDataValueEditing]

#### Type declaration

| Name | Type |
| :------ | :------ |
| `allowMultipleFiltersPerField?` | `boolean` |
| `bandColumns?` | `boolean` |
| `bandRows?` | `boolean` |
| `calcItemAggregation?` | [`CalcItemAggregation`](../enums/GC.Spread.Pivot.CalcItemAggregation) |
| `colHeaderCaption?` | `string` |
| `displayFieldsInPageFilterArea?` | [`DisplayFields`](../enums/GC.Spread.Pivot.DisplayFields) |
| `enableDataValueEditing?` | `boolean` |
| `errorValueInfo?` | `string` |
| `fieldPrintTitles?` | `boolean` |
| `fillDownLabels?` | `boolean` |
| `grandTotalPosition?` | [`GrandTotalPosition`](../enums/GC.Spread.Pivot.GrandTotalPosition) |
| `insertBlankLineAfterEachItem?` | `boolean` |
| `isShowErrorValue?` | `boolean` |
| `itemPrintTitles?` | `boolean` |
| `mergeItem?` | `boolean` |
| `missingCaption?` | `string` \| `number` |
| `printDrill?` | `boolean` |
| `reportFilterFieldsPerColumn?` | `number` |
| `rowHeaderCaption?` | `string` |
| `rowLabelIndent?` | `number` |
| `showColumnHeader?` | `boolean` |
| `showDrill?` | `boolean` |
| `showFilter?` | `boolean` |
| `showHeaders?` | `boolean` |
| `showMissing?` | `boolean` |
| `showRowHeader?` | `boolean` |
| `showToolTip?` | `boolean` |
| `subTotalsPosition?` | [`SubtotalsPosition`](../enums/GC.Spread.Pivot.SubtotalsPosition) |
| `subtotalsPosition?` | [`SubtotalsPosition`](../enums/GC.Spread.Pivot.SubtotalsPosition) |

___

### <a id="ipivottableposition" name="ipivottableposition"></a> IPivotTablePosition

Ƭ **IPivotTablePosition**: `Object`

**`property`** {number} row indicates pivot table start row

**`property`** {number} col indicates pivot table start col

**`property`** {number} [sheetName] which sheet is pivot table on

#### Type declaration

| Name | Type |
| :------ | :------ |
| `col` | `number` |
| `row` | `number` |
| `sheetName?` | `string` |

___

### <a id="ipivottablerange" name="ipivottablerange"></a> IPivotTableRange

Ƭ **IPivotTableRange**: `Object`

**`property`** {GC.Spread.Sheets.Range} page the filter area range

**`property`** {GC.Spread.Sheets.Range} content the content area range

#### Type declaration

| Name | Type |
| :------ | :------ |
| `content` | [`Range`](../classes/GC.Spread.Sheets.Range) |
| `page` | [`Range`](../classes/GC.Spread.Sheets.Range) |

___

### <a id="ipivottableview" name="ipivottableview"></a> IPivotTableView

Ƭ **IPivotTableView**: `Object`

**`property`** {string} name

**`property`** {GC.Spread.Pivot.ISerializeInfo} config

#### Type declaration

| Name | Type |
| :------ | :------ |
| `config` | [`ISerializeInfo`](GC.Spread.Pivot#iserializeinfo) |
| `name` | `string` |

___

### <a id="ipivottextfilterinfo" name="ipivottextfilterinfo"></a> IPivotTextFilterInfo

Ƭ **IPivotTextFilterInfo**: `Object`

**`property`** {GC.Spread.Pivot.ITextCollectionCondition} textItem

#### Type declaration

| Name | Type |
| :------ | :------ |
| `textItem` | [`ITextCollectionCondition`](GC.Spread.Pivot#itextcollectioncondition) |

___

### <a id="iserializefieldinfo" name="iserializefieldinfo"></a> ISerializeFieldInfo

Ƭ **ISerializeFieldInfo**: `Object`

**`property`** {string} conditionBySourceName

**`property`** {string} displayName

**`property`** {GC.Pivot.SubtotalType} [subtotal]

**`property`** {GC.Spread.Pivot.IPivotTextFilterInfo | GC.Spread.Pivot.IPivotConditionFilterInfo} [labelFilter]

**`property`** {GC.Spread.Pivot.IPivotConditionFilterInfo} [valueFilter]

**`property`** {GC.Pivot.IPivotViewSortInfo} [sortInfo]

#### Type declaration

| Name | Type |
| :------ | :------ |
| `displayName` | `string` |
| `labelFilter?` | [`IPivotTextFilterInfo`](GC.Spread.Pivot#ipivottextfilterinfo) \| [`IPivotConditionFilterInfo`](GC.Spread.Pivot#ipivotconditionfilterinfo) |
| `sortInfo?` | [`IPivotViewSortInfo`](GC.Pivot#ipivotviewsortinfo) |
| `sourceName` | `string` |
| `subtotal?` | [`SubtotalType`](../enums/GC.Pivot.SubtotalType) |
| `valueFilter?` | [`IPivotConditionFilterInfo`](GC.Spread.Pivot#ipivotconditionfilterinfo) |

___

### <a id="iserializeinfo" name="iserializeinfo"></a> ISerializeInfo

Ƭ **ISerializeInfo**: `Object`

**`property`** {GC.Spread.Pivot.PivotTableLayoutType} [layoutType]

**`property`** {object} [options] the options of pivot table

**`property`** {string} [theme] the theme of pivot table

**`property`** {GC.Pivot.IDataPosition} [valuePosition] the valuePosition info of pivot table

**`property`** {number[]} [pivotTablePosition] the position  of pivot table

**`property`** {GC.Spread.Pivot.ISerializeFieldInfo[][]} [fieldsInfo] the fields info of pivot table

**`property`** {GC.Spread.Pivot.IPivotStyle} [styles] the pivot area styles of pivot table

**`property`** {object} [collapseItems] the collapse info of pivot table

**`property`** {GC.Spread.Pivot.ISerializeShowDataAsInfo[]} [showDataAsList] the show data as info of pivot table

#### Type declaration

| Name | Type |
| :------ | :------ |
| `collapseItems?` | `object` |
| `fieldsInfo?` | [`ISerializeFieldInfo`](GC.Spread.Pivot#iserializefieldinfo)[][] |
| `layoutType?` | [`PivotTableLayoutType`](../enums/GC.Spread.Pivot.PivotTableLayoutType) |
| `options?` | `object` |
| `pivotTablePosition?` | `number`[] |
| `showDataAsList?` | [`ISerializeShowDataAsInfo`](GC.Spread.Pivot#iserializeshowdataasinfo)[] |
| `styles?` | [`IPivotStyle`](GC.Spread.Pivot#ipivotstyle)[] |
| `theme?` | `string` |
| `valuePosition?` | [`IDataPosition`](GC.Pivot#idataposition) |

___

### <a id="iserializeshowdataasinfo" name="iserializeshowdataasinfo"></a> ISerializeShowDataAsInfo

Ƭ **ISerializeShowDataAsInfo**: `Object`

**`property`** {string} valueFieldName

**`property`** {GC.Spread.Pivot.IPivotShowDataAsInfo} showDataAsInfo

#### Type declaration

| Name | Type |
| :------ | :------ |
| `showDataAsInfo` | [`IPivotShowDataAsInfo`](GC.Spread.Pivot#ipivotshowdataasinfo) |
| `valueFieldName` | `string` |

___

### <a id="isourcefieldinfo" name="isourcefieldinfo"></a> ISourceFieldInfo

Ƭ **ISourceFieldInfo**: `Object`

**`property`** {string} name the name of source field

**`property`** {GC.Pivot.PivotSourceFieldType} [fieldType] the pivot field type is calc field or group field

#### Type declaration

| Name | Type |
| :------ | :------ |
| `fieldType?` | [`PivotSourceFieldType`](../enums/GC.Pivot.PivotSourceFieldType) |
| `name` | `string` |

___

### <a id="itextcollectioncondition" name="itextcollectioncondition"></a> ITextCollectionCondition

Ƭ **ITextCollectionCondition**: `Object`

**`property`** {string[]} list

**`property`** {boolean} isAll

#### Type declaration

| Name | Type |
| :------ | :------ |
| `isAll` | `boolean` |
| `list` | `string`[] |

___

### <a id="itextgroupinfo" name="itextgroupinfo"></a> ITextGroupInfo

Ƭ **ITextGroupInfo**: `Object`

**`property`** {string} originFieldName  The source field name.

**`property`** {object} textGroup  The text group info

**`property`** {string} textGroup.fieldName  The group field name.

**`property`** {GC.Pivot.IStringGroupItems} textGroup.groupItems  The text group items info.

#### Type declaration

| Name | Type |
| :------ | :------ |
| `originFieldName` | `string` |
| `textGroup` | { `fieldName`: `string` ; `groupItems`: [`IStringGroupItems`](GC.Pivot#istringgroupitems)  } |
| `textGroup.fieldName` | `string` |
| `textGroup.groupItems` | [`IStringGroupItems`](GC.Pivot#istringgroupitems) |