このページは Cloud Translation API によって翻訳されました。

Class PivotTable

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

Methods

メソッド	戻り値の型	概要
`addCalculatedPivotValue(name, formula)`	`PivotValue`	指定された `name` を使用して、指定された `formula` から計算されたピボットテーブルに新しいピボット値を作成します。
`addColumnGroup(sourceDataColumn)`	`PivotGroup`	ピボットテーブル内で新しいピボット列のグループを定義します。
`addFilter(sourceDataColumn, filterCriteria)`	`PivotFilter`	ピボットテーブルの新しいピボットフィルタを作成します。
`addPivotValue(sourceDataColumn, summarizeFunction)`	`PivotValue`	指定された `summarizeFunction` でピボットテーブルの新しいピボット値を定義します。
`addRowGroup(sourceDataColumn)`	`PivotGroup`	ピボットテーブル内で新しいピボット行のグループを定義します。
`asDataSourcePivotTable()`	`DataSourcePivotTable`	ピボットテーブルが `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 - データソースのピボットテーブル。

承認

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