Class Filter

Filtr

Użyj tej klasy do modyfikowania dotychczasowych filtrów w arkuszu Grid (domyślnym typem arkusza). Arkusze siatki to zwykłe arkusze z danymi, które nie są połączone z bazą danych.

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

Aby korzystać z tych zajęć, musisz najpierw uzyskać dostęp do filtra arkusza siatki, używając języka Range.getFilter() lub Sheet.getFilter().

Typowe zastosowania

Usuwanie filtra

Przykład poniżej pobiera i usuwa filtr z aktywnego arkusza. 
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 używa metody getRange() z tej klasy do zapisania 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 z określonej kolumny lub null, jeśli do kolumny nie zastosowano kryteriów filtrowania.
getRange()RangePobiera zakres, do którego ma zastosowanie ten filtr.
remove()voidUsuwa ten filtr.
removeColumnFilterCriteria(columnPosition)FilterUsuwa kryteria filtra z określonej kolumny.
setColumnFilterCriteria(columnPosition, filterCriteria)FilterUstawia kryteria filtrowania w określonej kolumnie.
sort(columnPosition, ascending)FilterSortuje odfiltrowany zakres według określonej kolumny, z wyłączeniem pierwszego wiersza (wiersza nagłówka) w zakresie, którego dotyczy ten filtr.

Szczegółowa dokumentacja

getColumnFilterCriteria(columnPosition)

Pobiera kryteria filtrowania z określonej kolumny lub null, jeśli do kolumny nie zastosowano kryteriów filtrowania.

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

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 w indeksie 1. Na przykład indeks kolumny B wynosi 2.

Powroty

FilterCriteria – kryteria filtrowania.

Upoważnienie

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());

Powroty

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

Upoważnienie

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();

Upoważnienie

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 filtra 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 w indeksie 1. Na przykład indeks kolumny B wynosi 2.

Powroty

Filter – filtr do łańcuchów.

Upoważnienie

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 filtrów za pomocą właściwości SpreadsheetApp.newFilterCriteria(). Następnie dodaj kryteria do kreatora za pomocą klasy FilterCriteriaBuilder. Po utworzeniu kryteriów ustaw je jako parametr filterCriteria w tej metodzie. 

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 w indeksie 1. Na przykład indeks kolumny B wynosi 2.
filterCriteriaFilterCriteriaKryteria filtra do ustawienia. Jeśli ustawisz kryteria na null, zostaną one usunięte z określonej kolumny. Możesz też użyć polecenia removeColumnFilterCriteria(columnPosition).

Powroty

Filter – filtr do łańcuchów.

Upoważnienie

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 odfiltrowany zakres według określonej kolumny, z wyłączeniem pierwszego wiersza (wiersza nagłówka) w zakresie, którego dotyczy 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 w indeksie 1. Na przykład indeks kolumny B wynosi 2.
ascendingBooleanJeśli ustawiona jest wartość true, filtrowany jest zakres w kolejności rosnącej. Jeśli wybierzesz argument false, zakres filtrowany jest sortowany w kolejności malejącej.

Powroty

Filter – filtr do łańcuchów.

Upoważnienie

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