public class PivotField
Property Getters/Setters Summary | ||
---|---|---|
int | getAutoShowCount() | |
void | setAutoShowCount(intvalue) | |
Represent the number of top or bottom items that are automatically shown in the specified PivotTable field. | ||
int | getAutoShowField() | |
void | setAutoShowField(intvalue) | |
Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields. | ||
int | getAutoSortField() | |
void | setAutoSortField(intvalue) | |
Represents auto sort field index. -1 means PivotField itself,others means the position of the data fields. | ||
int | getBaseFieldIndex() | |
void | setBaseFieldIndex(intvalue) | |
Represents the base field for a custom calculation. | ||
int | getBaseIndex() | |
void | setBaseIndex(intvalue) | |
Represents the PivotField index in the base PivotFields. | ||
int | getBaseItemIndex() | |
void | setBaseItemIndex(intvalue) | |
Represents the item in the base field for a custom calculation. Valid only for data fields. | ||
int | getBaseItemPosition() | |
void | setBaseItemPosition(intvalue) | |
Represents the item in the base field for a custom calculation. Valid only for data fields. Because PivotItemPosition.InnerCustom is only for read,if you need to set PivotItemPosition.InnerCustom, please set PivotField.BaseItemIndex attribute. The value of the property is PivotItemPosition integer constant. | ||
short | getCurrentPageItem() | |
void | setCurrentPageItem(shortvalue) | |
Represents the current page item showing for the page field (valid only for page fields). | ||
int | getDataDisplayFormat() | |
void | setDataDisplayFormat(intvalue) | |
Represents how to display the values contained in a data field. The value of the property is PivotFieldDataDisplayFormat integer constant. | ||
java.lang.String | getDisplayName() | |
void | setDisplayName(java.lang.Stringvalue) | |
Represents the PivotField display name. | ||
boolean | getDragToColumn() | |
void | setDragToColumn(booleanvalue) | |
Indicates whether the specified field can be dragged to the column position. The default value is true. | ||
boolean | getDragToData() | |
void | setDragToData(booleanvalue) | |
Indicates whether the specified field can be dragged to the data position. The default value is true. | ||
boolean | getDragToHide() | |
void | setDragToHide(booleanvalue) | |
Indicates whether the specified field can be dragged to the hide position. The default value is true. | ||
boolean | getDragToPage() | |
void | setDragToPage(booleanvalue) | |
Indicates whether the specified field can be dragged to the page position. The default value is true. | ||
boolean | getDragToRow() | |
void | setDragToRow(booleanvalue) | |
Indicates whether the specified field can be dragged to the row position. The default value is true. | ||
int | getFunction() | |
void | setFunction(intvalue) | |
Represents the function used to summarize the PivotTable data field. The value of the property is ConsolidationFunction integer constant. | ||
boolean | getInsertBlankRow() | |
void | setInsertBlankRow(booleanvalue) | |
Indicates whether inserting blank line after each item. | ||
boolean | isAscendShow() | |
void | setAscendShow(booleanvalue) | |
Indicates whether the specified PivotTable field is autoshown ascending. | ||
boolean | isAscendSort() | |
void | setAscendSort(booleanvalue) | |
Indicates whether the specified PivotTable field is autosorted ascending. | ||
boolean | isAutoShow() | |
void | setAutoShow(booleanvalue) | |
Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003. | ||
boolean | isAutoSort() | |
void | setAutoSort(booleanvalue) | |
Indicates whether the specified PivotTable field is automatically sorted. | ||
boolean | isAutoSubtotals() | |
void | setAutoSubtotals(booleanvalue) | |
Indicates whether the specified field shows automatic subtotals. Default is true. | ||
boolean | isCalculatedField() | |
Indicates whether the specified PivotTable field is calculated field.
|
||
boolean | isIncludeNewItemsInFilter() | |
void | setIncludeNewItemsInFilter(booleanvalue) | |
indicates whether the field can include new items in manual filter The default value is false. | ||
boolean | isInsertPageBreaksBetweenItems() | |
void | setInsertPageBreaksBetweenItems(booleanvalue) | |
indicates whether the field can insert page breaks between items insert page break after each item The default value is false. | ||
boolean | isMultipleItemSelectionAllowed() | |
void | setMultipleItemSelectionAllowed(booleanvalue) | |
indicates whether the field can have multiple items selected in the page field The default value is false. | ||
boolean | isRepeatItemLabels() | |
void | setRepeatItemLabels(booleanvalue) | |
indicates whether the field can repeat items labels The default value is false. | ||
int | getItemCount() | |
Gets the base item count of this pivot field.
|
||
java.lang.String[] | getItems() | |
Get all base items;
|
||
java.lang.String | getName() | |
Represents the PivotField name.
|
||
int | getNumber() | |
void | setNumber(intvalue) | |
Represents the built-in display format of numbers and dates. | ||
java.lang.String | getNumberFormat() | |
void | setNumberFormat(java.lang.Stringvalue) | |
Represents the custom display format of numbers and dates. | ||
java.lang.String[] | getOriginalItems() | |
Get the original base items;
|
||
PivotItemCollection | getPivotItems() | |
Gets the pivot items of the pivot field
|
||
int | getPosition() | |
Represents the PivotField index in the PivotFields.
|
||
SxRng | getRange() | |
Gets the group range of the pivot field
|
||
boolean | getShowAllItems() | |
void | setShowAllItems(booleanvalue) | |
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. | ||
boolean | getShowCompact() | |
void | setShowCompact(booleanvalue) | |
boolean | getShowInOutlineForm() | |
void | setShowInOutlineForm(booleanvalue) | |
Indicates whether layout this field in outline form on the Pivot Table view | ||
boolean | getShowSubtotalAtTop() | |
void | setShowSubtotalAtTop(booleanvalue) | |
when ShowInOutlineForm is true, then display subtotals at the top of the list of items instead of at the bottom |
Method Summary | ||
---|---|---|
void | addCalculatedItem(java.lang.String name, java.lang.String formula) | |
Add a calculated item to the pivot field.
|
||
java.lang.String | getCalculatedFieldFormula() | |
Get the formula string of the specified calculated field .
|
||
PivotFilter | getPivotFilterByType(int type) | |
Gets the pivot filter of the pivot field by type
|
||
java.util.ArrayList | getPivotFilters() | |
Gets the pivot filters of the pivot field
|
||
boolean | getSubtotals(int subtotalType) | |
Gets whether the specified field shows that subtotals.
|
||
void | hideDetail(boolean isHiddenDetail) | |
Sets whether the PivotItems in a pivot field is hidden detail.That is collapse/expand this field.
|
||
void | hideItem(int index, boolean isHidden) | |
Sets whether the specific PivotItem in a data field is hidden.
|
||
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 | initPivotItems() | |
Init the pivot items of the pivot field
|
||
boolean | isHiddenItem(int index) | |
Indicates whether the specific PivotItem is hidden.
|
||
boolean | isHiddenItemDetail(int index) | |
Indicates whether the specific PivotItem is hidden detail.
|
||
void | setSubtotals(int subtotalType, boolean shown) | |
Sets whether the specified field shows that subtotals.
|
public PivotItemCollection getPivotItems()
public SxRng getRange()
public boolean isCalculatedField()
public int getBaseIndex() / public void setBaseIndex(int value)
public int getPosition()
public java.lang.String getName()
public java.lang.String getDisplayName() / public void setDisplayName(java.lang.String value)
public boolean isAutoSubtotals() / public void setAutoSubtotals(boolean value)
public boolean getDragToColumn() / public void setDragToColumn(boolean value)
public boolean getDragToHide() / public void setDragToHide(boolean value)
public boolean getDragToRow() / public void setDragToRow(boolean value)
public boolean getDragToPage() / public void setDragToPage(boolean value)
public boolean getDragToData() / public void setDragToData(boolean value)
public boolean isMultipleItemSelectionAllowed() / public void setMultipleItemSelectionAllowed(boolean value)
public boolean isRepeatItemLabels() / public void setRepeatItemLabels(boolean value)
public boolean isIncludeNewItemsInFilter() / public void setIncludeNewItemsInFilter(boolean value)
public boolean isInsertPageBreaksBetweenItems() / public void setInsertPageBreaksBetweenItems(boolean value)
public boolean getShowAllItems() / public void setShowAllItems(boolean value)
public boolean isAutoSort() / public void setAutoSort(boolean value)
public boolean isAscendSort() / public void setAscendSort(boolean value)
public int getAutoSortField() / public void setAutoSortField(int value)
public boolean isAutoShow() / public void setAutoShow(boolean value)
public boolean isAscendShow() / public void setAscendShow(boolean value)
public int getAutoShowCount() / public void setAutoShowCount(int value)
public int getAutoShowField() / public void setAutoShowField(int value)
public int getFunction() / public void setFunction(int value)
public int getDataDisplayFormat() / public void setDataDisplayFormat(int value)
public int getBaseFieldIndex() / public void setBaseFieldIndex(int value)
public int getBaseItemPosition() / public void setBaseItemPosition(int value)
public int getBaseItemIndex() / public void setBaseItemIndex(int value)
public short getCurrentPageItem() / public void setCurrentPageItem(short value)
public int getNumber() / public void setNumber(int value)
public boolean getInsertBlankRow() / public void setInsertBlankRow(boolean value)
public boolean getShowSubtotalAtTop() / public void setShowSubtotalAtTop(boolean value)
public boolean getShowInOutlineForm() / public void setShowInOutlineForm(boolean value)
public java.lang.String getNumberFormat() / public void setNumberFormat(java.lang.String value)
public java.lang.String[] getItems()
public java.lang.String[] getOriginalItems()
public int getItemCount()
public boolean getShowCompact() / public void setShowCompact(boolean value)
public PivotFilter getPivotFilterByType(int type)
type
- A PivotFilterType value.public java.util.ArrayList getPivotFilters()
public void initPivotItems()
public java.lang.String getCalculatedFieldFormula()
public void setSubtotals(int subtotalType, boolean shown)
subtotalType
- A shown
- whether the specified field shows that subtotals.public boolean getSubtotals(int subtotalType)
subtotalType
- A public boolean isHiddenItem(int index)
index
- the index of the pivotItem in the pivotField.public void hideItem(int index, boolean isHidden)
index
- the index of the pivotItem in the pivotField.isHidden
- whether the specific PivotItem is hiddenpublic boolean isHiddenItemDetail(int index)
index
- the index of the pivotItem in the pivotField.public void hideItemDetail(int index, boolean isHiddenDetail)
index
- the index of the pivotItem in the pivotField.isHiddenDetail
- whether the specific PivotItem is hiddenpublic void hideDetail(boolean isHiddenDetail)
isHiddenDetail
- whether the PivotItems is hiddenpublic void hideItem(java.lang.String itemValue, boolean isHidden)
itemValue
- the value of the pivotItem in the pivotField.isHidden
- whether the specific PivotItem is hiddenpublic void addCalculatedItem(java.lang.String name, java.lang.String formula)
name
- The item's name.formula
- The item's formula