PivotCache Class

Namespace:

GemBox.Spreadsheet.PivotTables

Assembly:

GemBox.Spreadsheet.dll

Represents a memory cache for a PivotTable.

• C#
• VB.NET

public sealed class PivotCache

Public NotInheritable Class PivotCache

Pivot Tables are used to arrange and aggregate complicated data and drill down on details.

Source of data for Pivot Table can be:

• WorksheetSource - CellRange, NamedRange, table, etc.
• External - database, OLAP cube, textual file, web query, etc.
• Other - multiple consolidation ranges in the workbook, another Pivot Table, etc.

Source of the data for Pivot Table contains following information:

• Scheme - data source fields/columns, its data types, etc.
• Data - actual data source records.

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 CacheSource property. PivotCache instances are stored in a PivotCaches collection. PivotCache can be refreshed by using the Refresh() method.

PivotTable is created from a PivotCache with the specified name and the specified cell in the worksheet where it is placed using the Add(PivotCache, String, String) method. PivotTable contains the PivotFields collection which PivotField elements can be Add(Int32) into the following Pivot Table areas:

• Report Filter Area represented by PageFields collection.
• Row Axis represented by RowFields collection.
• Column Axis represented by ColumnFields collection.
• Values Area represented by DataFields collection.

Each (non-calculated) PivotField can contain zero or more PivotItems which are used for filtering and grouping by a specific value.

Except using fields defined in Pivot Table data source (more precisely, in PivotCache) which cannot be removed, Pivot Table can also define calculated PivotFields and calculated PivotItems which use a formula to specify their values. Calculated PivotField can be added using a AddCalculated(String, String) method and removed using a RemoveCalculated(String) method. Property IsCalculated tells if a field is calculated or is a field from the data source. Calculated PivotField is automatically moved to a Values Area (DataFields collection) and only Values Area can contain calculated PivotFields. Calculated PivotItem can be added using a AddCalculated(String, String) method and removed using a RemoveCalculated(String) method. Property IsCalculated tells if an item is calculated.

PivotFields can be re-ordered in a specific area using the Move(Int32, Int32) method. PivotItems can be re-ordered using the Move(Int32, Int32) method.

GemBox.Spreadsheet provides functionality to calculate PivotTables by using the Calculate() method which updates the cells in the ExcelWorksheet. The Calculate() method uses values stored in PivotCache. If the cache is currently empty, or the values are outdated (because the underlying data source has changed), the cache needs to be refreshed using the Refresh() method.

Gets the source of the PivotCache.

• C#
• VB.NET

public PivotCacheSource CacheSource { get; }

Public ReadOnly Property CacheSource As PivotCacheSource

PivotCacheSource

Pivot Tables are used to arrange and aggregate complicated data and drill down on details.

Source of data for Pivot Table can be:

• WorksheetSource - CellRange, NamedRange, table, etc.
• External - database, OLAP cube, textual file, web query, etc.
• Other - multiple consolidation ranges in the workbook, another Pivot Table, etc.

Source of the data for Pivot Table contains following information:

• Scheme - data source fields/columns, its data types, etc.
• Data - actual data source records.

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 CacheSource property. PivotCache instances are stored in a PivotCaches collection. PivotCache can be refreshed by using the Refresh() method.

PivotTable is created from a PivotCache with the specified name and the specified cell in the worksheet where it is placed using the Add(PivotCache, String, String) method. PivotTable contains the PivotFields collection which PivotField elements can be Add(Int32) into the following Pivot Table areas:

• Report Filter Area represented by PageFields collection.
• Row Axis represented by RowFields collection.
• Column Axis represented by ColumnFields collection.
• Values Area represented by DataFields collection.

Each (non-calculated) PivotField can contain zero or more PivotItems which are used for filtering and grouping by a specific value.

Except using fields defined in Pivot Table data source (more precisely, in PivotCache) which cannot be removed, Pivot Table can also define calculated PivotFields and calculated PivotItems which use a formula to specify their values. Calculated PivotField can be added using a AddCalculated(String, String) method and removed using a RemoveCalculated(String) method. Property IsCalculated tells if a field is calculated or is a field from the data source. Calculated PivotField is automatically moved to a Values Area (DataFields collection) and only Values Area can contain calculated PivotFields. Calculated PivotItem can be added using a AddCalculated(String, String) method and removed using a RemoveCalculated(String) method. Property IsCalculated tells if an item is calculated.

PivotFields can be re-ordered in a specific area using the Move(Int32, Int32) method. PivotItems can be re-ordered using the Move(Int32, Int32) method.

GemBox.Spreadsheet provides functionality to calculate PivotTables by using the Calculate() method which updates the cells in the ExcelWorksheet. The Calculate() method uses values stored in PivotCache. If the cache is currently empty, or the values are outdated (because the underlying data source has changed), the cache needs to be refreshed using the Refresh() method.

Gets or sets a value indicating whether the data should be refreshed when opening the file.

The default value is true.

• C#
• VB.NET

public bool RefreshOnLoad { get; set; }

Public Property RefreshOnLoad As Boolean

System.Boolean

Changes the worksheet source of the PivotCache.

• C#
• VB.NET

public void ChangeWorksheetSource(string reference)

Public Sub ChangeWorksheetSource(reference As String)

reference

System.String

System.ArgumentException

System.InvalidOperationException

Refreshes the pivot cache based on its CacheSource.

• C#
• VB.NET

public void Refresh()

Public Sub Refresh

Refreshing the pivot cache also automatically refreshes PivotItems in PivotTables that use this pivot cache.

System.InvalidOperationException