Share via

2.2.5.24 PivotFilterType

  • Article

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

The PivotFilterType is an enumeration of types of PivotTable filters that can be applied on a PivotTable field. The following types of PivotTable filters are supported:

  • Top N filter or bottom N filter

  • PivotTable custom label filter

  • PivotTable custom value filter

     <xs:simpleType name="PivotFilterType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:restriction base="xs:string">
     <xs:enumeration value="Invalid"/>
     <xs:enumeration value="FirstTop10"/>
     <xs:enumeration value="Count"/>
     <xs:enumeration value="Percent"/>
     <xs:enumeration value="Sum"/>
     <xs:enumeration value="LastTop10"/>
     <xs:enumeration value="CaptionFirst"/>
     <xs:enumeration value="CaptionEquals"/>
     <xs:enumeration value="CaptionDoesNotEqual"/>
     <xs:enumeration value="CaptionBeginsWith"/>
     <xs:enumeration value="CaptionDoesNotBeginWith"/>
     <xs:enumeration value="CaptionEndsWith"/>
     <xs:enumeration value="CaptionDoesNotEndWith"/>
     <xs:enumeration value="CaptionContains"/>
     <xs:enumeration value="CaptionDoesNotContain"/>
     <xs:enumeration value="CaptionIsGreaterThan"/>
     <xs:enumeration value="CaptionIsGreaterThanOrEqualTo"/>
     <xs:enumeration value="CaptionIsLessThan"/>
     <xs:enumeration value="CaptionIsLessThanOrEqualTo"/>
     <xs:enumeration value="CaptionIsBetween"/>
     <xs:enumeration value="CaptionIsNotBetween"/>
     <xs:enumeration value="ValueFirst"/>
     <xs:enumeration value="ValueEqual"/>
     <xs:enumeration value="ValueNotEqual"/>
     <xs:enumeration value="ValueGreaterThan"/>
     <xs:enumeration value="ValueGreaterThanOrEqual"/>
     <xs:enumeration value="ValueLessThan"/>
     <xs:enumeration value="ValueLessThanOrEqual"/>
     <xs:enumeration value="ValueBetween"/>
     <xs:enumeration value="ValueNotBetween"/>
     <xs:enumeration value="DateFirst"/>
     <xs:enumeration value="DateEquals"/>
     <xs:enumeration value="DateOlderThan"/>
     <xs:enumeration value="DateNewerThan"/>
     <xs:enumeration value="DateBetween"/>
     <xs:enumeration value="DateTomorrow"/>
     <xs:enumeration value="DateToday"/>
     <xs:enumeration value="DateYesterday"/>
     <xs:enumeration value="DateNextWeek"/>
     <xs:enumeration value="DateThisWeek"/>
     <xs:enumeration value="DateLastWeek"/>
     <xs:enumeration value="DateNextMonth"/>
     <xs:enumeration value="DateThisMonth"/>
     <xs:enumeration value="DateLastMonth"/>
     <xs:enumeration value="DateNextQuarter"/>
     <xs:enumeration value="DateThisQuarter"/>
     <xs:enumeration value="DateLastQuarter"/>
     <xs:enumeration value="DateNextYear"/>
     <xs:enumeration value="DateThisYear"/>
     <xs:enumeration value="DateLastYear"/>
     <xs:enumeration value="DateYearToDate"/>
     <xs:enumeration value="DateAllDatesInPeriodQuarter1"/>
     <xs:enumeration value="DateAllDatesInPeriodQuarter2"/>
     <xs:enumeration value="DateAllDatesInPeriodQuarter3"/>
     <xs:enumeration value="DateAllDatesInPeriodQuarter4"/>
     <xs:enumeration value="DateAllDatesInPeriodJanuary"/>
     <xs:enumeration value="DateAllDatesInPeriodFebruary"/>
     <xs:enumeration value="DateAllDatesInPeriodMarch"/>
     <xs:enumeration value="DateAllDatesInPeriodApril"/>
     <xs:enumeration value="DateAllDatesInPeriodMay"/>
     <xs:enumeration value="DateAllDatesInPeriodJune"/>
     <xs:enumeration value="DateAllDatesInPeriodJuly"/>
     <xs:enumeration value="DateAllDatesInPeriodAugust"/>
     <xs:enumeration value="DateAllDatesInPeriodSeptember"/>
     <xs:enumeration value="DateAllDatesInPeriodOctober"/>
     <xs:enumeration value="DateAllDatesInPeriodNovember"/>
     <xs:enumeration value="DateAllDatesInPeriodDecember"/>
     <xs:enumeration value="DateNotEqual"/>
     <xs:enumeration value="DateOlderOrEqual"/>
     <xs:enumeration value="DateNewerOrEqual"/>
     <xs:enumeration value="DateNotBetween"/>
     <xs:enumeration value="Last"/>
   </xs:restriction>
 </xs:simpleType>

The following table specifies the allowable values for the PivotFilterType simple type.

Value

Meaning

Invalid

Neither a PivotTable custom filter nor a top N filter nor a bottom N filter are applied.

FirstTop10

A top N filter by count or a bottom N filter by count is applied. Used with top N filter or bottom N filter.

Count

A top N filter by count or a bottom N filter by count is applied. Used with top N filter or bottom N filter.

Percent

A top N filter by percent or a bottom N filter by percent is applied. Used with top N filter or bottom N filter.

Sum

A top N filter by sum or a bottom N filter by sum is applied. Used with top N filter or bottom N filter.

LastTop10

A top N filter by sum or a bottom N filter by sum is applied. Used with top N filter or bottom N filter.

CaptionFirst

The PivotTable member caption is equal to the value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionEquals

The PivotTable member caption is equal to the value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionDoesNotEqual

The PivotTable member caption is not equal to the value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionBeginsWith

The PivotTable member caption begins with the value in the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionDoesNotBeginWith

The PivotTable member caption does not begin with the value in the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionEndsWith

The PivotTable member caption ends with the value in the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionDoesNotEndWith

The PivotTable member caption does not end with the value in the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionContains

The PivotTable member caption contains the value in the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionDoesNotContain

The PivotTable member caption does not contain the value in the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionIsGreaterThan

The PivotTable member caption is greater than the value in the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionIsGreaterThanOrEqualTo

The PivotTable member caption is greater than or equal to the value in the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionIsLessThan

The PivotTable member caption is less than the value in the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionIsLessThanOrEqualTo

The PivotTable member caption is less than or equal to the value in the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

CaptionIsBetween

The PivotTable member caption is greater than or equal to the value of the first PivotTable filter parameter and less than or equal to the value of the second PivotTable filter parameter. Supports two PivotTable filter parameters. Used with PivotTable custom label filter.

CaptionIsNotBetween

The PivotTable member caption is less than the value of the first PivotTable filter parameter or greater than the value of the second PivotTable filter parameter. Supports two PivotTable filter parameters. Used with PivotTable custom label filter.

ValueFirst

The value of the PivotTable member is equal to the value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom value filter.

ValueEqual

The value of the PivotTable member is equal to the value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom value filter.

ValueNotEqual

The value of the PivotTable member is not equal to the value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom value filter.

ValueGreaterThan

The value of the PivotTable member is greater than the value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom value filter.

ValueGreaterThanOrEqual

The value of the PivotTable member is greater than or equal to the value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom value filter.

ValueLessThan

The value of the PivotTable member is less than the value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom value filter.

ValueLessThanOrEqual

The value of the PivotTable member is less than or equal to the value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom value filter.

ValueBetween

The value of the PivotTable member is greater than or equal to the value of the first PivotTable filter parameter and less than or equal to the value of the second PivotTable filter parameter. Supports two PivotTable filter parameters. Used with PivotTable custom value filter.

ValueNotBetween

The value of the PivotTable member is less than the value of the first PivotTable filter parameter or greater than the value of the second PivotTable filter parameter. Supports two PivotTable filter parameters. Used with PivotTable custom value filter.

DateFirst

The PivotTable member caption is equal to the date value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

DateEquals

The PivotTable member caption is equal to the date value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

DateOlderThan

The PivotTable member caption is less than the date value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

DateNewerThan

The PivotTable member caption is greater than the date value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

DateBetween

The PivotTable member caption is greater than or equal to the value of the first PivotTable filter parameter and less than or equal to the value of the second PivotTable filter parameter. Supports two PivotTable filter parameters. Used with PivotTable custom label filter.

DateTomorrow

The PivotTable member caption is tomorrow's date. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateToday

The PivotTable member caption is today's date. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateYesterday

The PivotTable member caption is yesterday's date. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateNextWeek

The PivotTable member caption is a date next week. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateThisWeek

The PivotTable member caption is a date this week. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateLastWeek

The PivotTable member caption is a date last week. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateNextMonth

The PivotTable member caption is a date next month. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateThisMonth

The PivotTable member caption is a date this month. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateLastMonth

The PivotTable member caption is a date last month. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateNextQuarter

The PivotTable member caption is a date next quarter. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateThisQuarter

The PivotTable member caption is a date this quarter. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateLastQuarter

The PivotTable member caption is a date last quarter. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateNextYear

The PivotTable member caption is a date next year. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateThisYear

The PivotTable member caption is a date this year. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateLastYear

The PivotTable member caption is a date last year. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateYearToDate

The PivotTable member caption is a date year to date. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodQuarter1

The PivotTable member caption is a date in the first quarter. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodQuarter2

The PivotTable member caption is a date in the second quarter. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodQuarter3

The PivotTable member caption is a date in the third quarter. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodQuarter4

The PivotTable member caption is a date in the fourth quarter. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodJanuary

The PivotTable member caption is a date in January. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodFebruary

The PivotTable member caption is a date in February. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodMarch

The PivotTable member caption is a date in March. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodApril

The PivotTable member caption is a date in April. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodMay

The PivotTable member caption is a date in May. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodJune

The PivotTable member caption is a date in June. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodJuly

The PivotTable member caption is a date in July. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodAugust

The PivotTable member caption is a date in August. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodSeptember

The PivotTable member caption is a date in September. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodOctober

The PivotTable member caption is a date in October. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodNovember

The PivotTable member caption is a date in November. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateAllDatesInPeriodDecember

The PivotTable member caption is a date in December. Supports zero PivotTable filter parameters. Used with PivotTable custom label filter.

DateNotEqual

The PivotTable member caption is not equal to the date value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

DateOlderOrEqual

The PivotTable member caption is less than or equal to the date value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

DateNewerOrEqual

The PivotTable member caption is greater than or equal to the date value of the PivotTable filter parameter. Supports one PivotTable filter parameter. Used with PivotTable custom label filter.

DateNotBetween

The PivotTable member caption is a date less than the first parameter or greater than the second parameter PivotTable filter parameters. Supports two PivotTable filter parameters. Used with PivotTable custom label filter.

Last

MUST NOT be used.