excel.datefiltercondition.yml

### YamlMime:TSEnum
name: Excel.DateFilterCondition
uid: 'excel!Excel.DateFilterCondition:enum'
package: excel!
fullName: Excel.DateFilterCondition
summary: >-
  Enum representing all accepted conditions by which a date filter can be applied. Used to configure the type of
  PivotFilter that is applied to the field.
remarks: >-
  \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


  #### Examples


  ```TypeScript

  // Link to full sample:
  https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-pivotfilters.yaml


  await Excel.run(async (context) => {
    // Add a date-based PivotFilter.

    // Get the PivotTable.
    const pivotTable = context.workbook.worksheets.getActiveWorksheet().pivotTables.getItem("Farm Sales");

    // PivotFilters can only be applied to PivotHierarchies that are being used for pivoting.
    // If it's not already there, add "Date Updated" to the hierarchies.
    let dateHierarchy = pivotTable.rowHierarchies.getItemOrNullObject("Date Updated");
    await context.sync();
    if (dateHierarchy.isNullObject) {
      dateHierarchy = pivotTable.rowHierarchies.add(pivotTable.hierarchies.getItem("Date Updated"));
    }

    // Apply a date filter to filter out anything logged before August.
    const filterField = dateHierarchy.fields.getItem("Date Updated");
    const dateFilter = {
      condition: Excel.DateFilterCondition.afterOrEqualTo,
      comparator: {
        date: "2020-08-01",
        specificity: Excel.FilterDatetimeSpecificity.month
      }
    };
    filterField.applyFilter({ dateFilter: dateFilter });

    await context.sync();
  });

  ```
isPreview: false
isDeprecated: false
fields:
  - name: after
    uid: 'excel!Excel.DateFilterCondition.after:member'
    package: excel!
    summary: |-
      Date is after comparator date.

      Required Criteria: {`comparator`<!-- -->}<!-- -->. Optional Criteria: {`wholeDays`<!-- -->}<!-- -->.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"After"'
  - name: afterOrEqualTo
    uid: 'excel!Excel.DateFilterCondition.afterOrEqualTo:member'
    package: excel!
    summary: |-
      Date is after or equal to comparator date.

      Required Criteria: {`comparator`<!-- -->}<!-- -->. Optional Criteria: {`wholeDays`<!-- -->}<!-- -->.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AfterOrEqualTo"'
  - name: allDatesInPeriodApril
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodApril:member'
    package: excel!
    summary: |-
      Date is in April.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodApril"'
  - name: allDatesInPeriodAugust
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodAugust:member'
    package: excel!
    summary: |-
      Date is in August.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodAugust"'
  - name: allDatesInPeriodDecember
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodDecember:member'
    package: excel!
    summary: |-
      Date is in December.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodDecember"'
  - name: allDatesInPeriodFebruary
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodFebruary:member'
    package: excel!
    summary: |-
      Date is in February.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodFebruary"'
  - name: allDatesInPeriodJanuary
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodJanuary:member'
    package: excel!
    summary: |-
      Date is in January.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodJanuary"'
  - name: allDatesInPeriodJuly
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodJuly:member'
    package: excel!
    summary: |-
      Date is in July.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodJuly"'
  - name: allDatesInPeriodJune
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodJune:member'
    package: excel!
    summary: |-
      Date is in June.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodJune"'
  - name: allDatesInPeriodMarch
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodMarch:member'
    package: excel!
    summary: |-
      Date is in March.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodMarch"'
  - name: allDatesInPeriodMay
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodMay:member'
    package: excel!
    summary: |-
      Date is in May.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodMay"'
  - name: allDatesInPeriodNovember
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodNovember:member'
    package: excel!
    summary: |-
      Date is in November.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodNovember"'
  - name: allDatesInPeriodOctober
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodOctober:member'
    package: excel!
    summary: |-
      Date is in October.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodOctober"'
  - name: allDatesInPeriodQuarter1
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodQuarter1:member'
    package: excel!
    summary: |-
      Date is in Quarter 1.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodQuarter1"'
  - name: allDatesInPeriodQuarter2
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodQuarter2:member'
    package: excel!
    summary: |-
      Date is in Quarter 2.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodQuarter2"'
  - name: allDatesInPeriodQuarter3
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodQuarter3:member'
    package: excel!
    summary: |-
      Date is in Quarter 3.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodQuarter3"'
  - name: allDatesInPeriodQuarter4
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodQuarter4:member'
    package: excel!
    summary: |-
      Date is in Quarter 4.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodQuarter4"'
  - name: allDatesInPeriodSeptember
    uid: 'excel!Excel.DateFilterCondition.allDatesInPeriodSeptember:member'
    package: excel!
    summary: |-
      Date is in September.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"AllDatesInPeriodSeptember"'
  - name: before
    uid: 'excel!Excel.DateFilterCondition.before:member'
    package: excel!
    summary: |-
      Date is before comparator date.

      Required Criteria: {`comparator`<!-- -->}<!-- -->. Optional Criteria: {`wholeDays`<!-- -->}<!-- -->.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"Before"'
  - name: beforeOrEqualTo
    uid: 'excel!Excel.DateFilterCondition.beforeOrEqualTo:member'
    package: excel!
    summary: |-
      Date is before or equal to comparator date.

      Required Criteria: {`comparator`<!-- -->}<!-- -->. Optional Criteria: {`wholeDays`<!-- -->}<!-- -->.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"BeforeOrEqualTo"'
  - name: between
    uid: 'excel!Excel.DateFilterCondition.between:member'
    package: excel!
    summary: >-
      Between `lowerBound` and `upperBound` dates.


      Required Criteria: {`lowerBound`<!-- -->, `upperBound`<!-- -->}<!-- -->. Optional Criteria: {`wholeDays`<!-- -->,
      `exclusive`<!-- -->}<!-- -->.


      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"Between"'
  - name: equals
    uid: 'excel!Excel.DateFilterCondition.equals:member'
    package: excel!
    summary: >-
      Equals comparator criterion.


      Required Criteria: {`comparator`<!-- -->}<!-- -->. Optional Criteria: {`wholeDays`<!-- -->, `exclusive`<!--
      -->}<!-- -->.


      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"Equals"'
  - name: lastMonth
    uid: 'excel!Excel.DateFilterCondition.lastMonth:member'
    package: excel!
    summary: |-
      Date is last month.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"LastMonth"'
  - name: lastQuarter
    uid: 'excel!Excel.DateFilterCondition.lastQuarter:member'
    package: excel!
    summary: |-
      Date is last quarter.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"LastQuarter"'
  - name: lastWeek
    uid: 'excel!Excel.DateFilterCondition.lastWeek:member'
    package: excel!
    summary: |-
      Date is last week.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"LastWeek"'
  - name: lastYear
    uid: 'excel!Excel.DateFilterCondition.lastYear:member'
    package: excel!
    summary: |-
      Date is last year.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"LastYear"'
  - name: nextMonth
    uid: 'excel!Excel.DateFilterCondition.nextMonth:member'
    package: excel!
    summary: |-
      Date is next month.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"NextMonth"'
  - name: nextQuarter
    uid: 'excel!Excel.DateFilterCondition.nextQuarter:member'
    package: excel!
    summary: |-
      Date is next quarter.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"NextQuarter"'
  - name: nextWeek
    uid: 'excel!Excel.DateFilterCondition.nextWeek:member'
    package: excel!
    summary: |-
      Date is next week.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"NextWeek"'
  - name: nextYear
    uid: 'excel!Excel.DateFilterCondition.nextYear:member'
    package: excel!
    summary: |-
      Date is next year.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"NextYear"'
  - name: thisMonth
    uid: 'excel!Excel.DateFilterCondition.thisMonth:member'
    package: excel!
    summary: |-
      Date is this month.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"ThisMonth"'
  - name: thisQuarter
    uid: 'excel!Excel.DateFilterCondition.thisQuarter:member'
    package: excel!
    summary: |-
      Date is this quarter.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"ThisQuarter"'
  - name: thisWeek
    uid: 'excel!Excel.DateFilterCondition.thisWeek:member'
    package: excel!
    summary: |-
      Date is this week.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"ThisWeek"'
  - name: thisYear
    uid: 'excel!Excel.DateFilterCondition.thisYear:member'
    package: excel!
    summary: |-
      Date is this year.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"ThisYear"'
  - name: today
    uid: 'excel!Excel.DateFilterCondition.today:member'
    package: excel!
    summary: |-
      Date is today.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"Today"'
  - name: tomorrow
    uid: 'excel!Excel.DateFilterCondition.tomorrow:member'
    package: excel!
    summary: |-
      Date is tomorrow.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"Tomorrow"'
  - name: unknown
    uid: 'excel!Excel.DateFilterCondition.unknown:member'
    package: excel!
    summary: |-
      `DateFilterCondition` is unknown or unsupported.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"Unknown"'
  - name: yearToDate
    uid: 'excel!Excel.DateFilterCondition.yearToDate:member'
    package: excel!
    summary: |-
      Date is in the same year to date.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"YearToDate"'
  - name: yesterday
    uid: 'excel!Excel.DateFilterCondition.yesterday:member'
    package: excel!
    summary: |-
      Date is yesterday.

      * \[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    value: '"Yesterday"'