com.spire.xls.core.spreadsheet.pivottables
Class XlsPivotField

java.lang.Object
  com.spire.xls.core.spreadsheet.pivottables.XlsPivotField

All Implemented Interfaces:

IPivotField

Direct Known Subclasses:

PivotField

public class XlsPivotField
extends java.lang.Object
implements IPivotField

Constructor Summary

XlsPivotField(java.lang.Object parent)

Method Summary

void	addItemOption(int index)
boolean	canDragOff() User can remove field from view.
void	canDragOff(boolean value) User can remove field from view.
boolean	canDragToColumn() User can drag field to column area.
void	canDragToColumn(boolean value) User can drag field to column area.
boolean	canDragToData() True if the specified field can be dragged to the data position.
void	canDragToData(boolean value) True if the specified field can be dragged to the data position.
boolean	canDragToPage() User can drag field to page area.
void	canDragToPage(boolean value) User can drag field to page area.
boolean	canDragToRow() User can drag field to row area.
void	canDragToRow(boolean value) User can drag field to row area.
AutoSortScope	getAutoSort() Preserves the sorting elements of the field
AxisTypes	getAxis() Gets field axis.
java.lang.String	getCaption() Specifies the unique name of the member property to be used as a caption for the field and field items.
boolean	getCompact() Specifies a boolean value that indicates whether the application will display fields compactly in the sheet on which this PivotTable resides
boolean	getDataField() Gets value indicating whether this is data field.
java.lang.String	getFormula() Specifies the formula for the calculated field
int	getItemsPerPage() Specifies the number of items showed per page in the PivotTable.
java.lang.String	getName() Returns pivot field name.
java.lang.String	getNumberFormat() Gets/sets number format.
int	getNumberFormatIndex() Gets / sets number format index.
PivotTableFields	getParent()
boolean	getShowBlankRow() True if a blank row is inserted after the specified row field in a PivotTable report.
PivotFieldFormatType	getShowDataAs() Gets or sets the show data as.
boolean	getShowDropDown() True if the flag for the specified PivotTable field or PivotTable item is set to "drilled" (expanded, or visible).
boolean	getShowNewItemsInFilter() Specifies a boolean value that indicates whether manual filter is in inclusive mode.
boolean	getShowNewItemsOnRefresh() Specifies a boolean value that indicates whether new items that appear after a refresh
boolean	getShowOutline() Specifies a boolean value that indicates whether the items in this field should be shown in Outline form.
boolean	getShowPageBreak() True if a page break is inserted after each field.
boolean	getShowPropAsCaption() Specifies a boolean value that indicates whether to show the property as a member caption.
boolean	getShowToolTip() Specifies a boolean value that indicates whether to show the member property value in a tooltip on the appropriate PivotTable cells.
PivotFieldSortType	getSortType() Specifies the type of sort that is applied to this field.
java.lang.String	getSubtotalCaption() Specifies the custom text that is displayed for the subtotals caption.
SubtotalTypes	getSubtotals() Gets or sets type of field subtotals.
boolean	getSubtotalTop() Get or set whether show
void	hideDetail(boolean isHiddenDetail) Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.
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	hideItemDetail(java.lang.String itemValue, boolean isHiddenDetail) Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.
boolean	isAutoShow() Autoshow is enabled.
void	isAutoShow(boolean value) Autoshow is enabled.
boolean	isDataField() Gets/sets value indicating whether this is data field.
boolean	isDragToHide() User can remove field from fiew.
void	isDragToHide(boolean value) User can remove field from fiew.
boolean	isFormulaField() Indicates whether this field is formula field
boolean	isHiddenItem(int index) Indicates whether the specific PivotItem is hidden.
boolean	isHiddenItemDetail(int index) Indicates whether the specific PivotItem is hidden detail.
boolean	isMultiSelected() Specifies a boolean value that indicates whether the field can have multiple items selected in the page field.
void	isMultiSelected(boolean value) Specifies a boolean value that indicates whether the field can have multiple items selected in the page field.
boolean	isShowAllItems() Show all items for this field.
void	isShowAllItems(boolean value) Show all items for this field.
void	setAutoSort(AutoSortScope value) Preserves the sorting elements of the field
void	setAxis(AxisTypes axis) Sets field axis.
void	setCaption(java.lang.String value) Specifies the unique name of the member property to be used as a caption for the field and field items.
void	setCompact(boolean value) Specifies a boolean value that indicates whether the application will display fields compactly in the sheet on which this PivotTable resides
void	setFormula(java.lang.String value) Specifies the formula for the calculated field
void	setItemsPerPage(int value) Specifies the number of items showed per page in the PivotTable.
void	setNumberFormat(java.lang.String value) Gets/sets number format.
void	setNumberFormatIndex(int value) Gets / sets number format index.
void	setShowBlankRow(boolean value) True if a blank row is inserted after the specified row field in a PivotTable report.
void	setShowDataAs(PivotFieldFormatType value) Gets or sets the show data as.
void	setShowDropDown(boolean value) True if the flag for the specified PivotTable field or PivotTable item is set to "drilled" (expanded, or visible).
void	setShowNewItemsInFilter(boolean value) Specifies a boolean value that indicates whether manual filter is in inclusive mode.
void	setShowNewItemsOnRefresh(boolean value) Specifies a boolean value that indicates whether new items that appear after a refresh
void	setShowOutline(boolean value) Specifies a boolean value that indicates whether the items in this field should be shown in Outline form.
void	setShowPageBreak(boolean value) True if a page break is inserted after each field.
void	setShowPropAsCaption(boolean value) Specifies a boolean value that indicates whether to show the property as a member caption.
void	setShowToolTip(boolean value) Specifies a boolean value that indicates whether to show the member property value in a tooltip on the appropriate PivotTable cells.
void	setSortType(PivotFieldSortType value) Specifies the type of sort that is applied to this field.
void	setSubtotalCaption(java.lang.String value) Specifies the custom text that is displayed for the subtotals caption.
void	setSubtotals(SubtotalTypes value) Gets or sets type of field subtotals.
void	setSubtotalTop(boolean value) Get or set whether show
void	sort(java.lang.Boolean isAscendSort, PivotDataField sortByField)

Constructor Detail

XlsPivotField

public XlsPivotField(java.lang.Object parent)

Method Detail

getParent

public PivotTableFields getParent()

getName

public java.lang.String getName()

Returns pivot field name. Read-only.

Specified by:

getName in interface IPivotField

Returns:

getAxis

public AxisTypes getAxis()

Gets field axis.

Specified by:

getAxis in interface IPivotField

Returns:

AxisTypes

setAxis

public void setAxis(AxisTypes axis)

Sets field axis.

Specified by:

setAxis in interface IPivotField

Parameters:

axis - sets field axis.

getNumberFormat

public java.lang.String getNumberFormat()

Gets/sets number format.

Specified by:

getNumberFormat in interface IPivotField

Returns:

setNumberFormat

public void setNumberFormat(java.lang.String value)

Gets/sets number format.

Specified by:

setNumberFormat in interface IPivotField

Parameters:

value -

getSubtotals

public SubtotalTypes getSubtotals()

Gets or sets type of field subtotals.

Specified by:

getSubtotals in interface IPivotField

Returns:

setSubtotals

public void setSubtotals(SubtotalTypes value)

Gets or sets type of field subtotals.

Specified by:

setSubtotals in interface IPivotField

Parameters:

value -

canDragToRow

public boolean canDragToRow()

User can drag field to row area.

Specified by:

canDragToRow in interface IPivotField

Returns:

canDragToRow

public void canDragToRow(boolean value)

User can drag field to row area.

Specified by:

canDragToRow in interface IPivotField

Parameters:

value -

canDragToColumn

public boolean canDragToColumn()

User can drag field to column area.

Specified by:

canDragToColumn in interface IPivotField

Returns:

canDragToColumn

public void canDragToColumn(boolean value)

User can drag field to column area.

Specified by:

canDragToColumn in interface IPivotField

Parameters:

value -

canDragToPage

public boolean canDragToPage()

User can drag field to page area.

Specified by:

canDragToPage in interface IPivotField

Returns:

canDragToPage

public void canDragToPage(boolean value)

User can drag field to page area.

Specified by:

canDragToPage in interface IPivotField

Parameters:

value -

canDragOff

public boolean canDragOff()

User can remove field from view.

Specified by:

canDragOff in interface IPivotField

Returns:

canDragOff

public void canDragOff(boolean value)

User can remove field from view.

Specified by:

canDragOff in interface IPivotField

Parameters:

value -

canDragToData

public boolean canDragToData()

True if the specified field can be dragged to the data position. The default value is True.

Specified by:

canDragToData in interface IPivotField

Returns:

canDragToData

public void canDragToData(boolean value)

True if the specified field can be dragged to the data position. The default value is True.

Specified by:

canDragToData in interface IPivotField

Parameters:

value -

getDataField

public boolean getDataField()

Gets value indicating whether this is data field.

Returns:

isDataField

public boolean isDataField()

Gets/sets value indicating whether this is data field.

Returns:

getNumberFormatIndex

public int getNumberFormatIndex()

Gets / sets number format index.

Returns:

setNumberFormatIndex

public void setNumberFormatIndex(int value)

Gets / sets number format index.

Parameters:

value -

getSubtotalCaption

public java.lang.String getSubtotalCaption()

Specifies the custom text that is displayed for the subtotals caption.

Returns:

setSubtotalCaption

public void setSubtotalCaption(java.lang.String value)

Specifies the custom text that is displayed for the subtotals caption.

Parameters:

value -

getSubtotalTop

public boolean getSubtotalTop()

Get or set whether show

Returns:

setSubtotalTop

public void setSubtotalTop(boolean value)

Get or set whether show

Parameters:

value -

isAutoShow

public boolean isAutoShow()

Autoshow is enabled.

Returns:

isAutoShow

public void isAutoShow(boolean value)

Autoshow is enabled.

Parameters:

value -

isDragToHide

public boolean isDragToHide()

User can remove field from fiew.

Returns:

isDragToHide

public void isDragToHide(boolean value)

User can remove field from fiew.

Parameters:

value -

getShowNewItemsInFilter

public boolean getShowNewItemsInFilter()

Specifies a boolean value that indicates whether manual filter is in inclusive mode.

Returns:

setShowNewItemsInFilter

public void setShowNewItemsInFilter(boolean value)

Specifies a boolean value that indicates whether manual filter is in inclusive mode.

Parameters:

value -

getShowNewItemsOnRefresh

public boolean getShowNewItemsOnRefresh()

Specifies a boolean value that indicates whether new items that appear after a refresh

Returns:

setShowNewItemsOnRefresh

public void setShowNewItemsOnRefresh(boolean value)

Specifies a boolean value that indicates whether new items that appear after a refresh

Parameters:

value -

getShowBlankRow

public boolean getShowBlankRow()

True if a blank row is inserted after the specified row field in a PivotTable report.

Specified by:

getShowBlankRow in interface IPivotField

Returns:

setShowBlankRow

public void setShowBlankRow(boolean value)

True if a blank row is inserted after the specified row field in a PivotTable report.

Specified by:

setShowBlankRow in interface IPivotField

Parameters:

value -

getShowPageBreak

public boolean getShowPageBreak()

True if a page break is inserted after each field.

Returns:

setShowPageBreak

public void setShowPageBreak(boolean value)

True if a page break is inserted after each field.

Parameters:

value -

getItemsPerPage

public int getItemsPerPage()

Specifies the number of items showed per page in the PivotTable.

Returns:

setItemsPerPage

public void setItemsPerPage(int value)

Specifies the number of items showed per page in the PivotTable.

Parameters:

value -

isMultiSelected

public boolean isMultiSelected()

Specifies a boolean value that indicates whether the field can have multiple items selected in the page field.

Returns:

isMultiSelected

public void isMultiSelected(boolean value)

Specifies a boolean value that indicates whether the field can have multiple items selected in the page field.

Parameters:

value -

isShowAllItems

public boolean isShowAllItems()

Show all items for this field.

Returns:

isShowAllItems

public void isShowAllItems(boolean value)

Show all items for this field.

Parameters:

value -

getShowOutline

public boolean getShowOutline()

Specifies a boolean value that indicates whether the items in this field should be shown in Outline form.

Returns:

setShowOutline

public void setShowOutline(boolean value)

Specifies a boolean value that indicates whether the items in this field should be shown in Outline form.

Parameters:

value -

getShowDropDown

public boolean getShowDropDown()

True if the flag for the specified PivotTable field or PivotTable item is set to "drilled" (expanded, or visible).

Returns:

setShowDropDown

public void setShowDropDown(boolean value)

True if the flag for the specified PivotTable field or PivotTable item is set to "drilled" (expanded, or visible).

Parameters:

value -

getShowPropAsCaption

public boolean getShowPropAsCaption()

Specifies a boolean value that indicates whether to show the property as a member caption.

Returns:

setShowPropAsCaption

public void setShowPropAsCaption(boolean value)

Specifies a boolean value that indicates whether to show the property as a member caption.

Parameters:

value -

getShowToolTip

public boolean getShowToolTip()

Specifies a boolean value that indicates whether to show the member property value in a tooltip on the appropriate PivotTable cells.

Returns:

setShowToolTip

public void setShowToolTip(boolean value)

Specifies a boolean value that indicates whether to show the member property value in a tooltip on the appropriate PivotTable cells.

Parameters:

value -

getSortType

public PivotFieldSortType getSortType()

Specifies the type of sort that is applied to this field.

Returns:

setSortType

public void setSortType(PivotFieldSortType value)

Specifies the type of sort that is applied to this field.

Parameters:

value -

getCaption

public java.lang.String getCaption()

Specifies the unique name of the member property to be used as a caption for the field and field items.

Returns:

setCaption

public void setCaption(java.lang.String value)

Specifies the unique name of the member property to be used as a caption for the field and field items.

Parameters:

value -

getCompact

public boolean getCompact()

Specifies a boolean value that indicates whether the application will display fields compactly in the sheet on which this PivotTable resides

Returns:

setCompact

public void setCompact(boolean value)

Specifies a boolean value that indicates whether the application will display fields compactly in the sheet on which this PivotTable resides

Parameters:

value -

getFormula

public java.lang.String getFormula()

Specifies the formula for the calculated field

Specified by:

getFormula in interface IPivotField

Returns:

setFormula

public void setFormula(java.lang.String value)

Specifies the formula for the calculated field

Specified by:

setFormula in interface IPivotField

Parameters:

value -

isFormulaField

public boolean isFormulaField()

Indicates whether this field is formula field

Specified by:

isFormulaField in interface IPivotField

Returns:

getAutoSort

public AutoSortScope getAutoSort()

Preserves the sorting elements of the field

Returns:

setAutoSort

public void setAutoSort(AutoSortScope value)

Preserves the sorting elements of the field

Parameters:

value -

getShowDataAs

public PivotFieldFormatType getShowDataAs()

Gets or sets the show data as.

Returns:

The show data as.

setShowDataAs

public void setShowDataAs(PivotFieldFormatType value)

Gets or sets the show data as.

Parameters:

value - The show data as.

addItemOption

public void addItemOption(int index)

isHiddenItemDetail

public boolean isHiddenItemDetail(int index)

Indicates whether the specific PivotItem is hidden detail. Must call after pivottable CalculateData function.

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. Must call after pivottable CalculateData function.

Parameters:

index - the index of the pivotItem in the pivotField.

isHiddenDetail - whether the specific PivotItem is hidden

hideItemDetail

public void hideItemDetail(java.lang.String itemValue,
                           boolean isHiddenDetail)

Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field. Must call after pivottable CalculateData function.

Parameters:

itemValue - the value 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. Must call after pivottable CalculateData function.

Parameters:

isHiddenDetail - whether DetailItems is hidden

isHiddenItem

public boolean isHiddenItem(int index)

Indicates whether the specific PivotItem is hidden. Must call after pivottable CalculateData function.

Parameters:

index - the index of the pivotItem in the pivotField.

Returns:

whether the specific PivotItem is hidden

hideItem

public void hideItem(java.lang.String itemValue,
                     boolean isHidden)

Sets whether the specific PivotItem in a data field is hidden. Must call after pivottable CalculateData function.

Parameters:

itemValue - the value of the pivotItem in the pivotField.

isHidden - whether the specific PivotItem is hidden

sort

public void sort(java.lang.Boolean isAscendSort,
                 PivotDataField sortByField)