Class PivotTable

PivotTable

ピボットテーブルにアクセスして変更します。

メソッド

メソッド	戻り値の型	概要
addCalculatedPivotValue(name, formula)	PivotValue	指定された name を使用して、指定された formula から計算されたピボットテーブルに新しいピボット値を作成します。
addColumnGroup(sourceDataColumn)	PivotGroup	ピボットテーブルに新しいピボット列のグループ化を定義します。
addFilter(sourceDataColumn, filterCriteria)	PivotFilter	ピボットテーブルに新しいピボットフィルタを作成します。
addPivotValue(sourceDataColumn, summarizeFunction)	PivotValue	指定された summarizeFunction を使用して、ピボットテーブルに新しいピボット値を定義します。
addRowGroup(sourceDataColumn)	PivotGroup	ピボットテーブルに新しいピボット行のグループ化を定義します。
asDataSourcePivotTable()	DataSourcePivotTable|null	ピボットテーブルが DataSource にリンクされている場合は、ピボットテーブルをデータソース ピボットテーブルとして返します。それ以外の場合は null を返します。
getAnchorCell()	Range	このピボットテーブルが固定されているセルを表す Range を返します。
getColumnGroups()	PivotGroup[]	このピボットテーブルの列グループの順序付きリストを返します。
getFilters()	PivotFilter[]	このピボットテーブルのフィルタの順序付きリストを返します。
getPivotValues()	PivotValue[]	このピボットテーブルのピボット値の順序付きリストを返します。
getRowGroups()	PivotGroup[]	このピボットテーブルの行グループの順序付きリストを返します。
getSourceDataRange()	Range	ピボットテーブルの作成元となるソースデータ範囲を返します。
getValuesDisplayOrientation()	Dimension	値が行として表示されるか、列として表示されるかを返します。
remove()	void	このピボットテーブルを削除します。
setValuesDisplayOrientation(dimension)	PivotTable	このピボットテーブルのレイアウトを設定して、値を列または行として表示します。

詳細なドキュメント

addCalculatedPivotValue(name, formula)

指定された name を使用して、指定された formula から計算されたピボットテーブルに新しいピボット値を作成します。

パラメータ

名前	タイプ	説明
name	String	この計算されたピボット値の名前。
formula	String	この値の計算に使用する数式。

戻る

PivotValue - 新しく作成された PivotValue

承認

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

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

---

addColumnGroup(sourceDataColumn)

ピボットテーブルに新しいピボット列のグループ化を定義します。指定された sourceDataColumn は、このグループ化の基準となるソースデータの列を示します。

パラメータ

名前	タイプ	説明
sourceDataColumn	Integer	このグループが集計する列の番号。このインデックスは、 スプレッドシート内の列の絶対数を表します。1は列 A、 2は列 B などです。

戻る

PivotGroup - 新しく作成された PivotGroup

承認

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

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

---

addFilter(sourceDataColumn, filterCriteria)

ピボットテーブルに新しいピボットフィルタを作成します。指定された sourceDataColumn は、このフィルタが動作するソースデータの列を示します。

パラメータ

名前	タイプ	説明
sourceDataColumn	Integer	このグループが集計する列の番号。このインデックスは、 スプレッドシート内の列の絶対数を表します。1は列 A、 2は列 B などです。
filterCriteria	FilterCriteria	フィルタリングの実行に使用するフィルタ条件。

戻る

PivotFilter - 新しく作成された PivotFilter

承認

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

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

---

addPivotValue(sourceDataColumn, summarizeFunction)

指定された summarizeFunction を使用して、ピボットテーブルに新しいピボット値を定義します。指定された sourceDataColumn は、この値の基準となるソースデータの列を示します。

パラメータ

名前	タイプ	説明
sourceDataColumn	Integer	このグループが集計する列の番号。このインデックスは、 スプレッドシート内の列の絶対数を表します。1は列 A、 2は列 B などです。
summarizeFunction	PivotTableSummarizeFunction

戻る

PivotValue - 新しく作成された PivotValue

承認

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

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

---

addRowGroup(sourceDataColumn)

ピボットテーブルに新しいピボット行のグループ化を定義します。指定された sourceDataColumn は、このグループ化の基準となるソースデータの列を示します。

パラメータ

名前	タイプ	説明
sourceDataColumn	Integer	このグループが集計する列の番号。このインデックスは、 スプレッドシート内の列の絶対数を表します。1は列 A、 2は列 B などです。

戻る

PivotGroup - 新しく作成された PivotGroup

承認

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

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

---

asDataSourcePivotTable()

ピボットテーブルが DataSource にリンクされている場合は、ピボットテーブルをデータソース ピボットテーブルとして返します。それ以外の場合は null を返します。

戻る

DataSourcePivotTable|null - データソース ピボットテーブル。

承認

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

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

---

getAnchorCell()

このピボットテーブルが固定されているセルを表す Range を返します。

戻る

Range - このピボットテーブルのアンカーセル

承認

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

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

---

getColumnGroups()

このピボットテーブルの列グループの順序付きリストを返します。

戻る

PivotGroup[] - このピボットテーブルの列グループ

承認

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

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

---

getFilters()

このピボットテーブルのフィルタの順序付きリストを返します。

戻る

PivotFilter[] - このピボットテーブルのフィルタ

承認

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

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

---

getPivotValues()

このピボットテーブルのピボット値の順序付きリストを返します。

戻る

PivotValue[] - このピボットテーブルのピボット値

承認

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

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

---

getRowGroups()

このピボットテーブルの行グループの順序付きリストを返します。

戻る

PivotGroup[] - このピボットテーブルの行グループ

承認

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

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

---

getSourceDataRange()

ピボットテーブルの作成元となるソースデータ範囲を返します。

戻る

Range - このピボットテーブルのソースデータ範囲。

承認

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

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

---

getValuesDisplayOrientation()

値が行として表示されるか、列として表示されるかを返します。

戻る

Dimension - 値が行として表示されるか、列として表示されるか

承認

このメソッドを使用するスクリプトには、次の 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

---

setValuesDisplayOrientation(dimension)

このピボットテーブルのレイアウトを設定して、値を列または行として表示します。

パラメータ

名前	タイプ	説明
dimension	Dimension	ピボット値の表示方法を示すディメンション。

戻る

PivotTable - 連結用のピボットテーブル

承認

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

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