Class Filter

Filtrele

Grid sayfalarındaki mevcut filtreleri değiştirmek için bu sınıfı kullanın. Bu sınıf, varsayılan sayfa türüdür. Tablo sayfaları, bir veritabanına bağlı olmayan verilerin bulunduğu normal sayfalardır.

E-tabloda henüz 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 örnek, etkin sayfadaki filtreyi alır ve kaldırır. 
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

Filtrenin uygulandığı 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öntemDönüş türüKısa açıklama
getColumnFilterCriteria(columnPosition)FilterCriteria|nullBelirtilen sütundaki filtre ölçütlerini veya sütunda filtre ölçütleri uygulanmamışsa null değerini alır.
getRange()RangeBu filtrenin uygulandığı aralığı alır.
remove()voidBu filtreyi kaldırır.
removeColumnFilterCriteria(columnPosition)FilterBelirtilen sütundaki filtre ölçütlerini kaldırır.
setColumnFilterCriteria(columnPosition, filterCriteria)FilterBelirtilen sütunda filtre ölçütlerini ayarlar.
sort(columnPosition, ascending)FilterFiltrelenmiş aralığı, bu filtrenin uygulandığı aralıktaki ilk satır (başlık satırı) hariç olmak üzere belirtilen sütuna göre sıralar.

Ayrıntılı belgeler

getColumnFilterCriteria(columnPosition)

Belirtilen sütundaki filtre ölçütlerini veya sütunda filtre ölçütleri 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

AdTürAçıklama
columnPositionIntegerSütunun 1 tabanlı dizin konumu. Örneğin, B sütununun dizini 2'dir.

Return

FilterCriteria|null: Filtre ölçütleri.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getRange()

Bu filtrenin uygulandığı 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ığı. Aralığı A1 biçiminde almak için bu yöntemi Range.getA1Notation() ile zincirleyin.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

  • 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ı, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

removeColumnFilterCriteria(columnPosition)

Belirtilen sütundaki filtre ölçütlerini kaldırır. 

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

Parametreler

AdTürAçıklama
columnPositionIntegerSütunun 1 tabanlı dizin konumu. Örneğin, B sütununun dizini 2'dir.

Return

Filter: Zincirleme için kullanılan filtre.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

  • 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çütü oluşturucuyu oluşturun. Ardından, FilterCriteriaBuilder sınıfını kullanarak oluşturucuya ölçütler ekleyin. Ölçütlerinizi oluşturduktan sonra bu yöntem için 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

AdTürAçıklama
columnPositionIntegerSütunun 1 tabanlı dizin konumu. Örneğin, B sütununun dizini 2'dir.
filterCriteriaFilterCriteriaAyarlanacak filtre ölçütleri. Ölçütleri null olarak ayarlarsanız filtre ölçütleri belirtilen sütundan kaldırılır. removeColumnFilterCriteria(columnPosition) aracını da kullanabilirsiniz.

Return

Filter: Zincirleme için kullanılan filtre.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

sort(columnPosition, ascending)

Filtrelenmiş aralığı, bu filtrenin uygulandığı aralıktaki ilk satır (başlık satırı) hariç olmak üzere 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

AdTürAçıklama
columnPositionIntegerSütunun 1 tabanlı dizin konumu. Örneğin, B sütununun dizini 2'dir.
ascendingBooleantrue ise filtrelenen aralığı artan düzende sıralar; false ise filtrelenen aralığı azalan düzende sıralar.

Return

Filter: Zincirleme için kullanılan filtre.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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