Class FilterCriteria

FilterCriteria

Mit dieser Klasse können Sie Informationen zu den Kriterien vorhandener Filter abrufen oder die Kriterien kopieren.

Gängige Einsatzmöglichkeiten

Kriterien kopieren

Im folgenden Beispiel wird der Filter für den Bereich A1:C20 abgerufen, die auf Spalte C angewendeten Kriterien werden abgerufen und die Kriterien werden 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);

Von Filtern ausgeblendete Werte abrufen

Im folgenden Beispiel wird der Filter für den angegebenen Bereich abgerufen und die Werte aus Spalte B protokolliert, die vom 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

MethodeRückgabetypKurzbeschreibung
copy()FilterCriteriaBuilderKopiert diese Filterkriterien und erstellt einen Kriterien-Builder, den Sie auf einen anderen Filter anwenden können.
getCriteriaType()BooleanCriteria|nullGibt den booleschen Typ der Kriterien 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 vom Filter ausgeblendet werden.
getVisibleBackgroundColor()Color|nullGibt die Hintergrundfarbe zurück, die als Filterkriterium verwendet wird.
getVisibleForegroundColor()Color|nullGibt 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 Tabellenblattfilter 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 Kriterien-Builder für Filter, der auf diesen Filterkriterien basiert.

getCriteriaType()

Gibt den booleschen Typ der Kriterien zurück, z. B. CELL_EMPTY. Informationen zu den Typen boolescher Kriterien finden Sie in der Enum BooleanCriteria.

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

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 der booleschen Kriterien oder null, wenn die Kriterien keine boolesche Bedingung sind.

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 Kriterien 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 für den booleschen Kriterientyp geeignet sind. Die Anzahl der Argumente und ihr Typ entsprechen der entsprechenden when...() Methode der FilterCriteriaBuilder Klasse.

getHiddenValues()

Gibt die Werte zurück, die vom Filter ausgeblendet werden.

Verwenden Sie diese Kriterien mit Filtern für Grid-Tabellenblätter, den Standardtyp von Tabellenblättern. 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 vom Filter ausgeblendet werden.

getVisibleBackgroundColor()

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

Verwenden Sie diese Kriterien mit Filtern für Grid-Tabellenblätter, den Standardtyp von Tabellenblättern. 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.

getVisibleForegroundColor()

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

Verwenden Sie diese Kriterien mit Filtern für Grid-Tabellenblätter, den Standardtyp von Tabellenblättern. 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.

getVisibleValues()

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

Diese Kriterien gelten nur für Filter für 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.