Class Filter

Filtr

Użyj tej klasy, aby zmodyfikować istniejące filtry w arkuszach Grid, czyli domyślnym typie arkusza. Arkusze siatki to zwykłe arkusze z danymi, które nie są połączone z bazą danych.

Jeśli na arkuszu nie ma jeszcze filtra, utwórz go za pomocą Range.createFilter().

Aby korzystać z tej klasy, musisz najpierw otworzyć filtr arkusza siatki, używając Range.getFilter() lub Sheet.getFilter().

Typowe zastosowania

Usuwanie filtra

Przykład poniżej pobiera filtr z aktywnego arkusza i usuwa go. 
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

Pobierz zakres, do którego ma zastosowanie filtr

Przykład poniżej pobiera filtr z aktywnego arkusza, a następnie za pomocą metody getRange() z tej klasy rejestruje zakres, do którego zastosowano filtr. 
const ss = SpreadsheetApp.getActiveSheet();
// Gets the existing filter on the active sheet.
const filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

Metody

MetodaZwracany typKrótki opis
getColumnFilterCriteria(columnPosition)FilterCriteriaPobiera kryteria filtra w wybranej kolumnie lub null, jeśli w kolumnie nie ma zastosowanych kryteriów filtra.
getRange()RangePobiera zakres, do którego ma być zastosowany filtr.
remove()voidUsuwa ten filtr.
removeColumnFilterCriteria(columnPosition)FilterUsuwa kryteria filtra z wybranej kolumny.
setColumnFilterCriteria(columnPosition, filterCriteria)FilterUstawia kryteria filtra w wybranej kolumnie.
sort(columnPosition, ascending)FilterSortuje odfiltrowany zakres według określonej kolumny, z wyjątkiem pierwszego wiersza (wiersza nagłówka) w zakresie, do którego ma zastosowanie ten filtr.

Szczegółowa dokumentacja

getColumnFilterCriteria(columnPosition)

Pobiera kryteria filtra w wybranej kolumnie lub null, jeśli w kolumnie nie ma zastosowanych kryteriów filtra.

Aby uzyskać więcej informacji o kryteriach filtra, połącz tę metodę z metodami z klasy FilterCriteria. 

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Gets the filter criteria applied to column B of the active sheet
// and logs the hidden values.
const filterCriteria = filter.getColumnFilterCriteria(2).getHiddenValues();
console.log(filterCriteria);

Parametry

NazwaTypOpis
columnPositionIntegerPozycja kolumny (z indeksem 1). Na przykład indeks kolumny B to 2.

Powrót

FilterCriteria – kryteria filtra.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange()

Pobiera zakres, do którego ma być zastosowany filtr. 

// Gets the existing filter on the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Logs the range that the filter applies to in A1 notation.
console.log(filter.getRange().getA1Notation());

Powrót

Range – zakres filtra. Aby uzyskać zakres w notacji A1, połącz tę metodę z funkcją Range.getA1Notation().

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

remove()

Usuwa ten filtr. 

// Removes the filter from the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.remove();

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeColumnFilterCriteria(columnPosition)

Usuwa kryteria filtra z wybranej kolumny. 

// Removes the filter criteria from column B.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

Parametry

NazwaTypOpis
columnPositionIntegerPozycja kolumny (z indeksem 1). Na przykład indeks kolumny B to 2.

Powrót

Filter – filtr do łańcucha.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnFilterCriteria(columnPosition, filterCriteria)

Ustawia kryteria filtra w wybranej kolumnie. Najpierw utwórz kreator kryteriów filtrowania za pomocą SpreadsheetApp.newFilterCriteria(). Następnie dodaj kryteria do kreatora, używając klasy FilterCriteriaBuilder. Po utworzeniu kryteriów ustaw je jako parametr filterCriteria dla tej metody. 

const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Builds the filter criteria to use as a parameter for setColumnFilterCriteria.
const criteria = SpreadsheetApp.newFilterCriteria()
                     .setHiddenValues(['Hello', 'World'])
                     .build();
// Sets the filter criteria for column C.
filter.setColumnFilterCriteria(3, criteria);

Parametry

NazwaTypOpis
columnPositionIntegerPozycja kolumny (z indeksem 1). Na przykład indeks kolumny B to 2.
filterCriteriaFilterCriteriaKryteria filtrowania do ustawienia. Jeśli ustawisz kryteria na null, zostaną one usunięte z kolumny. Możesz też użyć removeColumnFilterCriteria(columnPosition).

Powrót

Filter – filtr do łańcucha.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sort(columnPosition, ascending)

Sortuje odfiltrowany zakres według określonej kolumny, z wyjątkiem pierwszego wiersza (wiersza nagłówka) w zakresie, do którego ma zastosowanie ten filtr. 

// Gets the existing filter and sorts it by column B in ascending order.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.sort(2, true);

Parametry

NazwaTypOpis
columnPositionIntegerPozycja kolumny (z indeksem 1). Na przykład indeks kolumny B to 2.
ascendingBooleanJeśli true, filtrowany zakres jest sortowany w kolejności rosnącej; jeśli false, filtrowany zakres jest sortowany w kolejności malejącej.

Powrót

Filter – filtr do łańcucha.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets