Class FilterCriteriaBuilder

FilterCriteriaBuilder

So fügen Sie einem Filter Kriterien hinzu:

  1. Erstellen Sie den Kriterien-Builder mit SpreadsheetApp.newFilterCriteria().
  2. Fügen Sie dem Builder mithilfe der Methoden aus dieser Klasse Einstellungen hinzu.
  3. Verwenden Sie build(), um die Kriterien mit den angegebenen Einstellungen zusammenzustellen.

Übliche Anwendungsbereiche

Werte auf einem Tabellenblatt ausblenden

Im folgenden Beispiel wird der vorhandene Filter eines Tabellenblatts abgerufen und Kriterien hinzugefügt, die die Zellen in Spalte C ausblenden, die „Hallo“ oder „Welt“ enthalten. Die Kriterien in diesem Beispiel können nur mit Filtern auf Grid-Blättern verwendet werden, dem Standardblatttyp.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
const criteria = SpreadsheetApp.newFilterCriteria()
                     .setHiddenValues(['hello', 'world'])
                     .build();
filter.setColumnFilterCriteria(3, criteria);

Nur nicht leere Zellen anzeigen

Im folgenden Beispiel wird einer DataSource-Tabelle, die mit einer Datenbank verbunden ist, ein Filter mit Kriterien hinzugefügt, durch den nur Zellen in der Spalte „Kategorie“ angezeigt werden, die nicht leer sind.
// Gets the sheet named "Connected sheet," which is connected to a database.
const sheet = SpreadsheetApp.getActiveSpreadsheet()
                  .getSheetByName('Connected sheet')
                  .asDataSourceSheet();
// Creates criteria that only shows non-empty cells.
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();
// Applies the criteria to the column named "Category."
sheet.addFilter('Category', criteria);

Methoden

MethodeRückgabetypKurzbeschreibung
build()FilterCriteriaDie Filterkriterien werden anhand der Einstellungen erstellt, die Sie dem Tool zur Kriterienerstellung hinzufügen.
copy()FilterCriteriaBuilderKopiert diese Filterkriterien und erstellt einen Kriterien-Builder, den Sie auf einen anderen Filter anwenden können.
getCriteriaType()BooleanCriteriaGibt 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()ColorDie Hintergrundfarbe, die als Filterkriterium verwendet wird.
getVisibleForegroundColor()ColorGibt die Vordergrundfarbe zurück, die als Filterkriterium verwendet wird.
getVisibleValues()String[]Gibt die Werte zurück, die im Pivot-Tabellenfilter angezeigt werden.
setHiddenValues(values)FilterCriteriaBuilderHier legen Sie fest, welche Werte ausgeblendet werden sollen.
setVisibleBackgroundColor(visibleBackgroundColor)FilterCriteriaBuilderHier legen Sie die Hintergrundfarbe fest, die als Filterkriterien verwendet wird.
setVisibleForegroundColor(visibleForegroundColor)FilterCriteriaBuilderLegt die Vordergrundfarbe fest, die als Filterkriterien verwendet wird.
setVisibleValues(values)FilterCriteriaBuilderHier legen Sie fest, welche Werte in einer Pivot-Tabelle angezeigt werden sollen.
whenCellEmpty()FilterCriteriaBuilderLegen Sie mit den Filterkriterien fest, dass leere Zellen angezeigt werden.
whenCellNotEmpty()FilterCriteriaBuilderMit diesem Filter werden nur Zellen angezeigt, die nicht leer sind.
whenDateAfter(date)FilterCriteriaBuilderHiermit werden Filterkriterien festgelegt, mit denen Zellen mit Datumsangaben nach dem angegebenen Datum angezeigt werden.
whenDateAfter(date)FilterCriteriaBuilderHiermit werden Filterkriterien festgelegt, mit denen Zellen mit Datumsangaben nach dem angegebenen relativen Datum angezeigt werden.
whenDateBefore(date)FilterCriteriaBuilderHiermit legen Sie Filterkriterien fest, mit denen Zellen mit Datumsangaben angezeigt werden, die vor dem angegebenen Datum liegen.
whenDateBefore(date)FilterCriteriaBuilderHiermit werden Filterkriterien festgelegt, die Zellen mit Datumsangaben anzeigen, die vor dem angegebenen relativen Datum liegen.
whenDateEqualTo(date)FilterCriteriaBuilderHiermit werden Filterkriterien festgelegt, mit denen Zellen mit Datumsangaben angezeigt werden, die mit dem angegebenen Datum übereinstimmen.
whenDateEqualTo(date)FilterCriteriaBuilderLegt Filterkriterien fest, mit denen Zellen mit Datumsangaben angezeigt werden, die dem angegebenen relativen Datum entsprechen.
whenDateEqualToAny(dates)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit Datumsangaben angezeigt werden, die mit einem der angegebenen Datumsangaben übereinstimmen.
whenDateNotEqualTo(date)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen angezeigt werden, die nicht mit dem angegebenen Datum übereinstimmen.
whenDateNotEqualToAny(dates)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit Datumsangaben angezeigt werden, die keinem der angegebenen Datumsangaben entsprechen.
whenFormulaSatisfied(formula)FilterCriteriaBuilderMit dieser Option werden Zellen mit einer bestimmten Formel (z. B. =B:B<C:C) angezeigt, die zu true führt.
whenNumberBetween(start, end)FilterCriteriaBuilderHiermit legen Sie die Filterkriterien fest, um Zellen mit einer Zahl anzuzeigen, die zwischen zwei oder einer der beiden angegebenen Zahlen liegt.
whenNumberEqualTo(number)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die der angegebenen Zahl entspricht.
whenNumberEqualToAny(numbers)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die mit einer der angegebenen Zahlen übereinstimmt.
whenNumberGreaterThan(number)FilterCriteriaBuilderLegen Sie die Filterkriterien so fest, dass Zellen mit einer Zahl angezeigt werden, die größer als die angegebene Zahl ist.
whenNumberGreaterThanOrEqualTo(number)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die größer oder gleich der angegebenen Zahl ist.
whenNumberLessThan(number)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die kleiner als die angegebene Zahl ist.
whenNumberLessThanOrEqualTo(number)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die kleiner oder gleich der angegebenen Zahl ist.
whenNumberNotBetween(start, end)FilterCriteriaBuilderHiermit legen Sie die Filterkriterien fest, um Zellen mit einer Zahl anzuzeigen, die nicht zwischen zwei angegebenen Zahlen liegt und auch keine der beiden ist.
whenNumberNotEqualTo(number)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die nicht mit der angegebenen Zahl übereinstimmt.
whenNumberNotEqualToAny(numbers)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die keiner der angegebenen Zahlen entspricht.
whenTextContains(text)FilterCriteriaBuilderHiermit legen Sie die Filterkriterien fest, damit Zellen mit Text angezeigt werden, der den angegebenen Text enthält.
whenTextDoesNotContain(text)FilterCriteriaBuilderHiermit legen Sie die Filterkriterien fest, um Zellen mit Text anzuzeigen, der den angegebenen Text nicht enthält.
whenTextEndsWith(text)FilterCriteriaBuilderHiermit legen Sie die Filterkriterien fest, damit Zellen mit Text angezeigt werden, der mit dem angegebenen Text endet.
whenTextEqualTo(text)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit Text angezeigt werden, der mit dem angegebenen Text übereinstimmt.
whenTextEqualToAny(texts)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit Text angezeigt werden, der mit einem der angegebenen Textwerte übereinstimmt.
whenTextNotEqualTo(text)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit Text angezeigt werden, der nicht mit dem angegebenen Text übereinstimmt.
whenTextNotEqualToAny(texts)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit Text angezeigt werden, der mit keinem der angegebenen Werte übereinstimmt.
whenTextStartsWith(text)FilterCriteriaBuilderHiermit werden die Filterkriterien so festgelegt, dass Zellen mit Text angezeigt werden, der mit dem angegebenen Text beginnt.
withCriteria(criteria, args)FilterCriteriaBuilderDie Filterkriterien werden auf eine boolesche Bedingung festgelegt, die durch BooleanCriteria-Werte wie CELL_EMPTY oder NUMBER_GREATER_THAN definiert ist.

Detaillierte Dokumentation

build()

Die Filterkriterien werden anhand der Einstellungen erstellt, die Sie dem Tool zur Kriterienerstellung hinzufügen.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
const criteria = SpreadsheetApp
                     .newFilterCriteria()  // Creates a criteria builder.
                     .whenCellNotEmpty()   // Adds settings to the builder.
                     .build();             // Assembles the criteria.
filter.setColumnFilterCriteria(2, criteria);

Rückflug

FilterCriteria: Eine Darstellung der Filterkriterien.


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.

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 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.


setHiddenValues(values)

Hier legen Sie fest, welche Werte ausgeblendet werden sollen. Alle sichtbaren oder ausgeblendeten Werte werden gelöscht.

Sie können dieses Kriterium nur für Filter in Grid-Tabellen verwenden, dem Standardtyp von Tabellen.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Sets the values to hide and applies the criteria to column C.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .setHiddenValues(['Hello', 'World'])
                     .build();
filter.setColumnFilterCriteria(3, criteria);

Parameter

NameTypBeschreibung
valuesString[]Die Liste der zu verbergenden Werte.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.

Löst aus

Error: Wenn einer der Werte null ist.


setVisibleBackgroundColor(visibleBackgroundColor)

Hier legen Sie die Hintergrundfarbe fest, die als Filterkriterien verwendet wird. Zellen mit dieser Hintergrundfarbe bleiben sichtbar. Wenn Sie Filterkriterien für die Hintergrundfarbe festlegen, werden alle aktuellen Farbfilterkriterien aus diesem Builder entfernt.

Sie können dieses Kriterium nur für Filter in Grid-Tabellen verwenden, dem Standardtyp von Tabellen.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that filters by background color and sets it to column B.
const color = SpreadsheetApp.newColor().setRgbColor('#185ABC').build();
const criteria =
    SpreadsheetApp.newFilterCriteria().setVisibleBackgroundColor(color).build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
visibleBackgroundColorColorDie Hintergrundfarbe, die festgelegt werden soll. Die Farbe muss im RGB-Format angegeben werden. Diese Methode unterstützt keine Designfarben.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


setVisibleForegroundColor(visibleForegroundColor)

Legt die Vordergrundfarbe fest, die als Filterkriterien verwendet wird. Zellen mit dieser Vordergrundfarbe bleiben sichtbar. Wenn Sie Filterkriterien für die Vordergrundfarbe festlegen, werden alle aktuellen Farbfilterkriterien aus diesem Builder entfernt.

Sie können dieses Kriterium nur für Filter in Grid-Tabellen verwenden, dem Standardtyp von Tabellen.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that filters by foreground color and sets it to column B.
const color = SpreadsheetApp.newColor().setRgbColor('#185ABC').build();
const criteria =
    SpreadsheetApp.newFilterCriteria().setVisibleForegroundColor(color).build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
visibleForegroundColorColorDie zu festlegende Vordergrundfarbe. Die Farbe muss im RGB-Format angegeben werden. Diese Methode unterstützt keine Designfarben.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


setVisibleValues(values)

Hier legen Sie fest, welche Werte in einer Pivot-Tabelle angezeigt werden sollen. Alle sichtbaren oder ausgeblendeten Werte werden gelöscht.

Sie können dieses Kriterium nur für Filter in Pivot-Tabellen verwenden, die nicht mit einer Datenbank verbunden sind.

// Gets the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
// Gets the first pivot table on the sheet and adds a filter to it that
// sets the visible values to "Northeast" and "Southwest."
const pivotTable = ss.getPivotTables()[0];
const criteria = SpreadsheetApp.newFilterCriteria()
                     .setVisibleValues(['Northeast', 'Southwest'])
                     .build();
pivotTable.addFilter(2, criteria);

Parameter

NameTypBeschreibung
valuesString[]Liste der anzuzeigenden Werte.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.

Löst aus

Error: Wenn einer der Werte null ist.


whenCellEmpty()

Legen Sie mit den Filterkriterien fest, dass leere Zellen angezeigt werden.

Sie können diese Kriterien mit jedem Filtertyp verwenden.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Sets criteria to column B that only shows empty cells.
const criteria = SpreadsheetApp.newFilterCriteria().whenCellEmpty().build();
filter.setColumnFilterCriteria(2, criteria);

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenCellNotEmpty()

Mit diesem Filter werden nur Zellen angezeigt, die nicht leer sind.

Sie können diese Kriterien mit jedem Filtertyp verwenden.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Sets criteria to column B that only shows cells that aren't empty.
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();
filter.setColumnFilterCriteria(2, criteria);

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenDateAfter(date)

Hiermit werden Filterkriterien festgelegt, mit denen Zellen mit Datumsangaben nach dem angegebenen Datum angezeigt werden.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium für Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, ein Datum sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, kein Datum sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates after June 1, 2022
// and sets it to column A.
const date = new Date('June 1, 2022');
const criteria = SpreadsheetApp.newFilterCriteria().whenDateAfter(date).build();
filter.setColumnFilterCriteria(1, criteria);

Parameter

NameTypBeschreibung
dateDateDas Datum, bis zu dem Daten ausgeblendet werden sollen.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenDateAfter(date)

Hiermit werden Filterkriterien festgelegt, mit denen Zellen mit Datumsangaben nach dem angegebenen relativen Datum angezeigt werden. Die Optionen für relative Datumsangaben finden Sie unter Aufzählung RelativeDate.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium für Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, ein Datum sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, kein Datum sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates after today's date
// and sets it to column A.

const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateAfter(SpreadsheetApp.RelativeDate.TODAY)
                     .build();
filter.setColumnFilterCriteria(1, criteria);

Parameter

NameTypBeschreibung
dateRelativeDateDas letzte relative Datum.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenDateBefore(date)

Hiermit legen Sie Filterkriterien fest, mit denen Zellen mit Datumsangaben angezeigt werden, die vor dem angegebenen Datum liegen.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium für Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, ein Datum sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, kein Datum sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates before June 1, 2022
// and sets it to column A.
const date = new Date('June 1, 2022');
const criteria =
    SpreadsheetApp.newFilterCriteria().whenDateBefore(date).build();
filter.setColumnFilterCriteria(1, criteria);

Parameter

NameTypBeschreibung
dateDateDas früheste Datum, das ausgeblendet werden soll.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenDateBefore(date)

Hiermit werden Filterkriterien festgelegt, die Zellen mit Datumsangaben anzeigen, die vor dem angegebenen relativen Datum liegen. Die Optionen für relative Datumsangaben finden Sie unter Enum RelativeDate.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium für Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, ein Datum sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, kein Datum sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates before today's date
// and sets it to column A.

const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateBefore(SpreadsheetApp.RelativeDate.TODAY)
                     .build();
filter.setColumnFilterCriteria(1, criteria);

Parameter

NameTypBeschreibung
dateRelativeDateDas früheste relative Datum, das ausgeblendet werden soll.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenDateEqualTo(date)

Hiermit werden Filterkriterien festgelegt, mit denen Zellen mit Datumsangaben angezeigt werden, die mit dem angegebenen Datum übereinstimmen.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium für Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, ein Datum sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, kein Datum sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates equal to June 1, 2022
// and sets it to column A.
const date = new Date('June 1, 2022');
const criteria =
    SpreadsheetApp.newFilterCriteria().whenDateEqualTo(date).build();
filter.setColumnFilterCriteria(1, criteria);

Parameter

NameTypBeschreibung
dateDateDas Datum, mit dem die Zellenwerte übereinstimmen müssen.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenDateEqualTo(date)

Legt Filterkriterien fest, mit denen Zellen mit Datumsangaben angezeigt werden, die dem angegebenen relativen Datum entsprechen. Die Optionen für relative Datumsangaben finden Sie unter Enum RelativeDate.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium für Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, ein Datum sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, kein Datum sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the range.
const ss = SpreadsheetApp.getActiveSheet();
const range = ss.getRange('A1:C20');
const filter = range.getFilter();
// Creates criteria that only shows cells with dates that fall within the past
// month and sets it to column A.

const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateEqualTo(SpreadsheetApp.RelativeDate.PAST_MONTH)
                     .build();
filter.setColumnFilterCriteria(1, criteria);

Parameter

NameTypBeschreibung
dateRelativeDateDas relative Datum, mit dem die Zellenwerte übereinstimmen müssen.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenDateEqualToAny(dates)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit Datumsangaben angezeigt werden, die mit einem der angegebenen Datumsangaben übereinstimmen.

Sie können diese Kriterien nur für Daten verwenden, die mit einer Datenbank verbunden sind. Sie können diese Kriterien beispielsweise mit Filtern auf einem DataSource-Tabellenblatt, einem Tabellenblatt, das mit einer Datenbank verbunden ist, oder einer DataSourcePivotTable (Pivot-Tabelle, die aus einem DataSource-Tabellenblatt erstellt wurde) verwenden.

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "date" column that shows cells with any of the below
// dates.
const date1 = new Date('June 1, 2022');
const date2 = new Date('June 2, 2022');
const date3 = new Date('June 3, 2022');
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateEqualToAny([date1, date2, date3])
                     .build();
dataSheet.addFilter('date', criteria);

Parameter

NameTypBeschreibung
datesDate[]Die anzuzeigenden Datumsangaben.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenDateNotEqualTo(date)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen angezeigt werden, die nicht mit dem angegebenen Datum übereinstimmen.

Sie können diese Kriterien nur für Daten verwenden, die mit einer Datenbank verbunden sind. Sie können diese Kriterien beispielsweise mit Filtern auf einem DataSource-Tabellenblatt, einem Tabellenblatt, das mit einer Datenbank verbunden ist, oder einer DataSourcePivotTable (Pivot-Tabelle, die aus einem DataSource-Tabellenblatt erstellt wurde) verwenden.

Der Datentyp der Spalte, nach der Sie filtern, muss ein Datum sein.

// Gets a pivot table that's connected to a database.
const ss =
    SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Pivot Table Sheet');
const dataPivotTable = ss.getDataSourcePivotTables()[0];
// Creates criteria that only shows cells that don't equal June 16, 2022
// and sets it to the "date" column.
const date = new Date('June 16, 2022');
const criteria =
    SpreadsheetApp.newFilterCriteria().whenDateNotEqualTo(date).build();
dataPivotTable.addFilter('date', criteria);

Parameter

NameTypBeschreibung
dateDateDas Datum, das ausgeblendet werden soll.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenDateNotEqualToAny(dates)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit Datumsangaben angezeigt werden, die keinem der angegebenen Datumsangaben entsprechen.

Sie können diese Kriterien nur für Daten verwenden, die mit einer Datenbank verbunden sind. Sie können diese Kriterien beispielsweise mit Filtern auf einem DataSource-Tabellenblatt, einem Tabellenblatt, das mit einer Datenbank verbunden ist, oder einer DataSourcePivotTable (Pivot-Tabelle, die aus einem DataSource-Tabellenblatt erstellt wurde) verwenden.

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "date" column that hides cells with any of the below
// dates.
const date1 = new Date('June 1, 2022');
const date2 = new Date('June 2, 2022');
const date3 = new Date('June 3, 2022');
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenDateNotEqualToAny([date1, date2, date3])
                     .build();
dataSheet.addFilter('date', criteria);

Parameter

NameTypBeschreibung
datesDate[]Die zu verbergenden Datumsangaben.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenFormulaSatisfied(formula)

Mit dieser Option werden Zellen mit einer bestimmten Formel (z. B. =B:B<C:C) angezeigt, die zu true führt.

Sie können diese Kriterien nur zum Filtern von Daten verwenden, die nicht mit einer Datenbank verbunden sind.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows the rows where the value in column B is less than
// the value in column C and sets it to column A.
const formula = '=B:B<C:C';
const criteria =
    SpreadsheetApp.newFilterCriteria().whenFormulaSatisfied(formula).build();
filter.setColumnFilterCriteria(1, criteria);

Parameter

NameTypBeschreibung
formulaStringEine benutzerdefinierte Formel, die mit true ausgewertet wird, wenn die Eingabe gültig ist.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenNumberBetween(start, end)

Hiermit legen Sie die Filterkriterien fest, um Zellen mit einer Zahl anzuzeigen, die zwischen zwei oder einer der beiden angegebenen Zahlen liegt.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium mit Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, eine Zahl sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, keine Zahl sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that only shows cells with numbers that fall between 1-25,
// inclusively, and sets it to column A.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberBetween(1, 25).build();
filter.setColumnFilterCriteria(1, criteria);

Parameter

NameTypBeschreibung
startNumberDie niedrigste Zahl, die angezeigt werden soll.
endNumberDie höchste Zahl, die angezeigt werden soll.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenNumberEqualTo(number)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die der angegebenen Zahl entspricht.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium mit Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, eine Zahl sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, keine Zahl sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that only shows cells that are equal to 25 and sets it to
// column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberEqualTo(25).build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
numberNumberDie anzuzeigende Zahl.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenNumberEqualToAny(numbers)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die mit einer der angegebenen Zahlen übereinstimmt.

Sie können diese Kriterien nur für Daten verwenden, die mit einer Datenbank verbunden sind. Sie können diese Kriterien beispielsweise mit Filtern auf einem DataSource-Tabellenblatt, einem Tabellenblatt, das mit einer Datenbank verbunden ist, oder einer DataSourcePivotTable (Pivot-Tabelle, die aus einem DataSource-Tabellenblatt erstellt wurde) verwenden.

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "amount" column that only shows cells with the number
// 10, 20, or 30.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenNumberEqualToAny([10, 20, 30])
                     .build();
dataSheet.addFilter('amount', criteria);

Parameter

NameTypBeschreibung
numbersNumber[]Die anzuzeigenden Zahlen.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenNumberGreaterThan(number)

Legen Sie die Filterkriterien so fest, dass Zellen mit einer Zahl angezeigt werden, die größer als die angegebene Zahl ist.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium mit Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, eine Zahl sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, keine Zahl sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells greater than 10 and sets it to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberGreaterThan(10).build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
numberNumberDie höchste Zahl, die ausgeblendet werden soll.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenNumberGreaterThanOrEqualTo(number)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die größer oder gleich der angegebenen Zahl ist.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium mit Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, eine Zahl sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, keine Zahl sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells greater than or equal to 10 and sets it to
// column B.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenNumberGreaterThanOrEqualTo(10)
                     .build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
numberNumberDie niedrigste Zahl, die angezeigt werden soll.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenNumberLessThan(number)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die kleiner als die angegebene Zahl ist.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium mit Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, eine Zahl sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, keine Zahl sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells less than 10 and sets it to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberLessThan(10).build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
numberNumberDie niedrigste Zahl, die ausgeblendet werden soll.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenNumberLessThanOrEqualTo(number)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die kleiner oder gleich der angegebenen Zahl ist.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium mit Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, eine Zahl sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, keine Zahl sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells less than or equal to 10 and sets it to
// column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberLessThanOrEqualTo(10).build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
numberNumberDie höchste Zahl, die angezeigt werden soll.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenNumberNotBetween(start, end)

Hiermit legen Sie die Filterkriterien fest, um Zellen mit einer Zahl anzuzeigen, die nicht zwischen zwei angegebenen Zahlen liegt und auch keine der beiden ist.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium mit Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, eine Zahl sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, keine Zahl sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that hides cells with numbers that fall between 1-25,
// inclusively, and sets it to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberNotBetween(1, 25).build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
startNumberDie niedrigste Zahl wird ausgeblendet.
endNumberDie höchste Zahl, die ausgeblendet werden soll.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenNumberNotEqualTo(number)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die nicht mit der angegebenen Zahl übereinstimmt.

Sie können diese Kriterien mit jedem Filtertyp verwenden. Wenn Sie dieses Kriterium mit Daten verwenden, die mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, eine Zahl sein. Wenn die Daten nicht mit einer Datenbank verbunden sind, muss der Datentyp der Spalte, nach der Sie filtern, keine Zahl sein. Ist das nicht der Fall, können unerwartete Ergebnisse auftreten.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that hides cells that are equal to 25 and sets it to column
// B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenNumberNotEqualTo(25).build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
numberNumberDie Nummer, die ausgeblendet werden soll.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenNumberNotEqualToAny(numbers)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit einer Zahl angezeigt werden, die keiner der angegebenen Zahlen entspricht.

Sie können diese Kriterien nur für Daten verwenden, die mit einer Datenbank verbunden sind. Sie können diese Kriterien beispielsweise mit Filtern auf einem DataSource-Tabellenblatt, einem Tabellenblatt, das mit einer Datenbank verbunden ist, oder einer DataSourcePivotTable (Pivot-Tabelle, die aus einem DataSource-Tabellenblatt erstellt wurde) verwenden.

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "amount" column that hides cells with the number 10, 20,
// or 30.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenNumberNotEqualToAny([10, 20, 30])
                     .build();
dataSheet.addFilter('amount', criteria);

Parameter

NameTypBeschreibung
numbersNumber[]Die Zahlen, die ausgeblendet werden sollen.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenTextContains(text)

Hiermit legen Sie die Filterkriterien fest, damit Zellen mit Text angezeigt werden, der den angegebenen Text enthält. Bei dem Text wird die Groß- und Kleinschreibung nicht berücksichtigt.

Sie können diese Kriterien mit jedem Filtertyp verwenden.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells that contain "Northwest" and sets it to
// column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenTextContains('Northwest').build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
textStringDer Text, den die Zelle enthalten muss.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenTextDoesNotContain(text)

Hiermit legen Sie die Filterkriterien fest, um Zellen mit Text anzuzeigen, der den angegebenen Text nicht enthält. Bei dem Text wird die Groß- und Kleinschreibung nicht berücksichtigt.

Sie können diese Kriterien mit jedem Filtertyp verwenden.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that hides cells that contain "Northwest" and sets it to
// column B.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenTextDoesNotContain('Northwest')
                     .build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
textStringDer Text, den die Zelle nicht enthalten darf.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenTextEndsWith(text)

Hiermit legen Sie die Filterkriterien fest, damit Zellen mit Text angezeigt werden, der mit dem angegebenen Text endet. Bei dem Text wird die Groß- und Kleinschreibung nicht berücksichtigt.

Sie können diese Kriterien mit jedem Filtertyp verwenden.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells with text that ends with "est" and sets it
// to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenTextEndsWith('est').build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
textStringText, der am Ende des Zellentexts stehen muss.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenTextEqualTo(text)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit Text angezeigt werden, der mit dem angegebenen Text übereinstimmt. Bei dem Text wird die Groß- und Kleinschreibung nicht berücksichtigt.

Sie können diese Kriterien mit jedem Filtertyp verwenden.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells with text that equals "hello" and sets it
// to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenTextEqualTo('hello').build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
textStringDer Text, mit dem der Text der Zelle übereinstimmen muss.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenTextEqualToAny(texts)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit Text angezeigt werden, der mit einem der angegebenen Textwerte übereinstimmt. Bei dem Text wird nicht zwischen Groß- und Kleinschreibung unterschieden.

Sie können diese Kriterien nur für Daten verwenden, die mit einer Datenbank verbunden sind. Sie können diese Kriterien beispielsweise mit Filtern auf einem DataSource-Tabellenblatt, einem Tabellenblatt, das mit einer Datenbank verbunden ist, oder einer DataSourcePivotTable (Pivot-Tabelle, die aus einem DataSource-Tabellenblatt erstellt wurde) verwenden.

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that shows cells with the text "tech"
// or "business."
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenTextEqualToAny(['tech', 'business'])
                     .build();
dataSheet.addFilter('category', criteria);

Parameter

NameTypBeschreibung
textsString[]Die Textwerte, denen eine Zelle entsprechen muss.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenTextNotEqualTo(text)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit Text angezeigt werden, der nicht mit dem angegebenen Text übereinstimmt. Bei dem Text wird die Groß- und Kleinschreibung nicht berücksichtigt.

Sie können diese Kriterien nur für Daten verwenden, die mit einer Datenbank verbunden sind. Sie können diese Kriterien beispielsweise mit Filtern auf einem DataSource-Tabellenblatt, einem Tabellenblatt, das mit einer Datenbank verbunden ist, oder einer DataSourcePivotTable (Pivot-Tabelle, die aus einem DataSource-Tabellenblatt erstellt wurde) verwenden.

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that hides cells with text equal to
// "tech."
const criteria =
    SpreadsheetApp.newFilterCriteria().whenTextNotEqualTo('tech').build();
dataSheet.addFilter('category', criteria);

Parameter

NameTypBeschreibung
textStringDer Text, der nicht mit dem Text der Zelle übereinstimmen darf.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenTextNotEqualToAny(texts)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit Text angezeigt werden, der mit keinem der angegebenen Werte übereinstimmt. Bei dem Text wird nicht zwischen Groß- und Kleinschreibung unterschieden.

Sie können diese Kriterien nur für Daten verwenden, die mit einer Datenbank verbunden sind. Sie können diese Kriterien beispielsweise mit Filtern auf einem DataSource-Tabellenblatt, einem Tabellenblatt, das mit einer Datenbank verbunden ist, oder einer DataSourcePivotTable (Pivot-Tabelle, die aus einem DataSource-Tabellenblatt erstellt wurde) verwenden.

// Gets the sheet that's connected to a database.
const ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Data Sheet');
const dataSheet = ss.asDataSourceSheet();
// Adds criteria to the "category" column that hides cells with the text "tech"
// or "business."
const criteria = SpreadsheetApp.newFilterCriteria()
                     .whenTextNotEqualToAny(['tech', 'business'])
                     .build();
dataSheet.addFilter('category', criteria);

Parameter

NameTypBeschreibung
textsString[]Die Textwerte, die eine Zelle nicht haben darf.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


whenTextStartsWith(text)

Hiermit werden die Filterkriterien so festgelegt, dass Zellen mit Text angezeigt werden, der mit dem angegebenen Text beginnt. Bei dem Text wird die Groß- und Kleinschreibung nicht berücksichtigt.

Sie können diese Kriterien mit jedem Filtertyp verwenden.

// Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Creates criteria that shows cells with text that starts with "pre" and sets
// it to column B.
const criteria =
    SpreadsheetApp.newFilterCriteria().whenTextStartsWith('pre').build();
filter.setColumnFilterCriteria(2, criteria);

Parameter

NameTypBeschreibung
textStringText, der am Anfang des Zellentexts stehen muss.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.


withCriteria(criteria, args)

Die Filterkriterien werden auf eine boolesche Bedingung festgelegt, die durch BooleanCriteria-Werte wie CELL_EMPTY oder NUMBER_GREATER_THAN definiert ist. Wenn Sie die boolesche Bedingung aus vorhandenen Kriterien kopieren möchten, definieren Sie die Parameter für diese Methode mit getCriteriaType() und getCriteriaValues() in einem vorhandenen Kriterium.

Sie können diese Kriterien mit jedem Filtertyp verwenden, einige BooleanCriteria sind jedoch nicht für alle Filter geeignet.

// Builds a filter criteria that is based on existing boolean conditions from
// another criteria. Gets the existing filter on the sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Gets the existing boolean conditions applied to Column B and adds criteria to
// column C that has the same boolean conditions and additional criteria that
// hides the value, "Northwest."
const filterCriteria = filter.getColumnFilterCriteria(2);
const criteria = SpreadsheetApp.newFilterCriteria()
                     .withCriteria(
                         filterCriteria.getCriteriaType(),
                         filterCriteria.getCriteriaValues(),
                         )
                     .setHiddenValues(['Northwest'])
                     .build();
filter.setColumnFilterCriteria(3, criteria);

Parameter

NameTypBeschreibung
criteriaBooleanCriteriaDer Typ der booleschen Kriterien.
argsObject[]Ein Array von Argumenten, das dem Kriterientyp entspricht. Die Anzahl der Argumente und ihr Typ stimmen mit den entsprechenden when...()-Methoden oben überein.

Rückflug

FilterCriteriaBuilder – Dieser Builder zur Verkettung.