Class Filter

フィルタ

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

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

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

一般的な使用例

フィルタを削除する

次のサンプルは、アクティブなシートのフィルタを取得して削除します。

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

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

次のサンプルでは、アクティブなシートのフィルタを取得し、このクラスの getRange() メソッドを使用して、フィルタが適用される範囲をログに記録します。

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

メソッド

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

詳細なドキュメント

getColumnFilterCriteria(columnPosition)

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

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

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

パラメータ

名前	型	説明
columnPosition	Integer	列の 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.
const ss = SpreadsheetApp.getActiveSheet();
const 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.
const ss = SpreadsheetApp.getActiveSheet();
const 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.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.removeColumnFilterCriteria(2);

パラメータ

名前	型	説明
columnPosition	Integer	列の 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 パラメータとして設定します。

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

パラメータ

名前	型	説明
columnPosition	Integer	列の 1 番目の位置。たとえば、列 B のインデックスは 2 です。
filterCriteria	FilterCriteria	設定するフィルタ条件。条件を 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.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();
filter.sort(2, true);

パラメータ

名前	型	説明
columnPosition	Integer	列の 1 番目の位置。たとえば、列 B のインデックスは 2 です。
ascending	Boolean	true の場合は、フィルタされた範囲を昇順で並べ替えます。false の場合は、フィルタされた範囲を降順で並べ替えます。

戻る

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

承認

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

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