Share via

2.2.4.28 PivotOperationOptions

  • Article

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

The PivotOperationOptions complex type is a container for common information that is used by the following operations related to PivotTables:

  • ApplyPivot (section 3.1.4.47)

  • ApplyPivotFilter (section 3.1.4.2)

  • ApplyPivotSort (section 3.1.4.3)

  • ApplyPivotTop10Filter (section 3.1.4.4)

  • ApplyPivotValueFieldSettings (section 3.1.4.61)

  • BixDrill (section 3.1.4.58)

  • ConnectAndGetPivotFilterItemList (section 3.1.4.9)

  • ConnectAndGetPivotMenu (section 3.1.4.78)

  • ExpandPivotFieldListLevels (section 3.1.4.49)

  • GetBixAnalysis (section 3.1.4.51)

  • GetPivotFieldListData (section 3.1.4.52)

  • GetPivotFieldManagerData (section 3.1.4.53)

  • GetPivotFilterItemList (section 3.1.4.18)

  • GetPivotMenu (section 3.1.4.19)

  • GetPivotValueFieldSettings (section 3.1.4.63)

  • RemovePivotFilter (section 3.1.4.37)

  • TogglePivotDrill (section 3.1.4.46)

Some of the elements of this type have a common usage among all of the preceding operations and are specified in this section. Other elements have particular usage information that is specified in the sections of this document addressing the particular operations.

 <xs:complexType name="PivotOperationOptions" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="1" maxOccurs="1" name="AnchorType" type="tns:SharedPivotMenuAnchorType"/>
     <xs:element minOccurs="0" maxOccurs="1" name="SheetName" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="SourceIndex" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="NamedObject" type="xs:boolean"/>
     <xs:element minOccurs="0" maxOccurs="1" name="FieldId" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="DataFieldId" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="MemberPropertyId" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="FilterValue1" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="FilterValue2" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="FilterType" type="tns:PivotFilterType"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ParentId" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Column" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="Row" type="xs:int"/>
     <xs:element minOccurs="0" maxOccurs="1" name="Items" type="tns:ArrayOfInt"/>
     <xs:element minOccurs="1" maxOccurs="1" name="SortByValue" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="DataFieldIndex" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="HierarchyIndex" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="LevelIndex" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="NavDrillDown" type="xs:boolean"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ChartIndex" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ChartElementValue1" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="ChartElementValue2" type="xs:int"/>
     <xs:element minOccurs="1" maxOccurs="1" name="WholeDays" type="xs:boolean"/>
   </xs:sequence>
 </xs:complexType>

AnchorType: The type of item on which the anchor operation is occurring. The default value is 0. The following table lists all the possible values.

Value

Type of item

0

A PivotTable.

–1

Neither a PivotTable nor a PivotChart.

1

A PivotChart series.

2

A PivotChart category.

3

A PivotChart data point.

4

A PivotChart filter button.

5

A PivotChart series button.

6

A category button.

7

A general PivotChart area.

8

A PivotChart hierarchy.

9

A PivotTable hierarchy.

10

A field list that was brought up by a PivotChart but is not on the PivotChart.

11

A field list that was brought up by a PivotTable but is not on the PivotTable.

SheetName: The name of either the worksheet or the named object on which the operation is being performed. MUST be present and MUST NOT be empty. If the NamedObject element is set to true, the following constraints apply:

  • The SheetName element MUST refer to a named object in the workbook.

  • The length of SheetName MUST NOT be longer than 287 characters.

If the NamedObject element is set to false, the following constraints apply:

  • The SheetName element MUST refer to a worksheet in the workbook.

  • The length of SheetName MUST NOT be longer than 31 characters.

SourceIndex: The index of the connected data. MUST be the value of the ExternalSourceIndex attribute of the CT_PivotTable element, as specified in [MS-EXSPXML3] section 2.3.27, that is the PivotTable on which the operation is being performed (except when used in the GetPivotMenu operation, which specifies a different behavior).

NamedObject: A value that specifies whether the operation is being performed on a named object. MUST be set to true if the operation is being performed on a named object. Otherwise, MUST be set to false.

FieldId: The identifier of the PivotTable field on which the operation is being performed. MUST be present and MUST be equal to one of the following values (except when used in the GetPivotMenu or TogglePivotDrill operation, which specify different behavior):

  • The value of the IdString element of one of the PivotField (section 2.2.4.99) elements that have IsHierarchy set to false and that are nested inside the PivotFields element of the pivotMenu (section 2.2.4.101) element that was retrieved from the protocol server in a previous call to GetPivotMenu (section 3.1.4.19) on the same PivotTable area.

  • The value of the PageFieldID attribute of the CT_Cell element, as specified in [MS-EXSPXML3] section 2.3.40.

DataFieldId: The identifier of the PivotTable data field. MUST NOT be present, except when used in the following operations, which specify different behavior:

  • ApplyPivotFilter

  • ApplyPivotTop10Filter

MemberPropertyId: The identifier of the member property. MUST NOT be present, except when used in the ApplyPivotFilter operation, which specifies different behavior.

FilterValue1: The first PivotTable filter parameter. MUST NOT be present, except when used in ApplyPivotFilter, which specifies different behavior.

FilterValue2: The second PivotTable filter parameter. MUST NOT be present, except when used in ApplyPivotFilter, which specifies different behavior.

FilterType: The type of filter used in the operation. MUST have the value of "Invalid", except when used in the following operations, which specify different behavior:

  • ApplyPivotFilter

  • ApplyPivotTop10Filter

ParentId: The identifier of the PivotTable member on which the operation is being performed. MUST be ignored on receipt by the protocol server, except when used in the following operations, which specify different behavior:

  • ConnectAndGetPivotFilterItemList

  • GetPivotFilterItemList

Column: The column (2) of the PivotTable area location if AnchorType indicates that this operation is being performed on a PivotTable. MUST be the zero-based column (2) number of a worksheet cell of the PivotTable that has the HasDropDown attribute of the CT_Cell element (as specified in [MS-EXSPXML3] section 2.3.40) set to true, except when used in the TogglePivotDrill operation, which specifies different behavior.

Row: The row (2) of the PivotTable area location if AnchorType indicates that this operation is being performed on a PivotTable. MUST be the zero-based row (2) number of a worksheet cell of the PivotTable that has the HasDropDown attribute of the CT_Cell element (as specified in [MS-EXSPXML3] section 2.3.40) set to true, except when used in TogglePivotDrill, which specifies a different behavior.

Items: The list of PivotTable members applied in a PivotTable manual filter. MUST NOT be present, except when used in the ApplyPivotSort operation, which specifies different behavior.

SortByValue: A value that specifies whether the operation is a sort-by-value operation. MUST be false except when used in ApplyPivotSort, which specifies different behavior. 

DataFieldIndex: The index of a PivotTable data field. MUST be ignored on receipt except when used in ApplyPivotSort, which specifies different behavior.

HierarchyIndex: The index of the hierarchy of the PivotTable if AnchorType indicates that this operation is being performed on a PivotTable. This index is zero-based. MUST be ignored on receipt by the protocol server, except when used in the BixDrill operation, which specifies different behavior.

LevelIndex: The index of the level of a hierarchy of the PivotTable if AnchorType indicates that this operation is being performed on a PivotTable. This index is zero-based. MUST be ignored on receipt by the protocol server, except when used in BixDrill, which specifies different behavior.

NavDrillDown: A value that specifies whether the operation is a navigation drill-down mode for a double-click drill-down operation.

ChartIndex: The index of the chart of the worksheet if AnchorType indicates that this operation is being performed on a PivotChart.

ChartElementValue1: The index of the category or series. If the operation is being performed on a data point of a PivotChart, this attribute specifies the category index.

ChartElementValue2: The index of the series if the operation is being performed on a data point of a PivotChart.

WholeDays: A value that specifies whether using whole days is enabled. If the value is true, date comparisons are based only on the date stamp, and the time stamp is ignored. If the value is false, date comparisons are based on both the date stamp and the time stamp. This element specifies PivotTable advanced filter criteria, and the value MUST be false if the FilterType element does not indicate a filter operation on a PivotTable date field.