Class Filter

Filtrele

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

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

Bu sınıfı kullanmak için önce Range.getFilter() veya Sheet.getFilter() ile tablo 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.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

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

Aşağıdaki örnek, etkin sayfadaki filtreyi alır ve ardından şuradan getRange() yöntemini kullanır: bu sınıfı kullanın.
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());

Yöntemler

YöntemDönüş türüKısa açıklama
getColumnFilterCriteria(columnPosition)FilterCriteriaBelirtilen sütundaki filtre ölçütlerini veya sütunda hiç yoksa null filtre ölçütünün uygulanması anlamına gelir.
getRange()RangeBu filtrenin geçerli olduğu aralığı alır.
remove()voidBu filtreyi kaldırır.
removeColumnFilterCriteria(columnPosition)FilterFiltre ölçütlerini belirtilen sütundan kaldırır.
setColumnFilterCriteria(columnPosition, filterCriteria)FilterBelirtilen sütundaki filtre ölçütlerini ayarlar.
sort(columnPosition, ascending)FilterŞu sayfadaki ilk satırı (başlık satırı) hariç tutarak, filtrelenen aralığı belirtilen sütuna göre sıralar: filtrenin geçerli olduğu aralıktır.

Ayrıntılı belgeler

getColumnFilterCriteria(columnPosition)

Belirtilen sütundaki filtre ölçütlerini veya sütunda hiç yoksa null filtre ölçütünün uygulanması anlamına gelir.

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

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

Parametreler

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

Return

FilterCriteria: Filtre ölçütleri.

Yetkilendirme

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

  • 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.
let ss = SpreadsheetApp.getActiveSheet();
let 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österiminde aralığı almak için bu yöntemi Range.getA1Notation() ile zincirleyin.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.remove();

Yetkilendirme

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

  • 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.
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

Parametreler

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

Return

Filter — Zincirleme için filtre.

Yetkilendirme

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

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

setColumnFilterCriteria(columnPosition, filterCriteria)

Belirtilen sütundaki filtre ölçütlerini ayarlar. Öncelikle filtre ölçütü oluşturucuyu oluşturun SpreadsheetApp.newFilterCriteria() kullanılıyor. Ardından ölçüt oluşturucuya ekleyin (FilterCriteriaBuilder sınıfı kullanılıyor.) Kriterlerinizi oluşturduktan sonra, filterCriteria parametresi kullanmanız gerekir.

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

Parametreler

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

Return

Filter — Zincirleme için filtre.

Yetkilendirme

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

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

sort(columnPosition, ascending)

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

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

Parametreler

AdTürAçıklama
columnPositionIntegerSütunun 1 dizinli 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 filtre.

Yetkilendirme

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

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