Class FilterCriteria

FilterCriteria

Verwenden Sie diese Klasse, um Informationen zu erhalten oder die Kriterien für vorhandene Filter zu kopieren.

Übliche Anwendungsbereiche

Kriterien kopieren

Im folgenden Beispiel werden die Filter und Kriterien für den Bereich A1:C20 abgerufen. auf Spalte C angewendet und kopiert die Kriterien in Spalte B.
let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
// Copies the filter criteria applied to column C.
let filter = range.getFilter();
let 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 protokolliert die Werte aus Spalte B, die der Filter ausblendet.
let ss = SpreadsheetApp.getActiveSheet();
let range = ss.getRange("A1:C20");
let filter = range.getFilter();
// Gets the filter criteria applied to column B, then gets the hidden values.
let filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
// Logs the hidden values.
console.log(filterCriteria);

Methoden

MethodeRückgabetypKurzbeschreibung
copy()FilterCriteriaBuilderKopiert dieses Filterkriterium und erstellt eine Kriterienerstellung, die Sie auf ein anderes anwenden können aus.
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()ColorGibt die Hintergrundfarbe zurück, 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 Filter für Pivot-Tabellen angezeigt werden.

Detaillierte Dokumentation

copy()

Kopiert dieses Filterkriterium und erstellt eine Kriterienerstellung, die Sie auf ein anderes anwenden können aus.

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

let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Makes a copy of the filter criteria applied to column C.
let 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 zur Erstellung von Filterkriterien, der auf diesen Filterkriterien basiert.


getCriteriaType()

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

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

Sie können diese Methode für jeden Filtertyp verwenden. Wenn das Filterkriterium kein boolescher Wert ist Bedingung verwendet wird, wird null zurückgegeben.

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

Rückflug

BooleanCriteria: Der Typ des booleschen Kriteriums oder null, wenn das Kriterium kein boolescher Wert ist .


getCriteriaValues()

Gibt ein Array von Argumenten für boolesche Kriterien zurück. Einige boolesche Kriterientypen enthalten keine 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 sie zu ersetzen vorhandenen Kriterien.

  • Verwenden Sie getCriteriaType(), um den booleschen Kriterientyp abzurufen.
  • Informationen zur Verwendung des Kriterientyps und der Kriterienwerte zum Erstellen oder Ändern von Filterkriterien finden Sie unter FilterCriteriaBuilder.withCriteria(criteria, args)

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

    let ss = SpreadsheetApp.getActiveSheet();
    let 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.
    let 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 mit der entsprechenden when...()-Methode der FilterCriteriaBuilder-Klasse übereinstimmt.


getHiddenValues()

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

Verwenden Sie dieses Kriterium mit Filtern für Grid Tabellenblätter, dem Standardtabellenblatttyp. Gibt null zurück, wenn Sie diese Methode für andere Filtertypen aufrufen.

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

Rückflug

String[]: Ein Array von Werten, die der Filter ausblendet.


getVisibleBackgroundColor()

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

Verwenden Sie dieses Kriterium mit Filtern für Grid Tabellenblätter, dem Standardtabellenblatttyp. Gibt null zurück, wenn Sie diese Methode für andere Filtertypen aufrufen.

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

Rückflug

Color: Die als Filterkriterien verwendete Hintergrundfarbe.


getVisibleForegroundColor()

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

Verwenden Sie dieses Kriterium mit Filtern für Grid Tabellenblätter, dem Standardtabellenblatttyp. Gibt null zurück, wenn Sie diese Methode für andere Filtertypen aufrufen.

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

Rückflug

Color: Die als Filterkriterium verwendete Vordergrundfarbe.


getVisibleValues()

Gibt die Werte zurück, die im Filter für Pivot-Tabellen angezeigt werden.

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

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

Rückflug

String[]: Ein Array von Werten, die der Filter für die Pivot-Tabelle anzeigt.