PivotHierarchy Class
OLAP Hierarchy.When the object is serialized out as xml, its qualified name is x:pivotHierarchy.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlCompositeElement
DocumentFormat.OpenXml.Spreadsheet.PivotHierarchy
Namespace: DocumentFormat.OpenXml.Spreadsheet
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
<ChildElementInfoAttribute(GetType(MemberProperties))> _
<ChildElementInfoAttribute(GetType(Members))> _
<ChildElementInfoAttribute(GetType(PivotHierarchyExtensionList))> _
Public Class PivotHierarchy _
Inherits OpenXmlCompositeElement
'Usage
Dim instance As PivotHierarchy
[ChildElementInfoAttribute(typeof(MemberProperties))]
[ChildElementInfoAttribute(typeof(Members))]
[ChildElementInfoAttribute(typeof(PivotHierarchyExtensionList))]
public class PivotHierarchy : OpenXmlCompositeElement
Remarks
The following table lists the possible child types:
MemberProperties <x:mps>
Members <x:members>
PivotHierarchyExtensionList <x:extLst>
[ISO/IEC 29500-1 1st Edition]
18.10.1.72 pivotHierarchy (OLAP Hierarchy)
Represents a OLAP hierarchy associated with the PivotTable. A hierarchy is a hierarchical representation of related OLAP dimensions. Hierarchies are defined on the OLAP server and cannot be changed in the PivotTable. [Example: Hierarchy "A" might be defined as follows:
Level 1Country/Region
Level 2State\Provence
Level 3City
end example]
[Example:
<sh:pivotHierarchy dragToRow="0" dragToCol="0" dragToPage="0" dragToData="1"/>
end example]
Parent Elements |
|---|
pivotHierarchies (§18.10.1.71) |
Child Elements |
Subclause |
|---|---|
extLst (Future Feature Data Storage Area) |
§18.2.10 |
members (Members) |
§18.10.1.56 |
mps (OLAP Member Properties) |
§18.10.1.59 |
Attributes |
Description |
|---|---|
caption (Hierarchy Caption) |
Specifies the user defined caption of the hierarchy. The possible values for this attribute are defined by the ST_Xstring simple type (§22.9.2.19). |
dragOff (Drag Off) |
Specifies a boolean value that indicates whether the user is allowed to remove this hierarchy from the PivotTable. A value of 1 or true indicates the user can remove this hierarchy from the PivotTable. A value of 0 or false indicates the user cannot remove the hierarchy from the PivotTable. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
dragToCol (Drag To Column) |
Specifies a boolean value that indicates whether the user is allowed to put this hierarchy into the column area of the PivotTable. A value of 1 or true indicates the user can put this hierarchy into the column area of the PivotTable. A value of 0 or false indicates the user cannot remove this hierarchy. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
dragToData (Drag To Data) |
Specifies a boolean value that indicates whether the user is allowed to put this hierarchy into the data area of the view. A value of 1 or true indicates A value of 0 or false indicates The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
dragToPage (Drag to Page) |
Specifies a boolean value that indicates whether the user is allowed to put this hierarchy into the page area of the PivotTable. A value of 1 or true indicates the user can put this hierarchy into the page area of the PivotTable. A value of 0 or false indicates cannot put this hierarchy into the page area. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
dragToRow (Drag To Row) |
Specifies a boolean value that indicates whether the user is allowed to put this hierarchy into the row area of the PivotTable. A value of 1 or true indicates the user can put this hierarchy into the row area of the PivotTable. A value of 0 or false indicates cannot put this hierarchy into the row area. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
includeNewItemsInFilter (Inclusive Manual Filter) |
Specifies a boolean value that indicates whether the application will show only the items the user has selected. A value of 1 or true indicates the application will show only items the user has selected; all other items are hidden. A value of 0 or false indicates the application will show all items. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
multipleItemSelectionAllowed (Multiple Field Filters) |
Specifies a boolean value that indicates whether the user can select multiple members when the hierarchy is in the page field area of the view. A value of 1 or true indicates the user can select multiple members. A value of 0 or false indicates the user cannot select multiple members. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
outline (Outline New Levels) |
Specifies a boolean value that indicates whether new levels added to the PivotTable are shown in Outline mode. A value of 1 or true indicates new levels are shown in Outline mode. A value of 0 or false indicates new items are not shown in Outline mode. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
showInFieldList (Show In Field List) |
Specifies a boolean value that indicates whether this hierarchy is omitted from the field list. This attribute depends on how the application exposes a list of fields for PivotTables in the user interface. A value of 1 or true indicates this hierarchy is show in the field list or similar mechanism in the user interface. A value of 0 or false indicates is not shown in the field list. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
subtotalTop (New Levels Subtotals At Top) |
Specifies a boolean value that indicates whether new levels added to the view will show their subtotals at the top. A value of 1 or true indicates new levels added to the view show their subtotals at the top. A value of 0 or false indicates new levels added to the view show their subtotals at the bottom. The possible values for this attribute are defined by the W3C XML Schema boolean datatype. |
[Note: The W3C XML Schema definition of this element’s content model (CT_PivotHierarchy) 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.