2.2.4.20 PivotFilterOptions

  • Article

The PivotFilterOptions type is a container for common information used in the following operations related to PivotTables:

  • ApplyPivotFilter (section 3.1.4.2)

  • ApplyPivotSort (section 3.1.4.3)

  • ApplyPivotTop10Filter (section 3.1.4.5)

  • ConnectAndGetPivotFilterItemList (section 3.1.4.8)

  • GetPivotFilterItemList (section 3.1.4.13)

  • GetPivotMenu (section 3.1.4.14)

  • RemovePivotFilter (section 3.1.4.26)

  • TogglePivotDrill (section 3.1.4.31)

Some of the elements of this type have a common usage with all these operations and are specified here. Other elements have specific usage information that is specified in the sections of this document addressing those operations.

 <s:complexType name="PivotFilterOptions">
   <s:sequence>
     <s:element name="SheetName" type="s:string" minOccurs="0"/>
     <s:element name="SourceIndex" type="s:int"/>
     <s:element name="IsNamedObject" type="s:boolean"/>
     <s:element name="FieldId" type="s:string" minOccurs="0"/>
     <s:element name="DataFieldId" type="s:string" minOccurs="0"/>
     <s:element name="MemberPropertyId" type="s:string" minOccurs="0"/>
     <s:element name="FilterValue1" type="s:string" minOccurs="0"/>
     <s:element name="FilterValue2" type="s:string" minOccurs="0"/>
     <s:element name="FilterType" type="tns:PivotFilterType"/>
     <s:element name="ParentId" type="s:int"/>
     <s:element name="Column" type="s:int"/>
     <s:element name="Row" type="s:int"/>
     <s:element name="Items" type="tns:ArrayOfInt" minOccurs="0"/>
   </s:sequence>
 </s:complexType>

SheetName: The name of the worksheet or named object on which the operation is performed. MUST be present. If the IsNamedObject element is set to true, the following apply:

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

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

If the IsNamedObject element is set to false, the following apply:

  • The SheetName element MUST refer to a worksheet on 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 PivotTable (section 2.2.4.24.24) element that is the PivotTable on which the operation is performed, except when used in the GetPivotMenu operation that specifies a different behavior.

IsNamedObject: Specifies whether the operation is performed on a named object. MUST be set to true if the operation is performed on a named object, and MUST be set to false otherwise.

FieldId: The identifier for the PivotTable field on which the operation is performed. MUST be present and MUST be equal to either the IdString element of one of the PivotField elements that have IsHierarchy set to false and that are nested inside the PivotFields element of the pivotMenu element that was retrieved from the protocol server in a previous call to GetPivotMenu on the same PivotTable area or to the PageFieldID attribute of the Cell element (section 2.2.4.24.38), except when used in the following operations, which specify a different behavior:

  • GetPivotMenu

  • TogglePivotDrill

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

  • ApplyPivotFilter

  • ApplyPivotTop10Filter

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

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

FilterValue2: The second PivotTable filter parameter. MUST NOT be present, except when used in the ApplyPivotFilter operation, which specifies a 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 a different behavior:

  •  ApplyPivotFilter

  • ApplyPivotTop10Filter

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

  • ConnectAndGetPivotFilterItemList

  • GetPivotFilterItemList

Column: The column (2) of the PivotTable area location. MUST be the zero-based column (2) number of a worksheet cell of the PivotTable that has the HasDropDown attribute of the Cell element (Section 2.2.4.24.38) set to true, except when used in the TogglePivotDrill operation, which specifies a different behavior.

Row: The row (2) of the PivotTable area location. MUST be the zero-based row (2) number of a worksheet cell of the PivotTable that has the HasDropDown attribute of the Cell element set to true, except when used in the TogglePivotDrill operation, 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 ApplyPivotFilter operation, which specifies a different behavior.