Class Filter

Filtrele

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

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

Bu sınıfı kullanmak için önce Range.getFilter() veya Sheet.getFilter() kullanarak 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ığı alma

Aşağıdaki örnek, etkin sayfadaki filtreyi alır, ardından filtrenin uygulandığı aralığı günlüğe kaydetmek için bu sınıftaki getRange() yöntemini kullanır.
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 alır. Sütuna filtre ölçütleri uygulanmadıysa null değerini alır.
getRange()RangeBu filtrenin geçerli olduğu aralığı getirir.
remove()voidBu filtreyi kaldırır.
removeColumnFilterCriteria(columnPosition)FilterBelirtilen sütundan filtre ölçütlerini kaldırır.
setColumnFilterCriteria(columnPosition, filterCriteria)FilterBelirtilen sütundaki filtre ölçütlerini ayarlar.
sort(columnPosition, ascending)FilterBu filtrenin geçerli olduğu aralıktaki ilk satırı (başlık satırı) hariç tutarak, filtrelenen aralığı belirtilen sütuna göre sıralar.

Ayrıntılı belgeler

getColumnFilterCriteria(columnPosition)

Belirtilen sütundaki filtre ölçütlerini alır. Sütuna filtre ölçütleri uygulanmadıysa null değerini alır.

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

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 dizine eklenen 1 konumu. Örneğin, B sütununun dizini 2'dir.

Return

FilterCriteria: Filtre ölçütleri.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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ığı getirir.

// 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ığı. Aralığı A1 gösteriminde almak için bu yöntemi Range.getA1Notation() ile zincirleyin.

Yetkilendirme

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

Yetkilendirme

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

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

removeColumnFilterCriteria(columnPosition)

Belirtilen sütundan filtre ölçütlerini 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 dizine eklenen 1 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 kapsamların 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ütundaki filtre ölçütlerini ayarlar. Öncelikle SpreadsheetApp.newFilterCriteria() kullanarak filtre ölçütü oluşturucuyu oluşturun. Ardından FilterCriteriaBuilder sınıfını kullanarak ölçütleri oluşturucuya ekleyin. Ölçütlerinizi oluşturduktan sonra, bu yöntemin filterCriteria parametresi olarak ayarlayın.

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 dizine eklenen 1 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. Ayrıca removeColumnFilterCriteria(columnPosition) kullanabilirsiniz.

Return

Filter: Zincirleme için kullanılan filtre.

Yetkilendirme

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

  • 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ç tutarak, filtrelenen aralığı belirtilen sütuna göre sıralar.

// 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 dizine eklenen 1 konumu. Örneğin, B sütununun dizini 2'dir.
ascendingBooleantrue ise filtrelenen aralığı artan düzende, 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 kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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