Share via

2.2.4.100 PivotFilterParameter

  • Article

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

The PivotFilterParameter type specifies a PivotTable custom filter applied to a PivotTable field.

 <xs:complexType name="PivotFilterParameter" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:sequence>
     <xs:element minOccurs="0" maxOccurs="1" name="FilterString2" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="FilterString1" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="MemberPropertyId" type="xs:string"/>
     <xs:element minOccurs="0" maxOccurs="1" name="DataFieldId" type="xs:string"/>
     <xs:element minOccurs="1" maxOccurs="1" name="FilterType" type="tns:PivotFilterType"/>
     <xs:element minOccurs="1" maxOccurs="1" name="FilterValue2" type="xs:double"/>
     <xs:element minOccurs="1" maxOccurs="1" name="FilterValue1" type="xs:double"/>
   </xs:sequence>
 </xs:complexType>

FilterString2: The second PivotTable filter parameter, if the filter type supports two PivotTable filter parameters and is used with a PivotTable custom label filter. MUST be present. MUST be empty and MUST be ignored on receipt by the protocol client when FilterType supports zero or one parameters, as specified in section 2.2.5.24. MUST be empty and MUST be ignored on receipt by the protocol client when FilterType is used for PivotTable custom value filter as specified in PivotFilterType (section 2.2.5.24). Otherwise, it MUST contain the value of the second PivotTable filter parameter.

FilterString1: The first PivotTable filter parameter, if the filter type supports one or two PivotTable filter parameters and is used with a PivotTable custom label filter. MUST be present. MUST be empty and MUST be ignored on receipt by the protocol client when FilterType supports zero parameters, as specified in PivotFilterType. MUST be empty and MUST be ignored on receipt by the protocol client when FilterType is used for PivotTable custom value filter as specified in PivotFilterType. Otherwise, it MUST contain the value of the first PivotTable filter parameter.

MemberPropertyId: The identifier of the member property used with a PivotTable custom label filter on a member property. MUST be present. MUST be empty when FilterType is used for PivotTable custom value filter as specified in PivotFilterType. MUST be empty when FilterType is used for PivotTable custom label filter, as specified in PivotFilterType, but not on a member property. When FilterType is used with PivotTable custom label filter, as specified in PivotFilterType on a member property, MemberPropertyId MUST be equal to the IdString element of one of the PivotField elements of one of the MemberProperties elements one of the PivotField elements of the PivotFields element of the PivotMenu (section 2.2.4.101).

DataFieldId: The identifier of the PivotTable data field used with a PivotTable custom value filter. MUST be present. MUST be empty when FilterType is not used with PivotTable custom value filter as specified in PivotFilterType. When FilterType is used for PivotTable custom value filter, as specified in PivotFilterType, DataFieldId MUST be equal to the IdString element of one of the PivotField elements of the PivotDataFields element of the PivotMenu.

FilterType:  The type of the filter applied as specified in PivotFilterType. MUST be used with PivotTable custom label filter or with PivotTable custom value filter as specified in PivotFilterType.

FilterValue2: The second PivotTable filter parameter, if the filter type supports two PivotTable filter parameters and is used for PivotTable custom value filter. MUST be ignored on receipt by the protocol client when FilterType supports zero or one parameters as specified in PivotFilterType. MUST be ignored on receipt by the protocol client when FilterType is used with PivotTable custom label filter as specified in PivotFilterType. Otherwise, it MUST contain the value of the second PivotTable filter parameter.

FilterValue1: The first PivotTable filter parameter, if the filter type supports one or two PivotTable filter parameters and is used for PivotTable custom value filter. MUST be ignored on receipt by the protocol client when FilterType supports zero parameters, as specified in PivotFilterType. MUST be ignored on receipt by the protocol client when FilterType is used with PivotTable custom label filter as specified in PivotFilterType. Otherwise, it MUST contain the value of the first PivotTable filter parameter.