Class Filter

Filter

Gunakan class ini untuk mengubah filter yang ada di sheet Grid, jenis sheet default. Sheet petak adalah sheet biasa dengan data yang tidak terhubung ke database.

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

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

Penggunaan umum

Menghapus filter

Contoh di bawah mendapatkan filter pada sheet aktif dan menghapusnya. 
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

Mendapatkan rentang yang diterapkan filter

Contoh di bawah ini mendapatkan filter pada sheet aktif, lalu menggunakan metode getRange() dari class ini untuk mencatat rentang yang diterapkan filter. 
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());

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getColumnFilterCriteria(columnPosition)FilterCriteria|nullMendapatkan kriteria filter pada kolom yang ditentukan, atau null jika kriteria filter tidak diterapkan pada kolom tersebut.
getRange()RangeMendapatkan rentang yang berlaku untuk filter ini.
remove()voidMenghapus filter ini.
removeColumnFilterCriteria(columnPosition)FilterMenghapus kriteria filter dari kolom yang ditentukan.
setColumnFilterCriteria(columnPosition, filterCriteria)FilterMenetapkan kriteria filter pada kolom yang ditentukan.
sort(columnPosition, ascending)FilterMengurutkan rentang yang difilter menurut kolom yang ditentukan, tidak termasuk baris pertama (baris header) dalam rentang yang menerapkan filter ini.

Dokumentasi mendetail

getColumnFilterCriteria(columnPosition)

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

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

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom yang diindeks 1. Misalnya, indeks kolom B adalah 2.

Pulang pergi

FilterCriteria|null — 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 yang berlaku untuk filter ini. 

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

Pulang pergi

Range — Rentang filter. Untuk mendapatkan rentang dalam notasi A1, gabungkan 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.
const ss = SpreadsheetApp.getActiveSheet();
const 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.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom yang diindeks 1. Misalnya, indeks kolom B adalah 2.

Pulang pergi

Filter — Filter, untuk penggabungan.

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 membuat kriteria, tetapkan kriteria tersebut sebagai parameter filterCriteria untuk metode ini. 

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

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom yang diindeks 1. Misalnya, indeks kolom B adalah 2.
filterCriteriaFilterCriteriaKriteria filter yang akan ditetapkan. Jika Anda menetapkan kriteria ke null, kriteria filter akan dihapus dari kolom yang ditentukan. Anda juga dapat menggunakan removeColumnFilterCriteria(columnPosition).

Pulang pergi

Filter — Filter, untuk penggabungan.

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 header) dalam rentang yang menerapkan filter ini. 

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

Parameter

NamaJenisDeskripsi
columnPositionIntegerPosisi kolom yang diindeks 1. Misalnya, indeks kolom B adalah 2.
ascendingBooleanJika true, mengurutkan rentang yang difilter dalam urutan menaik; jika false, mengurutkan rentang yang difilter dalam urutan menurun.

Pulang pergi

Filter — Filter, untuk penggabungan.

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