ExcelScript.PivotDateFilter interface

パッケージ:

ExcelScript

PivotField に適用する日付フィルターの構成可能なテンプレート。 conditionは、フィルターを動作させるために設定する必要がある条件を定義します。

プロパティ

comparator	コンパレータは、他の値が比較される静的な値です。 比較の種類は条件によって定義されます。
condition	必要なフィルター条件を定義するフィルターの条件を指定します。
exclusive	true 場合、フィルターは条件を満たす項目を除外します。 既定値は false です (条件を満たす項目を含むようにフィルター処理します)。
lowerBound	betweenフィルター条件の範囲の下限。
upperBound	between フィルター条件の範囲の上限。
wholeDays	equals 、before、after、およびbetweenフィルター条件では、比較を 1 日で行う必要があるかどうかを示します。

プロパティの詳細

comparator

コンパレータは、他の値が比較される静的な値です。 比較の種類は条件によって定義されます。

comparator?: FilterDatetime;

プロパティ値

ExcelScript.FilterDatetime

condition

必要なフィルター条件を定義するフィルターの条件を指定します。

condition: DateFilterCondition;

プロパティ値

ExcelScript.DateFilterCondition

例

/**
 * This script applies a filter to a PivotTable that filters out rows 
 * that aren't from this month.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the "Date Recorded" field to filter. 
  // The data in this field must be dates in order for the filter to work.
  const pivot = workbook.getPivotTables()[0];
  const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
  const rowField = rowHierarchy.getFields()[0];

  // Apply the date filter.
  rowField.applyFilter({
    dateFilter: {
      // Setting the condition to `thisMonth` means items that are before or
      // after this month will not be displayed.
      condition: ExcelScript.DateFilterCondition.thisMonth
    }
  });
}

exclusive

true 場合、フィルターは条件を満たす項目を除外します。 既定値は false です (条件を満たす項目を含むようにフィルター処理します)。

exclusive?: boolean;

プロパティ値

boolean

lowerBound

betweenフィルター条件の範囲の下限。

lowerBound?: FilterDatetime;

プロパティ値

ExcelScript.FilterDatetime

例

/**
 * This script applies a filter to a PivotTable that filters it
 * to only show rows from between June 20th, 2022 and July 10th, 2022.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the "Date Recorded" field to filter. 
  // The data in this field must be dates in order for the filter to work.
  const pivot = workbook.getPivotTables()[0];
  const rowHierarchy = pivot.getRowHierarchy("Date Recorded");
  const rowField = rowHierarchy.getFields()[0];

  // Create the filter's date boundaries.
  let earliestDate: ExcelScript.FilterDatetime = {
    date: "2022-06-20",
    specificity: ExcelScript.FilterDatetimeSpecificity.day
  };
  let latestDate: ExcelScript.FilterDatetime = {
    date: "2022-07-10",
    specificity: ExcelScript.FilterDatetimeSpecificity.day
  };

  // Apply the date filter.
  rowField.applyFilter({
    dateFilter: {
      condition: ExcelScript.DateFilterCondition.between,
      lowerBound: earliestDate,
      upperBound: latestDate
    }
  });
}

upperBound

between フィルター条件の範囲の上限。

upperBound?: FilterDatetime;

プロパティ値

ExcelScript.FilterDatetime

wholeDays

equals 、before、after、およびbetweenフィルター条件では、比較を 1 日で行う必要があるかどうかを示します。

wholeDays?: boolean;

プロパティ値

boolean