com.aspose.cells
Class PivotField

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

public class PivotField 
extends java.lang.Object

public PivotItemCollection getPivotItems()

Gets the pivot items of the pivot field

public SxRng getRange()

Gets the group range of the pivot field

public boolean isCalculatedField()

Indicates whether the specified PivotTable field is calculated field.

public int getBaseIndex() / public void setBaseIndex(int value)

Represents the PivotField index in the base PivotFields.

public int getPosition()

Represents the PivotField index in the PivotFields.

public java.lang.String getName()

Represents the PivotField name.

public java.lang.String getDisplayName() / public void setDisplayName(java.lang.String value)

Represents the PivotField display name.

public boolean isAutoSubtotals() / public void setAutoSubtotals(boolean value)

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

public boolean getDragToColumn() / public void setDragToColumn(boolean value)

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

public boolean getDragToHide() / public void setDragToHide(boolean value)

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

public boolean getDragToRow() / public void setDragToRow(boolean value)

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

public boolean getDragToPage() / public void setDragToPage(boolean value)

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

public boolean getDragToData() / public void setDragToData(boolean value)

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

public boolean isMultipleItemSelectionAllowed() / public void setMultipleItemSelectionAllowed(boolean value)

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

public boolean isRepeatItemLabels() / public void setRepeatItemLabels(boolean value)

indicates whether the field can repeat items labels The default value is false.

public boolean isIncludeNewItemsInFilter() / public void setIncludeNewItemsInFilter(boolean value)

indicates whether the field can include new items in manual filter The default value is false.

public boolean isInsertPageBreaksBetweenItems() / public void setInsertPageBreaksBetweenItems(boolean value)

indicates whether the field can insert page breaks between items insert page break after each item The default value is false.

public boolean getShowAllItems() / public void setShowAllItems(boolean value)

Indicates whether all items in the PivotTable report are displayed, even if they don't contain summary data. show items with no data The default value is false.

public boolean isAutoSort() / public void setAutoSort(boolean value)

Indicates whether the specified PivotTable field is automatically sorted.

public boolean isAscendSort() / public void setAscendSort(boolean value)

Indicates whether the specified PivotTable field is autosorted ascending.

public int getAutoSortField() / public void setAutoSortField(int value)

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

public boolean isAutoShow() / public void setAutoShow(boolean value)

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

public boolean isAscendShow() / public void setAscendShow(boolean value)

Indicates whether the specified PivotTable field is autoshown ascending.

public int getAutoShowCount() / public void setAutoShowCount(int value)

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

public int getAutoShowField() / public void setAutoShowField(int value)

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

public int getFunction() / public void setFunction(int value)

Represents the function used to summarize the PivotTable data field. The value of the property is ConsolidationFunction integer constant.

public int getDataDisplayFormat() / public void setDataDisplayFormat(int value)

Represents how to display the values contained in a data field. The value of the property is PivotFieldDataDisplayFormat integer constant.

PivotFieldDataDisplayFormat

public int getBaseField() / public void setBaseField(int value)

Represents the base field for a custom calculation.

public int getBaseItemPosition() / public void setBaseItemPosition(int value)

Represents the item in the base field for a custom calculation. Valid only for data fields. The value of the property is PivotItemPosition integer constant.

PivotItemPosition

public int getBaseItem() / public void setBaseItem(int value)

Represents the item in the base field for a custom calculation. Valid only for data fields.

public short getCurrentPageItem() / public void setCurrentPageItem(short value)

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

public int getNumber() / public void setNumber(int value)

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

public boolean getInsertBlankRow() / public void setInsertBlankRow(boolean value)

Indicates whether inserting blank line after each item.

public boolean getShowSubtotalAtTop() / 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

public boolean getShowInOutlineForm() / public void setShowInOutlineForm(boolean value)

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

public java.lang.String getNumberFormat() / public void setNumberFormat(java.lang.String value)

Represents the custom display format of numbers and dates.

public java.lang.String[] getItems()

Get all base items;

public java.lang.String[] getOriginalItems()

Get the original base items;

public int getItemCount()

Gets the base item count of this pivot field.

public boolean getShowCompact() / public void setShowCompact(boolean value)

public PivotFilter getPivotFilterByType(int type)

Gets the pivot filter of the pivot field by type

Parameters:

type - A PivotFilterType value.

public java.util.ArrayList getPivotFilters()

Gets the pivot filters of the pivot field

public void initPivotItems()

Init the pivot items of the pivot field

public java.lang.String getCalculatedFieldFormula()

Get the formula string of the specified calculated field .

public void setSubtotals(int subtotalType, boolean shown)

Sets whether the specified field shows that subtotals.

PivotFieldSubtotalType

Parameters:

subtotalType - A PivotFieldSubtotalType value. subtotals type.

shown - whether the specified field shows that subtotals.

public boolean getSubtotals(int subtotalType)

Gets whether the specified field shows that subtotals.

Parameters:

subtotalType - A PivotFieldSubtotalType value. subtotals type.

Returns:

whether the specified field shows that subtotals.

public boolean dragToColumn()

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

NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Pivot.PivotField.DragToColumn property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public boolean dragToHide()

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

NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Pivot.PivotField.DragToHide property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public boolean dragToRow()

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

NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Pivot.PivotField.DragToRow property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public boolean dragToPage()

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

NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Pivot.PivotField.DragToPage property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public boolean showAllItems()

Indicates whether all items in the PivotTable report are displayed, even if they don't contain summary data. show items with no data The default value is false.

NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Pivot.PivotField.ShowAllItems property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

public boolean isHiddenItem(int index)

Indicates whether the specific PivotItem is hidden.

Parameters:

index - the index of the pivotItem in the pivotField.

Returns:

whether the specific PivotItem is hidden

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

public boolean isHiddenItemDetail(int index)

Indicates whether the specific PivotItem is hidden detail.

Parameters:

index - the index of the pivotItem in the pivotField.

Returns:

whether the specific PivotItem is hidden detail

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

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 the PivotItems is hidden

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

public void addCalculatedItem(java.lang.String name, java.lang.String formula)

Add a calculated item to the pivot field.

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

Parameters:

name - The item's name.

formula - The item's formula