java.lang.Objectcom.aspose.cells.PivotField
public class PivotField
Property Getters/Setters Summary | ||
---|---|---|
int | getAutoShowCount() | |
void | setAutoShowCount(int value) | |
Represent the number of top or bottom items that are automatically shown in the specified PivotTable field. | ||
int | getAutoShowField() | |
void | setAutoShowField(int value) | |
Represents auto show field index. -1 means PivotField itself. It should be the index of the data fields. | ||
int | getAutoSortField() | |
void | setAutoSortField(int value) | |
Represents auto sort field index. -1 means PivotField itself,others means the position of the data fields. | ||
int | getBaseField() | |
void | setBaseField(int value) | |
Represents the base field for a custom calculation. | ||
int | getBaseIndex() | |
void | setBaseIndex(int value) | |
Represents the PivotField index in the base PivotFields. | ||
int | getBaseItem() | |
void | setBaseItem(int value) | |
Represents the item in the base field for a custom calculation. Valid only for data fields. | ||
int | getBaseItemPosition() | |
void | setBaseItemPosition(int value) | |
Represents the item in the base field for a custom calculation. Valid only for data fields. The value of the property is PivotItemPosition integer constant. | ||
short | getCurrentPageItem() | |
void | setCurrentPageItem(short value) | |
Represents the current page item showing for the page field (valid only for page fields). | ||
int | getDataDisplayFormat() | |
void | setDataDisplayFormat(int value) | |
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.String value) | |
Represents the PivotField display name. | ||
boolean | getDragToColumn() | |
void | setDragToColumn(boolean value) | |
Indicates whether the specified field can be dragged to the column position. The default value is true. | ||
boolean | getDragToData() | |
void | setDragToData(boolean value) | |
Indicates whether the specified field can be dragged to the data position. The default value is true. | ||
boolean | getDragToHide() | |
void | setDragToHide(boolean value) | |
Indicates whether the specified field can be dragged to the hide position. The default value is true. | ||
boolean | getDragToPage() | |
void | setDragToPage(boolean value) | |
Indicates whether the specified field can be dragged to the page position. The default value is true. | ||
boolean | getDragToRow() | |
void | setDragToRow(boolean value) | |
Indicates whether the specified field can be dragged to the row position. The default value is true. | ||
int | getFunction() | |
void | setFunction(int value) | |
Represents the function used to summarize the PivotTable data field. The value of the property is ConsolidationFunction integer constant. | ||
boolean | getInsertBlankRow() | |
void | setInsertBlankRow(boolean value) | |
Indicates whether inserting blank line after each item. | ||
boolean | isAscendShow() | |
void | setAscendShow(boolean value) | |
Indicates whether the specified PivotTable field is autoshown ascending. | ||
boolean | isAscendSort() | |
void | setAscendSort(boolean value) | |
Indicates whether the specified PivotTable field is autosorted ascending. | ||
boolean | isAutoShow() | |
void | setAutoShow(boolean value) | |
Indicates whether the specified PivotTable field is automatically shown,only valid for excel 2003. | ||
boolean | isAutoSort() | |
void | setAutoSort(boolean value) | |
Indicates whether the specified PivotTable field is automatically sorted. | ||
boolean | isAutoSubtotals() | |
void | setAutoSubtotals(boolean value) | |
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(boolean value) | |
indicates whether the field can include new items in manual filter The default value is false. | ||
boolean | isInsertPageBreaksBetweenItems() | |
void | setInsertPageBreaksBetweenItems(boolean value) | |
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(boolean value) | |
indicates whether the field can have multiple items selected in the page field The default value is false. | ||
boolean | isRepeatItemLabels() | |
void | setRepeatItemLabels(boolean value) | |
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(int value) | |
Represents the built-in display format of numbers and dates. | ||
java.lang.String | getNumberFormat() | |
void | setNumberFormat(java.lang.String value) | |
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(boolean value) | |
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(boolean value) | |
boolean | getShowInOutlineForm() | |
void | setShowInOutlineForm(boolean value) | |
Indicates whether layout this field in outline form on the Pivot Table view | ||
boolean | getShowSubtotalAtTop() | |
void | setShowSubtotalAtTop(boolean value) | |
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. | ||
boolean | dragToColumn() | |
Indicates whether the specified field can be dragged to the column position. The default value is true. | ||
boolean | dragToHide() | |
Indicates whether the specified field can be dragged to the hide position. The default value is true. | ||
boolean | dragToPage() | |
Indicates whether the specified field can be dragged to the page position. The default value is true. | ||
boolean | dragToRow() | |
Indicates whether the specified field can be dragged to the row position. The default value is true. | ||
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. | ||
boolean | showAllItems() | |
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. |
Property Getters/Setters Detail |
---|
getPivotItems | |
public PivotItemCollection getPivotItems() |
getRange | |
public SxRng getRange() |
isCalculatedField | |
public boolean isCalculatedField() |
getBaseIndex/setBaseIndex | |
public int getBaseIndex() / public void setBaseIndex(int value) |
getPosition | |
public int getPosition() |
getName | |
public java.lang.String getName() |
getDisplayName/setDisplayName | |
public java.lang.String getDisplayName() / public void setDisplayName(java.lang.String value) |
isAutoSubtotals/setAutoSubtotals | |
public boolean isAutoSubtotals() / public void setAutoSubtotals(boolean value) |
getDragToColumn/setDragToColumn | |
public boolean getDragToColumn() / public void setDragToColumn(boolean value) |
getDragToHide/setDragToHide | |
public boolean getDragToHide() / public void setDragToHide(boolean value) |
getDragToRow/setDragToRow | |
public boolean getDragToRow() / public void setDragToRow(boolean value) |
getDragToPage/setDragToPage | |
public boolean getDragToPage() / public void setDragToPage(boolean value) |
getDragToData/setDragToData | |
public boolean getDragToData() / public void setDragToData(boolean value) |
isMultipleItemSelectionAllowed/setMultipleItemSelectionAllowed | |
public boolean isMultipleItemSelectionAllowed() / public void setMultipleItemSelectionAllowed(boolean value) |
isRepeatItemLabels/setRepeatItemLabels | |
public boolean isRepeatItemLabels() / public void setRepeatItemLabels(boolean value) |
isIncludeNewItemsInFilter/setIncludeNewItemsInFilter | |
public boolean isIncludeNewItemsInFilter() / public void setIncludeNewItemsInFilter(boolean value) |
isInsertPageBreaksBetweenItems/setInsertPageBreaksBetweenItems | |
public boolean isInsertPageBreaksBetweenItems() / public void setInsertPageBreaksBetweenItems(boolean value) |
getShowAllItems/setShowAllItems | |
public boolean getShowAllItems() / public void setShowAllItems(boolean value) |
isAutoSort/setAutoSort | |
public boolean isAutoSort() / public void setAutoSort(boolean value) |
isAscendSort/setAscendSort | |
public boolean isAscendSort() / public void setAscendSort(boolean value) |
getAutoSortField/setAutoSortField | |
public int getAutoSortField() / public void setAutoSortField(int value) |
isAutoShow/setAutoShow | |
public boolean isAutoShow() / public void setAutoShow(boolean value) |
isAscendShow/setAscendShow | |
public boolean isAscendShow() / public void setAscendShow(boolean value) |
getAutoShowCount/setAutoShowCount | |
public int getAutoShowCount() / public void setAutoShowCount(int value) |
getAutoShowField/setAutoShowField | |
public int getAutoShowField() / public void setAutoShowField(int value) |
getFunction/setFunction | |
public int getFunction() / public void setFunction(int value) |
getDataDisplayFormat/setDataDisplayFormat | |
public int getDataDisplayFormat() / public void setDataDisplayFormat(int value) |
getBaseField/setBaseField | |
public int getBaseField() / public void setBaseField(int value) |
getBaseItemPosition/setBaseItemPosition | |
public int getBaseItemPosition() / public void setBaseItemPosition(int value) |
getBaseItem/setBaseItem | |
public int getBaseItem() / public void setBaseItem(int value) |
getCurrentPageItem/setCurrentPageItem | |
public short getCurrentPageItem() / public void setCurrentPageItem(short value) |
getNumber/setNumber | |
public int getNumber() / public void setNumber(int value) |
getInsertBlankRow/setInsertBlankRow | |
public boolean getInsertBlankRow() / public void setInsertBlankRow(boolean value) |
getShowSubtotalAtTop/setShowSubtotalAtTop | |
public boolean getShowSubtotalAtTop() / public void setShowSubtotalAtTop(boolean value) |
getShowInOutlineForm/setShowInOutlineForm | |
public boolean getShowInOutlineForm() / public void setShowInOutlineForm(boolean value) |
getNumberFormat/setNumberFormat | |
public java.lang.String getNumberFormat() / public void setNumberFormat(java.lang.String value) |
getItems | |
public java.lang.String[] getItems() |
getOriginalItems | |
public java.lang.String[] getOriginalItems() |
getItemCount | |
public int getItemCount() |
getShowCompact/setShowCompact | |
public boolean getShowCompact() / public void setShowCompact(boolean value) |
Method Detail |
---|
getPivotFilterByType | |
public PivotFilter getPivotFilterByType(int type) |
type
- A PivotFilterType value.getPivotFilters | |
public java.util.ArrayList getPivotFilters() |
initPivotItems | |
public void initPivotItems() |
getCalculatedFieldFormula | |
public java.lang.String getCalculatedFieldFormula() |
setSubtotals | |
public void setSubtotals(int subtotalType, boolean shown) |
subtotalType
- A shown
- whether the specified field shows that subtotals.getSubtotals | |
public boolean getSubtotals(int subtotalType) |
subtotalType
- A dragToColumn | |
public boolean dragToColumn() |
dragToHide | |
public boolean dragToHide() |
dragToRow | |
public boolean dragToRow() |
dragToPage | |
public boolean dragToPage() |
showAllItems | |
public boolean showAllItems() |
isHiddenItem | |
public boolean isHiddenItem(int index) |
index
- the index of the pivotItem in the pivotField.hideItem | |
public void hideItem(int index, boolean isHidden) |
index
- the index of the pivotItem in the pivotField.isHidden
- whether the specific PivotItem is hiddenisHiddenItemDetail | |
public boolean isHiddenItemDetail(int index) |
index
- the index of the pivotItem in the pivotField.hideItemDetail | |
public void hideItemDetail(int index, boolean isHiddenDetail) |
index
- the index of the pivotItem in the pivotField.isHiddenDetail
- whether the specific PivotItem is hiddenhideDetail | |
public void hideDetail(boolean isHiddenDetail) |
isHiddenDetail
- whether the PivotItems is hiddenhideItem | |
public void hideItem(java.lang.String itemValue, boolean isHidden) |
itemValue
- the value of the pivotItem in the pivotField.isHidden
- whether the specific PivotItem is hiddenaddCalculatedItem | |
public void addCalculatedItem(java.lang.String name, java.lang.String formula) |
name
- The item's name.formula
- The item's formula