Class PivotValue

PivotValue

ピボット テーブルの値グループにアクセスして変更できます。

Methods

メソッド戻り値の型概要
getDisplayType()PivotValueDisplayTypeこのピボット値が表で現在どのように表示されているかを示す表示タイプを返します。
getFormula()Stringこの値の計算に使用された数式を返します。
getPivotTable()PivotTableこの値が属する PivotTable を返します。
getSourceDataColumn()Integerピボット値が集計するソースデータ列の数を返します。
getSourceDataSourceColumn()DataSourceColumnピボット値が集計したデータソース列を返します。
getSummarizedBy()PivotTableSummarizeFunctionこのグループの要約関数を返します。
remove()voidピボット テーブルからこの値を削除します。
setDisplayName(name)PivotValueピボット テーブル内に、この値の表示名を設定します。
setFormula(formula)PivotValueこの値の計算に使用する数式を設定します。
showAs(displayType)PivotValueこの値をピボット テーブルに別の値の関数として表示します。
summarizeBy(summarizeFunction)PivotValue要約関数を設定します。

詳細なドキュメント

getDisplayType()

このピボット値が表で現在どのように表示されているかを示す表示タイプを返します。

リターン

PivotValueDisplayType - このピボット値の表示タイプ

承認

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

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

getFormula()

この値の計算に使用された数式を返します。この値が計算フィールドでない場合、このメソッドは null を返します。

リターン

String - チェーンのピボット値

承認

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

getSummarizedBy()

このグループの要約関数を返します。

リターン

PivotTableSummarizeFunction - グループの要約関数

承認

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

setDisplayName(name)

ピボット テーブル内に、この値の表示名を設定します。

パラメータ

名前型説明
nameString設定する表示名。

リターン

PivotValue - チェーンのピボット値

承認

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

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

setFormula(formula)

この値の計算に使用する数式を設定します。この値が計算フィールドでない場合、このメソッドはエラーになります。

パラメータ

名前型説明
formulaStringこの値の計算に使用する数式です。

リターン

PivotValue - チェーンのピボット値

承認

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

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

showAs(displayType)

この値をピボット テーブルに別の値の関数として表示します。

パラメータ

名前型説明
displayTypePivotValueDisplayType値の表示方法。

リターン

PivotValue - チェーンのピボット値

承認

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

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

summarizeBy(summarizeFunction)

要約関数を設定します。

パラメータ

名前型説明
summarizeFunctionPivotTableSummarizeFunctionこの値のソースデータ列のデータを集計するために使用する関数。

リターン

PivotValue - チェーンのピボット値

承認

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

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