![]() |
||
Home Products Purchase Downloads Demos Forums Blogs Ticket Wiki API Corporate |
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.cells.PivotField
public class PivotField
Represents a field in a PivotTable report.
Method Summary | |
---|---|
boolean |
dragToColumn()
Indicates whether the specified field can be dragged to the column position. |
boolean |
dragToHide()
Indicates whether the specified field can be dragged to the hide position. |
boolean |
dragToPage()
Indicates whether the specified field can be dragged to the page position. |
boolean |
dragToRow()
Indicates whether the specified field can be dragged to the row position. |
int |
getAutoShowCount()
Gets the number of top or bottom items that are automatically shown in the specified PivotTable field. |
int |
getAutoShowField()
Gets auto show field index. |
int |
getAutoSortField()
Gets auto sort field index. |
int |
getBaseField()
Gets the base field for a custom calculation. |
short |
getBaseItem()
Gets the item in the base field for a custom calculation. |
short |
getCurrentPageItem()
Gets the current page item showing for the page field (valid only for page fields). |
int |
getDataDisplayFormat()
Gets how to display the values contained in a data field. |
java.lang.String |
getDisplayName()
Gets the PivotField display name. |
int |
getFunction()
Gets the function used to summarize the PivotTable data field. |
java.lang.String |
getName()
Gets the PivotField name. |
int |
getNumber()
Gets the built-in display format of numbers and dates. |
java.lang.String |
getNumberFormat()
Represents the custom display format of numbers and dates. |
PivotItems |
getPivotItems()
Gets the pivot items in the field. |
int |
getPosition()
Get the position of the PivotField int the specific PivotFields. |
boolean |
getShowCompact()
Indicates when ShowInOutlineForm is true, whether the application will display fields compactly in the sheet on which this PivotTable resides. |
boolean |
getShowInOutlineForm()
Indicates whether layout this field in outline form on the Pivot Table view. |
boolean |
getShowSubtotalAtTop()
Indicates when ShowInOutlineForm is true, whether the application will display subtotals at the top of the list of items instead of at the bottom. |
boolean |
getSubtotals(short subtotals)
Gets whether the specified field shows that subtotals. |
void |
hideItem(int index,
boolean isHidden)
Sets whether the specific PivotItem in a data field is hidden. |
boolean |
isAscendShow()
Gets whether the specified PivotTable field is autoshown ascending. |
boolean |
isAscendSort()
Indicates whether the specified PivotTable field is autosorted ascending. |
boolean |
isAutoShow()
Indicates whether the specified PivotTable field is automatically shown. |
boolean |
isAutoSort()
Indicates whether the specified PivotTable field is automatically sorted. |
boolean |
isAutoSubtotals()
Gets whether the specified field shows automatic subtotals. |
boolean |
isHiddenItem(int index)
Indicates whether the specific PivotItem is hidden. |
void |
setAscendShow(boolean isAscendShow)
Sets whether the specified PivotTable field is autoshown ascending. |
void |
setAscendSort(boolean isAscendSort)
Sets whether the specified PivotTable field is autosorted ascending. |
void |
setAutoShow(boolean isAutoShow)
Sets whether the specified PivotTable field is automatically shown. |
void |
setAutoShowCount(int count)
Gets the number of top or bottom items that are automatically shown in the specified PivotTable field. |
void |
setAutoShowField(int dataFieldIndex)
Sets auto show field index. |
void |
setAutoSort(boolean isAutoSort)
Sets whether the specified PivotTable field is automatically sorted. |
void |
setAutoSortField(int dataFieldIndex)
Sets auto sort field index. |
void |
setAutoSubtotals(boolean isAutoSubtotals)
Sets whether the specified field shows automatic subtotals. |
void |
setBaseField(int baseFieldIndex)
Sets the base field for a custom calculation. |
void |
setBaseItem(int baseItemIndex)
Sets the item in the base field for a custom calculation. |
void |
setCurrentPageItem(int baseItemIndex)
Sets the current page item showing for the page field (valid only for page fields). |
void |
setDataDisplayFormat(short dataDisplayFormat)
Sets how to display the values contained in a data field. |
void |
setDisplayName(java.lang.String displayName)
Sets the PivotField display name. |
void |
setDragToColumn(boolean dragToColumn)
Indicates whether the specified field can be dragged to the column position. |
void |
setDragToHide(boolean dragToHide)
Indicates whether the field can be hidden by being dragged off the PivotTable report. |
void |
setDragToPage(boolean dragToPage)
Indicates whether the specified field can be dragged to the page position. |
void |
setDragToRow(boolean dragToRow)
Indicates whether the specified field can be dragged to the row position. |
void |
setFunction(int function)
Sets the function used to summarize the PivotTable data field. |
void |
setNumber(int number)
Sets the built-in display format of numbers and dates. |
void |
setNumberFormat(java.lang.String numberFormat)
Represents the custom display format of numbers and dates. |
void |
setShowAllItems(boolean showAllItems)
Indicates whether all items in the PivotTable report are displayed, even if they don't contain summary data. |
void |
setShowCompact(boolean _showCompact)
Indicates when ShowInOutlineForm is true, whether the application will display fields compactly in the sheet on which this PivotTable resides. |
void |
setShowInOutlineForm(boolean _showInOutlineForm)
Indicates whether layout this field in outline form on the Pivot Table view. |
void |
setShowSubtotalAtTop(boolean _showSubtotalAtTop)
Indicates when ShowInOutlineForm is true, whether the application will display subtotals at the top of the list of items instead of at the bottom. |
void |
setSubtotals(short subtotals,
boolean shown)
Sets whether the specified field shows that subtotals. |
boolean |
showAllItems()
Indicates whether all items in the PivotTable report are displayed, even if they don't contain summary data. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public int getPosition()
public java.lang.String getName()
public PivotItems getPivotItems()
public java.lang.String getDisplayName()
public void setDisplayName(java.lang.String displayName)
displayName
- the PivotField display name.public void setSubtotals(short subtotals, boolean shown)
subtotals
- subtotals type.shown
- whether the field shows that subtotal.
java.lang.IllegalArgumentException
- if the subtotals type is invalid.
CellsException
- if the pivotField is data field or read-only.PivotFieldSubtotalType
public boolean getSubtotals(short subtotals)
subtotals
- subtotals type.
java.lang.IllegalArgumentException
- if the subtotals type is invalid.PivotFieldSubtotalType
public boolean isAutoSubtotals()
public void setAutoSubtotals(boolean isAutoSubtotals)
isAutoSubtotals
- whether the specified field shows automatic subtotals.
CellsException
- if the pivotField is data field or read-only.public boolean dragToColumn()
public void setDragToColumn(boolean dragToColumn)
dragToColumn
- whether the specified field can be dragged to the column position.public boolean dragToHide()
public void setDragToHide(boolean dragToHide)
dragToHide
- the field can be hidden by being dragged off the PivotTable report.public boolean dragToRow()
public void setDragToRow(boolean dragToRow)
dragToRow
- whether the specified field can be dragged to the row position.public boolean dragToPage()
public void setDragToPage(boolean dragToPage)
dragToPage
- whether the specified field can be dragged to the page position.public boolean showAllItems()
public void setShowAllItems(boolean showAllItems)
showAllItems
- Indicates whether all items in the PivotTable report are displayed,public boolean isAutoSort()
public void setAutoSort(boolean isAutoSort)
isAutoSort
- whether the specified PivotTable field is automatically sorted.public boolean isAscendSort()
public void setAscendSort(boolean isAscendSort)
isAscendSort
- whether the specified PivotTable field is autosorted ascending.public int getAutoSortField()
public void setAutoSortField(int dataFieldIndex)
dataFieldIndex
- auto sort field index.
java.lang.IllegalArgumentException
- if data field index is out of range.public boolean isAutoShow()
public void setAutoShow(boolean isAutoShow)
isAutoShow
- whether the specified PivotTable field is automatically shown.public boolean isAscendShow()
public void setAscendShow(boolean isAscendShow)
isAscendShow
- whether the specified PivotTable field is autoshown ascending.public int getAutoShowCount()
public void setAutoShowCount(int count)
count
- the number of top or bottom itemspublic int getAutoShowField()
public void setAutoShowField(int dataFieldIndex)
dataFieldIndex
- auto show field index.
java.lang.IllegalArgumentException
- if data field index is out of range.public int getFunction()
ConsolidationFunction
public void setFunction(int function)
function
- the function used to summarize the PivotTable data field.
java.lang.IllegalArgumentException
- if the function is an invalid consolidation function.
CellsException
- if the pivotField is read-only.ConsolidationFunction
public int getDataDisplayFormat()
PivotFieldDataDisplayFormat
public void setDataDisplayFormat(short dataDisplayFormat)
dataDisplayFormat
- how to display the values contained in a data field.
CellsException
- if the pivotField is read-only.
java.lang.IllegalArgumentException
- if data display format is invalid.PivotFieldDataDisplayFormat
public int getBaseField()
public void setBaseField(int baseFieldIndex)
baseFieldIndex
- the base field for a custom calculation.
java.lang.IllegalArgumentException
- if base field index is out of range.
CellsException
- if the pivotField is read-only.public void setBaseItem(int baseItemIndex)
baseItemIndex
- the item in the base field for a custom calculation.
It could be base item index , PivotItemPosition.NEXT or PivotItemPosition.PREVIOUS.
CellsException
- if the pivotField is read-only.
java.lang.IllegalArgumentException
- if base item index is out of range.public short getBaseItem()
public short getCurrentPageItem()
public void setCurrentPageItem(int baseItemIndex)
baseItemIndex
- the current page item showing for the page field (valid only for page fields).
It could be base item index or PivotItemPosition.ALL.
java.lang.IllegalArgumentException
- if base item index is out of range.public int getNumber()
public void setNumber(int number)
number
- the built-in formatting number.
java.lang.IllegalArgumentException
- if number is invalid.
CellsException
- if the pivotField is read-only.Style.setNumber(int)
public java.lang.String getNumberFormat()
public void setNumberFormat(java.lang.String numberFormat)
numberFormat
- public boolean isHiddenItem(int index)
index
- the PivotItem index.
java.lang.IllegalArgumentException
- if index is out of range.public void hideItem(int index, boolean isHidden)
index
- the PivotItem index.isHidden
- whether the specific PivotItem in a data field is hidden.
java.lang.IllegalArgumentException
- if index is out of range.public boolean getShowInOutlineForm()
public void setShowInOutlineForm(boolean _showInOutlineForm)
_showInOutlineForm
- true indicates the items in this field will be shown in outline form.
false indicates the items in this field will not be shown in outline form.public boolean getShowCompact()
public void setShowCompact(boolean _showCompact)
_showCompact
- true indicates the next field should be displayed in the same column of the sheet.
false indicates each pivot field will display in its own column in the sheet.public boolean getShowSubtotalAtTop()
public void setShowSubtotalAtTop(boolean _showSubtotalAtTop)
_showSubtotalAtTop
- true indicates a subtotal will be display at the top of the group.
false indicates subtotal will not be displayed at the top of the group.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |