PivotField

Inheritance: java.lang.Object

public class PivotField

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");

Methods

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

addCalculatedItem(String name, String formula)

public void addCalculatedItem(String name, String formula)

Add a calculated formula item to the pivot field.

Remarks

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

Parameters:

Parameter	Type	Description
name	java.lang.String	The item’s name.
formula	java.lang.String	The formula of pivot item.

clearFilter()

public void clearFilter()

Clears filter setting on this pivot field.

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

filterByDate(int type, DateTime dateTime1, DateTime dateTime2)

public PivotFilter filterByDate(int type, DateTime dateTime1, DateTime dateTime2)

Filters by date setting of row or column pivot field.

Parameters:

Parameter	Type	Description
type	int	PivotFilterType. The type of filtering data.
dateTime1	DateTime	The date label of filter condition
dateTime2	DateTime	The upper-bound date label of between filter condition

Returns: PivotFilter

filterByLabel(int type, String label1, String label2)

public PivotFilter filterByLabel(int type, String label1, String label2)

Filters by captions of row or column pivot field.

Parameters:

Parameter	Type	Description
type	int	PivotFilterType. The type of filtering data.
label1	java.lang.String	The label of filter condition
label2	java.lang.String	The upper-bound label of between filter condition

Returns: PivotFilter

filterByValue(int valueFieldIndex, int type, double value1, double value2)

public PivotFilter filterByValue(int valueFieldIndex, int type, double value1, double value2)

Filters by values of data pivot field.

Parameters:

Parameter	Type	Description
valueFieldIndex	int	The index of value field in the value region.
type	int	PivotFilterType. The type of filtering data.
value1	double	The value of filter condition
value2	double	The upper-bound value of between filter condition

Returns: PivotFilter

filterTop10(int valueFieldIndex, int type, boolean isTop, int itemCount)

public PivotFilter filterTop10(int valueFieldIndex, int type, boolean isTop, int itemCount)

Filters by values of data pivot field.

Parameters:

Parameter	Type	Description
valueFieldIndex	int	The index of data field in the data region.
type	int	PivotFilterType. The type of filtering data. Only can be Count,Sum and Percent.
isTop	boolean	Indicates whether filter from top or bottom
itemCount	int	The item count

Returns: PivotFilter

getAutoShowCount()

public int getAutoShowCount()

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

Returns: int

getAutoShowField()

public int getAutoShowField()

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

Returns: int

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.

Returns: int

getBaseFieldIndex()

public int getBaseFieldIndex()

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.

Returns: int

getBaseIndex()

public int getBaseIndex()

Represents the PivotField index in the base PivotFields.

Returns: int

getBaseItemIndex()

public int getBaseItemIndex()

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.

Returns: int

getBaseItemPosition()

public int getBaseItemPosition()

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.

Returns: int

getCalculatedFieldFormula()

public String getCalculatedFieldFormula()

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.

Returns: java.lang.String

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCurrentPageItem()

public short getCurrentPageItem()

Represents the current page item showing for the page field (valid only for page fields).

Returns: short

getDataDisplayFormat()

public int getDataDisplayFormat()

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.

Returns: int

getDisplayName()

public String getDisplayName()

Represents the PivotField display name.

Returns: java.lang.String

getDragToColumn()

public boolean getDragToColumn()

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

Returns: boolean

getDragToData()

public boolean getDragToData()

Indicates whether the specified field can be dragged to the data position. The default value is true.

Returns: boolean

getDragToHide()

public boolean getDragToHide()

Indicates whether the specified field can be dragged to the hide position. The default value is true.

Returns: boolean

getDragToPage()

public boolean getDragToPage()

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

Returns: boolean

getDragToRow()

public boolean getDragToRow()

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

Returns: boolean

getFilters()

public PivotFilter[] getFilters()

Gets all pivot filters of this pivot field.

Returns: com.aspose.cells.PivotFilter[]

getFormula()

public String getFormula()

Gets formula of the calculated field .

Returns: java.lang.String

getFunction()

public int getFunction()

Represents the function used to summarize the PivotTable data field.

See ConsolidationFunction.

Returns: int

getGroupSettings()

public PivotFieldGroupSettings getGroupSettings()

Gets the group settings of the pivot field.

Remarks

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

Returns: PivotFieldGroupSettings

getInsertBlankRow()

public boolean getInsertBlankRow()

Indicates whether inserting blank line after each item.

Returns: boolean

getItemCount()

public int getItemCount()

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

Returns: int

getItems()

public String[] getItems()

Get all labels of pivot items in this field.

Returns: java.lang.String[]

getName()

public String getName()

Represents the name of PivotField.

Returns: java.lang.String

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.

Returns: boolean

getNumber()

public int getNumber()

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

Returns: int

getNumberFormat()

public String getNumberFormat()

Represents the custom display format of numbers and dates.

Returns: java.lang.String

getOriginalItems()

public String[] getOriginalItems()

Get the original base items;

Returns: java.lang.String[]

getPivotFilterByType(int type)

public PivotFilter getPivotFilterByType(int type)

Gets the pivot filter of the pivot field by type

Parameters:

Parameter	Type	Description
type	int

Returns: PivotFilter

getPivotFilters()

public ArrayList getPivotFilters()

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.

Returns: java.util.ArrayList

getPivotItems()

public PivotItemCollection getPivotItems()

Gets the pivot items of the pivot field

Returns: PivotItemCollection

getPosition()

public int getPosition()

Represents the index of PivotField in the region.

Returns: int

getRange()

public SxRng getRange()

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.

Returns: SxRng

getRegionType()

public int getRegionType()

Specifies the region of the PivotTable that this field is displayed.

See PivotFieldType.

Returns: int

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.

Returns: boolean

getShowCompact()

public boolean getShowCompact()

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

Returns: boolean

getShowInOutlineForm()

public boolean getShowInOutlineForm()

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

Returns: boolean

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.

Returns: boolean

getShowValuesSetting()

public PivotShowValuesSetting getShowValuesSetting()

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

Returns: PivotShowValuesSetting

getSortSetting()

public PivotFieldSortSetting getSortSetting()

Gets all settings of auto sorting

Returns: PivotFieldSortSetting

getSubtotals(int subtotalType)

public boolean getSubtotals(int subtotalType)

Indicates whether showing specified subtotal.

Parameters:

Parameter	Type	Description
subtotalType	int	PivotFieldSubtotalType. subtotal type.

Returns: boolean - Returns whether showing specified subtotal.

groupBy(CustomPiovtFieldGroupItem[] customGroupItems, boolean newField)

public boolean groupBy(CustomPiovtFieldGroupItem[] customGroupItems, boolean newField)

Custom group the field.

Parameters:

Parameter	Type	Description
customGroupItems	CustomPiovtFieldGroupItem[]	The custom group items.
newField	boolean	Indicates whether adding a new field to the pivottable

Returns: boolean - False means this field could not be grouped by date time.

groupBy(DateTime start, DateTime end, int[] groups, double interval, boolean firstAsNewField)

public boolean groupBy(DateTime start, DateTime end, int[] groups, double interval, boolean firstAsNewField)

Group the file by the date group types.

Parameters:

Parameter	Type	Description
start	DateTime	The start datetime
end	DateTime	The end of datetime
groups	int[]	PivotGroupByType. Group types
interval	double	The interval
firstAsNewField	boolean	Indicates whether adding a new field to the pivottable. Only for the first group item.

Returns: boolean - False means this field could not be grouped by date time.

groupBy(double interval, boolean newField)

public void groupBy(double interval, boolean newField)

Automatically group the field with internal

Parameters:

Parameter	Type	Description
interval	double	The internal of group. Automatic value will be assigned if it’s zero,
newField	boolean	Indicates whether adding a new field to the pivottable.

groupBy(double start, double end, double interval, boolean newField)

public boolean groupBy(double start, double end, double interval, boolean newField)

Group the file by number.

Parameters:

Parameter	Type	Description
start	double	The start value
end	double	The end of value
interval	double	The interval
newField	boolean	Indicates whether adding a new field to the pivottable

Returns: boolean - False means this field could not be grouped by date time.

hashCode()

public native int hashCode()

Returns: int

hideDetail(boolean isHiddenDetail)

public void hideDetail(boolean isHiddenDetail)

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

Parameters:

Parameter	Type	Description
isHiddenDetail	boolean	Whether hide the detail of the pivot field.

hideItem(int index, boolean isHidden)

public void hideItem(int index, boolean isHidden)

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

Parameters:

Parameter	Type	Description
index	int	the index of the pivotItem in the pivotField.
isHidden	boolean	whether the specific PivotItem is hidden

hideItem(String itemValue, boolean isHidden)

public void hideItem(String itemValue, boolean isHidden)

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

Parameters:

Parameter	Type	Description
itemValue	java.lang.String	the value of the pivotItem in the pivotField.
isHidden	boolean	whether the specific PivotItem is hidden

hideItemDetail(int index, boolean isHiddenDetail)

public void hideItemDetail(int index, boolean isHiddenDetail)

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

Parameters:

Parameter	Type	Description
index	int	the index of the pivotItem in the pivotField.
isHiddenDetail	boolean	whether the specific PivotItem is hidden

initPivotItems()

public void initPivotItems()

Init the pivot items of the pivot field

isAscendShow()

public boolean isAscendShow()

Indicates whether the specified PivotTable field is autoshown ascending.

Returns: boolean

isAscendSort()

public boolean isAscendSort()

Indicates whether the specified PivotTable field is autosorted ascending.

Returns: boolean

isAutoShow()

public boolean isAutoShow()

Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.

Returns: boolean

isAutoSort()

public boolean isAutoSort()

Indicates whether the specified PivotTable field is automatically sorted.

Returns: boolean

isAutoSubtotals()

public boolean isAutoSubtotals()

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

Returns: boolean

isCalculatedField()

public boolean isCalculatedField()

Indicates whether the specified PivotTable field is calculated field.

Returns: boolean

isHiddenItem(int index)

public boolean isHiddenItem(int index)

Gets whether the specific PivotItem is hidden.

Parameters:

Parameter	Type	Description
index	int	The index of the pivotItem in the pivotField.

Returns: boolean - whether the specific PivotItem is hidden

isHiddenItemDetail(int index)

public boolean isHiddenItemDetail(int index)

Gets whether hidding the detail of the specific PivotItem..

Parameters:

Parameter	Type	Description
index	int	The index of the pivotItem in the pivotField.

Returns: boolean - whether the specific PivotItem is hidden detail

isIncludeNewItemsInFilter()

public boolean isIncludeNewItemsInFilter()

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

Returns: boolean

isInsertPageBreaksBetweenItems()

public boolean isInsertPageBreaksBetweenItems()

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

Returns: boolean

isMultipleItemSelectionAllowed()

public boolean isMultipleItemSelectionAllowed()

indicates whether the field can have multiple items selected in the page field The default value is false.

Returns: boolean

isRepeatItemLabels()

public boolean isRepeatItemLabels()

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

Returns: boolean

isValueFields()

public boolean isValueFields()

Indicates whether this field represents values fields.

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setAscendShow(boolean value)

public void setAscendShow(boolean value)

Indicates whether the specified PivotTable field is autoshown ascending.

Parameters:

Parameter	Type	Description
value	boolean

setAscendSort(boolean value)

public void setAscendSort(boolean value)

Indicates whether the specified PivotTable field is autosorted ascending.

Parameters:

Parameter	Type	Description
value	boolean

setAutoShow(boolean value)

public void setAutoShow(boolean value)

Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.

Parameters:

Parameter	Type	Description
value	boolean

setAutoShowCount(int value)

public void setAutoShowCount(int value)

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

Parameters:

Parameter	Type	Description
value	int

setAutoShowField(int value)

public void setAutoShowField(int value)

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

Parameters:

Parameter	Type	Description
value	int

setAutoSort(boolean value)

public void setAutoSort(boolean value)

Indicates whether the specified PivotTable field is automatically sorted.

Parameters:

Parameter	Type	Description
value	boolean

setAutoSortField(int value)

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.

Parameters:

Parameter	Type	Description
value	int

setAutoSubtotals(boolean value)

public void setAutoSubtotals(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setBaseFieldIndex(int value)

public void setBaseFieldIndex(int value)

Represents the base field for a custom calculation when the ShowDataAs calculation is in use.

Remarks

Parameters:

Parameter	Type	Description
value	int

setBaseIndex(int value)

public void setBaseIndex(int value)

Represents the PivotField index in the base PivotFields.

Parameters:

Parameter	Type	Description
value	int

setBaseItemIndex(int value)

public void setBaseItemIndex(int value)

Represents the item in the base field for a custom calculation when the ShowDataAs calculation is in use. Valid only for data fields.

Remarks

Parameters:

Parameter	Type	Description
value	int

setBaseItemPosition(int value)

public void setBaseItemPosition(int value)

See PivotItemPosition.

Remarks

Parameters:

Parameter	Type	Description
value	int

setCurrentPageItem(short value)

public void setCurrentPageItem(short value)

Represents the current page item showing for the page field (valid only for page fields).

Parameters:

Parameter	Type	Description
value	short

setDataDisplayFormat(int value)

public void setDataDisplayFormat(int value)

Represents how to display the values in a data field of the pivot report.

See PivotFieldDataDisplayFormat.

Remarks

Parameters:

Parameter	Type	Description
value	int

setDisplayName(String value)

public void setDisplayName(String value)

Represents the PivotField display name.

Parameters:

Parameter	Type	Description
value	java.lang.String

setDragToColumn(boolean value)

public void setDragToColumn(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setDragToData(boolean value)

public void setDragToData(boolean value)

Indicates whether the specified field can be dragged to the data position. The default value is true.

Parameters:

Parameter	Type	Description
value	boolean

setDragToHide(boolean value)

public void setDragToHide(boolean value)

Indicates whether the specified field can be dragged to the hide position. The default value is true.

Parameters:

Parameter	Type	Description
value	boolean

setDragToPage(boolean value)

public void setDragToPage(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setDragToRow(boolean value)

public void setDragToRow(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setFunction(int value)

public void setFunction(int value)

Represents the function used to summarize the PivotTable data field.

See ConsolidationFunction.

Parameters:

Parameter	Type	Description
value	int

setIncludeNewItemsInFilter(boolean value)

public void setIncludeNewItemsInFilter(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setInsertBlankRow(boolean value)

public void setInsertBlankRow(boolean value)

Indicates whether inserting blank line after each item.

Parameters:

Parameter	Type	Description
value	boolean

setInsertPageBreaksBetweenItems(boolean value)

public void setInsertPageBreaksBetweenItems(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setMultipleItemSelectionAllowed(boolean value)

public void setMultipleItemSelectionAllowed(boolean value)

indicates whether the field can have multiple items selected in the page field The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setName(String value)

public void setName(String value)

Represents the name of PivotField.

Parameters:

Parameter	Type	Description
value	java.lang.String

setNonAutoSortDefault(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setNumber(int value)

public void setNumber(int value)

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

Parameters:

Parameter	Type	Description
value	int

setNumberFormat(String value)

public void setNumberFormat(String value)

Represents the custom display format of numbers and dates.

Parameters:

Parameter	Type	Description
value	java.lang.String

setRepeatItemLabels(boolean value)

public void setRepeatItemLabels(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setShowAllItems(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setShowCompact(boolean value)

public void setShowCompact(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setShowInOutlineForm(boolean value)

public void setShowInOutlineForm(boolean value)

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

Parameters:

Parameter	Type	Description
value	boolean

setShowSubtotalAtTop(boolean value)

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.

Parameters:

Parameter	Type	Description
value	boolean

setSubtotals(int subtotalType, boolean shown)

public void setSubtotals(int subtotalType, boolean shown)

Sets whether the specified field shows that subtotals.

Parameters:

Parameter	Type	Description
subtotalType	int	PivotFieldSubtotalType. subtotals type.
shown	boolean	whether the specified field shows that subtotals.

showValuesAs(int displayFormat, int baseField, int baseItemPositionType, int baseItem)

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:

Parameter	Type	Description
displayFormat	int	PivotFieldDataDisplayFormat. The data display format type.
baseField	int	The index to the field which ShowDataAs calculation bases on.
baseItemPositionType	int	PivotItemPositionType. The position type of base iteam.
baseItem	int	The index to the base item which ShowDataAs calculation bases on. Only works when baseItemPositionType is custom.

sortBy(int sortType, int fieldSortedBy)

public void sortBy(int sortType, int fieldSortedBy)

Sorts this pivot field.

Parameters:

Parameter	Type	Description
sortType	int	SortOrder. The type of sorting this field.
fieldSortedBy	int	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(int sortType, int fieldSortedBy, int dataType, String cellName)

public void sortBy(int sortType, int fieldSortedBy, int dataType, String cellName)

Sorts this pivot field.

Parameters:

Parameter	Type	Description
sortType	int	SortOrder. The type of sorting this field.
fieldSortedBy	int	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	int	PivotLineType. The type of data sorted by.
cellName	java.lang.String	Sort by values in the row or column

toString()

public String toString()

Returns: java.lang.String

ungroup()

public void ungroup()

Ungroup the pivot field.

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

Parameter	Type	Description
arg0	long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

Parameter	Type	Description
arg0	long
arg1	int