Class FilterCriteria

Kopiert diese Filterkriterien und erstellt einen Kriterien-Builder, den Sie auf einen anderen Filter anwenden können.

Sie können diese Methode mit jeder Art von Filter verwenden. Wenn Sie einen Tabellenfilter verwenden, können Sie die Kriterien in eine andere Spalte kopieren.

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Makes a copy of the filter criteria applied to column C.
const criteria = filter.getColumnFilterCriteria(3).copy().build();
// Applies the copied criteria to column B. The copied criteria overwrites any
// existing criteria on column B.
filter.setColumnFilterCriteria(2, criteria);

Rückflug

FilterCriteriaBuilder: Ein Tool zum Erstellen von Filterkriterien basierend auf diesem Filterkriterium.

Gibt den booleschen Typ des Kriteriums zurück, z. B. CELL_EMPTY. Informationen zu den verschiedenen Arten von booleschen Kriterien finden Sie im BooleanCriteria-Enum.

Diese Methode wird häufig verwendet, um einem Filter boolesche Bedingungskriterien hinzuzufügen, ohne vorhandene Kriterien zu ersetzen.

• Verwenden Sie getCriteriaValues(), um die Argumente für die Kriterien abzurufen.
• Informationen zum Erstellen oder Ändern von Filterkriterien mit dem Kriterientyp und den Kriterienwerten finden Sie unter FilterCriteriaBuilder.withCriteria(criteria, args).

Sie können diese Methode für jeden Filtertyp verwenden. Wenn die Filterkriterien keine boolesche Bedingung sind, wird null zurückgegeben.

const ss = SpreadsheetApp.getActiveSheet();
// Gets the filter on the active sheet.
const filter = ss.getFilter();
// Gets the criteria type and returns a string representing the criteria type
// object.
const criteriaType =
    filter.getColumnFilterCriteria(2).getCriteriaType().toString();
// Logs the criteria type.
console.log(criteriaType);

Rückflug

BooleanCriteria|null: Der Typ des booleschen Kriteriums oder null, wenn das Kriterium keine boolesche Bedingung ist.

Gibt ein Array von Argumenten für boolesche Kriterien zurück. Einige boolesche Kriterientypen haben keine Argumente und geben ein leeres Array zurück, z. B. CELL_NOT_EMPTY.

Diese Methode wird häufig verwendet, um einem Filter boolesche Bedingungskriterien hinzuzufügen, ohne vorhandene Kriterien zu ersetzen.

• Verwenden Sie getCriteriaType(), um den booleschen Kriterientyp abzurufen.
• Informationen zum Erstellen oder Ändern von Filterkriterien mit dem Kriterientyp und den Kriterienwerten finden Sie unter FilterCriteriaBuilder.withCriteria(criteria, args).

  Sie können diese Methode für jeden Filtertyp verwenden.

  const ss = SpreadsheetApp.getActiveSheet();
  const filter = ss.getFilter();
  // Gets the values of the boolean criteria and logs them. For example, if the
  // boolean condition is whenNumberGreaterThan(10), then the logged value is 10.
  const criteriaValues = filter.getColumnFilterCriteria(2).getCriteriaValues();
  console.log(criteriaValues);

  Rückflug

  Object[]: Ein Array von Argumenten, die dem booleschen Kriterientyp entsprechen. Die Anzahl der Argumente und ihr Typ stimmen mit der entsprechenden when...()-Methode der FilterCriteriaBuilder-Klasse überein.

Gibt die Werte zurück, die durch den Filter ausgeblendet werden.

Verwenden Sie dieses Kriterium mit Filtern in Grid-Tabellen, dem Standardtyp von Tabellen. Gibt null zurück, wenn Sie diese Methode für andere Filtertypen aufrufen.

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);

Rückflug

String[]: Ein Array von Werten, die durch den Filter ausgeblendet werden.

Gibt die Hintergrundfarbe zurück, die als Filterkriterium verwendet wird. Zellen mit dieser Hintergrundfarbe bleiben sichtbar.

Verwenden Sie dieses Kriterium mit Filtern in Grid-Tabellen, dem Standardtyp von Tabellen. Gibt null zurück, wenn Sie diese Methode für andere Filtertypen aufrufen.

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the background color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleBackgroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

Rückflug

Color|null: Die Hintergrundfarbe, die als Filterkriterium verwendet wird.

Gibt die als Filterkriterium verwendete Vordergrundfarbe zurück. Zellen mit dieser Vordergrundfarbe bleiben sichtbar.

Verwenden Sie dieses Kriterium mit Filtern in Grid-Tabellen, dem Standardtyp von Tabellen. Gibt null zurück, wenn Sie diese Methode für andere Filtertypen aufrufen.

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Logs the foreground color that column B is filtered by as a hexadecimal
// string.
const filter = range.getFilter();
const color = filter.getColumnFilterCriteria(2)
                  .getVisibleForegroundColor()
                  .asRgbColor()
                  .asHexString();
console.log(color);

Rückflug

Color|null: Die Vordergrundfarbe, die als Filterkriterium verwendet wird.

Gibt die Werte zurück, die im Pivot-Tabellenfilter angezeigt werden.

Dieses Kriterium gilt nur für Filter in Pivot-Tabellen, die nicht mit einer Datenbank verbunden sind. Gibt für andere Filtertypen ein leeres Array zurück.

const ss = SpreadsheetApp.getActiveSheet();
// Gets the first pivot table on the sheet, then gets the visible values of its
// first filter.
const pivotTable = ss.getPivotTables()[0];
const pivotFilterValues =
    pivotTable.getFilters()[0].getFilterCriteria().getVisibleValues();
// Logs the visible values.
console.log(pivotFilterValues);

Rückflug

String[]: Ein Array von Werten, die im Pivot-Tabellenfilter angezeigt werden.