Class Filter

Filter

Gunakan class ini untuk mengubah filter yang ada di sheet Grid, jenis default {i>sheet<i}. {i>Grid sheets<i} adalah {i>sheet<i} biasa dengan data yang tidak terhubung ke sebuah {i>database<i}.

Jika filter belum ada di sheet, buat filter menggunakan Range.createFilter().

Untuk menggunakan class ini, Anda harus mengakses filter sheet petak menggunakan Range.getFilter() atau Sheet.getFilter() terlebih dahulu.

Penggunaan umum

Menghapus filter

Contoh di bawah mendapatkan filter pada sheet yang aktif dan menghapusnya.

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

Mendapatkan rentang penerapan filter

Contoh di bawah mendapatkan filter pada sheet yang aktif, lalu menggunakan metode getRange() dari kelas ini untuk mencatat log rentang yang menerapkan filter.

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

Metode

Metode	Jenis hasil yang ditampilkan	Deskripsi singkat
getColumnFilterCriteria(columnPosition)	FilterCriteria	Mendapatkan kriteria filter pada kolom yang ditentukan, atau null jika kolom tidak memiliki kriteria filter yang diterapkan.
getRange()	Range	Mendapatkan rentang tempat filter ini diterapkan.
remove()	void	Menghapus filter ini.
removeColumnFilterCriteria(columnPosition)	Filter	Menghapus kriteria filter dari kolom yang ditentukan.
setColumnFilterCriteria(columnPosition, filterCriteria)	Filter	Menetapkan kriteria filter pada kolom yang ditentukan.
sort(columnPosition, ascending)	Filter	Mengurutkan rentang yang difilter menurut kolom yang ditentukan, tidak termasuk baris pertama (baris {i>header<i}) di rentang penerapan filter ini.

Dokumentasi mendetail

getColumnFilterCriteria(columnPosition)

Mendapatkan kriteria filter pada kolom yang ditentukan, atau null jika kolom tidak memiliki kriteria filter yang diterapkan.

Untuk mendapatkan detail selengkapnya tentang kriteria filter, rantaikan metode ini dengan metode dari Class 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);

Parameter

Nama	Jenis	Deskripsi
columnPosition	Integer	Posisi kolom terindeks 1. Misalnya, indeks kolom B adalah 2.

Pulang pergi

FilterCriteria — Kriteria filter.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

---

getRange()

Mendapatkan rentang tempat filter ini diterapkan.

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

Pulang pergi

Range — Rentang filter. Untuk mendapatkan rentang dalam notasi A1, rantai metode ini dengan Range.getA1Notation().

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

---

remove()

Menghapus filter ini.

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

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

---

removeColumnFilterCriteria(columnPosition)

Menghapus kriteria filter dari kolom yang ditentukan.

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

Parameter

Nama	Jenis	Deskripsi
columnPosition	Integer	Posisi kolom terindeks 1. Misalnya, indeks kolom B adalah 2.

Pulang pergi

Filter — Filter, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

---

setColumnFilterCriteria(columnPosition, filterCriteria)

Menetapkan kriteria filter pada kolom yang ditentukan. Pertama, buat pembuat kriteria filter menggunakan SpreadsheetApp.newFilterCriteria(). Kemudian, tambahkan kriteria ke builder menggunakan class FilterCriteriaBuilder. Setelah Anda membuat kriteria, tetapkan sebagai Parameter filterCriteria untuk metode ini.

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

Parameter

Nama	Jenis	Deskripsi
columnPosition	Integer	Posisi kolom terindeks 1. Misalnya, indeks kolom B adalah 2.
filterCriteria	FilterCriteria	Kriteria filter yang akan ditetapkan. Jika Anda menetapkan kriteria ke null, menghapus kriteria filter dari kolom yang ditentukan. Anda juga dapat menggunakan removeColumnFilterCriteria(columnPosition).

Pulang pergi

Filter — Filter, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

---

sort(columnPosition, ascending)

Mengurutkan rentang yang difilter menurut kolom yang ditentukan, tidak termasuk baris pertama (baris {i>header<i}) di rentang penerapan filter ini.

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

Parameter

Nama	Jenis	Deskripsi
columnPosition	Integer	Posisi kolom terindeks 1. Misalnya, indeks kolom B adalah 2.
ascending	Boolean	Jika true, mengurutkan rentang yang difilter dalam urutan menaik; jika false, mengurutkan rentang yang difilter dalam urutan menurun.

Pulang pergi

Filter — Filter, untuk perantaian.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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