Class Filter

Filtr

Użyj tej klasy do modyfikowania istniejących filtrów w Grid arkuszach (domyślny typ: arkusza kalkulacyjnego. Arkusze siatki to zwykłe arkusze z danymi, które nie są połączone z bazą danych.

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

Aby używać tej klasy, musisz najpierw uzyskać dostęp do filtra arkusza siatki za pomocą właściwości Range.getFilter() lub Sheet.getFilter().

Typowe zastosowania

Usuwanie filtra

Poniższy przykład pokazuje filtr w aktywnym arkuszu i go usuwa. 
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

Pobierz zakres, do którego ma zastosowanie filtr

Poniższy przykład pobiera filtr w aktywnym arkuszu, a następnie wykorzystuje metodę getRange() z w celu zarejestrowania zakresu, do którego ma zastosowanie filtr. 
let ss = SpreadsheetApp.getActiveSheet();
// Gets the existing filter on the active sheet.
let 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 filtrowania w określonej kolumnie lub null, jeśli kolumna nie zawiera kryteria filtrowania.
getRange()RangePobiera zakres, do którego ma zastosowanie ten filtr.
remove()voidUsuwa ten filtr.
removeColumnFilterCriteria(columnPosition)FilterUsuwa kryteria filtrowania z określonej kolumny.
setColumnFilterCriteria(columnPosition, filterCriteria)FilterUstawia kryteria filtrowania w określonej kolumnie.
sort(columnPosition, ascending)FilterSortuje przefiltrowany zakres według określonej kolumny, z wyłączeniem pierwszego wiersza (wiersza nagłówka) w zakres, do którego ma zastosowanie ten filtr.

Szczegółowa dokumentacja

getColumnFilterCriteria(columnPosition)

Pobiera kryteria filtrowania w określonej kolumnie lub null, jeśli kolumna nie zawiera kryteria filtrowania.

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

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

Parametry

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

Powrót

FilterCriteria – kryteria filtrowania.

Autoryzacja

Skrypty korzystające 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 zastosowanie ten filtr. 

// Gets the existing filter on the active sheet.
let ss = SpreadsheetApp.getActiveSheet();
let 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ę w łańcuch za pomocą funkcji Range.getA1Notation().

Autoryzacja

Skrypty korzystające 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.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.remove();

Autoryzacja

Skrypty korzystające 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 filtrowania z określonej kolumny. 

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

Parametry

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

Powrót

Filter – filtr służący do tworzenia łańcuchów.

Autoryzacja

Skrypty korzystające 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 filtrowania w określonej kolumnie. Najpierw utwórz konstruktor kryteriów filtrowania za pomocą funkcji SpreadsheetApp.newFilterCriteria(). Następnie dodaj kryteria do kreatora za pomocą klasy FilterCriteriaBuilder. Po utworzeniu kryteriów ustaw je jako filterCriteria parametr dla tej metody. 

let ss = SpreadsheetApp.getActiveSheet();
let 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 zindeksowana. Na przykład indeks kolumny B to 2.
filterCriteriaFilterCriteriaKryteria filtra do ustawienia. Jeśli ustawisz kryteria na null, usuwa kryteria filtrowania z określonej kolumny. Możesz też użyć removeColumnFilterCriteria(columnPosition).

Powrót

Filter – filtr służący do tworzenia łańcuchów.

Autoryzacja

Skrypty korzystające 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 przefiltrowany zakres według określonej kolumny, z wyłączeniem pierwszego wiersza (wiersza nagłówka) w zakres, do którego ma zastosowanie ten filtr. 

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

Parametry

NazwaTypOpis
columnPositionIntegerPozycja kolumny z indeksem 1 zindeksowana. Na przykład indeks kolumny B to 2.
ascendingBooleanJeśli true, sortuje przefiltrowany zakres w kolejności rosnącej. jeśli false, sortuje przefiltrowany zakres w kolejności malejącej.

Powrót

Filter – filtr służący do tworzenia łańcuchów.

Autoryzacja

Skrypty korzystające 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