Aspose::Cells::Pivot::PivotTableCollection class

PivotTableCollection class

Represents the collection of all the PivotTable objects on the specified worksheet.

class PivotTableCollection

Methods

MethodDescription
Add(const U16String& sourceData, const U16String& destCellName, const U16String& tableName)Adds a new PivotTable.
Add(const char16_t* sourceData, const char16_t* destCellName, const char16_t* tableName)Adds a new PivotTable.
Add(const U16String& sourceData, const U16String& destCellName, const U16String& tableName, bool useSameSource)Adds a new PivotTable.
Add(const char16_t* sourceData, const char16_t* destCellName, const char16_t* tableName, bool useSameSource)Adds a new PivotTable.
Add(const U16String& sourceData, int32_t row, int32_t column, const U16String& tableName)Adds a new PivotTable.
Add(const char16_t* sourceData, int32_t row, int32_t column, const char16_t* tableName)Adds a new PivotTable.
Add(const U16String& sourceData, int32_t row, int32_t column, const U16String& tableName, bool useSameSource)Adds a new PivotTable.
Add(const char16_t* sourceData, int32_t row, int32_t column, const char16_t* tableName, bool useSameSource)Adds a new PivotTable.
Add(const U16String& sourceData, int32_t row, int32_t column, const U16String& tableName, bool useSameSource, bool isXlsClassic)Adds a new PivotTable.
Add(const char16_t* sourceData, int32_t row, int32_t column, const char16_t* tableName, bool useSameSource, bool isXlsClassic)Adds a new PivotTable.
Add(const U16String& sourceData, const U16String& cell, const U16String& tableName, bool useSameSource, bool isXlsClassic)Adds a new PivotTable.
Add(const char16_t* sourceData, const char16_t* cell, const char16_t* tableName, bool useSameSource, bool isXlsClassic)Adds a new PivotTable.
Add(const PivotTable& pivotTable, const U16String& destCellName, const U16String& tableName)Adds a new PivotTable based on another PivotTable.
Add(const PivotTable& pivotTable, const char16_t* destCellName, const char16_t* tableName)Adds a new PivotTable based on another PivotTable.
Add(const PivotTable& pivotTable, int32_t row, int32_t column, const U16String& tableName)Adds a new PivotTable based on another PivotTable.
Add(const PivotTable& pivotTable, int32_t row, int32_t column, const char16_t* tableName)Adds a new PivotTable based on another PivotTable.
Add(const Vector <U16String>& sourceData, bool isAutoPage, const PivotPageFields& pageFields, const U16String& destCellName, const U16String& tableName)Adds a new PivotTableObject to the collection with multiple consolidation ranges as data source.
Add(const Vector <U16String>& sourceData, bool isAutoPage, const PivotPageFields& pageFields, const char16_t* destCellName, const char16_t* tableName)Adds a new PivotTableObject to the collection with multiple consolidation ranges as data source.
Add(const Vector <U16String>& sourceData, bool isAutoPage, const PivotPageFields& pageFields, int32_t row, int32_t column, const U16String& tableName)Adds a new PivotTableObject to the collection with multiple consolidation ranges as data source.
Add(const Vector <U16String>& sourceData, bool isAutoPage, const PivotPageFields& pageFields, int32_t row, int32_t column, const char16_t* tableName)Adds a new PivotTableObject to the collection with multiple consolidation ranges as data source.
begin()Returns an iterator to the beginning of the PivotTableCollection.
Clear()Clears all pivot tables.
Dispose()Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
end()Returns an iterator to the end of the PivotTableCollection.
Get(int32_t index)Gets the PivotTable report by index.
Get(const U16String& name)Gets the PivotTable report by pivottable’s name.
Get(const char16_t* name)Gets the PivotTable report by pivottable’s name.
Get(int32_t row, int32_t column)Gets the PivotTable report by pivottable’s position.
GetCount()Gets the number of elements contained in the instance.
IsNull() constChecks whether the implementation object is nullptr.
explicit operator bool() constoperator bool()
operator=(const PivotTableCollection& src)operator=
PivotTableCollection(PivotTableCollection_Impl* impl)Constructs from an implementation object.
PivotTableCollection(const PivotTableCollection& src)Copy constructor.
Remove(const PivotTable& pivotTable)Deletes the specified PivotTable and delete the PivotTable data.
Remove(const PivotTable& pivotTable, bool keepData)Deletes the specified PivotTable.
RemoveAt(int32_t index)Deletes the PivotTable at the specified index and delete the PivotTable data.
RemoveAt(int32_t index, bool keepData)Deletes the PivotTable at the specified index.
~PivotTableCollection()Destructor.

Fields

FieldDescription
_implThe implementation object.

Examples

Aspose::Cells::Startup();
Workbook book;
Worksheet sheet = book.GetWorksheets().Get(0);
Cells cells = sheet.GetCells();
cells.Get(0, 0).PutValue(u"fruit");
cells.Get(1, 0).PutValue(u"grape");
cells.Get(2, 0).PutValue(u"blueberry");
cells.Get(3, 0).PutValue(u"kiwi");
cells.Get(4, 0).PutValue(u"cherry");
cells.Get(5, 0).PutValue(u"grape");
cells.Get(6, 0).PutValue(u"blueberry");
cells.Get(7, 0).PutValue(u"kiwi");
cells.Get(8, 0).PutValue(u"cherry");

cells.Get(0, 1).PutValue(u"year");
cells.Get(1, 1).PutValue(2020);
cells.Get(2, 1).PutValue(2020);
cells.Get(3, 1).PutValue(2020);
cells.Get(4, 1).PutValue(2020);
cells.Get(5, 1).PutValue(2021);
cells.Get(6, 1).PutValue(2021);
cells.Get(7, 1).PutValue(2021);
cells.Get(8, 1).PutValue(2021);

cells.Get(0, 2).PutValue(u"amount");
cells.Get(1, 2).PutValue(50);
cells.Get(2, 2).PutValue(60);
cells.Get(3, 2).PutValue(70);
cells.Get(4, 2).PutValue(80);
cells.Get(5, 2).PutValue(90);
cells.Get(6, 2).PutValue(100);
cells.Get(7, 2).PutValue(110);
cells.Get(8, 2).PutValue(120);

PivotTableCollection pivots = sheet.GetPivotTables();

int pivotIndex = pivots.Add(u"=Sheet1!A1:C9", u"A12", u"TestPivotTable");
PivotTable pivot = pivots.Get(pivotIndex);
pivot.AddFieldToArea(PivotFieldType::Row, u"fruit");
pivot.AddFieldToArea(PivotFieldType::Column, u"year");
pivot.AddFieldToArea(PivotFieldType::Data, u"amount");

pivot.SetPivotTableStyleType(PivotTableStyleType::PivotTableStyleMedium10);

//Change PivotField's attributes
PivotField rowField = pivot.GetRowFields().Get(0);
rowField.SetDisplayName(u"custom display name");

//Add PivotFilter
int index = pivot.GetPivotFilters().Add(0, PivotFilterType::Count);
PivotFilter filter = pivot.GetPivotFilters().Get(index);
filter.GetAutoFilter().FilterTop10(0, false, false, 2);

//Add PivotFormatCondition
int formatIndex = pivot.GetPivotFormatConditions().Add();
PivotFormatCondition pfc = pivot.GetPivotFormatConditions().Get(formatIndex);
FormatConditionCollection fcc = pfc.GetFormatConditions();
fcc.AddArea(pivot.GetDataBodyRange());
int idx = fcc.AddCondition(FormatConditionType::CellValue);
FormatCondition fc = fcc.Get(idx);
fc.SetFormula1(u"100");
fc.SetOperator(OperatorType::GreaterOrEqual);
fc.GetStyle().SetBackgroundColor(Color{ 0xff, 0xff, 0, 0 });//Red

pivot.RefreshData();
pivot.CalculateData();


book.Save("out.xlsx");

Aspose::Cells::Cleanup();

See Also