PivotItem Class

Namespace:
GemBox.Spreadsheet.PivotTables
Assembly:
GemBox.Spreadsheet.dll

Represents an item in a PivotField.

public sealed class PivotItem
Public NotInheritable Class PivotItem
Inheritance:
System.Object
PivotItem
Remarks

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.
note

GemBox.Spreadsheet currently supports creating only WorksheetSource.

All other sources are supported through preservation (to correctly round-trip to XLSX format).

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:

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.

note

If calculated PivotField is added/removed in one PivotTable, then it is also added/removed from all other PivotTables which reference the same PivotCache.

Since adding/removing calculated PivotFields means changing the data scheme, which is defined in PivotCache, actual modification is made in PivotCache and propagated to all PivotTables which are referencing it.

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.

Properties

Collapsed

Gets or sets whether the PivotItem is collapsed.

public bool Collapsed { get; set; }
Public Property Collapsed As Boolean
Property Value
System.Boolean

true if this PivotItem is collapsed; otherwise, false.

Remarks

To collapse/expand entire PivotField use Collapse(Boolean) method.

Formula

Gets the PivotItem's formula in A1-style notation.

public string Formula { get; }
Public ReadOnly Property Formula As String
Property Value
System.String

The PivotItem's formula in A1-style notation.

Hidden

Gets or sets a value indicating whether the PivotItem is hidden.

public bool Hidden { get; set; }
Public Property Hidden As Boolean
Property Value
System.Boolean

true if the PivotItem is hidden; otherwise, false.

IsCalculated

Gets a value indicating whether the PivotItem is a calculated item.

public bool IsCalculated { get; }
Public ReadOnly Property IsCalculated As Boolean
Property Value
System.Boolean

true if this PivotItem is a calculated item; otherwise, false.

Name

Gets the name of the PivotItem.

public string Name { get; }
Public ReadOnly Property Name As String
Property Value
System.String

The name of the PivotItem.

PivotField

Gets the parent PivotField.

public PivotField PivotField { get; }
Public ReadOnly Property PivotField As PivotField
Property Value
PivotField

The parent PivotField.

Value

Gets the value of the PivotItem.

public object Value { get; }
Public ReadOnly Property Value As Object
Property Value
System.Object

The value of the PivotItem.

Examples