Class PivotGroup

PivotGroup

ピボット テーブルのブレイクアウト グループにアクセスして変更します。

メソッド

メソッド戻り値の型概要
addManualGroupingRule(groupName, groupMembers)PivotGroupこのピボット グループの手動グループ化ルールを追加します。
areLabelsRepeated()Booleanラベルが繰り返し表示されるかどうかを返します。
clearGroupingRule()PivotGroupこのピボット グループからグループ化ルールを削除します。
clearSort()PivotGroupこのグループに適用されている並べ替えを削除します。
getDateTimeGroupingRule()DateTimeGroupingRule|nullピボット グループの日時のグループ化ルールを返します。日時のグループ化ルールが設定されていない場合は null を返します。
getDimension()Dimensionこれが行グループか列グループかを返します。
getGroupLimit()PivotGroupLimit|nullピボット グループのピボット グループの上限を返します。
getIndex()Integer現在のグループ順序におけるこのピボット グループのインデックスを返します。
getPivotTable()PivotTableこのグループが属する PivotTable を返します。
getSourceDataColumn()Integerこのグループが要約するソースデータ列の数を返します。
getSourceDataSourceColumn()DataSourceColumn|nullピボット グループが動作するデータソース列を返します。
hideRepeatedLabels()PivotGroupこのグループの重複するラベルを非表示にします。
isSortAscending()Boolean並べ替えが昇順の場合は true を返し、並べ替え順序が降順の場合は false を返します。
moveToIndex(index)PivotGroupこのグループを、行グループまたは列グループの現在のリスト内の指定された位置に移動します。
remove()voidこのピボット グループをテーブルから削除します。
removeManualGroupingRule(groupName)PivotGroup指定された groupName の手動グループ化ルールを削除します。
resetDisplayName()PivotGroupピボット テーブル内のこのグループの表示名をデフォルト値にリセットします。
setDateTimeGroupingRule(dateTimeGroupingRuleType)PivotGroupピボット グループに日時のグループ化ルールを設定します。
setDisplayName(name)PivotGroupピボット テーブルでこのグループの表示名を設定します。
setGroupLimit(countLimit)PivotGroupピボット グループのピボット グループの上限を設定します。
setHistogramGroupingRule(minValue, maxValue, intervalSize)PivotGroupこのピボット グループのヒストグラム グループ化ルールを設定します。
showRepeatedLabels()PivotGroup行または列のグループ化が複数ある場合、このメソッドは、後続のグループ化の各エントリに対して、このグループ化のラベルを表示します。
showTotals(showTotals)PivotGroupこのピボット グループの合計値を表に表示するかどうかを設定します。
sortAscending()PivotGroup並べ替え順を昇順に設定します。
sortBy(value, oppositeGroupValues)PivotGroupこのグループを、oppositeGroupValues の値の指定された PivotValue で並べ替えます。
sortDescending()PivotGroup並べ替え順を降順に設定します。
totalsAreShown()Booleanこのピボット グループの合計値が現在表示されているかどうかを返します。

詳細なドキュメント

addManualGroupingRule(groupName, groupMembers)

このピボット グループの手動グループ化ルールを追加します。

パラメータ

名前説明
groupNameStringこのグループ化ルールの名前。
groupMembersObject[]このグループ化ルールに含まれる値。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

areLabelsRepeated()

ラベルが繰り返し表示されるかどうかを返します。

戻る

Boolean - ラベルが繰り返されている場合は true、それ以外の場合は false を返します。

承認

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

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

clearGroupingRule()

このピボット グループからグループ化ルールを削除します。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

clearSort()

このグループに適用されている並べ替えを削除します。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

getDateTimeGroupingRule()

ピボット グループの日時のグループ化ルールを返します。日時のグループ化ルールが設定されていない場合は null を返します。

戻る

DateTimeGroupingRule|null - 日時のグループ化ルール。

承認

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

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

getDimension()

これが行グループか列グループかを返します。

戻る

Dimension - このグループのタイプを表すディメンション

承認

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

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

getGroupLimit()

ピボット グループのピボット グループの上限を返します。ピボット グループの上限が設定されていない場合は null を返します。

戻る

PivotGroupLimit|null - ピボット グループの上限。

承認

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

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

getIndex()

現在のグループ順序におけるこのピボット グループのインデックスを返します。

戻る

Integer - ピボット グループのインデックス

承認

このメソッドを使用するスクリプトには、次の 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|null - ピボット グループが処理するデータソースの列。

承認

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

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

hideRepeatedLabels()

このグループの重複するラベルを非表示にします。ラベルがすでに非表示になっている場合、このメソッドは何も行いません。複数の行または列のグループ化が行われる前にこのメソッドが呼び出された場合、追加のグループ化が追加されると、繰り返されるラベルが非表示になります。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

isSortAscending()

並べ替えが昇順の場合は true を返し、並べ替え順序が降順の場合は false を返します。

戻る

Boolean - 並べ替え順序が昇順の場合の true

承認

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

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

moveToIndex(index)

このグループを、行グループまたは列グループの現在のリスト内の指定された位置に移動します。これらのインデックスは 0 ベースです。たとえば、このグループを最初の位置に移動する場合は、このメソッドを 0 で呼び出す必要があります。

パラメータ

名前説明
indexIntegerこのグループを移動するインデックス。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

removeManualGroupingRule(groupName)

指定された groupName の手動グループ化ルールを削除します。

パラメータ

名前説明
groupNameString削除するグループ化ルールの名前。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

resetDisplayName()

ピボット テーブル内のこのグループの表示名をデフォルト値にリセットします。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

setDateTimeGroupingRule(dateTimeGroupingRuleType)

ピボット グループの日時のグループ化ルールを設定します。

ルールを削除するには、clearGroupingRule() を使用します。

パラメータ

名前説明
dateTimeGroupingRuleTypeDateTimeGroupingRuleType設定するルールのタイプ。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

setDisplayName(name)

ピボット テーブルでこのグループの表示名を設定します。

パラメータ

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

戻る

PivotGroup - チェーン用のピボット グループ

承認

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

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

setGroupLimit(countLimit)

ピボット グループのピボット グループの上限を設定します。このオペレーションは DataSourcePivotTable でのみサポートされています。

パラメータ

名前説明
countLimitInteger設定する行または列のカウント上限。正の値である必要があります。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

setHistogramGroupingRule(minValue, maxValue, intervalSize)

このピボット グループのヒストグラム グループ化ルールを設定します。ヒストグラム ルールは、ソースデータ列の値を一定サイズのバケットに整理します。minValue から maxValue までのすべての値が、サイズ interval のグループに配置されます。minValue より小さい値はすべて 1 つのバケットに配置され、maxValue より大きい値もすべて 1 つのバケットに配置されます。

パラメータ

名前説明
minValueIntegerアイテムをバケットに配置するための最小値。これより小さい値は 1 つのバケットにまとめられます。
maxValueIntegerバケットに配置するアイテムの最大値。これより大きい値は 1 つのバケットにまとめられます。
intervalSizeInteger

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

showRepeatedLabels()

行または列のグループ化が複数ある場合、このメソッドは、後続のグループ化の各エントリに対して、このグループ化のラベルを表示します。ラベルがすでに繰り返されている場合、このメソッドは何も行いません。複数の行または列のグループ化が行われる前にこのメソッドが呼び出されると、追加のグループ化が追加されたときに繰り返されたラベルが表示されます。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

showTotals(showTotals)

このピボット グループの合計値を表に表示するかどうかを設定します。

パラメータ

名前説明
showTotalsBoolean合計を表示するかどうか。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

sortAscending()

並べ替え順を昇順に設定します。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

sortBy(value, oppositeGroupValues)

このグループを、oppositeGroupValues の値の指定された PivotValue で並べ替えます。

// Sorts the item group by the "SUM of Quantity" pivot value for the specified
// salespersons.
const sheet = SpreadsheetApp.getActiveSheet();
const pivotTable = sheet.getPivotTables()[0];
const itemGroup = pivotTable.getRowGroups()[0];
const sumQuantityValue = pivotTable.getPivotValues()[0];
itemGroup.sortBy(sumQuantityValue, ['Beth', 'Amir', 'Devyn']);

パラメータ

名前説明
valuePivotValue並べ替えの基準となるピボット値。
oppositeGroupValuesObject[]並べ替えに使用される反対側のピボット グループ(行グループを並べ替える場合は列グループ、列グループを並べ替える場合は行グループ)の値。これらの値の順序によって、タイブレークの優先順位が決まります。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

sortDescending()

並べ替え順を降順に設定します。

戻る

PivotGroup - チェーン用のピボット グループ。

承認

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

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

totalsAreShown()

このピボット グループの合計値が現在表示されているかどうかを返します。

戻る

Boolean - このピボット グループの合計値が表示される場合は true、それ以外の場合は false を返します。

承認

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

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