com.spire.xls.core
Interface IPivotField

All Known Implementing Classes:

PivotField, XlsPivotField

public interface IPivotField

Represents pivot field object.

Method Summary

boolean	canDragOff()
void	canDragOff(boolean canDragOff)
boolean	canDragToColumn()
void	canDragToColumn(boolean canDragToColumn)
boolean	canDragToData()
void	canDragToData(boolean canDragTodata)
boolean	canDragToPage()
void	canDragToPage(boolean canDragToPage)
boolean	canDragToRow()
void	canDragToRow(boolean canDragToRow)
AxisTypes	getAxis() Gets field axis.
java.lang.String	getFormula()
java.lang.String	getName()
java.lang.String	getNumberFormat()
boolean	getShowBlankRow()
SubtotalTypes	getSubtotals()
boolean	isFormulaField()
void	setAxis(AxisTypes axisTypes)
void	setFormula(java.lang.String formula)
void	setNumberFormat(java.lang.String numberFormat)
void	setShowBlankRow(boolean showBlankRow)
void	setSubtotals(SubtotalTypes subtotals)

Method Detail

getName

java.lang.String getName()

Returns:

Returns pivot field name. Read-only.

getAxis

AxisTypes getAxis()

Gets field axis.

Returns:

AxisTypes

setAxis

void setAxis(AxisTypes axisTypes)

Parameters:

axisTypes - sets field axis.

getNumberFormat

java.lang.String getNumberFormat()

Returns:

Gets/sets number format.

setNumberFormat

void setNumberFormat(java.lang.String numberFormat)

Parameters:

numberFormat - sets number format.

getSubtotals

SubtotalTypes getSubtotals()

Returns:

Gets type of field subtotals.

setSubtotals

void setSubtotals(SubtotalTypes subtotals)

Parameters:

subtotals - sets type of field subtotals.

canDragToRow

boolean canDragToRow()

Returns:

User can drag field to row area.

canDragToRow

void canDragToRow(boolean canDragToRow)

Parameters:

canDragToRow - ser can drag field to row area.

canDragToColumn

boolean canDragToColumn()

Returns:

User can drag field to column area.

canDragToColumn

void canDragToColumn(boolean canDragToColumn)

Parameters:

canDragToColumn - User can drag field to column area.

canDragToPage

boolean canDragToPage()

Returns:

User can drag field to page area.

canDragToPage

void canDragToPage(boolean canDragToPage)

Parameters:

canDragToPage - User can drag field to page area.

canDragOff

boolean canDragOff()

Returns:

User can remove field from view.

canDragOff

void canDragOff(boolean canDragOff)

Parameters:

canDragOff - User can remove field from view.

getShowBlankRow

boolean getShowBlankRow()

Returns:

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

setShowBlankRow

void setShowBlankRow(boolean showBlankRow)

Parameters:

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

canDragToData

boolean canDragToData()

Returns:

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

canDragToData

void canDragToData(boolean canDragTodata)

Parameters:

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

isFormulaField

boolean isFormulaField()

Returns:

Indicates whether this field is formula field

getFormula

java.lang.String getFormula()

Returns:

Specifies the formula for the calculated field

setFormula

void setFormula(java.lang.String formula)

Parameters:

formula - Specifies the formula for the calculated field