public class BookPivotField
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static int |
SortAscend |
static int |
SortAuto |
static int |
SortDescend |
static int |
SortManual |
static int |
SubTotalTypeAutomatic |
static int |
SubTotalTypeCustom |
static int |
SubTotalTypeNone |
static short |
SummarizeCalcAverage |
static short |
SummarizeCalcCount |
static short |
SummarizeCalcCountNums |
static short |
SummarizeCalcMax |
static short |
SummarizeCalcMin |
static short |
SummarizeCalcProduct |
static short |
SummarizeCalcStdDev |
static short |
SummarizeCalcStdDevp |
static short |
SummarizeCalcSum |
static short |
SummarizeCalcVar |
static short |
SummarizeCalcVarp |
Modifier and Type | Method and Description |
---|---|
void |
addCalcItem(java.lang.String name,
java.lang.String formula)
add a calculated item to the field list items
|
boolean |
canAddToArea(BookPivotArea area)
Indicates if this field can be added to the specified area.
|
java.lang.String[] |
getFieldItems()
return the name of the field items
|
java.lang.String |
getName()
the name of the pivot field
|
java.lang.String |
getNumberFormatting()
get the custom formatting string from the specified area in pivot table
|
int |
getSortType()
return the sort type
|
int |
getSubTotalType()
return the type of subtotal
|
int |
getSummarizeFieldCalcType()
Indicates the summary function type
|
boolean |
isFieldItemHidden(int index)
is the field specified index shown or hidden
|
boolean |
isSummarizeField()
Indicates if this field is a summary field
|
void |
setFieldItemHidden(int index,
boolean isVisible)
set the field item hidden or shown
|
void |
setLayout(boolean compact,
boolean outline,
boolean subtotalTop)
set the pivot field lay out setting
|
void |
setNumberFormatting(java.lang.String customFormat)
set the custom formatting for area in pivot table
|
void |
setShowDataAs(ShowDataAs type)
set the ShowDataAs value for the summary field
|
void |
setShowDetail(boolean show)
set whether the details are hidden for this field
|
void |
setSortType(int type)
set the sort type
|
void |
setSubTotalType(int type)
set the type of subtotal
|
void |
setSummarizeFieldCalcType(int type,
java.lang.String name)
Set the current calculation type of the summary field
|
public static final short SummarizeCalcSum
public static final short SummarizeCalcCount
public static final short SummarizeCalcAverage
public static final short SummarizeCalcMax
public static final short SummarizeCalcMin
public static final short SummarizeCalcProduct
public static final short SummarizeCalcCountNums
public static final short SummarizeCalcStdDev
public static final short SummarizeCalcStdDevp
public static final short SummarizeCalcVar
public static final short SummarizeCalcVarp
public static final int SubTotalTypeNone
public static final int SubTotalTypeAutomatic
public static final int SubTotalTypeCustom
public static final int SortAuto
public static final int SortAscend
public static final int SortDescend
public static final int SortManual
public java.lang.String getName()
public boolean canAddToArea(BookPivotArea area)
area
- The desired area for adding the field.public boolean isSummarizeField()
public int getSummarizeFieldCalcType()
SummarizeCalcSum
,SummarizeCalcCount,SummarizeCalcAverage,SummarizeCalcMax,SummarizeCalcMin
SummarizeCalcProduct,SummarizeCalcCountNums,SummarizeCalcStdDev,SummarizeCalcStdDevp,SummarizeCalcVar,
SummarizeCalcVarppublic void setSummarizeFieldCalcType(int type, java.lang.String name)
type
- the calculation type to be used.
one of the following values:
SummarizeCalcSumSummarizeCalcSum
,SummarizeCalcCount,SummarizeCalcAverage,SummarizeCalcMax,SummarizeCalcMin
SummarizeCalcProduct,SummarizeCalcCountNums,SummarizeCalcStdDev,SummarizeCalcStdDevp,SummarizeCalcVar,
SummarizeCalcVarpname
- filed namepublic int getSubTotalType()
SubTotalTypeNone
,SubTotalTypeAutomatic,SubTotalTypeCustompublic void setSubTotalType(int type) throws java.lang.Exception
type
- SubtotalType value
one of the following values:
SubTotalTypeNoneSubTotalTypeNone
,SubTotalTypeAutomatic,SubTotalTypeCustomjava.lang.Exception
- exceptionpublic int getSortType()
SortAuto
,SortAscend,SortDescend,SortManualpublic void setSortType(int type) throws java.lang.Exception
type
- sort type value
one of the following values:
SortAutoSortAuto
,SortAscend,SortDescend,SortManualjava.lang.Exception
- exceptionpublic java.lang.String getNumberFormatting()
public void setNumberFormatting(java.lang.String customFormat)
customFormat
- custom format stringpublic void setShowDataAs(ShowDataAs type)
type
- com.smartxls.enums.ShowDataAs
public void setLayout(boolean compact, boolean outline, boolean subtotalTop)
compact
- whether the application will display fields compactly in the sheet on which this PivotTable residesoutline
- whether the items in this field should be shown in Outline formsubtotalTop
- whether to display subtotals at the top of the grouppublic void setShowDetail(boolean show)
show
- whether the details are shown for this fieldpublic void setFieldItemHidden(int index, boolean isVisible) throws java.lang.Exception
index
- item indexisVisible
- visibilityjava.lang.Exception
- exception when data field is applied or invalid parameterpublic boolean isFieldItemHidden(int index)
index
- field indexpublic java.lang.String[] getFieldItems()
public void addCalcItem(java.lang.String name, java.lang.String formula) throws java.lang.Exception
name
- item nameformula
- item formula contentjava.lang.Exception
- invalid formula