public final class PivotAreaFieldCollection extends PivotFieldBaseCollection
PivotField
s.
Pivot Tables are used to arrange and aggregate complicated data and drill down on details.
Source of data for Pivot Table can be:
Worksheet
- cell range
, named range
, table, etc.
GemBox.Spreadsheet currently supports creating only worksheet source
.
All other sources are supported through preservation (to correctly round-trip to XLSX format).
Source of the data for Pivot Table contains following information:
Pivot Table does not directly reference its data source, but instead it references a cache of a data source. Cache of a data source contains an in-memory copy of data source scheme and, optionally, data and is stored in a workbook which may contain multiple caches of various sources of data.
Cache can be updated/refreshed from a data source automatically (for example, when opening a workbook) or on request. Cache is used to provide better performance of Pivot Table functionality which requires frequent access to data records and their values and to enable sharing the same data source between multiple Pivot Tables.
GemBox.Spreadsheet represents cache with a PivotCache
type.
Cache source is represented with a PivotCacheSource
type (and its sub-types) and can be accessed from a PivotCache.getCacheSource()
method.
PivotCache
instances are stored in a ExcelFile.getPivotCaches()
collection.
PivotCache
currently doesn't store the actual cached records (it stores only scheme - fields and their properties), but instead Microsoft Excel is instructed to update the record cache from the data source when opening a workbook.
PivotTable
is created from a PivotCache
with the specified name and the specified cell in the worksheet where it is placed using the PivotTableCollection.add(PivotCache, String, String)
methods.
PivotTable
contains the PivotFields
collection which PivotField
elements can be moved
into the following Pivot Table areas:
PivotTable.getPageFields()
collection.
PivotTable.getRowFields()
collection.
PivotTable.getColumnFields()
collection.
PivotTable.getDataFields()
collection.
Each (non-calculated) PivotField
can contain zero or more PivotItem
s which are used for filtering and grouping by a specific value.
Except using fields defined in Pivot Table data source (more precisely, in PivotTable.getPivotCache()
) which cannot be removed, Pivot Table can also define calculated PivotField
s and calculated PivotItem
s which use a formula to specify their values.
Calculated PivotField
can be added using a PivotFieldCollection.addCalculated(String, String)
method and removed using a PivotFieldCollection.removeCalculated(String)
method. Method PivotField.isCalculated()
tells if a field is calculated or is a field from the data source.
Calculated PivotField
is automatically moved to a Values Area (PivotTable.getDataFields()
collection) and only Values Area can contain calculated PivotField
s.
Calculated PivotItem
can be added using a PivotItemCollection.addCalculated(String, String)
method and removed using a PivotItemCollection.removeCalculated(String)
method. Method PivotItem.isCalculated()
tells if an item is calculated.
If calculated PivotField
is added/removed in one PivotTable
, then it is also added/removed from all other PivotTable
s which reference the same PivotTable.getPivotCache()
.
Since adding/removing calculated PivotField
s means changing the data scheme, which is defined in PivotCache
, actual modification is made in PivotCache
and propagated to all PivotTable
s which are referencing it.
PivotField
s can be re-ordered in a specific area using the move(int, int)
method. PivotItem
s can be re-ordered using the PivotItemCollection.move(int, int)
method.
GemBox.Spreadsheet currently does not provide functionality to read/calculate the actual data from the PivotTable
.
It provides the functionality to arrange and customize PivotField
s, PivotItem
s and PivotTable
appearance.
Because of that PivotTable
data is not rendered/written to other output formats like HTML. When output XLSX file with Pivot Table is opened in Microsoft Excel application, its data is automatically retrieved and calculated from the data source by Microsoft Excel.
Following code demonstrates how to create and customize PivotTable
using GemBox.Spreadsheet component to get the following information out of the sample records:
This information might help you decide if working for GemBox is worth it if you are a man or a woman and in which department would it be the best to work (considering department salaries of other companies).
Input workbook can be downloaded from PivotTableData.xlsx
// Load workbook from XLSX file on Desktop.
ExcelFile workbook = ExcelFile.load("PivotTableData.xlsx");
// Create pivot cache from named range 'Sheet1!PivotDataRange'.
PivotCache pivotCache = workbook.getPivotCaches().addWorksheetSource("Sheet1!PivotDataRange");
// Create pivot table using the specified pivot cache, name it 'PivotTable1' and add it to the 'Sheet1' worksheet at the cell location 'G2'.
PivotTable pivotTable = workbook.getWorksheet("Sheet1").addPivotTable(pivotCache, "PivotTable1", "G2");
// Aggregate 'Salary' values into average value and show it as a percentage of difference from average value for 'GemBox' company.
PivotField field = pivotTable.getDataFields().add("Salary");
field.setFunction(PivotFieldCalculationType.AVERAGE);
field.setNumberFormat("[$$-409]#,##0.00");
field.setShowDataAs(PivotFieldDisplayFormat.PERCENTAGE_OF_DIFFERENCE);
field.setBaseField(pivotTable.getPivotFields().get("Company"));
field.setBaseItem(field.getBaseField().getPivotItems().get("GemBox"));
// Aggregate 'Salary' values into max value and show it as a percentage of difference from max value for 'GemBox' company.
field = pivotTable.getDataFields().add("Salary");
field.setFunction(PivotFieldCalculationType.MAX);
field.setNumberFormat("[$$-409]#,##0.00");
field.setShowDataAs(PivotFieldDisplayFormat.PERCENTAGE_OF_DIFFERENCE);
field.setBaseField(pivotTable.getPivotFields().get("Company"));
field.setBaseItem(field.getBaseField().getPivotItems().get("GemBox"));
// Group rows first into 'Departments' and then into 'Companies'.
pivotTable.getRowFields().add("Department");
pivotTable.getRowFields().add("Company");
// Group columns first into 'Data' (average 'Salary' and max 'Salary) and then into 'Genders'.
pivotTable.getColumnFields().add(pivotTable.getDataPivotField());
pivotTable.getColumnFields().add("Gender");
// Do not show grand totals for columns because we are only interested in a relative difference between 'GemBox' and other companies.
pivotTable.setColumnGrandTotals(false);
// Style pivot table.
pivotTable.setBuiltInStyle(BuiltInPivotStyleName.PIVOT_STYLE_LIGHT_16);
// Save workbook to XLSX file on Desktop.
workbook.save("PivotTable.xlsx");
Modifier and Type | Method and Description |
---|---|
PivotField |
add(int fieldIndex)
Adds the
PivotField to this area collection. |
PivotField |
add(PivotField pivotField)
Adds the
PivotField to this area collection. |
PivotField |
add(String fieldName)
Adds the
PivotField to this area collection. |
void |
clear()
Removes all
PivotField s from this area collection. |
void |
move(int oldIndex,
int newIndex)
Moves the
PivotField at the specified index to a new location in the collection. |
void |
remove(int fieldIndex)
Removes
PivotField at the specified index from this area collection. |
void |
remove(PivotField pivotField)
Removes
PivotField from this area collection. |
void |
remove(String fieldName)
Removes
PivotField with the specified name from this area collection. |
contains, get, get, indexOf, iterator, size
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEach, spliterator
public PivotField add(int fieldIndex)
PivotField
to this area collection.fieldIndex
- The PivotField
index in the pivot fields
collection.PivotField
added to this area collection.IllegalStateException
- PivotTable
created from non-worksheet data source cannot be modified.IndexOutOfBoundsException
- fieldIndex
is less than 0 or is equal to or greater than pivot fields
size.public PivotField add(PivotField pivotField)
PivotField
to this area collection.pivotField
- The PivotField
in the pivot fields
, row fields
, column fields
, page fields
or data fields
collection.PivotField
added to this area collection.IllegalStateException
- PivotTable
created from non-worksheet data source cannot be modified.NullPointerException
- pivotField
can't be null
.IllegalArgumentException
- Field is not part of the parent PivotTable
.public PivotField add(String fieldName)
PivotField
to this area collection.fieldName
- The PivotField
name in the pivot fields
collection.PivotField
added to this area collection.IllegalStateException
- PivotTable
created from non-worksheet data source cannot be modified.IllegalArgumentException
- fieldName
can't be null
or empty string.IllegalArgumentException
- Field with specified name doesn't exist.public void clear()
PivotField
s from this area collection.IllegalStateException
- PivotTable
created from non-worksheet data source cannot be modified.public void move(int oldIndex, int newIndex)
PivotField
at the specified index to a new location in the collection.oldIndex
- The zero-based index specifying the location of the PivotField
to be moved.newIndex
- The zero-based index specifying the new location of the PivotField
.IndexOutOfBoundsException
- oldIndex
is less than 0 or is equal to or greater than field count.IndexOutOfBoundsException
- newIndex
is less than 0 or is equal to or greater than field count.IllegalStateException
- PivotTable
created from non-worksheet data source cannot be modified.public void remove(int fieldIndex)
PivotField
at the specified index from this area collection.fieldIndex
- The PivotField
index in this area collection.IllegalStateException
- PivotTable
created from non-worksheet data source cannot be modified.IndexOutOfBoundsException
- fieldIndex
is less than 0 or is equal to or greater than field count.public void remove(PivotField pivotField)
PivotField
from this area collection.pivotField
- The PivotField
in this area collection.IllegalStateException
- PivotTable
created from non-worksheet data source cannot be modified.NullPointerException
- pivotField
can't be null
.IllegalArgumentException
- Field is not part of this pivot area.public void remove(String fieldName)
PivotField
with the specified name from this area collection.fieldName
- The PivotField
name.IllegalStateException
- PivotTable
created from non-worksheet data source cannot be modified.IllegalArgumentException
- fieldName
can't be null
or empty string.IllegalArgumentException
- Field with specified name doesn't exist.© GemBox d.o.o. — All rights reserved.