Class 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)`

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

パラメータ

名前	タイプ	説明
`groupName`	`String`	このグループ化ルールの名前。
`groupMembers`	`Object[]`	このグループ化ルールに含まれる値。

戻る

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 で呼び出す必要があります。

パラメータ

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

戻る

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 の手動グループ化ルールを削除します。

パラメータ

名前	タイプ	説明
`groupName`	`String`	削除するグループ化ルールの名前。

戻る

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() を使用します。

パラメータ

名前	タイプ	説明
`dateTimeGroupingRuleType`	`DateTimeGroupingRuleType`	設定するルールのタイプ。

戻る

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

承認

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

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

`setDisplayName(name)`

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

パラメータ

名前	タイプ	説明
`name`	`String`	設定する表示名。

戻る

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

承認

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

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

`setGroupLimit(countLimit)`

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

パラメータ

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

戻る

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 つのバケットに配置されます。

パラメータ

名前	タイプ	説明
`minValue`	`Integer`	アイテムをバケットに配置するための最小値。これより小さい値は 1 つのバケットにまとめられます。
`maxValue`	`Integer`	バケットに配置するアイテムの最大値。これより大きい値は 1 つのバケットにまとめられます。
`intervalSize`	`Integer`

戻る

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)`

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

パラメータ

名前	タイプ	説明
`showTotals`	`Boolean`	合計を表示するかどうか。

戻る

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']);

パラメータ

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

戻る

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

Class PivotGroup コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

メソッド

詳細なドキュメント

addManualGroupingRule(groupName, groupMembers)

パラメータ

戻る

承認

areLabelsRepeated()

戻る

承認

clearGroupingRule()

戻る

承認

clearSort()

戻る

承認

getDateTimeGroupingRule()

戻る

承認

getDimension()

戻る

承認

getGroupLimit()

戻る

承認

getIndex()

戻る

承認

getPivotTable()

戻る

承認

getSourceDataColumn()

戻る

承認

getSourceDataSourceColumn()

戻る

承認

hideRepeatedLabels()

戻る

承認

isSortAscending()

戻る

承認

moveToIndex(index)

パラメータ

戻る

承認

remove()

承認

removeManualGroupingRule(groupName)

パラメータ

戻る

承認

resetDisplayName()

戻る

承認

setDateTimeGroupingRule(dateTimeGroupingRuleType)

パラメータ

戻る

承認

setDisplayName(name)

パラメータ

戻る

承認

setGroupLimit(countLimit)

パラメータ

戻る

承認

setHistogramGroupingRule(minValue, maxValue, intervalSize)

パラメータ

戻る

承認

showRepeatedLabels()

戻る

承認

showTotals(showTotals)

パラメータ

戻る

承認

sortAscending()

Class PivotGroup

`addManualGroupingRule(groupName, groupMembers)`

`areLabelsRepeated()`

`clearGroupingRule()`

`clearSort()`

`getDateTimeGroupingRule()`

`getDimension()`

`getGroupLimit()`

`getIndex()`

`getPivotTable()`

`getSourceDataColumn()`

`getSourceDataSourceColumn()`

`hideRepeatedLabels()`

`isSortAscending()`

`moveToIndex(index)`

`remove()`

`removeManualGroupingRule(groupName)`

`resetDisplayName()`

`setDateTimeGroupingRule(dateTimeGroupingRuleType)`

`setDisplayName(name)`

`setGroupLimit(countLimit)`

`setHistogramGroupingRule(minValue, maxValue, intervalSize)`

`showRepeatedLabels()`

`showTotals(showTotals)`

`sortAscending()`

`sortBy(value, oppositeGroupValues)`

`sortDescending()`

`totalsAreShown()`