Class Filter

フィルタ

このクラスを使用して、デフォルトのシートタイプ Grid シートの既存のフィルタを変更します。グリッドシートは、データベースに接続されていないデータを含む通常のシートです。

シート上にフィルタが存在しない場合は、Range.createFilter() を使用してフィルタを作成します。

このクラスを使用するには、まず Range.getFilter() または Sheet.getFilter() を使用してグリッドシート フィルタにアクセスする必要があります。

一般的な用途

フィルタを削除する

以下のサンプルでは、アクティブ シート上のフィルタを取得して削除します。
let ss = SpreadsheetApp.getActiveSheet();
let filter = ss.getFilter();
// Removes the filter from the active sheet.
filter.remove();

フィルタが適用される範囲を取得します

以下のサンプルでは、アクティブなシートのフィルタを取得してから、このクラスの getRange() メソッドを使用して、フィルタが適用される範囲をログに記録します。
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());

Methods

方法戻り値の型概要
getColumnFilterCriteria(columnPosition)FilterCriteria指定された列のフィルタ条件を取得します。列にフィルタ条件が適用されていない場合は null を取得します。
getRange()Rangeこのフィルタが適用される範囲を取得します。
remove()voidこのフィルタを削除します。
removeColumnFilterCriteria(columnPosition)Filter指定した列からフィルタ条件を削除します。
setColumnFilterCriteria(columnPosition, filterCriteria)Filter指定した列にフィルタ条件を設定します。
sort(columnPosition, ascending)Filterフィルタされた範囲を、指定された列で並べ替えます。このフィルタが適用される範囲の最初の行(ヘッダー行)は除外します。

詳細なドキュメント

getColumnFilterCriteria(columnPosition)

指定された列のフィルタ条件を取得します。列にフィルタ条件が適用されていない場合は null を取得します。

フィルタ条件の詳細を取得するには、このメソッドを FilterCriteria クラスのメソッドと連鎖させます。

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

パラメータ

名前説明
columnPositionInteger列の 1 から始まる位置。たとえば、列 B のインデックスは 2 です。

戻る

FilterCriteria - フィルタ条件。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getRange()

このフィルタが適用される範囲を取得します。

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

戻る

Range - フィルタの範囲。A1 表記の範囲を取得するには、このメソッドを Range.getA1Notation() で連結します。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

remove()

このフィルタを削除します。

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

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

removeColumnFilterCriteria(columnPosition)

指定した列からフィルタ条件を削除します。

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

パラメータ

名前説明
columnPositionInteger列の 1 から始まる位置。たとえば、列 B のインデックスは 2 です。

戻る

Filter - チェーン用のフィルタ。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setColumnFilterCriteria(columnPosition, filterCriteria)

指定した列にフィルタ条件を設定します。まず、SpreadsheetApp.newFilterCriteria() を使用してフィルタ条件ビルダーを作成します。次に、FilterCriteriaBuilder クラスを使用してビルダーに条件を追加します。条件を作成したら、このメソッドの filterCriteria パラメータとして設定します。

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

パラメータ

名前説明
columnPositionInteger列の 1 から始まる位置。たとえば、列 B のインデックスは 2 です。
filterCriteriaFilterCriteria設定するフィルタ条件。条件を null に設定すると、指定した列からフィルタ条件が削除されます。removeColumnFilterCriteria(columnPosition) を使用することもできます。

戻る

Filter - チェーン用のフィルタ。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

sort(columnPosition, ascending)

フィルタが適用される範囲の最初の行(ヘッダー行)を除く、指定された列でフィルタされた範囲で並べ替えます。

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

パラメータ

名前説明
columnPositionInteger列の 1 から始まる位置。たとえば、列 B のインデックスは 2 です。
ascendingBooleantrue の場合、フィルタされた範囲を昇順で並べ替えます。false の場合、フィルタされた範囲を降順で並べ替えます。

戻る

Filter - チェーン用のフィルタ。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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