<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. For example, hierarchy "A" might be defined as follows:

Level 1Country/Region

Level 2State\Provence

Level 3City

example: 
<sh:pivotHierarchy dragToRow="0" dragToCol="0" dragToPage="0" dragToData="1"/>

Parent Elements

<pivotHierarchies> (§3.10.1.71)

Child Elements

Subclause

<extLst> (Future Feature Data Storage Area)

§3.2.10

<members> (Members)

§3.10.1.56

<mps> (OLAP Member Properties)

§3.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 (§3.18.96).

<dragOff> (Drag Off)

Specifies a boolean value that indicates whether the user is allowed to remove this hierarchy from the PivotTable.

A value of on, 1, or true indicates the user can remove this hierarchy from the PivotTable.

A value of off, 0, or false indicates the user cannot remove the hierarchy from the PivotTable.

The possible values for this attribute are defined by the 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 on, 1, or true indicates the user can put this hierarchy into the column area of the PivotTable.

A value of off, 0, or false indicates the user cannot remove this hierarchy.

The possible values for this attribute are defined by the 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 on, 1, or true indicates

A value of off, 0, or false indicates

The possible values for this attribute are defined by the 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 on, 1, or true indicates the user can put this hierarchy into the page area of the PivotTable.

A value of off, 0, or false indicates cannot put this hierarchy into the page area.

The possible values for this attribute are defined by the 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 on, 1, or true indicates the user can put this hierarchy into the row area of the PivotTable.

A value of off, 0, or false indicates cannot put this hierarchy into the row area.

The possible values for this attribute are defined by the 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 on, 1, or true indicates the application will show only items the user has selected; all other items will be hidden.

A value of off, 0, or false indicates the application will show all items.

The possible values for this attribute are defined by the 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 on, 1, or true indicates the user can select multiple members.

A value of off, 0, or false indicates the user cannot select multiple members.

The possible values for this attribute are defined by the 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 on, 1, or true indicates new levels are shown in Outline mode.

A value of off, 0, or false indicates new items are not shown in Outline mode.

The possible values for this attribute are defined by the 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 on, 1, or true indicates this hierarchy is show in the field list or similar mechanism in the user interface.

A value of off, 0, or false indicates is not shown in the field list.

The possible values for this attribute are defined by the 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 on, 1, or true indicates new levels added to the view show their subtotals at the top.

A value of off, 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 XML Schema boolean datatype.

The following XML Schema fragment defines the contents of this element:

<complexType name="CT_PivotHierarchy">
	<sequence>
	<element name="mps" minOccurs="0" type="CT_MemberProperties"/>
	<element name="members" minOccurs="0" maxOccurs="unbounded" type="CT_Members"/>
	<element name="extLst" minOccurs="0" type="CT_ExtensionList"/>
	</sequence>
	<attribute name="outline" type="xsd:boolean" default="false"/>
	<attribute name="multipleItemSelectionAllowed" type="xsd:boolean" default="false"/>
	<attribute name="subtotalTop" type="xsd:boolean" default="false"/>
	<attribute name="showInFieldList" type="xsd:boolean" default="true"/>
	<attribute name="dragToRow" type="xsd:boolean" default="true"/>
	<attribute name="dragToCol" type="xsd:boolean" default="true"/>
	<attribute name="dragToPage" type="xsd:boolean" default="true"/>
	<attribute name="dragToData" type="xsd:boolean" default="false"/>
	<attribute name="dragOff" type="xsd:boolean" default="true"/>
	<attribute name="includeNewItemsInFilter" type="xsd:boolean" default="false"/>
	<attribute name="caption" type="ST_Xstring" use="optional"/>
</complexType>