Class ExcelPivotArea¶

Namespace: OfficeOpenXml.Table.PivotTable
Assembly: EPPlus.dll

Defines a pivot table area of selection used for different purposes.

public class ExcelPivotArea : XmlHelper

Inheritance¶

object ← XmlHelper ← ExcelPivotArea

Derived¶

ExcelPivotAreaAutoSort
ExcelPivotTableAreaConditionalFormatting
ExcelPivotTableAreaStyle

Inherited Members¶

object.Equals(object?, object?)
object.Equals(object?)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object?, object?)
object.ToString()

Properties¶

Axis¶

The region of the PivotTable affected.

public ePivotTableAxis Axis { get; set; }

Property Value¶

ePivotTableAxis

CacheIndex¶

If any indexes refers to fields or items in the pivot cache and not the view.

public bool CacheIndex { get; set; }

Property Value¶

bool

CollapsedLevelsAreSubtotals¶

If collapsed levels/dimensions are considered subtotals

public bool CollapsedLevelsAreSubtotals { get; set; }

Property Value¶

bool

Conditions¶

Conditions for the pivot table. Conditions can be set for specific row-, column- or data fields. Specify labels, data grand totals and more.

public ExcelPivotAreaStyleConditions Conditions { get; }

Property Value¶

ExcelPivotAreaStyleConditions

DataOnly¶

If the data values in the data area are included. Setting this property to true will set LabelOnly to false. LabelOnly

public bool DataOnly { get; set; }

Property Value¶

bool

FieldIndex¶

The field referenced. -2 means refers to values.

public int? FieldIndex { get; set; }

Property Value¶

int?

FieldPosition¶

Position of the field within the axis to which this rule applies.

public int? FieldPosition { get; set; }

Property Value¶

int?

GrandColumn¶

If the column grand total is included

public bool GrandColumn { get; set; }

Property Value¶

bool

GrandRow¶

If the row grand total is included

public bool GrandRow { get; set; }

Property Value¶

bool

IsValuesField¶

If the pivot area referes to the "Σ Values" field in the column or row fields.

public bool IsValuesField { get; set; }

Property Value¶

bool

LabelOnly¶

If the item labels are included. Setting this property to true will set DataOnly to false. DataOnly

public bool LabelOnly { get; set; }

Property Value¶

bool

Offset¶

A address in A1C1 format that specifies a subset of the selection area. Points are relative to the top left of the selection area. The first cell is referenced as A1. For example, B1:C1 reference the second and third column of the first row of the pivot area.

public string Offset { get; }

Property Value¶

string

Outline¶

Indicating whether the pivot table area refers to an area that is in outline mode.

public bool Outline { get; set; }

Property Value¶

bool

PivotAreaType¶

The pivot area type that affecting the selection.

public ePivotAreaType PivotAreaType { get; }

Property Value¶

ePivotAreaType