Table of Contents |
---|
This example takes an existing workbook that contains some data and creates a PivotTable. The workbook used in this example is available for download: Download BasicExample.xlsx.
Before writing any PivotTable code, make sure to open the workbook with ExcelApplication
and get references to the data worksheet and a worksheet for the PivotTable. See Adding OfficeWriter to your .NET Application.
ExcelApplication xla = new ExcelApplication(); //Example.xlsx has a worksheet 'Data' with 9 columns and 244 rows of data Workbook wb = xla.Open("\\BasicExample.xlsx"); Worksheet data_ws = wb.Worksheets["Data"]; Worksheet pivot_ws = wb.Worksheets.CreateWorksheet("Pivot"); |
This example places the PivotTable on a separate sheet. It is recommended that each PivotTable be placed on a separate sheet. This is because Excel does not allow PivotTables to overlap. When building PivotTables in Excel, an error message will be thrown if performing an action would cause two PivotTables to overlap. ExcelWriter does not have the ability to render PivotTables so it cannot calculate which cells a PivotTable occupies. Therefore, it cannot detect when PivotTables might overlap and will not throw an exception even if the code generates overlapping PivotTables. To avoid this, we encourage you to keep your PivotTables on separate worksheets. |
The data source needs to be a continuous block of cells with a header row with column names. The data source can be defined as an Area
or a NamedRange
.
Here is a snapshot of the data for this tutorial, which can also be found in BasicExample.xlsx:
There are 9 columns and 244 rows in the data set, including the row with the header values.
In this case, the data source for the PivotTable will be a dynamically defined Area
on the data worksheet. Note that the row of column names is included in the area.
Area data_area = data_ws.CreateArea(0, 0, 9, 244); |
To create a PivotTable
, call CreatePivotTable
on the PivotTables
collection. Specify the 0-indexed row and column values for the PivotTable location:
PivotTable pt = pivot_ws.PivotTables.CreatePivotTable(data_area, 0, 0); |
After creating the PivotTable, always set RefreshOnOpen
to true
.
pt.PivotTableSettings.RefreshOnOpen = true; |
ExcelWriter does not have the ability to render a PivotTable, so any modifications made to a PivotTable will not take affect until the output file is opened in Excel and the PivotTable is refreshed. If RefreshOnOpen
is true
, Excel will refresh the PivotTable when the workbook opens, which will re-render the PivotTable.
Next, add PivotTableFields
to the PivotTable. There are four types of PivotTableField
: DataFields
, RowLabels
, ColumnLabels
, and PageFields
(or report filters). The Pivot field properties are available for all four types of PivotTableField
, however some properties will not have an affect, depending on the type of field. These properties can be read and written to, but they will be ignored by Excel.
All PivotTableFields
are created from SourceFields
. A SourceField
is a read-only field that is automatically generated from the data source of the PivotTable. Each column in the data source corresponds with a SourceField
in the PivotTable and the name of the SourceField
comes from the column header name.
A |
To add a PageField
, call CreateField
on the PivotTable.PageFields
collection. You will need to specify the SourceField
that will be used to create the PageField
.
INSERT PageField CODE HERE |
If there is no space to add the |
Adding a pivot table field - row labels / column labels, source fields, naming convention, changing the display name
Adding data fields - calculated fields, naming conventions, changing the display name