ExcelScript.PivotDateFilter interface

Paket:

ExcelScript

Konfigurierbare Vorlage für einen Datumsfilter, der auf ein PivotField angewendet werden soll. Definiert condition , welche Kriterien festgelegt werden müssen, damit der Filter funktioniert.

Eigenschaften

comparator	Der Vergleichsparameter ist der statische Wert, mit dem andere Werte verglichen werden. Der Vergleichstyp wird durch die Bedingung definiert.
condition	Gibt die Bedingung für den Filter an, der die erforderlichen Filterkriterien definiert.
exclusive	Wenn true, schließt filter Elemente aus , die Kriterien erfüllen. Der Standardwert ist false (Filter, um Elemente einzuschließen, die Kriterien erfüllen).
lowerBound	Die untere Grenze des Bereichs für die between Filterbedingung.
upperBound	Die obere Grenze des Bereichs für die between Filterbedingung.
wholeDays	Gibt für equalsdie Filterbedingungen , before, afterund between an, ob Vergleiche als ganze Tage durchgeführt werden sollen.

Details zur Eigenschaft

comparator

Der Vergleichsparameter ist der statische Wert, mit dem andere Werte verglichen werden. Der Vergleichstyp wird durch die Bedingung definiert.

comparator?: FilterDatetime;

Eigenschaftswert

ExcelScript.FilterDatetime

condition

Gibt die Bedingung für den Filter an, der die erforderlichen Filterkriterien definiert.

condition: DateFilterCondition;

Eigenschaftswert

ExcelScript.DateFilterCondition

Beispiele

/**
 * 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

Wenn true, schließt filter Elemente aus , die Kriterien erfüllen. Der Standardwert ist false (Filter, um Elemente einzuschließen, die Kriterien erfüllen).

exclusive?: boolean;

Eigenschaftswert

boolean

lowerBound

Die untere Grenze des Bereichs für die between Filterbedingung.

lowerBound?: FilterDatetime;

Eigenschaftswert

ExcelScript.FilterDatetime

Beispiele

/**
 * 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

Die obere Grenze des Bereichs für die between Filterbedingung.

upperBound?: FilterDatetime;

Eigenschaftswert

ExcelScript.FilterDatetime

wholeDays

Gibt für equalsdie Filterbedingungen , before, afterund between an, ob Vergleiche als ganze Tage durchgeführt werden sollen.

wholeDays?: boolean;

Eigenschaftswert

boolean