Class ExcelPivotArea

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

Inheritance

System.Object

XmlHelper

ExcelPivotArea

ExcelPivotAreaAutoSort

ExcelPivotTableAreaStyle

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: OfficeOpenXml.Table.PivotTable

Assembly: EPPlus.dll

Syntax

public class ExcelPivotArea : XmlHelper

Properties

Axis

The region of the PivotTable affected.

Declaration

public ePivotTableAxis Axis { get; set; }

Property Value

Type	Description
ePivotTableAxis

CacheIndex

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

Declaration

public bool CacheIndex { get; set; }

Property Value

Type	Description
System.Boolean

CollapsedLevelsAreSubtotals

If collapsed levels/dimensions are considered subtotals

Declaration

public bool CollapsedLevelsAreSubtotals { get; set; }

Property Value

Type	Description
System.Boolean

DataOnly

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

Declaration

public bool DataOnly { get; set; }

Property Value

Type	Description
System.Boolean

FieldIndex

The field referenced. -2 means refers to values.

Declaration

public int? FieldIndex { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

FieldPosition

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

Declaration

public int? FieldPosition { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

GrandColumn

If the column grand total is included

Declaration

public bool GrandColumn { get; set; }

Property Value

Type	Description
System.Boolean

GrandRow

If the row grand total is included

Declaration

public bool GrandRow { get; set; }

Property Value

Type	Description
System.Boolean

IsValuesField

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

Declaration

public bool IsValuesField { get; set; }

Property Value

Type	Description
System.Boolean

LabelOnly

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

Declaration

public bool LabelOnly { get; set; }

Property Value

Type	Description
System.Boolean

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.

Declaration

public string Offset { get; }

Property Value

Type	Description
System.String

Outline

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

Declaration

public bool Outline { get; set; }

Property Value

Type	Description
System.Boolean

PivotAreaType

The pivot area type that affecting the selection.

Declaration

public ePivotAreaType PivotAreaType { get; }

Property Value

Type	Description
ePivotAreaType