Class Filter

Filtrele

Varsayılan sayfa türü olan Grid sayfalarındaki mevcut filtreleri değiştirmek için bu sınıfı kullanın. Tablo sayfaları, bir veritabanına bağlı olmayan verileri içeren normal sayfalardır.

Sayfada henüz bir filtre yoksa Range.createFilter() simgesini kullanarak filtre oluşturun.

Bu sınıfı kullanmak için önce Range.getFilter() veya Sheet.getFilter() kullanarak ızgara sayfası filtresine erişmeniz gerekir.

Yaygın kullanım alanları

Filtre kaldırma

Aşağıdaki örnekte, etkin sayfadaki filtre alınır ve kaldırılır.

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

Filtrenin geçerli olduğu aralığı alma

Aşağıdaki örnek, etkin sayfadaki filtreyi alır ve ardından filtrenin uygulandığı aralığı günlüğe kaydetmek için bu sınıftaki getRange() yöntemini kullanır.

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

Yöntemler

Yöntem	Dönüş türü	Kısa açıklama
getColumnFilterCriteria(columnPosition)	FilterCriteria	Belirtilen sütundaki filtre ölçütlerini veya sütuna filtre ölçütü uygulanmamışsa null değerini alır.
getRange()	Range	Bu filtrenin geçerli olduğu aralığı alır.
remove()	void	Bu filtreyi kaldırır.
removeColumnFilterCriteria(columnPosition)	Filter	Filtre ölçütlerini belirtilen sütundan kaldırır.
setColumnFilterCriteria(columnPosition, filterCriteria)	Filter	Belirtilen sütunda filtre ölçütlerini ayarlar.
sort(columnPosition, ascending)	Filter	Bu filtrenin geçerli olduğu aralıktaki ilk satır (başlık satırı) hariç, filtrelenen aralığı belirtilen sütuna göre sıralar.

Ayrıntılı dokümanlar

getColumnFilterCriteria(columnPosition)

Belirtilen sütundaki filtre ölçütlerini veya sütuna filtre ölçütü uygulanmamışsa null değerini alır.

Filtre ölçütleri hakkında daha fazla bilgi edinmek için bu yöntemi FilterCriteria sınıfındaki yöntemlerle zincirleyin.

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

Parametreler

Ad	Tür	Açıklama
columnPosition	Integer	Sütunun 1 tabanlı dizini. Örneğin, B sütununun dizini 2'dir.

Return

FilterCriteria: Filtre ölçütleri.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

---

getRange()

Bu filtrenin geçerli olduğu aralığı alır.

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

Return

Range: Filtrenin aralığı. A1 gösterimindeki aralığı almak için bu yöntemi Range.getA1Notation() ile zincirleyin.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

---

remove()

Bu filtreyi kaldırır.

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

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

---

removeColumnFilterCriteria(columnPosition)

Filtre ölçütlerini belirtilen sütundan kaldırır.

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

Parametreler

Ad	Tür	Açıklama
columnPosition	Integer	Sütunun 1 tabanlı dizini. Örneğin, B sütununun dizini 2'dir.

Return

Filter: Zincirleme için filtre.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

---

setColumnFilterCriteria(columnPosition, filterCriteria)

Belirtilen sütunda filtre ölçütlerini ayarlar. Öncelikle SpreadsheetApp.newFilterCriteria() kullanarak filtre ölçütleri oluşturucuyu oluşturun. Ardından FilterCriteriaBuilder sınıfını kullanarak oluşturucuya ölçütler ekleyin. Ölçütlerinizi oluşturduktan sonra bu yöntemin filterCriteria parametresi olarak ayarlayın.

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

Parametreler

Ad	Tür	Açıklama
columnPosition	Integer	Sütunun 1 tabanlı dizini. Örneğin, B sütununun dizini 2'dir.
filterCriteria	FilterCriteria	Ayarlanacak filtre ölçütleri. Ölçütleri null olarak ayarlarsanız filtre ölçütleri, belirtilen sütundan kaldırılır. removeColumnFilterCriteria(columnPosition) simgesini de kullanabilirsiniz.

Return

Filter: Zincirleme için filtre.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

---

sort(columnPosition, ascending)

Bu filtrenin geçerli olduğu aralıktaki ilk satır (başlık satırı) hariç, filtrelenen aralığı belirtilen sütuna göre sıralar.

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

Parametreler

Ad	Tür	Açıklama
columnPosition	Integer	Sütunun 1 tabanlı dizini. Örneğin, B sütununun dizini 2'dir.
ascending	Boolean	true ise filtrelenen aralığı artan düzende, false ise azalan düzende sıralar.

Return

Filter: Zincirleme için filtre.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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