Class PivotFilter

PivotFilter

ピボット テーブルのフィルタにアクセスして変更できます。

Methods

メソッド戻り値の型概要
getFilterCriteria()FilterCriteriaこのピボット フィルタのフィルタ条件を返します。
getPivotTable()PivotTableこのフィルタが属する PivotTable を返します。
getSourceDataColumn()Integerこのフィルタが適用されるソースデータ列の数を返します。
getSourceDataSourceColumn()DataSourceColumnフィルタが適用されるデータソース列を返します。
remove()voidピボット テーブルからこのピボット フィルタを削除します。
setFilterCriteria(filterCriteria)PivotFilterこのピボット フィルタのフィルタ条件を設定します。

詳細なドキュメント

getFilterCriteria()

このピボット フィルタのフィルタ条件を返します。

リターン

FilterCriteria - このピボット フィルタのフィルタ条件

承認

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

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

getPivotTable()

このフィルタが属する PivotTable を返します。

リターン

PivotTable - このフィルタが属するピボット テーブル

承認

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

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

getSourceDataColumn()

このフィルタが適用されるソースデータ列の数を返します。これらのインデックスは 1 から始まります。たとえば、このフィルタがスプレッドシートの列 A のデータに適用される場合、このメソッドは「1」を返します。

リターン

Integer - このフィルタが適用されるソースデータの列の数

承認

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

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

getSourceDataSourceColumn()

フィルタが適用されるデータソース列を返します。ピボット テーブルが {DataSourcePivotTableApi} でない場合、null を返します。

リターン

DataSourceColumn - フィルタが適用されるデータソース列。

承認

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

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

remove()

ピボット テーブルからこのピボット フィルタを削除します。

承認

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

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

setFilterCriteria(filterCriteria)

このピボット フィルタのフィルタ条件を設定します。

パラメータ

名前説明
filterCriteriaFilterCriteria設定するフィルタ条件。

リターン

PivotFilter - チェーンのピボット フィルタ

承認

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

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