Diese Seite wurde von der Cloud Translation API übersetzt.

Class FilterCriteria

Mit dieser Klasse können Sie Informationen zu vorhandenen Filtern abrufen oder die Kriterien kopieren.

Weitere Informationen zum Erstellen eines neuen Filters finden Sie unter den folgenden Links:
- Verwenden Sie Range.createFilter() für Tabellen.
- Verwenden Sie PivotTable.addFilter(sourceDataColumn, filterCriteria) für Pivot-Tabellen.
- Verwenden Sie DataSourceSheet.addFilter(columnName, filterCriteria) für Tabellenblätter, die mit einer Datenbank verbunden sind.
- Verwenden Sie DataSourcePivotTable.addFilter(columnName, filterCriteria) für Pivot-Tabellen, die mit einer Datenbank verbunden sind.
Informationen zum Erstellen der Kriterien für jeden Filtertyp finden Sie unter SpreadsheetApp.newFilterCriteria() und FilterCriteriaBuilder.

Übliche Anwendungsbereiche

Kriterien kopieren

Im folgenden Beispiel werden der Filter für den Bereich A1:C20 und die Kriterien für Spalte C abgerufen und in Spalte B kopiert.

const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
// Copies the filter criteria applied to column C.
const filter = range.getFilter();
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);

Vom Filter ausgeblendete Werte abrufen

Im folgenden Beispiel wird der Filter abgerufen, der auf den angegebenen Bereich angewendet wird, und die Werte aus Spalte B protokolliert, die durch den Filter ausgeblendet werden.

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);

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
`copy()`	`FilterCriteriaBuilder`	Kopiert diese Filterkriterien und erstellt einen Kriterien-Builder, den Sie auf einen anderen Filter anwenden können.
`getCriteriaType()`	`BooleanCriteria`	Gibt den booleschen Typ des Kriteriums zurück, z. B. `CELL_EMPTY`.
`getCriteriaValues()`	`Object[]`	Gibt ein Array von Argumenten für boolesche Kriterien zurück.
`getHiddenValues()`	`String[]`	Gibt die Werte zurück, die durch den Filter ausgeblendet werden.
`getVisibleBackgroundColor()`	`Color`	Die Hintergrundfarbe, die als Filterkriterium verwendet wird.
`getVisibleForegroundColor()`	`Color`	Gibt die Vordergrundfarbe zurück, die als Filterkriterium verwendet wird.
`getVisibleValues()`	`String[]`	Gibt die Werte zurück, die im Pivot-Tabellenfilter angezeigt werden.

Detaillierte Dokumentation

`copy()`

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

Sie können diese Methode mit jedem Filtertyp 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 Filterkriterium-Builder, der auf diesen Filterkriterien basiert.

`getCriteriaType()`

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

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.
Wie Sie Filterkriterien mithilfe des Kriterientyps und der Kriterienwerte erstellen oder ändern, erfahren 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: Der Typ der booleschen Kriterien oder null, wenn es sich nicht um eine boolesche Bedingung handelt.

`getCriteriaValues()`

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.
Wie Sie Filterkriterien mithilfe des Kriterientyps und der Kriterienwerte erstellen oder ändern, erfahren 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, das dem booleschen Kriterientyp entspricht. Die Anzahl der Argumente und ihr Typ stimmen mit der entsprechenden when...()-Methode der FilterCriteriaBuilder-Klasse überein.

`getHiddenValues()`

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

Verwenden Sie diese Kriterien mit Filtern in Grid-Listen, dem Standardlistentyp. Wird null zurückgegeben, 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 vom Filter ausgeblendet werden

`getVisibleBackgroundColor()`

Die Hintergrundfarbe, die als Filterkriterium verwendet wird. Zellen mit dieser Hintergrundfarbe bleiben sichtbar.

Verwenden Sie diese Kriterien mit Filtern in Grid-Listen, dem Standardlistentyp. Wird null zurückgegeben, 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: Die Hintergrundfarbe, die als Filterkriterien verwendet wird.

`getVisibleForegroundColor()`

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

Verwenden Sie diese Kriterien mit Filtern in Grid-Listen, dem Standardlistentyp. Wird null zurückgegeben, 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: Die Vordergrundfarbe, die als Filterkriterium verwendet wird.

`getVisibleValues()`

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. Für andere Filtertypen wird ein leeres Array zurückgegeben.

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.