Class PivotTable

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 から計算されたピボット テーブルに新しいピボット値を作成します。

パラメータ

名前型説明
nameStringこの計算されたピボット値の名前。
formulaStringこの値の計算に使用される数式。

リターン

PivotValue - 新しく作成された PivotValue

承認

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

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

addColumnGroup(sourceDataColumn)

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

パラメータ

名前型説明
sourceDataColumnIntegerこのグループで要約される列の数。このインデックスはスプレッドシート内の列の絶対数を表します。1 は列 A を表し、2 は列 B を表します。

リターン

PivotGroup - 新しく作成された PivotGroup

承認

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

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

addFilter(sourceDataColumn, filterCriteria)

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

パラメータ

名前型説明
sourceDataColumnIntegerこのグループで要約される列の数。このインデックスはスプレッドシート内の列の絶対数を表します。1 は列 A を表し、2 は列 B を表します。
filterCriteriaFilterCriteriaフィルタリングに使用するフィルタ条件。

リターン

PivotFilter - 新しく作成された PivotFilter

承認

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

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

addPivotValue(sourceDataColumn, summarizeFunction)

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

パラメータ

名前型説明
sourceDataColumnIntegerこのグループで要約される列の数。このインデックスはスプレッドシート内の列の絶対数を表します。1 は列 A を表し、2 は列 B を表します。
summarizeFunctionPivotTableSummarizeFunction

リターン

PivotValue - 新しく作成された PivotValue

承認

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

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

addRowGroup(sourceDataColumn)

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

パラメータ

名前型説明
sourceDataColumnIntegerこのグループで要約される列の数。このインデックスはスプレッドシート内の列の絶対数を表します。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)

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

パラメータ

名前型説明
dimensionDimensionピボット値の表示方法を示すディメンション。

リターン

PivotTable - チェーンのピボット テーブル

承認

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

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