com.aspose.cells
Classes 
AboveAverage
AbstractCalculationEngine
AbstractCalculationMonitor
AbstractGlobalizationSettings
AbstractInterruptMonitor
AbstractTextLoadOptions
ActiveXControl
ActiveXControlBase
ArcShape
Area
AutoFilter
AutoFitterOptions
AutomaticFill
AutoNumberedBulletValue
Axis
AxisBins
BaseShapeGuide
Bevel
Border
BorderCollection
BuiltInDocumentPropertyCollection
Bullet
BulletValue
Button
CalculationCell
CalculationData
CalculationOptions
Cell
CellArea
Cells
CellsColor
CellsDataTableFactory
CellsDrawing
CellsException
CellsFactory
CellsHelper
CellWatch
CellWatchCollection
CharacterBulletValue
Chart
ChartArea
ChartCollection
ChartDataTable
ChartFrame
ChartGlobalizationSettings
ChartPoint
ChartPointCollection
ChartShape
ChartTextFrame
CheckBox
CheckBoxActiveXControl
CheckBoxCollection
CollectionBase
Color
ColorFilter
ColorHelper
ColorScale
Column
ColumnCollection
ComboBox
ComboBoxActiveXControl
CommandButtonActiveXControl
Comment
CommentCollection
CommentShape
ConditionalFormattingCollection
ConditionalFormattingIcon
ConditionalFormattingIconCollection
ConditionalFormattingResult
ConditionalFormattingValue
ConditionalFormattingValueCollection
ConnectionParameter
ConnectionParameterCollection
ContentTypeProperty
ContentTypePropertyCollection
CopyOptions
CustomDocumentPropertyCollection
CustomFilter
CustomFilterCollection
CustomGeometry
CustomImplementationFactory
CustomProperty
CustomPropertyCollection
CustomXmlPart
CustomXmlPartCollection
CustomXmlShape
DataBar
DataBarBorder
DataLabels
DataSorter
DataSorterKey
DataSorterKeyCollection
DateTime
DateTimeGroupItem
DBConnection
DefaultStyleSettings
DeleteOptions
DialogBox
DifSaveOptions
DigitalSignature
DigitalSignatureCollection
DisplayUnitLabel
DocumentProperty
DocumentPropertyCollection
DocxSaveOptions
DrawObject
DrawObjectEventHandler
DropBars
DxfCollection
DynamicFilter
Encoding
ErrorBar
ErrorCheckOption
ErrorCheckOptionCollection
ExportObjectEvent
ExportRangeToJsonOptions
ExportTableOptions
ExternalConnection
ExternalConnectionCollection
ExternalLink
ExternalLinkCollection
FileFontSource
FileFormatInfo
FileFormatUtil
Fill
FillFormat
FilterColumn
FilterColumnCollection
FindOptions
Floor
FolderFontSource
Font
FontConfigs
FontSetting
FontSettingCollection
FontSourceBase
Format3D
FormatCondition
FormatConditionCollection
FormulaParseOptions
FormulaSettings
Geometry
GlobalizationSettings
GlowEffect
GradientFill
GradientStop
GradientStopCollection
GroupBox
GroupFill
GroupShape
HeaderFooterCommand
HorizontalPageBreak
HorizontalPageBreakCollection
HtmlLoadOptions
HtmlSaveOptions
Hyperlink
HyperlinkCollection
IconFilter
IconSet
ImageActiveXControl
ImageFormat
ImageOrPrintOptions
ImageSaveOptions
ImportTableOptions
IndividualFontConfigs
InsertOptions
InterruptMonitor
JsonLayoutOptions
JsonLoadOptions
JsonSaveOptions
JsonUtility
Label
LabelActiveXControl
Legend
LegendEntry
LegendEntryCollection
License
Line
LineFormat
LineShape
ListBox
ListBoxActiveXControl
ListColumn
ListColumnCollection
ListObject
ListObjectCollection
LoadFilter
LoadOptions
MarkdownSaveOptions
Marker
MemoryFontSource
MetadataOptions
Metered
MsoFillFormat
MsoFillFormatHelper
MsoFormatPicture
MsoLineFormat
MsoLineFormatHelper
MsoTextFrame
MultipleFilterCollection
Name
NameCollection
NegativeBarFormat
NoneBulletValue
NoneFill
OdsCellField
OdsCellFieldCollection
OdsLoadOptions
OdsPageBackground
OdsSaveOptions
OleObject
OleObjectCollection
OoxmlSaveOptions
Outline
Oval
PageEndSavingArgs
PageSavingArgs
PageSetup
PageStartSavingArgs
PaginatedSaveOptions
PaneCollection
PasteOptions
PatternFill
PdfBookmarkEntry
PdfSaveOptions
PdfSecurityOptions
PicFormatOption
Picture
PictureBulletValue
PictureCollection
PivotField
PivotFieldCollection
PivotFilter
PivotFilterCollection
PivotFormatCondition
PivotFormatConditionCollection
PivotItem
PivotItemCollection
PivotOptions
PivotPageFields
PivotTable
PivotTableCollection
PlotArea
PptxSaveOptions
ProtectedRange
ProtectedRangeCollection
Protection
QueryTable
QueryTableCollection
RadioButton
RadioButtonActiveXControl
Range
RangeCollection
RectangleShape
ReferredArea
ReferredAreaCollection
ReflectionEffect
ReplaceOptions
Revision
RevisionAutoFormat
RevisionCellChange
RevisionCellComment
RevisionCellMove
RevisionCollection
RevisionCustomView
RevisionDefinedName
RevisionFormat
RevisionInsertDelete
RevisionInsertSheet
RevisionLog
RevisionLogCollection
RevisionMergeConflict
RevisionQueryTable
RevisionRenameSheet
Row
RowCollection
SaveOptions
Scenario
ScenarioCollection
ScenarioInputCell
ScenarioInputCellCollection
ScrollBar
ScrollBarActiveXControl
Series
SeriesCollection
SeriesLayoutProperties
ShadowEffect
Shape
ShapeCollection
ShapeFormat
ShapeGuide
ShapeGuideCollection
ShapePath
ShapePathCollection
ShapePathPoint
ShapePathPointCollection
ShapePropertyCollection
ShapeSegmentPath
ShapeSegmentPathCollection
ShapeTextAlignment
SheetPrintingPreview
SheetRender
SheetSet
SignatureLine
Slicer
SlicerCache
SlicerCacheItem
SlicerCacheItemCollection
SlicerCollection
SmartArtShape
SmartTag
SmartTagCollection
SmartTagOptions
SmartTagProperty
SmartTagPropertyCollection
SmartTagSetting
SolidFill
Sparkline
SparklineCollection
SparklineGroup
SparklineGroupCollection
SpinButtonActiveXControl
Spinner
SpreadsheetML2003SaveOptions
StreamProviderOptions
Style
StyleFlag
SubtotalSetting
SvgSaveOptions
SxRng
TableStyle
TableStyleCollection
TableStyleElement
TableStyleElementCollection
TableToRangeOptions
TextBox
TextBoxActiveXControl
TextBoxCollection
TextEffectFormat
TextOptions
TextParagraph
TextParagraphCollection
TextTabStop
TextTabStopCollection
TextureFill
ThemeColor
ThreadedComment
ThreadedCommentAuthor
ThreadedCommentAuthorCollection
ThreadedCommentCollection
ThreeDFormat
TickLabelItem
TickLabels
TilePicOption
Timeline
TimelineCollection
Title
ToggleButtonActiveXControl
Top10
Top10Filter
Trendline
TrendlineCollection
TxtLoadOptions
TxtSaveOptions
UnionRange
UnknownControl
Validation
ValidationCollection
VbaModule
VbaModuleCollection
VbaProject
VbaProjectReference
VbaProjectReferenceCollection
VerticalPageBreak
VerticalPageBreakCollection
VmlShapeGuide
Walls
WarningInfo
WebExtension
WebExtensionBinding
WebExtensionBindingCollection
WebExtensionCollection
WebExtensionProperty
WebExtensionPropertyCollection
WebExtensionReference
WebExtensionReferenceCollection
WebExtensionShape
WebExtensionTaskPane
WebExtensionTaskPaneCollection
WebQueryConnection
Workbook
WorkbookDesigner
WorkbookMetadata
WorkbookPrintingPreview
WorkbookRender
WorkbookSettings
Worksheet
WorksheetCollection
WriteProtection
XlsbSaveOptions
XlsSaveOptions
XmlColumnProperty
XmlDataBinding
XmlLoadOptions
XmlMap
XmlMapCollection
XmlSaveOptions
XpsSaveOptions
Interfaces 
ICellsDataTable
ICustomFunction
ICustomParser
IExportObjectListener
IFilePathProvider
IPageSavingCallback
ISmartMarkerCallBack
IStreamProvider
IWarningCallback
LightCellsDataHandler
LightCellsDataProvider
Constants 
AccessCacheOptions
ActiveXPersistenceType
AutoFillType
AutoFitMergedCellsType
AutoFitWrappedTextType
AutoShapeType
AxisType
BackgroundMode
BackgroundType
Bar3DShapeType
BevelPresetType
BevelType
BorderType
BubbleSizeRepresents
BuiltinStyleType
BulletType
CalcModeType
CalculationPrecisionStrategy
CategoryType
CellBorderType
CellValueFormatStrategy
CellValueType
ChartLineFormattingType
ChartMarkerType
ChartSplitType
ChartTextDirectionType
ChartType
CheckValueType
ColorDepth
ColorType
CommentTitleType
ConnectionDataSourceType
ConnectionParameterType
ConsolidationFunction
ControlBorderType
ControlCaptionAlignmentType
ControlListStyle
ControlMatchEntryType
ControlMousePointerType
ControlPictureAlignmentType
ControlPicturePositionType
ControlPictureSizeMode
ControlScrollBarType
ControlScrollOrientation
ControlSpecialEffectType
ControlType
CopyFormatType
CountryCode
CredentialsMethodType
CrossType
DataBarAxisPosition
DataBarBorderType
DataBarFillType
DataBarNegativeColorType
DataLabelShapeType
DataLabelsSeparatorType
DataLablesSeparatorType
DateTimeGroupingType
DefaultEditLanguage
DirectoryType
DisplayDrawingObjects
DisplayUnitType
DrawObjectEnum
DropButtonStyle
DynamicFilterType
EmfRenderSetting
EncryptionType
ErrorBarDisplayType
ErrorBarType
ErrorCheckType
ExceptionType
ExternalLinkType
FileFormatType
FillPattern
FillPictureType
FillType
FilterOperatorType
FilterType
FontSchemeType
FontSourceType
FontUnderlineType
FormatConditionType
FormatConditionValueType
FormatSetType
FormattingType
GradientColorType
GradientDirectionType
GradientFillType
GradientPresetType
GradientStyleType
GridlineType
HeaderFooterCommandType
HtmlCrossType
HtmlExportDataOptions
HtmlFormatHandlingType
HtmlHiddenColDisplayType
HtmlHiddenRowDisplayType
HtmlLinkTargetType
IconSetType
ImageType
InputMethodEditorMode
LabelPositionType
LegendPositionType
LightRigDirectionType
LightRigType
LineCapType
LineJoinType
LineSpaceSizeType
LineType
LoadDataFilterOptions
LoadFormat
LookAtType
LookInType
MapChartLabelLayout
MapChartProjectionType
MapChartRegionType
MemorySetting
MetadataType
MirrorType
MsoArrowheadLength
MsoArrowheadStyle
MsoArrowheadWidth
MsoDrawingType
MsoLineDashStyle
MsoLineStyle
MsoPresetTextEffect
MsoPresetTextEffectShape
NameScopeType
NumberCategoryType
OdsCellFieldType
OdsGeneratorType
OdsPageBackgroundGraphicPositionType
OdsPageBackgroundGraphicType
OdsPageBackgroundType
OLEDBCommandType
OoxmlCompliance
OoxmlCompressionType
OperatorType
PageLayoutAlignmentType
PageOrientationType
PaneStateType
PaperSizeType
ParameterType
PasteOperationType
PasteType
PdfCompliance
PdfCompressionCore
PdfCustomPropertiesExport
PdfFontEncoding
PdfOptimizationType
PivotConditionFormatRuleType
PivotConditionFormatScopeType
PivotFieldDataDisplayFormat
PivotFieldSubtotalType
PivotFieldType
PivotFilterType
PivotGroupByType
PivotItemPosition
PivotMissingItemLimitType
PivotTableAutoFormatType
PivotTableStyleType
PlacementType
PlotDataByType
PlotEmptyCellsType
PresetCameraType
PresetMaterialType
PresetShadowType
PresetWordArtStyle
PrintCommentsType
PrintErrorsType
PrintingPageType
PrintOrderType
PrintSizeType
PropertyType
ProtectionType
QuartileCalculationType
ReConnectionMethodType
RectangleAlignmentType
ReflectionEffectType
RenameStrategy
ResourceLoadingType
RevisionActionType
RevisionType
SaveFormat
SelectionType
ShapeAnchorType
ShapeLockType
ShapePathType
SheetType
ShiftType
ShowDropButtonType
SlicerCacheCrossFilterType
SlicerCacheItemSortType
SlicerStyleType
SmartTagShowType
SortOnType
SortOrder
SparklineAxisMinMaxType
SparklinePresetStyleType
SparklineType
SqlDataType
StyleModifyFlag
TableDataSourceType
TableStyleElementType
TableStyleType
TargetModeType
TextAlignmentType
TextAutonumberScheme
TextCapsType
TextCrossType
TextDirectionType
TextFontAlignType
TextNodeType
TextOrientationType
TextOverflowType
TextStrikeType
TextTabAlignmentType
TextureType
TextVerticalType
ThemeColorType
TickLabelPositionType
TickMarkType
TiffCompression
TimePeriodType
TimeUnit
TotalsCalculation
TrendlineType
TxtLoadStyleStrategy
TxtValueQuoteType
UpdateLinksType
ValidationAlertType
ValidationType
VbaModuleType
VbaProjectReferenceType
ViewType
VisibilityType
WarningType
WebExtensionStoreType
WeightType
XAdESType

com.aspose.cells
Class PivotField

java.lang.Object
    extended by 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");


Property Getters/Setters Summary
intgetAutoShowCount()
voidsetAutoShowCount(int)
           Represent the number of top or bottom items that are automatically shown in the specified PivotTable field.
intgetAutoShowField()
voidsetAutoShowField(int)
           Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields.
intgetAutoSortField()
voidsetAutoSortField(int)
           Represents auto sort field index. -1 means PivotField itself,others means the position of the data fields.
intgetBaseFieldIndex()
voidsetBaseFieldIndex(int)
           Represents the base field for a custom calculation.
intgetBaseIndex()
voidsetBaseIndex(int)
           Represents the PivotField index in the base PivotFields.
intgetBaseItemIndex()
voidsetBaseItemIndex(int)
           Represents the item in the base field for a custom calculation. Valid only for data fields.
intgetBaseItemPosition()
voidsetBaseItemPosition(int)
           Represents the item in the base field for a custom calculation. Valid only for data fields. Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, please set PivotField.BaseItemIndex attribute. The value of the property is PivotItemPosition integer constant.
shortgetCurrentPageItem()
voidsetCurrentPageItem(short)
           Represents the current page item showing for the page field (valid only for page fields).
intgetDataDisplayFormat()
voidsetDataDisplayFormat(int)
           Represents how to display the values contained in a data field. The value of the property is PivotFieldDataDisplayFormat integer constant.
java.lang.StringgetDisplayName()
voidsetDisplayName(java.lang.String)
           Represents the PivotField display name.
booleangetDragToColumn()
voidsetDragToColumn(boolean)
           Indicates whether the specified field can be dragged to the column position. The default value is true.
booleangetDragToData()
voidsetDragToData(boolean)
           Indicates whether the specified field can be dragged to the data position. The default value is true.
booleangetDragToHide()
voidsetDragToHide(boolean)
           Indicates whether the specified field can be dragged to the hide position. The default value is true.
booleangetDragToPage()
voidsetDragToPage(boolean)
           Indicates whether the specified field can be dragged to the page position. The default value is true.
booleangetDragToRow()
voidsetDragToRow(boolean)
           Indicates whether the specified field can be dragged to the row position. The default value is true.
intgetFunction()
voidsetFunction(int)
           Represents the function used to summarize the PivotTable data field. The value of the property is ConsolidationFunction integer constant.
booleangetInsertBlankRow()
voidsetInsertBlankRow(boolean)
           Indicates whether inserting blank line after each item.
booleanisAscendShow()
voidsetAscendShow(boolean)
           Indicates whether the specified PivotTable field is autoshown ascending.
booleanisAscendSort()
voidsetAscendSort(boolean)
           Indicates whether the specified PivotTable field is autosorted ascending.
booleanisAutoShow()
voidsetAutoShow(boolean)
           Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.
booleanisAutoSort()
voidsetAutoSort(boolean)
           Indicates whether the specified PivotTable field is automatically sorted.
booleanisAutoSubtotals()
voidsetAutoSubtotals(boolean)
           Indicates whether the specified field shows automatic subtotals. Default is true.
booleanisCalculatedField()
           Indicates whether the specified PivotTable field is calculated field.
booleanisIncludeNewItemsInFilter()
voidsetIncludeNewItemsInFilter(boolean)
           indicates whether the field can include new items in manual filter The default value is false.
booleanisInsertPageBreaksBetweenItems()
voidsetInsertPageBreaksBetweenItems(boolean)
           indicates whether the field can insert page breaks between items insert page break after each item The default value is false.
booleanisMultipleItemSelectionAllowed()
voidsetMultipleItemSelectionAllowed(boolean)
           indicates whether the field can have multiple items selected in the page field The default value is false.
booleanisRepeatItemLabels()
voidsetRepeatItemLabels(boolean)
           indicates whether the field can repeat items labels The default value is false.
intgetItemCount()
           Gets the base item count of this pivot field.
java.lang.String[]getItems()
           Get all base items;
java.lang.StringgetName()
           Represents the PivotField name.
intgetNumber()
voidsetNumber(int)
           Represents the built-in display format of numbers and dates.
java.lang.StringgetNumberFormat()
voidsetNumberFormat(java.lang.String)
           Represents the custom display format of numbers and dates.
java.lang.String[]getOriginalItems()
           Get the original base items;
PivotItemCollectiongetPivotItems()
           Gets the pivot items of the pivot field
intgetPosition()
           Represents the PivotField index in the PivotFields.
SxRnggetRange()
           Gets the group range of the pivot field
booleangetShowAllItems()
voidsetShowAllItems(boolean)
           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.
booleangetShowCompact()
voidsetShowCompact(boolean)
           Indicates whether display labels from the next field in the same column on the Pivot Table view
booleangetShowInOutlineForm()
voidsetShowInOutlineForm(boolean)
           Indicates whether layout this field in outline form on the Pivot Table view
booleangetShowSubtotalAtTop()
voidsetShowSubtotalAtTop(boolean)
           when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom
 
Method Summary
voidaddCalculatedItem(java.lang.String name, java.lang.String formula)
           Add a calculated item to the pivot field.
java.lang.StringgetCalculatedFieldFormula()
           Get the formula string of the specified calculated field .
PivotFiltergetPivotFilterByType(int type)
           Gets the pivot filter of the pivot field by type
java.util.ArrayListgetPivotFilters()
           Gets the pivot filters of the pivot field
booleangetSubtotals(int subtotalType)
           Gets whether the specified field shows that subtotals.
voidhideDetail(boolean isHiddenDetail)
           Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.
voidhideItem(int index, boolean isHidden)
           Sets whether the specific PivotItem in a data field is hidden.
voidhideItem(java.lang.String itemValue, boolean isHidden)
           Sets whether the specific PivotItem in a data field is hidden.
voidhideItemDetail(int index, boolean isHiddenDetail)
           Sets whether the specific PivotItem in a pivot field is hidden detail.
voidinitPivotItems()
           Init the pivot items of the pivot field
booleanisHiddenItem(int index)
           Indicates whether the specific PivotItem is hidden.
booleanisHiddenItemDetail(int index)
           Indicates whether the specific PivotItem is hidden detail.
voidsetSubtotals(int subtotalType, boolean shown)
           Sets whether the specified field shows that subtotals.
 

Property Getters/Setters Detail

getPivotItems

public PivotItemCollection getPivotItems()
Gets the pivot items of the pivot field

getRange

public SxRng getRange()
Gets the group range of the pivot field

isCalculatedField

public boolean isCalculatedField()
Indicates whether the specified PivotTable field is calculated field.

getBaseIndex/setBaseIndex

public int getBaseIndex() / public void setBaseIndex(int value)
Represents the PivotField index in the base PivotFields.

getPosition

public int getPosition()
Represents the PivotField index in the PivotFields.

getName

public java.lang.String getName()
Represents the PivotField name.

getDisplayName/setDisplayName

public java.lang.String getDisplayName() / public void setDisplayName(java.lang.String value)
Represents the PivotField display name.

isAutoSubtotals/setAutoSubtotals

public boolean isAutoSubtotals() / public void setAutoSubtotals(boolean value)
Indicates whether the specified field shows automatic subtotals. Default is true.

getDragToColumn/setDragToColumn

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.

getDragToHide/setDragToHide

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.

getDragToRow/setDragToRow

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.

getDragToPage/setDragToPage

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.

getDragToData/setDragToData

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.

isMultipleItemSelectionAllowed/setMultipleItemSelectionAllowed

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.

isRepeatItemLabels/setRepeatItemLabels

public boolean isRepeatItemLabels() / public void setRepeatItemLabels(boolean value)
indicates whether the field can repeat items labels The default value is false.

isIncludeNewItemsInFilter/setIncludeNewItemsInFilter

public boolean isIncludeNewItemsInFilter() / public void setIncludeNewItemsInFilter(boolean value)
indicates whether the field can include new items in manual filter The default value is false.

isInsertPageBreaksBetweenItems/setInsertPageBreaksBetweenItems

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.

getShowAllItems/setShowAllItems

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.

isAutoSort/setAutoSort

public boolean isAutoSort() / public void setAutoSort(boolean value)
Indicates whether the specified PivotTable field is automatically sorted.

isAscendSort/setAscendSort

public boolean isAscendSort() / public void setAscendSort(boolean value)
Indicates whether the specified PivotTable field is autosorted ascending.

getAutoSortField/setAutoSortField

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.

isAutoShow/setAutoShow

public boolean isAutoShow() / public void setAutoShow(boolean value)
Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003.

isAscendShow/setAscendShow

public boolean isAscendShow() / public void setAscendShow(boolean value)
Indicates whether the specified PivotTable field is autoshown ascending.

getAutoShowCount/setAutoShowCount

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.

getAutoShowField/setAutoShowField

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.

getFunction/setFunction

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.

getDataDisplayFormat/setDataDisplayFormat

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

getBaseFieldIndex/setBaseFieldIndex

public int getBaseFieldIndex() / public void setBaseFieldIndex(int value)
Represents the base field for a custom calculation.

getBaseItemPosition/setBaseItemPosition

public int getBaseItemPosition() / public void setBaseItemPosition(int value)
Represents the item in the base field for a custom calculation. Valid only for data fields. Because PivotItemPosition.Custom is only for read,if you need to set PivotItemPosition.Custom, please set PivotField.BaseItemIndex attribute. The value of the property is PivotItemPosition integer constant.PivotItemPosition

getBaseItemIndex/setBaseItemIndex

public int getBaseItemIndex() / public void setBaseItemIndex(int value)
Represents the item in the base field for a custom calculation. Valid only for data fields.

getCurrentPageItem/setCurrentPageItem

public short getCurrentPageItem() / public void setCurrentPageItem(short value)
Represents the current page item showing for the page field (valid only for page fields).

getNumber/setNumber

public int getNumber() / public void setNumber(int value)
Represents the built-in display format of numbers and dates.

getInsertBlankRow/setInsertBlankRow

public boolean getInsertBlankRow() / public void setInsertBlankRow(boolean value)
Indicates whether inserting blank line after each item.

getShowSubtotalAtTop/setShowSubtotalAtTop

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

getShowInOutlineForm/setShowInOutlineForm

public boolean getShowInOutlineForm() / public void setShowInOutlineForm(boolean value)
Indicates whether layout this field in outline form on the Pivot Table view

getNumberFormat/setNumberFormat

public java.lang.String getNumberFormat() / public void setNumberFormat(java.lang.String value)
Represents the custom display format of numbers and dates.

getItems

public java.lang.String[] getItems()
Get all base items;

getOriginalItems

public java.lang.String[] getOriginalItems()
Get the original base items;

getItemCount

public int getItemCount()
Gets the base item count of this pivot field.

getShowCompact/setShowCompact

public boolean getShowCompact() / public void setShowCompact(boolean value)
Indicates whether display labels from the next field in the same column on the Pivot Table view

Method Detail

getPivotFilterByType

public PivotFilter getPivotFilterByType(int type)
Gets the pivot filter of the pivot field by type
Parameters:
type - A PivotFilterType value.

getPivotFilters

public java.util.ArrayList getPivotFilters()
Gets the pivot filters of the pivot field

initPivotItems

public void initPivotItems()
Init the pivot items of the pivot field

getCalculatedFieldFormula

public java.lang.String getCalculatedFieldFormula()
Get the formula string of the specified calculated field .

setSubtotals

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.

getSubtotals

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.

isHiddenItem

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

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

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

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

addCalculatedItem

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

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.