Share via

2.2.4.101 PivotMenu

  • Article

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

The PivotMenu type contains information about a PivotTable area that is returned by the protocol server.

 <xs:complexType name="PivotMenu" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="1" maxOccurs="1" name="Top10MaxItems" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="AdvancedFiltering" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="IsPageFilter" type="xs:boolean"/>
     <xs:element minOccurs="0" maxOccurs="1" name="PivotDataItems" type="tns:ArrayOfPivotField"/>
     <xs:element minOccurs="0" maxOccurs="1" name="PivotDataFields" type="tns:ArrayOfPivotField"/>
     <xs:element minOccurs="0" maxOccurs="1" name="PivotFields" type="tns:ArrayOfPivotField"/>
   </xs:sequence>
 </xs:complexType>

Top10MaxItems:  The maximum value to be used when applying a top N filter or a bottom N filter as specified in section 3.1.4.6.

AdvancedFiltering: Specifies whether the protocol server implementation supports PivotTable custom filters for the current PivotTable. MUST be set to true if the protocol server implementation supports PivotTable custom filters for the PivotTable that contains the current PivotTable area, and MUST be set to false otherwise.

IsPageFilter: Specifies whether the PivotTable area is a PivotTable page field filter. MUST be true if the PivotTable area is a PivotTable page field filter. MUST be false if the PivotTable area is not a PivotTable page field filter.

PivotDataItems: The list of PivotTable data fields of the PivotTable, as specified in ArrayOfPivotField (section 2.2.4.94). MUST be present. MUST contain the list of all the PivotTable data fields of the PivotTable that contains the PivotTable area, in the same order as they appear in the PivotTable.

PivotDataFields: If the data source for the PivotTable is OLAP then MUST contain all OLAP measures. Otherwise, MUST contain the list of all the PivotTable data fields of the PivotTable that contains the PivotTable area, as specified in ArrayOfPivotField, in the same order as they appear in the PivotTable. MUST be present.

PivotFields:  The list of PivotTable fields of the PivotTable area, as specified in ArrayOfPivotField. MUST be present. MUST contain the list of all the PivotTable fields in the PivotTable area as follows:

  • The first PivotField element in the ArrayOfPivotField MUST be the first hierarchy PivotTable field.

  • The PivotField elements following a PivotField element in the ArrayOfPivotField that is a hierarchy PivotTable field MUST be all the PivotTable fields that belong to that hierarchy PivotTable field, ordered from the highest level PivotTable field to the lowest level PivotTable field.

  • The PivotField element following a PivotField element in the ArrayOfPivotField that is the lowest level PivotTable field that belongs to a hierarchy PivotTable field that is not the last hierarchy PivotTable field of the PivotTable area MUST be the next hierarchy PivotTable fields of the PivotTable area.