PivotField (Aspose.Cells for Java)

java.lang.Object
- com.aspose.cells.PivotField

public class PivotField
extends java.lang.Object

Represents a field in a PivotTable report.

Example

 
         Workbook book = new Workbook();
         Worksheet sheet = book.getWorksheets().get(0);
         Cells cells = sheet.getCells();
         cells.get(0, 0).setValue("fruit");
         cells.get(1, 0).setValue("grape");
         cells.get(2, 0).setValue("blueberry");
         cells.get(3, 0).setValue("kiwi");
         cells.get(4, 0).setValue("cherry");
         cells.get(5, 0).setValue("grape");
         cells.get(6, 0).setValue("blueberry");
         cells.get(7, 0).setValue("kiwi");
         cells.get(8, 0).setValue("cherry");
 
         cells.get(0, 1).setValue("year");
         cells.get(1, 1).setValue(2020);
         cells.get(2, 1).setValue(2020);
         cells.get(3, 1).setValue(2020);
         cells.get(4, 1).setValue(2020);
         cells.get(5, 1).setValue(2021);
         cells.get(6, 1).setValue(2021);
         cells.get(7, 1).setValue(2021);
         cells.get(8, 1).setValue(2021);
 
         cells.get(0, 2).setValue("amount");
         cells.get(1, 2).setValue(50);
         cells.get(2, 2).setValue(60);
         cells.get(3, 2).setValue(70);
         cells.get(4, 2).setValue(80);
         cells.get(5, 2).setValue(90);
         cells.get(6, 2).setValue(100);
         cells.get(7, 2).setValue(110);
         cells.get(8, 2).setValue(120);
 
         PivotTableCollection pivots = sheet.getPivotTables();
 
         int pivotIndex = pivots.add("=Sheet1!A1:C9", "A12", "TestPivotTable");
         PivotTable pivot = pivots.get(pivotIndex);
         pivot.addFieldToArea(PivotFieldType.ROW, "fruit");
         pivot.addFieldToArea(PivotFieldType.COLUMN, "year");
         pivot.addFieldToArea(PivotFieldType.DATA, "amount");
 
         pivot.setPivotTableStyleType(PivotTableStyleType.PIVOT_TABLE_STYLE_MEDIUM_10);
 
         //Change PivotField's attributes
         PivotField rowField = pivot.getRowFields().get(0);
         rowField.setDisplayName("custom display name");
 
         pivot.refreshData();
         pivot.calculateData();
 
         //do your business
 
         book.save("out.xlsx");

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCalculatedItem(java.lang.String name, java.lang.String formula)` Add a calculated formula item to the pivot field.
`void`	`clearFilter()` Clears filter setting on this pivot field.
`PivotFilter`	`filterByDate(int type, DateTime dateTime1, DateTime dateTime2)` Filters by date setting of row or column pivot field.
`PivotFilter`	`filterByLabel(int type, java.lang.String label1, java.lang.String label2)` Filters by captions of row or column pivot field.
`PivotFilter`	`filterByValue(int valueFieldIndex, int type, double value1, double value2)` Filters by values of data pivot field.
`PivotFilter`	`filterTop10(int valueFieldIndex, int type, boolean isTop, int itemCount)` Filters by values of data pivot field.
`int`	`getAutoShowCount()` Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.
`int`	`getAutoShowField()` Represents auto show field index.
`int`	`getAutoSortField()` Represents the index of field which is auto sorted.
`int`	`getBaseFieldIndex()` Deprecated. Use PivotField.ShowValuesSetting.BaseFieldIndex property instead.
`int`	`getBaseIndex()` Represents the PivotField index in the base PivotFields.
`int`	`getBaseItemIndex()` Deprecated. Use PivotField.ShowValuesSetting.BaseItemIndex property instead.
`int`	`getBaseItemPosition()` Deprecated. Use PivotField.ShowValuesSetting.BaseItemPositionType property instead.
`java.lang.String`	`getCalculatedFieldFormula()` Deprecated. Use PivotField.GetFormula() method instead.
`short`	`getCurrentPageItem()` Represents the current page item showing for the page field (valid only for page fields).
`int`	`getDataDisplayFormat()` Deprecated. Use PivotField.ShowValuesSetting.CalculationType property instead.
`java.lang.String`	`getDisplayName()` Represents the PivotField display name.
`boolean`	`getDragToColumn()` Indicates whether the specified field can be dragged to the column position.
`boolean`	`getDragToData()` Indicates whether the specified field can be dragged to the data position.
`boolean`	`getDragToHide()` Indicates whether the specified field can be dragged to the hide position.
`boolean`	`getDragToPage()` Indicates whether the specified field can be dragged to the page position.
`boolean`	`getDragToRow()` Indicates whether the specified field can be dragged to the row position.
`PivotFilter[]`	`getFilters()` Gets all pivot filters of this pivot field.
`java.lang.String`	`getFormula()` Gets formula of the calculated field .
`int`	`getFunction()` Represents the function used to summarize the PivotTable data field.
`PivotFieldGroupSettings`	`getGroupSettings()` Gets the group settings of the pivot field.
`boolean`	`getInsertBlankRow()` Indicates whether inserting blank line after each item.
`int`	`getItemCount()` Gets the count of the base items in this pivot field.
`java.lang.String[]`	`getItems()` Get all labels of pivot items in this field.
`java.lang.String`	`getName()` Represents the name of PivotField.
`boolean`	`getNonAutoSortDefault()` Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort.
`int`	`getNumber()` Represents the built-in display format of numbers and dates.
`java.lang.String`	`getNumberFormat()` Represents the custom display format of numbers and dates.
`java.lang.String[]`	`getOriginalItems()` Get the original base items;
`PivotFilter`	`getPivotFilterByType(int type)` Gets the pivot filter of the pivot field by type
`java.util.ArrayList`	`getPivotFilters()` Deprecated. Use PivotField.GetFilters() instead.
`PivotItemCollection`	`getPivotItems()` Gets the pivot items of the pivot field
`int`	`getPosition()` Represents the index of `PivotField` in the region.
`SxRng`	`getRange()` Deprecated. Use PivotField.GroupSettings property instead.
`int`	`getRegionType()` Specifies the region of the PivotTable that this field is displayed.
`boolean`	`getShowAllItems()` Indicates whether all items displays in the PivotTable report, even if they don't contain summary data.
`boolean`	`getShowCompact()` Indicates whether display labels from the next field in the same column on the Pivot Table view
`boolean`	`getShowInOutlineForm()` Indicates whether layout this field in outline form on the Pivot Table view
`boolean`	`getShowSubtotalAtTop()` when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
`PivotShowValuesSetting`	`getShowValuesSetting()` Gets the settings of showing values as when the ShowDataAs calculation is in use.
`PivotFieldSortSetting`	`getSortSetting()` Gets all settings of auto sorting
`boolean`	`getSubtotals(int subtotalType)` Indicates whether showing specified subtotal.
`boolean`	`groupBy(CustomPiovtFieldGroupItem[] customGroupItems, boolean newField)` Custom group the field.
`boolean`	`groupBy(DateTime start, DateTime end, int[] groups, double interval, boolean firstAsNewField)` Group the file by the date group types.
`void`	`groupBy(double interval, boolean newField)` Automatically group the field with internal
`boolean`	`groupBy(double start, double end, double interval, boolean newField)` Group the file by number.
`void`	`hideDetail(boolean isHiddenDetail)` Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.
`void`	`hideItem(int index, boolean isHidden)` Sets whether the specific PivotItem in a data field is hidden.
`void`	`hideItem(java.lang.String itemValue, boolean isHidden)` Sets whether the specific PivotItem in a data field is hidden.
`void`	`hideItemDetail(int index, boolean isHiddenDetail)` Sets whether the specific PivotItem in a pivot field is hidden detail.
`void`	`initPivotItems()` Init the pivot items of the pivot field
`boolean`	`isAscendShow()` Indicates whether the specified PivotTable field is autoshown ascending.
`boolean`	`isAscendSort()` Indicates whether the specified PivotTable field is autosorted ascending.
`boolean`	`isAutoShow()` Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
`boolean`	`isAutoSort()` Indicates whether the specified PivotTable field is automatically sorted.
`boolean`	`isAutoSubtotals()` Indicates whether the specified field shows automatic subtotals.
`boolean`	`isCalculatedField()` Indicates whether the specified PivotTable field is calculated field.
`boolean`	`isHiddenItem(int index)` Gets whether the specific PivotItem is hidden.
`boolean`	`isHiddenItemDetail(int index)` Gets whether hidding the detail of the specific PivotItem..
`boolean`	`isIncludeNewItemsInFilter()` Indicates whether including new items to the field in manual filter.
`boolean`	`isInsertPageBreaksBetweenItems()` Indicates whether inserting page breaks after each item.
`boolean`	`isMultipleItemSelectionAllowed()` indicates whether the field can have multiple items selected in the page field The default value is false.
`boolean`	`isRepeatItemLabels()` Indicates whether repeating labels of the field in the region.
`boolean`	`isValueFields()` Indicates whether this field represents values fields.
`void`	`setAscendShow(boolean value)` Indicates whether the specified PivotTable field is autoshown ascending.
`void`	`setAscendSort(boolean value)` Indicates whether the specified PivotTable field is autosorted ascending.
`void`	`setAutoShow(boolean value)` Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
`void`	`setAutoShowCount(int value)` Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.
`void`	`setAutoShowField(int value)` Represents auto show field index.
`void`	`setAutoSort(boolean value)` Indicates whether the specified PivotTable field is automatically sorted.
`void`	`setAutoSortField(int value)` Represents the index of field which is auto sorted.
`void`	`setAutoSubtotals(boolean value)` Indicates whether the specified field shows automatic subtotals.
`void`	`setBaseFieldIndex(int value)` Deprecated. Use PivotField.ShowValuesSetting.BaseFieldIndex property instead.
`void`	`setBaseIndex(int value)` Represents the PivotField index in the base PivotFields.
`void`	`setBaseItemIndex(int value)` Deprecated. Use PivotField.ShowValuesSetting.BaseItemIndex property instead.
`void`	`setBaseItemPosition(int value)` Deprecated. Use PivotField.ShowValuesSetting.BaseItemPositionType property instead.
`void`	`setCurrentPageItem(short value)` Represents the current page item showing for the page field (valid only for page fields).
`void`	`setDataDisplayFormat(int value)` Deprecated. Use PivotField.ShowValuesSetting.CalculationType property instead.
`void`	`setDisplayName(java.lang.String value)` Represents the PivotField display name.
`void`	`setDragToColumn(boolean value)` Indicates whether the specified field can be dragged to the column position.
`void`	`setDragToData(boolean value)` Indicates whether the specified field can be dragged to the data position.
`void`	`setDragToHide(boolean value)` Indicates whether the specified field can be dragged to the hide position.
`void`	`setDragToPage(boolean value)` Indicates whether the specified field can be dragged to the page position.
`void`	`setDragToRow(boolean value)` Indicates whether the specified field can be dragged to the row position.
`void`	`setFunction(int value)` Represents the function used to summarize the PivotTable data field.
`void`	`setIncludeNewItemsInFilter(boolean value)` Indicates whether including new items to the field in manual filter.
`void`	`setInsertBlankRow(boolean value)` Indicates whether inserting blank line after each item.
`void`	`setInsertPageBreaksBetweenItems(boolean value)` Indicates whether inserting page breaks after each item.
`void`	`setMultipleItemSelectionAllowed(boolean value)` indicates whether the field can have multiple items selected in the page field The default value is false.
`void`	`setName(java.lang.String value)` Represents the name of PivotField.
`void`	`setNonAutoSortDefault(boolean value)` Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort.
`void`	`setNumber(int value)` Represents the built-in display format of numbers and dates.
`void`	`setNumberFormat(java.lang.String value)` Represents the custom display format of numbers and dates.
`void`	`setRepeatItemLabels(boolean value)` Indicates whether repeating labels of the field in the region.
`void`	`setShowAllItems(boolean value)` Indicates whether all items displays in the PivotTable report, even if they don't contain summary data.
`void`	`setShowCompact(boolean value)` Indicates whether display labels from the next field in the same column on the Pivot Table view
`void`	`setShowInOutlineForm(boolean value)` Indicates whether layout this field in outline form on the Pivot Table view
`void`	`setShowSubtotalAtTop(boolean value)` when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
`void`	`setSubtotals(int subtotalType, boolean shown)` Sets whether the specified field shows that subtotals.
`void`	`showValuesAs(int displayFormat, int baseField, int baseItemPositionType, int baseItem)` Shows values of data field as different display format when the ShowDataAs calculation is in use.
`void`	`sortBy(int sortType, int fieldSortedBy)` Sorts this pivot field.
`void`	`sortBy(int sortType, int fieldSortedBy, int dataType, java.lang.String cellName)` Sorts this pivot field.
`void`	`ungroup()` Ungroup the pivot field.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getPivotItems
```
public PivotItemCollection getPivotItems()
```
    Gets the pivot items of the pivot field
  - getRange
```
public SxRng getRange()
```
    Deprecated. Use PivotField.GroupSettings property instead.
    
    Gets the group range of the pivot field
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.GroupSettings property. This method will be removed 12 months later since October 2023. Aspose apologizes for any inconvenience you may have experienced.
  - getGroupSettings
```
public PivotFieldGroupSettings getGroupSettings()
```
    Gets the group settings of the pivot field.
    Remarks
    If this field is not grouped, Null will be returned.
  - initPivotItems
```
public void initPivotItems()
```
    Init the pivot items of the pivot field
  - groupBy
```
public void groupBy(double interval,
           boolean newField)
```
    Automatically group the field with internal
    
    Parameters:
    interval - The internal of group. Automatic value will be assigned if it's zero,
    newField - Indicates whether adding a new field to the pivottable.
  - groupBy
```
public boolean groupBy(DateTime start,
              DateTime end,
              int[] groups,
              double interval,
              boolean firstAsNewField)
```
    Group the file by the date group types.
    
    Parameters:
    start - The start datetime
    end - The end of datetime
    groups - PivotGroupByType. Group types
    interval - The interval
    firstAsNewField - 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.
  - groupBy
```
public boolean groupBy(double start,
              double end,
              double interval,
              boolean newField)
```
    Group the file by number.
    
    Parameters:
    start - The start value
    end - The end of value
    interval - The interval
    newField - Indicates whether adding a new field to the pivottable
    
    Returns:
    False means this field could not be grouped by date time.
  - groupBy
```
public boolean groupBy(CustomPiovtFieldGroupItem[] customGroupItems,
              boolean newField)
```
    Custom group the field.
    
    Parameters:
    customGroupItems - The custom group items.
    newField - Indicates whether adding a new field to the pivottable
    
    Returns:
    False means this field could not be grouped by date time.
  - ungroup
```
public void ungroup()
```
    Ungroup the pivot field.
  - getPivotFilterByType
```
public PivotFilter getPivotFilterByType(int type)
```
    Gets the pivot filter of the pivot field by type
  - getPivotFilters
```
public java.util.ArrayList getPivotFilters()
```
    Deprecated. Use PivotField.GetFilters() instead.
    
    Gets the pivot filters of the pivot field
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.GetFilters() method. This method will be removed 12 months later since November 2023. Aspose apologizes for any inconvenience you may have experienced.
  - getFilters
```
public PivotFilter[] getFilters()
```
    Gets all pivot filters of this pivot field.
  - clearFilter
```
public void clearFilter()
```
    Clears filter setting on this pivot field.
  - filterTop10
```
public PivotFilter filterTop10(int valueFieldIndex,
                      int type,
                      boolean isTop,
                      int itemCount)
```
    Filters by values of data pivot field.
    
    Parameters:
    valueFieldIndex - The index of data field in the data region.
    type - PivotFilterType. The type of filtering data. Only can be Count,Sum and Percent.
    isTop - Indicates whether filter from top or bottom
    itemCount - The item count
  - filterByValue
```
public PivotFilter filterByValue(int valueFieldIndex,
                        int type,
                        double value1,
                        double value2)
```
    Filters by values of data pivot field.
    
    Parameters:
    valueFieldIndex - The index of value field in the value region.
    type - PivotFilterType. The type of filtering data.
    value1 - The value of filter condition
    value2 - The upper-bound value of between filter condition
  - filterByLabel
```
public PivotFilter filterByLabel(int type,
                        java.lang.String label1,
                        java.lang.String label2)
```
    Filters by captions of row or column pivot field.
    
    Parameters:
    type - PivotFilterType. The type of filtering data.
    label1 - The label of filter condition
    label2 - The upper-bound label of between filter condition
  - filterByDate
```
public PivotFilter filterByDate(int type,
                       DateTime dateTime1,
                       DateTime dateTime2)
```
    Filters by date setting of row or column pivot field.
    
    Parameters:
    type - PivotFilterType. The type of filtering data.
    dateTime1 - The date label of filter condition
    dateTime2 - The upper-bound date label of between filter condition
  - isCalculatedField
```
public boolean isCalculatedField()
```
    Indicates whether the specified PivotTable field is calculated field.
  - getCalculatedFieldFormula
```
public java.lang.String getCalculatedFieldFormula()
```
    Deprecated. Use PivotField.GetFormula() method instead.
    
    Get the formula string of the specified calculated field .
    Remarks
    NOTE: This method is now obsolete. Instead, please use PivotField.GetFormula() method. This method will be removed 12 months later since August 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getFormula
```
public java.lang.String getFormula()
```
    Gets formula of the calculated field .
  - isValueFields
```
public boolean isValueFields()
```
    Indicates whether this field represents values fields.
  - getBaseIndex
```
public int getBaseIndex()
```
    Represents the PivotField index in the base PivotFields.
  - setBaseIndex
```
public void setBaseIndex(int value)
```
    Represents the PivotField index in the base PivotFields.
  - getPosition
```
public int getPosition()
```
    Represents the index of PivotField in the region.
  - getRegionType
```
public int getRegionType()
```
    Specifies the region of the PivotTable that this field is displayed.
    See PivotFieldType.
  - getName
```
public java.lang.String getName()
```
    Represents the name of PivotField.
  - setName
```
public void setName(java.lang.String value)
```
    Represents the name of PivotField.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Represents the PivotField display name.
  - setDisplayName
```
public void setDisplayName(java.lang.String value)
```
    Represents the PivotField display name.
  - setSubtotals
```
public void setSubtotals(int subtotalType,
                boolean shown)
```
    Sets whether the specified field shows that subtotals.
    
    Parameters:
    subtotalType - PivotFieldSubtotalType. subtotals type.
    shown - whether the specified field shows that subtotals.
  - getSubtotals
```
public boolean getSubtotals(int subtotalType)
```
    Indicates whether showing specified subtotal.
    
    Parameters:
    subtotalType - PivotFieldSubtotalType. subtotal type.
    
    Returns:
    Returns whether showing specified subtotal.
  - isAutoSubtotals
```
public boolean isAutoSubtotals()
```
    Indicates whether the specified field shows automatic subtotals. Default is true.
  - setAutoSubtotals
```
public void setAutoSubtotals(boolean value)
```
    Indicates whether the specified field shows automatic subtotals. Default is true.
  - getDragToColumn
```
public boolean getDragToColumn()
```
    Indicates whether the specified field can be dragged to the column position. The default value is true.
  - setDragToColumn
```
public void setDragToColumn(boolean value)
```
    Indicates whether the specified field can be dragged to the column position. The default value is true.
  - getDragToHide
```
public boolean getDragToHide()
```
    Indicates whether the specified field can be dragged to the hide position. The default value is true.
  - setDragToHide
```
public void setDragToHide(boolean value)
```
    Indicates whether the specified field can be dragged to the hide position. The default value is true.
  - getDragToRow
```
public boolean getDragToRow()
```
    Indicates whether the specified field can be dragged to the row position. The default value is true.
  - setDragToRow
```
public void setDragToRow(boolean value)
```
    Indicates whether the specified field can be dragged to the row position. The default value is true.
  - getDragToPage
```
public boolean getDragToPage()
```
    Indicates whether the specified field can be dragged to the page position. The default value is true.
  - setDragToPage
```
public void setDragToPage(boolean value)
```
    Indicates whether the specified field can be dragged to the page position. The default value is true.
  - getDragToData
```
public boolean getDragToData()
```
    Indicates whether the specified field can be dragged to the data position. The default value is true.
  - setDragToData
```
public void setDragToData(boolean value)
```
    Indicates whether the specified field can be dragged to the data position. The default value is true.
  - isMultipleItemSelectionAllowed
```
public boolean isMultipleItemSelectionAllowed()
```
    indicates whether the field can have multiple items selected in the page field The default value is false.
  - setMultipleItemSelectionAllowed
```
public void setMultipleItemSelectionAllowed(boolean value)
```
    indicates whether the field can have multiple items selected in the page field The default value is false.
  - isRepeatItemLabels
```
public boolean isRepeatItemLabels()
```
    Indicates whether repeating labels of the field in the region. The default value is false.
  - setRepeatItemLabels
```
public void setRepeatItemLabels(boolean value)
```
    Indicates whether repeating labels of the field in the region. The default value is false.
  - isIncludeNewItemsInFilter
```
public boolean isIncludeNewItemsInFilter()
```
    Indicates whether including new items to the field in manual filter. The default value is false.
  - setIncludeNewItemsInFilter
```
public void setIncludeNewItemsInFilter(boolean value)
```
    Indicates whether including new items to the field in manual filter. The default value is false.
  - isInsertPageBreaksBetweenItems
```
public boolean isInsertPageBreaksBetweenItems()
```
    Indicates whether inserting page breaks after each item. The default value is false.
  - setInsertPageBreaksBetweenItems
```
public void setInsertPageBreaksBetweenItems(boolean value)
```
    Indicates whether inserting page breaks after each item. The default value is false.
  - getShowAllItems
```
public boolean getShowAllItems()
```
    Indicates whether all items displays in the PivotTable report, even if they don't contain summary data. show items with no data The default value is false.
  - setShowAllItems
```
public void setShowAllItems(boolean value)
```
    Indicates whether all items displays in the PivotTable report, even if they don't contain summary data. show items with no data The default value is false.
  - sortBy
```
public void sortBy(int sortType,
          int fieldSortedBy)
```
    Sorts this pivot field.
    
    Parameters:
    sortType - SortOrder. The type of sorting this field.
    fieldSortedBy - 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.
  - sortBy
```
public void sortBy(int sortType,
          int fieldSortedBy,
          int dataType,
          java.lang.String cellName)
```
    Sorts this pivot field.
    
    Parameters:
    sortType - SortOrder. The type of sorting this field.
    fieldSortedBy - 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. The type of data sorted by.
    cellName - Sort by values in the row or column
  - getNonAutoSortDefault
```
public boolean getNonAutoSortDefault()
```
    Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort.
  - setNonAutoSortDefault
```
public void setNonAutoSortDefault(boolean value)
```
    Indicates whether a sort operation that will be applied to this pivot field is an autosort operation or a simple data sort.
  - isAutoSort
```
public boolean isAutoSort()
```
    Indicates whether the specified PivotTable field is automatically sorted.
  - setAutoSort
```
public void setAutoSort(boolean value)
```
    Indicates whether the specified PivotTable field is automatically sorted.
  - isAscendSort
```
public boolean isAscendSort()
```
    Indicates whether the specified PivotTable field is autosorted ascending.
  - setAscendSort
```
public void setAscendSort(boolean value)
```
    Indicates whether the specified PivotTable field is autosorted ascending.
  - getSortSetting
```
public PivotFieldSortSetting getSortSetting()
```
    Gets all settings of auto sorting
  - getAutoSortField
```
public int getAutoSortField()
```
    Represents the index of field which is auto sorted. -1 means PivotField itself,others means the position of the data fields.
  - setAutoSortField
```
public void setAutoSortField(int value)
```
    Represents the index of field which is auto sorted. -1 means PivotField itself,others means the position of the data fields.
  - isAutoShow
```
public boolean isAutoShow()
```
    Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
  - setAutoShow
```
public void setAutoShow(boolean value)
```
    Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
  - isAscendShow
```
public boolean isAscendShow()
```
    Indicates whether the specified PivotTable field is autoshown ascending.
  - setAscendShow
```
public void setAscendShow(boolean value)
```
    Indicates whether the specified PivotTable field is autoshown ascending.
  - getAutoShowCount
```
public int getAutoShowCount()
```
    Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.
  - setAutoShowCount
```
public void setAutoShowCount(int value)
```
    Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.
  - getAutoShowField
```
public int getAutoShowField()
```
    Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.
  - setAutoShowField
```
public void setAutoShowField(int value)
```
    Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.
  - getFunction
```
public int getFunction()
```
    Represents the function used to summarize the PivotTable data field.
    See ConsolidationFunction.
  - setFunction
```
public void setFunction(int value)
```
    Represents the function used to summarize the PivotTable data field.
    See ConsolidationFunction.
  - showValuesAs
```
public void showValuesAs(int displayFormat,
                int baseField,
                int baseItemPositionType,
                int baseItem)
```
    Shows values of data field as different display format when the ShowDataAs calculation is in use.
    Remarks
    Only for data field.
    
    Parameters:
    displayFormat - PivotFieldDataDisplayFormat. The data display format type.
    baseField - The index to the field which ShowDataAs calculation bases on.
    baseItemPositionType - PivotItemPositionType. The position type of base iteam.
    baseItem - The index to the base item which ShowDataAs calculation bases on. Only works when baseItemPositionType is custom.
  - getShowValuesSetting
```
public PivotShowValuesSetting getShowValuesSetting()
```
    Gets the settings of showing values as when the ShowDataAs calculation is in use.
  - getDataDisplayFormat
```
public int getDataDisplayFormat()
```
    Deprecated. Use PivotField.ShowValuesSetting.CalculationType property instead.
    
    Represents how to display the values in a data field of the pivot report.
    See PivotFieldDataDisplayFormat.
    
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotField.ShowValuesSetting.CalculationType property instead. This method will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.
  - setDataDisplayFormat
```
public void setDataDisplayFormat(int value)
```
    Deprecated. Use PivotField.ShowValuesSetting.CalculationType property instead.
    
    Represents how to display the values in a data field of the pivot report.
    See PivotFieldDataDisplayFormat.
    
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotField.ShowValuesSetting.CalculationType property instead. This method will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getBaseFieldIndex
```
public int getBaseFieldIndex()
```
    Deprecated. Use PivotField.ShowValuesSetting.BaseFieldIndex property instead.
    
    Represents the base field for a custom calculation when the ShowDataAs calculation is in use.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotField.ShowValuesSetting.BaseFieldIndex property instead. This method will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.
  - setBaseFieldIndex
```
public void setBaseFieldIndex(int value)
```
    Deprecated. Use PivotField.ShowValuesSetting.BaseFieldIndex property instead.
    
    Represents the base field for a custom calculation when the ShowDataAs calculation is in use.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotField.ShowValuesSetting.BaseFieldIndex property instead. This method will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getBaseItemPosition
```
public int getBaseItemPosition()
```
    Deprecated. Use PivotField.ShowValuesSetting.BaseItemPositionType property instead.
    
    Represents the item in the base field for a custom calculation when the ShowDataAs calculation is in use. Valid only for data fields. Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, please set PivotField.BaseItemIndex attribute.
    See PivotItemPosition.
    
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotField.ShowValuesSetting.BaseItemPositionType property instead. This method will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.
  - setBaseItemPosition
```
public void setBaseItemPosition(int value)
```
    Deprecated. Use PivotField.ShowValuesSetting.BaseItemPositionType property instead.
    
    Represents the item in the base field for a custom calculation when the ShowDataAs calculation is in use. Valid only for data fields. Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, please set PivotField.BaseItemIndex attribute.
    See PivotItemPosition.
    
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotField.ShowValuesSetting.BaseItemPositionType property instead. This method will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getBaseItemIndex
```
public int getBaseItemIndex()
```
    Deprecated. Use PivotField.ShowValuesSetting.BaseItemIndex property instead.
    
    Represents the item in the base field for a custom calculation when the ShowDataAs calculation is in use. Valid only for data fields.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotField.ShowValuesSetting.BaseItemIndex property instead. This method will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.
  - setBaseItemIndex
```
public void setBaseItemIndex(int value)
```
    Deprecated. Use PivotField.ShowValuesSetting.BaseItemIndex property instead.
    
    Represents the item in the base field for a custom calculation when the ShowDataAs calculation is in use. Valid only for data fields.
    Remarks
    NOTE: This property is now obsolete. Instead, please use PivotField.ShowValuesSetting.BaseItemIndex property instead. This method will be removed 12 months later since June 2024. Aspose apologizes for any inconvenience you may have experienced.
  - getCurrentPageItem
```
public short getCurrentPageItem()
```
    Represents the current page item showing for the page field (valid only for page fields).
  - setCurrentPageItem
```
public void setCurrentPageItem(short value)
```
    Represents the current page item showing for the page field (valid only for page fields).
  - getNumber
```
public int getNumber()
```
    Represents the built-in display format of numbers and dates.
  - setNumber
```
public void setNumber(int value)
```
    Represents the built-in display format of numbers and dates.
  - getInsertBlankRow
```
public boolean getInsertBlankRow()
```
    Indicates whether inserting blank line after each item.
  - setInsertBlankRow
```
public void setInsertBlankRow(boolean value)
```
    Indicates whether inserting blank line after each item.
  - getShowSubtotalAtTop
```
public boolean getShowSubtotalAtTop()
```
    when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
    Remarks
    Only works when ShowInOutlineForm is true.
  - setShowSubtotalAtTop
```
public void setShowSubtotalAtTop(boolean value)
```
    when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
    Remarks
    Only works when ShowInOutlineForm is true.
  - getShowInOutlineForm
```
public boolean getShowInOutlineForm()
```
    Indicates whether layout this field in outline form on the Pivot Table view
  - setShowInOutlineForm
```
public void setShowInOutlineForm(boolean value)
```
    Indicates whether layout this field in outline form on the Pivot Table view
  - getNumberFormat
```
public java.lang.String getNumberFormat()
```
    Represents the custom display format of numbers and dates.
  - setNumberFormat
```
public void setNumberFormat(java.lang.String value)
```
    Represents the custom display format of numbers and dates.
  - isHiddenItem
```
public boolean isHiddenItem(int index)
```
    Gets whether the specific PivotItem is hidden.
    
    Parameters:
    index - The index of the pivotItem in the pivotField.
    
    Returns:
    whether the specific PivotItem is hidden
  - hideItem
```
public void hideItem(int index,
            boolean isHidden)
```
    Sets whether the specific PivotItem in a data field is hidden.
    
    Parameters:
    index - the index of the pivotItem in the pivotField.
    isHidden - whether the specific PivotItem is hidden
  - isHiddenItemDetail
```
public boolean isHiddenItemDetail(int index)
```
    Gets whether hidding the detail of the specific PivotItem..
    
    Parameters:
    index - The index of the pivotItem in the pivotField.
    
    Returns:
    whether the specific PivotItem is hidden detail
  - hideItemDetail
```
public void hideItemDetail(int index,
                  boolean isHiddenDetail)
```
    Sets whether the specific PivotItem in a pivot field is hidden detail.
    
    Parameters:
    index - the index of the pivotItem in the pivotField.
    isHiddenDetail - whether the specific PivotItem is hidden
  - hideDetail
```
public void hideDetail(boolean isHiddenDetail)
```
    Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.
    
    Parameters:
    isHiddenDetail - Whether hide the detail of the pivot field.
  - hideItem
```
public void hideItem(java.lang.String itemValue,
            boolean isHidden)
```
    Sets whether the specific PivotItem in a data field is hidden.
    
    Parameters:
    itemValue - the value of the pivotItem in the pivotField.
    isHidden - whether the specific PivotItem is hidden
  - getItems
```
public java.lang.String[] getItems()
```
    Get all labels of pivot items in this field.
  - getOriginalItems
```
public java.lang.String[] getOriginalItems()
```
    Get the original base items;
  - getItemCount
```
public int getItemCount()
```
    Gets the count of the base items in this pivot field.
  - addCalculatedItem
```
public void addCalculatedItem(java.lang.String name,
                     java.lang.String formula)
```
    Add a calculated formula item to the pivot field.
    Remarks
    Only supports to add calculated item to Row/Column field.
    
    Parameters:
    name - The item's name.
    formula - The formula of pivot item.
  - getShowCompact
```
public boolean getShowCompact()
```
    Indicates whether display labels from the next field in the same column on the Pivot Table view
  - setShowCompact
```
public void setShowCompact(boolean value)
```
    Indicates whether display labels from the next field in the same column on the Pivot Table view

Class PivotField

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getPivotItems

getRange

getGroupSettings

initPivotItems

groupBy

groupBy

groupBy

groupBy

ungroup

getPivotFilterByType

getPivotFilters

getFilters

clearFilter

filterTop10

filterByValue

filterByLabel

filterByDate

isCalculatedField

getCalculatedFieldFormula

getFormula

isValueFields

getBaseIndex

setBaseIndex

getPosition

getRegionType

getName

setName

getDisplayName

setDisplayName

setSubtotals

getSubtotals

isAutoSubtotals

setAutoSubtotals

getDragToColumn

setDragToColumn

getDragToHide

setDragToHide

getDragToRow

setDragToRow

getDragToPage

setDragToPage

getDragToData

setDragToData

isMultipleItemSelectionAllowed

setMultipleItemSelectionAllowed

isRepeatItemLabels

setRepeatItemLabels

isIncludeNewItemsInFilter

setIncludeNewItemsInFilter

isInsertPageBreaksBetweenItems

setInsertPageBreaksBetweenItems

getShowAllItems

setShowAllItems

sortBy

sortBy

getNonAutoSortDefault

setNonAutoSortDefault

isAutoSort

setAutoSort

isAscendSort

setAscendSort

getSortSetting

getAutoSortField

setAutoSortField

isAutoShow

setAutoShow

isAscendShow

setAscendShow

getAutoShowCount

setAutoShowCount

getAutoShowField

setAutoShowField

getFunction

setFunction

showValuesAs

getShowValuesSetting