Excel.DateFilterCondition enum

表示可应用日期筛选器的所有接受条件的枚举。 用于配置应用于字段的 PivotFilter 的类型。

注解

[ API 集:ExcelApi 1.12 ]

示例

// 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();
});

字段

after = "After"

日期在比较器日期之后。

必需条件:{comparator}。 可选条件:{wholeDays}

afterOrEqualTo = "AfterOrEqualTo"

日期晚于或等于比较器日期。

必需条件:{comparator}。 可选条件:{wholeDays}

allDatesInPeriodApril = "AllDatesInPeriodApril"

日期为 4 月。

allDatesInPeriodAugust = "AllDatesInPeriodAugust"

日期为 8 月。

allDatesInPeriodDecember = "AllDatesInPeriodDecember"

日期为 12 月。

allDatesInPeriodFebruary = "AllDatesInPeriodFebruary"

日期为 2 月。

allDatesInPeriodJanuary = "AllDatesInPeriodJanuary"

日期为 1 月。

allDatesInPeriodJuly = "AllDatesInPeriodJuly"

日期为 7 月。

allDatesInPeriodJune = "AllDatesInPeriodJune"

日期为 6 月。

allDatesInPeriodMarch = "AllDatesInPeriodMarch"

日期为 3 月。

allDatesInPeriodMay = "AllDatesInPeriodMay"

日期为 5 月。

allDatesInPeriodNovember = "AllDatesInPeriodNovember"

日期为 11 月。

allDatesInPeriodOctober = "AllDatesInPeriodOctober"

日期为 10 月。

allDatesInPeriodQuarter1 = "AllDatesInPeriodQuarter1"

日期位于第 1 季度。

allDatesInPeriodQuarter2 = "AllDatesInPeriodQuarter2"

日期位于第 2 季度。

allDatesInPeriodQuarter3 = "AllDatesInPeriodQuarter3"

日期位于第 3 季度。

allDatesInPeriodQuarter4 = "AllDatesInPeriodQuarter4"

日期位于第 4 季度。

allDatesInPeriodSeptember = "AllDatesInPeriodSeptember"

日期为 9 月。

before = "Before"

日期早于比较器日期。

必需条件:{comparator}。 可选条件:{wholeDays}

beforeOrEqualTo = "BeforeOrEqualTo"

日期早于或等于比较器日期。

必需条件:{comparator}。 可选条件:{wholeDays}

between = "Between"

介于 和 upperBound 日期之间lowerBound

必需条件: {lowerBoundupperBound}。 可选条件: {wholeDaysexclusive}

equals = "Equals"

等于比较器条件。

必需条件:{comparator}。 可选条件: {wholeDaysexclusive}

lastMonth = "LastMonth"

日期为上个月。

lastQuarter = "LastQuarter"

日期为上一季度。

lastWeek = "LastWeek"

日期为上周。

lastYear = "LastYear"

日期为去年。

nextMonth = "NextMonth"

日期为下个月。

nextQuarter = "NextQuarter"

日期为下一季度。

nextWeek = "NextWeek"

日期为下周。

nextYear = "NextYear"

日期为明年。

thisMonth = "ThisMonth"

日期是本月。

thisQuarter = "ThisQuarter"

日期是本季度。

thisWeek = "ThisWeek"

日期为本周。

thisYear = "ThisYear"

日期是今年。

today = "Today"

日期为今天。

tomorrow = "Tomorrow"

日期为明天。

unknown = "Unknown"

DateFilterCondition 未知或不受支持。

yearToDate = "YearToDate"

日期是同一年至今。

yesterday = "Yesterday"

日期为昨天。