## PivotField class

Represents a field in a PivotTable report.

```javascript
class PivotField;
```


## Properties

| Property | Type | Description |
| --- | --- | --- |
| [pivotItems](#pivotItems--)| PivotItemCollection | Readonly. Gets the pivot items of the pivot field |
| [groupSettings](#groupSettings--)| PivotFieldGroupSettings | Readonly. Gets the group settings of the pivot field. |
| [isCalculatedField](#isCalculatedField--)| boolean | Readonly. Indicates whether the this pivot field is calculated field. |
| [isValuesField](#isValuesField--)| boolean | Readonly. Indicates whether this field represents values field. |
| [baseIndex](#baseIndex--)| number | Represents the index in the source pivot fields. |
| [position](#position--)| number | Readonly. Represents the index of [PivotField](../pivotfield/) in the region. |
| [regionType](#regionType--)| PivotFieldType | Readonly. Specifies the region of the pivot table that this field is displayed. |
| [name](#name--)| string | Represents the name of PivotField. |
| [displayName](#displayName--)| string | Represents the display name of pivot field in the pivot table view. |
| [subtotals](#subtotals--)| PivotFieldSubtotalType | Gets or sets the subtotals of the field. Only for Row or Column pivot field. |
| [isAutoSubtotals](#isAutoSubtotals--)| boolean | Indicates whether the specified field shows automatic subtotals. Default is true. |
| [dragToRow](#dragToRow--)| boolean | Indicates whether the specified field can be dragged to the row region. The default value is true. |
| [allowDraggingToRow](#allowDraggingToRow--)| boolean | Indicates whether the specified field can be dragged to the row region. The default value is true. |
| [dragToColumn](#dragToColumn--)| boolean | Indicates whether the specified field can be dragged to the column region. The default value is true. |
| [allowDraggingToColumn](#allowDraggingToColumn--)| boolean | Indicates whether the specified field can be dragged to the column region. The default value is true. |
| [dragToPage](#dragToPage--)| boolean | Indicates whether the specified field can be dragged to the page region. The default value is true. |
| [allowDraggingToPage](#allowDraggingToPage--)| boolean | Indicates whether the specified field can be dragged to the page region. The default value is true. |
| [dragToHide](#dragToHide--)| boolean | Indicates whether this pivot field can be removed from the PivotTable view. The default value is true. |
| [allowRemovingFromView](#allowRemovingFromView--)| boolean | Indicates whether this pivot field can be removed from the PivotTable view. The default value is true. |
| [dragToData](#dragToData--)| boolean | Indicates whether the specified field can be dragged to the values region. The default value is true. |
| [allowDraggingToData](#allowDraggingToData--)| boolean | Indicates whether the specified field can be dragged to the values region. The default value is true. |
| [isMultipleItemSelectionAllowed](#isMultipleItemSelectionAllowed--)| boolean | Indicates whether multiple items could be selected in the page field. The default value is false. |
| [isRepeatItemLabels](#isRepeatItemLabels--)| boolean | Indicates whether to repeat labels of the field in the region. The default value is false. |
| [isIncludeNewItemsInFilter](#isIncludeNewItemsInFilter--)| boolean | Indicates whether to include new items to the field in manual filter. The default value is false. |
| [isInsertPageBreaksBetweenItems](#isInsertPageBreaksBetweenItems--)| boolean | Indicates whether to insert page breaks after each item. The default value is false. |
| [showAllItems](#showAllItems--)| boolean | Indicates whether to display all items in the PivotTable view, even if they don't contain summary data. The default value is false. |
| [nonAutoSortDefault](#nonAutoSortDefault--)| boolean | Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort. |
| [isAutoSort](#isAutoSort--)| boolean | Indicates whether the items of this PivotTable field are automatically sorted. |
| [isAscendSort](#isAscendSort--)| boolean | Indicates whether the items of this pivot field is autosorted ascending. |
| [autoSortField](#autoSortField--)| number | Represents the index of field which is auto sorted. -1 means PivotField itself,others means the position of the data fields. |
| [sortSetting](#sortSetting--)| PivotFieldSortSetting | Readonly. Gets all settings of auto sorting |
| [top10AutoShowSettings](#top10AutoShowSettings--)| PivotFieldTop10AutoShowSettings | Readonly. Gets the Top 10 AutoShow settings for a pivot field. |
| [isAutoShow](#isAutoShow--)| boolean | Indicates whether the specified PivotTable field is automatically shown. |
| [isAscendShow](#isAscendShow--)| boolean | Indicates whether the specified PivotTable field is autoshown ascending. |
| [autoShowCount](#autoShowCount--)| number | Represent the number of top or bottom items that are automatically shown in the specified PivotTable field. |
| [autoShowField](#autoShowField--)| number | Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields. |
| [function](#function--)| ConsolidationFunction | Represents the function used to summarize this PivotTable data field. |
| [showValuesSetting](#showValuesSetting--)| PivotShowValuesSetting | Readonly. Gets the settings of showing values as when the ShowDataAs calculation is in use. |
| [currentPageItem](#currentPageItem--)| number | Represents the current selected page item of the page field to filter data. Only valid for page fields. |
| [insertBlankRow](#insertBlankRow--)| boolean | Indicates whether to insert a blank line after each item. Only for row fields. |
| [showSubtotalAtTop](#showSubtotalAtTop--)| boolean | Indicates whether to display subtotals at the top or bottom of items when ShowInOutlineForm is true, then |
| [showInOutlineForm](#showInOutlineForm--)| boolean | Indicates whether to layout this field in outline form on the Pivot Table view. |
| [number](#number--)| number | Represents the built-in display format of numbers and dates. |
| [numberFormat](#numberFormat--)| string | Represents the custom display format of numbers and dates. |
| [items](#items--)| string[] | Readonly. Get all labels of pivot items in this field. |
| [originalItems](#originalItems--)| string[] | Readonly. Get the original base items; |
| [itemCount](#itemCount--)| number | Readonly. Gets the count of the base items in this pivot field. |
| [showCompact](#showCompact--)| boolean | Indicates whether to display labels of the next field in the same column on the Pivot Table view |

## Methods

| Method | Description |
| --- | --- |
| [getMaxValue()](#getMaxValue--)| Gets the max value of this field. |
| [getMinValue()](#getMinValue--)| Gets the max value of this field. |
| [initPivotItems()](#initPivotItems--)| Init the pivot items of the pivot field |
| [group()](#group--)| Automatically group the field. |
| [group(PivotFieldGroupOptions)](#group-pivotfieldgroupoptions-)| Groups the pivot field with options. |
| [groupBy(number, boolean)](#groupBy-number-boolean-)| Automatically group the field with interval |
| [groupBy(PivotGroupByType[], number, boolean)](#groupBy-pivotgroupbytypearray-number-boolean-)| Automatically group the field with internal |
| [groupBy(Date, Date, PivotGroupByType[], number, boolean)](#groupBy-date-date-pivotgroupbytypearray-number-boolean-)| Group the file by the date group types. |
| [groupBy(boolean, Date, boolean, Date, PivotGroupByType[], number, boolean)](#groupBy-boolean-date-boolean-date-pivotgroupbytypearray-number-boolean-)| Group the file by the date group types. |
| [groupBy(number, number, number, boolean)](#groupBy-number-number-number-boolean-)| Group the file by number. |
| [groupBy(boolean, number, boolean, number, number, boolean)](#groupBy-boolean-number-boolean-number-number-boolean-)| Group the file by number. |
| [groupBy(CustomPiovtFieldGroupItem[], boolean)](#groupBy-custompiovtfieldgroupitemarray-boolean-)| Custom group the field. |
| [groupBy(DiscreteGroupItem[], boolean)](#groupBy-discretegroupitemarray-boolean-)| Custom group the field. |
| [ungroup()](#ungroup--)| Ungroup the pivot field. |
| [getPivotFilterByType(PivotFilterType)](#getPivotFilterByType-pivotfiltertype-)| Gets the pivot filter of the pivot field by type |
| [getFilters()](#getFilters--)| Gets all pivot filters applied for this pivot field. |
| [clearFilter()](#clearFilter--)| Clears filter setting on this pivot field. |
| [filterTop10(number, PivotFilterType, boolean, number)](#filterTop10-number-pivotfiltertype-boolean-number-)| Filters by values of data pivot field. |
| [filterByValue(number, PivotFilterType, number, number)](#filterByValue-number-pivotfiltertype-number-number-)| Filters by values of data pivot field. |
| [filterByLabel(PivotFilterType, string, string)](#filterByLabel-pivotfiltertype-string-string-)| Filters by captions of row or column pivot field. |
| [filterByDate(PivotFilterType, Date, Date)](#filterByDate-pivotfiltertype-date-date-)| Filters by date values of row or column pivot field. |
| [getFormula()](#getFormula--)| Gets the formula of the calculated field . Only works for calculated field. |
| [setSubtotals(PivotFieldSubtotalType, boolean)](#setSubtotals-pivotfieldsubtotaltype-boolean-)| Sets how to subtotal the specified field. |
| [getSubtotals(PivotFieldSubtotalType)](#getSubtotals-pivotfieldsubtotaltype-)| Indicates whether to show specified subtotal for this pivot field. |
| [sortBy(SortOrder)](#sortBy-sortorder-)| Sorts this pivot field. |
| [sortBy(SortOrder, number)](#sortBy-sortorder-number-)| Sorts this pivot field. |
| [sortBy(SortOrder, number, PivotLineType, string)](#sortBy-sortorder-number-pivotlinetype-string-)| Sorts this pivot field. |
| [sortBy(SortOrder, number, string)](#sortBy-sortorder-number-string-)| Sorts this pivot field. |
| [top10AutoShow(boolean, boolean, number, number)](#top10AutoShow-boolean-boolean-number-number-)| Configures Top10 AutoShow settings for this pivot field. |
| [showValuesAs(PivotFieldDataDisplayFormat, number, PivotItemPositionType, number)](#showValuesAs-pivotfielddatadisplayformat-number-pivotitempositiontype-number-)| Shows values of data field as different display format when the ShowDataAs calculation is in use. |
| [isHiddenItem(number)](#isHiddenItem-number-)| Indicates whether the specific PivotItem is hidden. |
| [hideItem(number, boolean)](#hideItem-number-boolean-)| Sets whether the specific PivotItem in a data field is hidden. |
| [hideItem(string, boolean)](#hideItem-string-boolean-)| Sets whether the specific PivotItem in a data field is hidden. |
| [isHiddenItemDetail(number)](#isHiddenItemDetail-number-)| Indicates whether to hide the detail of the specific PivotItem.. |
| [hideItemDetail(number, boolean)](#hideItemDetail-number-boolean-)| Sets whether the specific PivotItem in a pivot field is hidden detail. |
| [hideDetail(boolean)](#hideDetail-boolean-)| Sets whether the detail of all PivotItems in a pivot field are hidden. That is collapse/expand this field. |
| [hideAllDetails()](#hideAllDetails--)| Hides all details |
| [showAllDetails()](#showAllDetails--)| Show all details |
| [addCalculatedItem(string, string)](#addCalculatedItem-string-string-)| Add a calculated formula item to the pivot field. |


### pivotItems {#pivotItems--}

Readonly. Gets the pivot items of the pivot field

```javascript
pivotItems : PivotItemCollection;
```


### groupSettings {#groupSettings--}

Readonly. Gets the group settings of the pivot field.

```javascript
groupSettings : PivotFieldGroupSettings;
```


**Remarks**

If this field is not grouped, Null will be returned.

### isCalculatedField {#isCalculatedField--}

Readonly. Indicates whether the this pivot field is calculated field.

```javascript
isCalculatedField : boolean;
```


### isValuesField {#isValuesField--}

Readonly. Indicates whether this field represents values field.

```javascript
isValuesField : boolean;
```


**Remarks**

Only works when there are two or more data fields in the pivot table view.

### baseIndex {#baseIndex--}

Represents the index in the source pivot fields.

```javascript
baseIndex : number;
```


**Remarks**

NOTE: This setter of this property is now obsolete. This setter of this property will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### position {#position--}

Readonly. Represents the index of [PivotField](../pivotfield/) in the region.

```javascript
position : number;
```


### regionType {#regionType--}

Readonly. Specifies the region of the pivot table that this field is displayed.

```javascript
regionType : PivotFieldType;
```


### name {#name--}

Represents the name of PivotField.

```javascript
name : string;
```


### displayName {#displayName--}

Represents the display name of pivot field in the pivot table view.

```javascript
displayName : string;
```


### subtotals {#subtotals--}

Gets or sets the subtotals of the field. Only for Row or Column pivot field.

```javascript
subtotals : PivotFieldSubtotalType;
```


### isAutoSubtotals {#isAutoSubtotals--}

Indicates whether the specified field shows automatic subtotals. Default is true.

```javascript
isAutoSubtotals : boolean;
```


### dragToRow {#dragToRow--}

Indicates whether the specified field can be dragged to the row region. The default value is true.

```javascript
dragToRow : boolean;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.AllowDraggingToRow property instead. This method will be removed 12 months later since July 2026. Aspose apologizes for any inconvenience you may have experienced.

### allowDraggingToRow {#allowDraggingToRow--}

Indicates whether the specified field can be dragged to the row region. The default value is true.

```javascript
allowDraggingToRow : boolean;
```


### dragToColumn {#dragToColumn--}

Indicates whether the specified field can be dragged to the column region. The default value is true.

```javascript
dragToColumn : boolean;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.AllowDraggingToColumn property instead. This method will be removed 12 months later since July 2026. Aspose apologizes for any inconvenience you may have experienced.

### allowDraggingToColumn {#allowDraggingToColumn--}

Indicates whether the specified field can be dragged to the column region. The default value is true.

```javascript
allowDraggingToColumn : boolean;
```


### dragToPage {#dragToPage--}

Indicates whether the specified field can be dragged to the page region. The default value is true.

```javascript
dragToPage : boolean;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.AllowDraggingToPage property instead. This method will be removed 12 months later since July 2026. Aspose apologizes for any inconvenience you may have experienced.

### allowDraggingToPage {#allowDraggingToPage--}

Indicates whether the specified field can be dragged to the page region. The default value is true.

```javascript
allowDraggingToPage : boolean;
```


### dragToHide {#dragToHide--}

Indicates whether this pivot field can be removed from the PivotTable view. The default value is true.

```javascript
dragToHide : boolean;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.AllowRemovingFromView property instead. This method will be removed 12 months later since July 2026. Aspose apologizes for any inconvenience you may have experienced.

### allowRemovingFromView {#allowRemovingFromView--}

Indicates whether this pivot field can be removed from the PivotTable view. The default value is true.

```javascript
allowRemovingFromView : boolean;
```


### dragToData {#dragToData--}

Indicates whether the specified field can be dragged to the values region. The default value is true.

```javascript
dragToData : boolean;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.AllowDraggingToData property instead. This method will be removed 12 months later since July 2026. Aspose apologizes for any inconvenience you may have experienced.

### allowDraggingToData {#allowDraggingToData--}

Indicates whether the specified field can be dragged to the values region. The default value is true.

```javascript
allowDraggingToData : boolean;
```


### isMultipleItemSelectionAllowed {#isMultipleItemSelectionAllowed--}

Indicates whether multiple items could be selected in the page field. The default value is false.

```javascript
isMultipleItemSelectionAllowed : boolean;
```


### isRepeatItemLabels {#isRepeatItemLabels--}

Indicates whether to repeat labels of the field in the region. The default value is false.

```javascript
isRepeatItemLabels : boolean;
```


### isIncludeNewItemsInFilter {#isIncludeNewItemsInFilter--}

Indicates whether to include new items to the field in manual filter. The default value is false.

```javascript
isIncludeNewItemsInFilter : boolean;
```


### isInsertPageBreaksBetweenItems {#isInsertPageBreaksBetweenItems--}

Indicates whether to insert page breaks after each item. The default value is false.

```javascript
isInsertPageBreaksBetweenItems : boolean;
```


### showAllItems {#showAllItems--}

Indicates whether to display all items in the PivotTable view, even if they don't contain summary data. The default value is false.

```javascript
showAllItems : boolean;
```


### nonAutoSortDefault {#nonAutoSortDefault--}

Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort.

```javascript
nonAutoSortDefault : boolean;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use !PivotField.SortSetting.IsSimpleSort property instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### isAutoSort {#isAutoSort--}

Indicates whether the items of this PivotTable field are automatically sorted.

```javascript
isAutoSort : boolean;
```


**Remarks**

remarks> NOTE: This property is now obsolete. Instead, please use PivotField.SortSetting.SortType property or PivotField.SortBy() method instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced. </remarks

### isAscendSort {#isAscendSort--}

Indicates whether the items of this pivot field is autosorted ascending.

```javascript
isAscendSort : boolean;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.SortSetting.SortType property or PivotField.SortBy() method instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### autoSortField {#autoSortField--}

Represents the index of field which is auto sorted. -1 means PivotField itself,others means the position of the data fields.

```javascript
autoSortField : number;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.SortSetting.SortBy property or PivotField.SortBy() method instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### sortSetting {#sortSetting--}

Readonly. Gets all settings of auto sorting

```javascript
sortSetting : PivotFieldSortSetting;
```


### top10AutoShowSettings {#top10AutoShowSettings--}

Readonly. Gets the Top 10 AutoShow settings for a pivot field.

```javascript
top10AutoShowSettings : PivotFieldTop10AutoShowSettings;
```


### isAutoShow {#isAutoShow--}

Indicates whether the specified PivotTable field is automatically shown.

```javascript
isAutoShow : boolean;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.Top10AutoShowSettings.IsAutoShow property or PivotField.Top10AutoShow() method instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### isAscendShow {#isAscendShow--}

Indicates whether the specified PivotTable field is autoshown ascending.

```javascript
isAscendShow : boolean;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.Top10AutoShowSettings.IsTop property or PivotField.Top10AutoShow() method instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### autoShowCount {#autoShowCount--}

Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.

```javascript
autoShowCount : number;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.Top10AutoShowSettings.AutoShowCount property or PivotField.Top10AutoShow() method instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### autoShowField {#autoShowField--}

Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.

```javascript
autoShowField : number;
```


**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.Top10AutoShowSettings.RankBy property or PivotField.Top10AutoShow() method instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### function {#function--}

Represents the function used to summarize this PivotTable data field.

```javascript
function : ConsolidationFunction;
```


### showValuesSetting {#showValuesSetting--}

Readonly. Gets the settings of showing values as when the ShowDataAs calculation is in use.

```javascript
showValuesSetting : PivotShowValuesSetting;
```


### currentPageItem {#currentPageItem--}

Represents the current selected page item of the page field to filter data. Only valid for page fields.

```javascript
currentPageItem : number;
```


### insertBlankRow {#insertBlankRow--}

Indicates whether to insert a blank line after each item. Only for row fields.

```javascript
insertBlankRow : boolean;
```


### showSubtotalAtTop {#showSubtotalAtTop--}

Indicates whether to display subtotals at the top or bottom of items when ShowInOutlineForm is true, then

```javascript
showSubtotalAtTop : boolean;
```


**Remarks**

Only works when ShowInOutlineForm is true.

### showInOutlineForm {#showInOutlineForm--}

Indicates whether to layout this field in outline form on the Pivot Table view.

```javascript
showInOutlineForm : boolean;
```


### number {#number--}

Represents the built-in display format of numbers and dates.

```javascript
number : number;
```


### numberFormat {#numberFormat--}

Represents the custom display format of numbers and dates.

```javascript
numberFormat : string;
```


### items {#items--}

Readonly. Get all labels of pivot items in this field.

```javascript
items : string[];
```


### originalItems {#originalItems--}

Readonly. Get the original base items;

```javascript
originalItems : string[];
```


### itemCount {#itemCount--}

Readonly. Gets the count of the base items in this pivot field.

```javascript
itemCount : number;
```


**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.PivotItems.Count property instead . This method will be removed 12 months later since August 2026. Aspose apologizes for any inconvenience you may have experienced.

### showCompact {#showCompact--}

Indicates whether to display labels of the next field in the same column on the Pivot Table view

```javascript
showCompact : boolean;
```


### getMaxValue() {#getMaxValue--}

Gets the max value of this field.

```javascript
getMaxValue() : CellValue;
```


**Returns**

[CellValue](../cellvalue/)

**Remarks**

Only works for row or column fields which value must be date time, number or blank.

### getMinValue() {#getMinValue--}

Gets the max value of this field.

```javascript
getMinValue() : CellValue;
```


**Returns**

[CellValue](../cellvalue/)

**Remarks**

Only works for row or column fields which value must be date time, number or blank.

### initPivotItems() {#initPivotItems--}

Init the pivot items of the pivot field

```javascript
initPivotItems() : void;
```


### group() {#group--}

Automatically group the field.

```javascript
group() : boolean;
```


**Remarks**

If the field only contains blank and date time, the field will be grouped by Months. If the field only contains blank and number, the field will be grouped by Number. Else only returns false without any group.

### group(PivotFieldGroupOptions) {#group-pivotfieldgroupoptions-}

Groups the pivot field with options.

```javascript
group(options: PivotFieldGroupOptions) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| options | [PivotFieldGroupOptions](../pivotfieldgroupoptions/) | Options for pivot field grouping settings. |

### groupBy(number, boolean) {#groupBy-number-boolean-}

Automatically group the field with interval

```javascript
groupBy(interval: number, newField: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| interval | number | The internal of group.         /// Automatic value will be assigned if it's zero, |
| newField | boolean | Indicates whether adding a new field to the pivottable.         /// Only for DateTime group. |

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.Group(PivotFieldGroupOptions) method . This method will be removed 6 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### groupBy(PivotGroupByType[], number, boolean) {#groupBy-pivotgroupbytypearray-number-boolean-}

Automatically group the field with internal

```javascript
groupBy(groups: PivotGroupByType[], interval: number, newField: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| groups | [PivotGroupByType](../pivotgroupbytype/)[] | Group types |
| interval | number | The internal of group.         /// Automatic value will be assigned if it's zero,         /// Only works for grouping by Numbers or Days. |
| newField | boolean | Indicates whether adding a new field to the pivottable. |

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.Group(PivotFieldGroupOptions) method . This method will be removed 6 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### groupBy(Date, Date, PivotGroupByType[], number, boolean) {#groupBy-date-date-pivotgroupbytypearray-number-boolean-}

Group the file by the date group types.

```javascript
groupBy(start: Date, end: Date, groups: PivotGroupByType[], interval: number, firstAsNewField: boolean) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| start | Date | The start datetime |
| end | Date | The end of datetime |
| groups | [PivotGroupByType](../pivotgroupbytype/)[] | Group types |
| interval | number | The interval |
| firstAsNewField | boolean | Indicates whether adding a new field to the pivottable.         /// Only for the first group item. |

**Returns**

False means this field could not be grouped by date time.

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.Group(PivotFieldGroupOptions) method . This method will be removed 6 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### groupBy(boolean, Date, boolean, Date, PivotGroupByType[], number, boolean) {#groupBy-boolean-date-boolean-date-pivotgroupbytypearray-number-boolean-}

Group the file by the date group types.

```javascript
groupBy(isAutoStart: boolean, start: Date, isAutoEnd: boolean, end: Date, groups: PivotGroupByType[], interval: number, firstAsNewField: boolean) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isAutoStart | boolean | Indicates whether to auto detect the start date time value. |
| start | Date | The start datetime |
| isAutoEnd | boolean | Indicates whether to auto detect the end date time value. |
| end | Date | The end of datetime |
| groups | [PivotGroupByType](../pivotgroupbytype/)[] | Group types |
| interval | number | The interval |
| firstAsNewField | boolean | Indicates whether adding a new field to the pivottable.         /// Only for the first group item. |

**Returns**

False means this field could not be grouped by date time.

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.Group(PivotFieldGroupOptions) method . This method will be removed 6 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### groupBy(number, number, number, boolean) {#groupBy-number-number-number-boolean-}

Group the file by number.

```javascript
groupBy(start: number, end: number, interval: number, newField: boolean) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| start | number | The start value |
| end | number | The end of value |
| interval | number | The interval |
| newField | boolean | Indicates whether adding a new field to the pivottable |

**Returns**

False means this field could not be grouped by date time.

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.Group(PivotFieldGroupOptions) method . This method will be removed 6 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### groupBy(boolean, number, boolean, number, number, boolean) {#groupBy-boolean-number-boolean-number-number-boolean-}

Group the file by number.

```javascript
groupBy(isAutoStart: boolean, start: number, isAutoEnd: boolean, end: number, interval: number, newField: boolean) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isAutoStart | boolean | Indicates whether to auto detect the start value. |
| start | number | The start value |
| isAutoEnd | boolean | Indicates whether to auto detect the end value. |
| end | number | The end of value |
| interval | number | The interval |
| newField | boolean | Indicates whether adding a new field to the pivottable |

**Returns**

False means this field could not be grouped by date time.

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.Group(PivotFieldGroupOptions) method . This method will be removed 6 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### groupBy(CustomPiovtFieldGroupItem[], boolean) {#groupBy-custompiovtfieldgroupitemarray-boolean-}

Custom group the field.

```javascript
groupBy(customGroupItems: CustomPiovtFieldGroupItem[], newField: boolean) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| customGroupItems | [CustomPiovtFieldGroupItem](../custompiovtfieldgroupitem/)[] | The custom group items. |
| newField | boolean | Indicates whether adding a new field to the pivottable |

**Returns**

False means this field could not be grouped by date time.

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.GroupBy(DiscreteGroupItem[], bool) method . This method will be removed 6 months later since July 2026. Aspose apologizes for any inconvenience you may have experienced.

### groupBy(DiscreteGroupItem[], boolean) {#groupBy-discretegroupitemarray-boolean-}

Custom group the field.

```javascript
groupBy(customGroupItems: DiscreteGroupItem[], newField: boolean) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| customGroupItems | [DiscreteGroupItem](../discretegroupitem/)[] | The custom group items. |
| newField | boolean | Indicates whether adding a new field to the pivottable |

**Returns**

False means this field could not be grouped by date time.

### ungroup() {#ungroup--}

Ungroup the pivot field.

```javascript
ungroup() : void;
```


### getPivotFilterByType(PivotFilterType) {#getPivotFilterByType-pivotfiltertype-}

Gets the pivot filter of the pivot field by type

```javascript
getPivotFilterByType(type: PivotFilterType) : PivotFilter;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | [PivotFilterType](../pivotfiltertype/) |  |

**Returns**

[PivotFilter](../pivotfilter/)

### getFilters() {#getFilters--}

Gets all pivot filters applied for this pivot field.

```javascript
getFilters() : PivotFilter[];
```


**Returns**

[PivotFilter](../pivotfilter/)[]

### clearFilter() {#clearFilter--}

Clears filter setting on this pivot field.

```javascript
clearFilter() : void;
```


### filterTop10(number, PivotFilterType, boolean, number) {#filterTop10-number-pivotfiltertype-boolean-number-}

Filters by values of data pivot field.

```javascript
filterTop10(valueFieldIndex: number, type: PivotFilterType, isTop: boolean, itemCount: number) : PivotFilter;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| valueFieldIndex | number | The index of data field  in the data region. |
| type | [PivotFilterType](../pivotfiltertype/) | The type of filtering data. Only can be Count,Sum and Percent. |
| isTop | boolean | Indicates whether filter from top or bottom |
| itemCount | number | The item count |

**Returns**

[PivotFilter](../pivotfilter/)

### filterByValue(number, PivotFilterType, number, number) {#filterByValue-number-pivotfiltertype-number-number-}

Filters by values of data pivot field.

```javascript
filterByValue(valueFieldIndex: number, type: PivotFilterType, value1: number, value2: number) : PivotFilter;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| valueFieldIndex | number | The index of value field in the value region. |
| type | [PivotFilterType](../pivotfiltertype/) | The type of filtering data. |
| value1 | number | The value of filter condition |
| value2 | number | The upper-bound value of between filter condition |

**Returns**

[PivotFilter](../pivotfilter/)

### filterByLabel(PivotFilterType, string, string) {#filterByLabel-pivotfiltertype-string-string-}

Filters by captions of row or column pivot field.

```javascript
filterByLabel(type: PivotFilterType, label1: string, label2: string) : PivotFilter;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | [PivotFilterType](../pivotfiltertype/) | The type of filtering data. |
| label1 | string | The label of filter condition |
| label2 | string | The upper-bound label of between filter condition |

**Returns**

[PivotFilter](../pivotfilter/)

### filterByDate(PivotFilterType, Date, Date) {#filterByDate-pivotfiltertype-date-date-}

Filters by date values of row or column pivot field.

```javascript
filterByDate(type: PivotFilterType, dateTime1: Date, dateTime2: Date) : PivotFilter;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| type | [PivotFilterType](../pivotfiltertype/) | The type of filtering data. |
| dateTime1 | Date | The date label of filter condition |
| dateTime2 | Date | The upper-bound date label of between filter condition |

**Returns**

[PivotFilter](../pivotfilter/)

### getFormula() {#getFormula--}

Gets the formula of the calculated field . Only works for calculated field.

```javascript
getFormula() : string;
```


### setSubtotals(PivotFieldSubtotalType, boolean) {#setSubtotals-pivotfieldsubtotaltype-boolean-}

Sets how to subtotal the specified field.

```javascript
setSubtotals(subtotalType: PivotFieldSubtotalType, shown: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| subtotalType | [PivotFieldSubtotalType](../pivotfieldsubtotaltype/) | [PivotFieldSubtotalType](../pivotfieldsubtotaltype/) |
| shown | boolean | Whether the specified field shows that subtotals. |

### getSubtotals(PivotFieldSubtotalType) {#getSubtotals-pivotfieldsubtotaltype-}

Indicates whether to show specified subtotal for this pivot field.

```javascript
getSubtotals(subtotalType: PivotFieldSubtotalType) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| subtotalType | [PivotFieldSubtotalType](../pivotfieldsubtotaltype/) | Subtotal type. |

**Returns**

Returns whether showing specified subtotal.

### sortBy(SortOrder) {#sortBy-sortorder-}

Sorts this pivot field.

```javascript
sortBy(sortType: SortOrder) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sortType | [SortOrder](../sortorder/) | The type of sorting this field. |

### sortBy(SortOrder, number) {#sortBy-sortorder-number-}

Sorts this pivot field.

```javascript
sortBy(sortType: SortOrder, fieldSortedBy: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sortType | [SortOrder](../sortorder/) | The type of sorting this field. |
| fieldSortedBy | number | The index of pivot field sorted by.         /// -1 means sorting by data labels of this field, others mean the index of data field sorted by. |

**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.SortBy(SortOrder, int,string) method or PivotField.IsAutoSort property instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### sortBy(SortOrder, number, PivotLineType, string) {#sortBy-sortorder-number-pivotlinetype-string-}

Sorts this pivot field.

```javascript
sortBy(sortType: SortOrder, fieldSortedBy: number, dataType: PivotLineType, cellName: string) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sortType | [SortOrder](../sortorder/) | The type of sorting this field. |
| fieldSortedBy | number | The index of pivot field sorted by.         /// -1 means sorting by data labels of this field, others mean the index of data field sorted by. |
| dataType | [PivotLineType](../pivotlinetype/) | The type of data sorted by. |
| cellName | string | Sort by values in the row or column |

**Remarks**

NOTE: This property is now obsolete. Instead, please use PivotField.SortBy(SortOrder, int,string) method instead. This method will be removed 12 months later since September 2026. Aspose apologizes for any inconvenience you may have experienced.

### sortBy(SortOrder, number, string) {#sortBy-sortorder-number-string-}

Sorts this pivot field.

```javascript
sortBy(sortType: SortOrder, fieldSortedBy: number, cellName: string) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| sortType | [SortOrder](../sortorder/) | The type of sorting this field. |
| fieldSortedBy | number | The index of pivot field sorted by.         /// -1 means sorting by data labels of this field, others mean the index of data field sorted by. |
| cellName | string | Sort by values in the row or column.         /// If Null, group by total of the field, else group by values in selected column or row. |

### top10AutoShow(boolean, boolean, number, number) {#top10AutoShow-boolean-boolean-number-number-}

Configures Top10 AutoShow settings for this pivot field.

```javascript
top10AutoShow(isAutoShow: boolean, isTop: boolean, count: number, rankBy: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isAutoShow | boolean | true to enable AutoShow; false to disable. |
| isTop | boolean | If true, shows top items; false shows bottom items. |
| count | number | Number of top/bottom items to display. |
| rankBy | number | Index of data field used for ranking. Use -1 to rank by pivot item's own values. |

**Remarks**

ara>This method configures the [PivotFieldTop10AutoShowSettings](../pivotfieldtop10autoshowsettings/).</para> <para>XLS binary format: AutoShow (Top10) is the native and only supported option.</para> <para>XLSX (OpenXML): The underlying file format supports Top10 AutoShow, but Excel 2007 and later user interface only exposes this via Top10 filter. If XLS compatibility is not required, it is recommended to use Top10 filter instead.</para

### showValuesAs(PivotFieldDataDisplayFormat, number, PivotItemPositionType, number) {#showValuesAs-pivotfielddatadisplayformat-number-pivotitempositiontype-number-}

Shows values of data field as different display format when the ShowDataAs calculation is in use.

```javascript
showValuesAs(displayFormat: PivotFieldDataDisplayFormat, baseField: number, baseItemPositionType: PivotItemPositionType, baseItem: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| displayFormat | [PivotFieldDataDisplayFormat](../pivotfielddatadisplayformat/) | The data display format type. |
| baseField | number | The index to the field which ShowDataAs calculation bases on. |
| baseItemPositionType | [PivotItemPositionType](../pivotitempositiontype/) | The position type of base iteam. |
| baseItem | number | The index to the base item which ShowDataAs calculation bases on.         /// Only works when baseItemPositionType is custom. |

**Remarks**

Only for data field.

### isHiddenItem(number) {#isHiddenItem-number-}

Indicates whether the specific PivotItem is hidden.

```javascript
isHiddenItem(index: number) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | number | The index of the pivotItem in the pivotField. |

**Returns**

whether the specific PivotItem is hidden

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.PivotItems[int].IsHidden property instead . This method will be removed 12 months later since August 2026. Aspose apologizes for any inconvenience you may have experienced.

### hideItem(number, boolean) {#hideItem-number-boolean-}

Sets whether the specific PivotItem in a data field is hidden.

```javascript
hideItem(index: number, isHidden: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | number | the index of the pivotItem in the pivotField. |
| isHidden | boolean | whether the specific PivotItem is hidden |

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.PivotItems[int].IsHidden property instead . This method will be removed 12 months later since August 2026. Aspose apologizes for any inconvenience you may have experienced.

### hideItem(string, boolean) {#hideItem-string-boolean-}

Sets whether the specific PivotItem in a data field is hidden.

```javascript
hideItem(itemValue: string, isHidden: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| itemValue | string | The name of the pivotItem in the pivotField. |
| isHidden | boolean | Whether the specific PivotItem is hidden |

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.PivotItems[string].IsHidden property instead . This method will be removed 12 months later since August 2026. Aspose apologizes for any inconvenience you may have experienced.

### isHiddenItemDetail(number) {#isHiddenItemDetail-number-}

Indicates whether to hide the detail of the specific PivotItem..

```javascript
isHiddenItemDetail(index: number) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | number | The index of the pivotItem in the pivotField. |

**Returns**

whether the specific PivotItem is hidden detail

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.PivotItems[int].IsDetailHidden property instead . This method will be removed 12 months later since August 2026. Aspose apologizes for any inconvenience you may have experienced.

### hideItemDetail(number, boolean) {#hideItemDetail-number-boolean-}

Sets whether the specific PivotItem in a pivot field is hidden detail.

```javascript
hideItemDetail(index: number, isHiddenDetail: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| index | number | the index of the pivotItem in the pivotField. |
| isHiddenDetail | boolean | whether the specific PivotItem is hidden |

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.PivotItems[int].IsDetailHidden property instead . This method will be removed 12 months later since August 2026. Aspose apologizes for any inconvenience you may have experienced.

### hideDetail(boolean) {#hideDetail-boolean-}

Sets whether the detail of all PivotItems in a pivot field are hidden. That is collapse/expand this field.

```javascript
hideDetail(isHiddenDetail: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| isHiddenDetail | boolean | Whether hide the detail of the pivot field. |

**Remarks**

NOTE: This method is now obsolete. Instead, please use PivotField.HideAllDetails() and ShowAllDetails() method instead . This method will be removed 12 months later since Septempber 2026. Aspose apologizes for any inconvenience you may have experienced.

### hideAllDetails() {#hideAllDetails--}

Hides all details

```javascript
hideAllDetails() : void;
```


### showAllDetails() {#showAllDetails--}

Show all details

```javascript
showAllDetails() : void;
```


### addCalculatedItem(string, string) {#addCalculatedItem-string-string-}

Add a calculated formula item to the pivot field.

```javascript
addCalculatedItem(name: string, formula: string) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| name | string | The item's name. |
| formula | string | The formula of pivot item. |

**Remarks**

Only supports to add calculated item to Row/Column field.