Edit

Share via

Excel.PivotDateFilter interface

Package:
excel

Configurable template for a date filter to apply to a PivotField. The condition defines what criteria need to be set in order for the filter to operate.

Remarks

[ API set: ExcelApi 1.12 ]

Properties

comparator

The comparator is the static value to which other values are compared. The type of comparison is defined by the condition.
condition

Specifies the condition for the filter, which defines the necessary filtering criteria.
exclusive

If true, filter excludes items that meet criteria. The default is false (filter to include items that meet criteria).
lowerBound

The lower-bound of the range for the between filter condition.
upperBound

The upper-bound of the range for the between filter condition.
wholeDays

For equals, before, after, and between filter conditions, indicates if comparisons should be made as whole days.

Property Details

comparator

The comparator is the static value to which other values are compared. The type of comparison is defined by the condition.

comparator?: Excel.FilterDatetime;

Property Value

Excel.FilterDatetime

Remarks

[ API set: ExcelApi 1.12 ]

condition

Specifies the condition for the filter, which defines the necessary filtering criteria.

condition: Excel.DateFilterCondition | "Unknown" | "Equals" | "Before" | "BeforeOrEqualTo" | "After" | "AfterOrEqualTo" | "Between" | "Tomorrow" | "Today" | "Yesterday" | "NextWeek" | "ThisWeek" | "LastWeek" | "NextMonth" | "ThisMonth" | "LastMonth" | "NextQuarter" | "ThisQuarter" | "LastQuarter" | "NextYear" | "ThisYear" | "LastYear" | "YearToDate" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodFebruary" | "AllDatesInPeriodMarch" | "AllDatesInPeriodApril" | "AllDatesInPeriodMay" | "AllDatesInPeriodJune" | "AllDatesInPeriodJuly" | "AllDatesInPeriodAugust" | "AllDatesInPeriodSeptember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodNovember" | "AllDatesInPeriodDecember";

Property Value

Excel.DateFilterCondition | "Unknown" | "Equals" | "Before" | "BeforeOrEqualTo" | "After" | "AfterOrEqualTo" | "Between" | "Tomorrow" | "Today" | "Yesterday" | "NextWeek" | "ThisWeek" | "LastWeek" | "NextMonth" | "ThisMonth" | "LastMonth" | "NextQuarter" | "ThisQuarter" | "LastQuarter" | "NextYear" | "ThisYear" | "LastYear" | "YearToDate" | "AllDatesInPeriodQuarter1" | "AllDatesInPeriodQuarter2" | "AllDatesInPeriodQuarter3" | "AllDatesInPeriodQuarter4" | "AllDatesInPeriodJanuary" | "AllDatesInPeriodFebruary" | "AllDatesInPeriodMarch" | "AllDatesInPeriodApril" | "AllDatesInPeriodMay" | "AllDatesInPeriodJune" | "AllDatesInPeriodJuly" | "AllDatesInPeriodAugust" | "AllDatesInPeriodSeptember" | "AllDatesInPeriodOctober" | "AllDatesInPeriodNovember" | "AllDatesInPeriodDecember"

Remarks

[ API set: ExcelApi 1.12 ]

exclusive

If true, filter excludes items that meet criteria. The default is false (filter to include items that meet criteria).

exclusive?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.12 ]

lowerBound

The lower-bound of the range for the between filter condition.

lowerBound?: Excel.FilterDatetime;

Property Value

Excel.FilterDatetime

Remarks

[ API set: ExcelApi 1.12 ]

upperBound

The upper-bound of the range for the between filter condition.

upperBound?: Excel.FilterDatetime;

Property Value

Excel.FilterDatetime

Remarks

[ API set: ExcelApi 1.12 ]

wholeDays

For equals, before, after, and between filter conditions, indicates if comparisons should be made as whole days.

wholeDays?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.12 ]