PivotArea Class
Calculated Item Location.When the object is serialized out as xml, its qualified name is x:pivotArea.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Spreadsheet.PivotArea
Namespace: DocumentFormat.OpenXml.Spreadsheet
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(ExtensionList))> _
<ChildElementInfoAttribute(GetType(PivotAreaReferences))> _
Public Class PivotArea _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As PivotArea
[ChildElementInfoAttribute(typeof(ExtensionList))]
[ChildElementInfoAttribute(typeof(PivotAreaReferences))]
public class PivotArea : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
PivotAreaReferences <x:references>
ExtensionList <x:extLst>
[ISO/IEC 29500-1 1st Edition]
18.3.1.68 pivotArea (Pivot Area)
Rule describing a PivotTable selection.
Parent Elements |
|---|
autoSortScope (§18.10.1.1); calculatedItem (§18.10.1.8); chartFormat (§18.10.1.12); format (§18.10.1.35); pivotAreas (§18.10.1.66); pivotSelection (§18.3.1.69) |
Child Elements |
Subclause |
|---|---|
extLst (Future Feature Data Storage Area) |
§18.2.10 |
references (References) |
§18.10.2.2 |
Attributes |
Description |
|---|---|
axis (Axis) |
The region of the PivotTable to which this rule applies. The possible values for this attribute are defined by the ST_Axis simple type (§18.18.1). |
cacheIndex (Cache Index) |
Flag indicating whether any indexes refer to fields or items in the Pivot cache and not the view. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
collapsedLevelsAreSubtotals (Collapsed Levels Are Subtotals) |
Flag indicating if collapsed levels/dimensions are considered subtotals. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
dataOnly (Data Only) |
Flag indicating whether only the data values (in the data area of the view) for an item selection are selected and does not include the item labels. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
field (Field Index) |
Index of the field that this selection rule refers to. The possible values for this attribute are defined by the W3C XML Schema int datatype. |
fieldPosition (Field Position) |
Position of the field within the axis to which this rule applies. The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype. |
grandCol (Include Column Grand Total) |
Flag indicating whether the column grand total is included. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
grandRow (Include Row Grand Total) |
Flag indicating whether the row grand total is included. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
labelOnly (Labels Only) |
Flag indicating whether only the item labels for an item selection are selected and does not include the data values (in the data area of the view). The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
offset (Offset Reference) |
A Reference that specifies a subset of the selection area. Points are relative to the top left of the selection area. The possible values for this attribute are defined by the ST_Ref simple type (§18.18.62). |
outline (Outline) |
Flag indicating whether the rule refers to an area that is in outline mode. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
type (Rule Type) |
Indicates the type of selection rule. The possible values for this attribute are defined by the ST_PivotAreaType simple type (§18.18.58). |
[Note: The W3C XML Schema definition of this element’s content model (CT_PivotArea) is located in §A.2. end note]
© ISO/IEC29500: 2008.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.