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

Class PivotGroup

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

メソッド

メソッド	戻り値の型	概要
`addManualGroupingRule(groupName, groupMembers)`	`PivotGroup`	このピボットグループの手動グループ化ルールを追加します。
`areLabelsRepeated()`	`Boolean`	ラベルが繰り返しとして表示されるかどうかを返します。
`clearGroupingRule()`	`PivotGroup`	このピボットグループからすべてのグループ化ルールを削除します。
`clearSort()`	`PivotGroup`	このグループに適用されている並べ替えをすべて削除します。
`getDateTimeGroupingRule()`	`DateTimeGroupingRule`	ピボットグループの日時のグループ化ルールを返します。日時のグループ化ルールが設定されていない場合は `null` を返します。
`getDimension()`	`Dimension`	行グループか列グループかを返します。
`getGroupLimit()`	`PivotGroupLimit`	ピボットグループのピボットグループの上限を返します。
`getIndex()`	`Integer`	現在のグループ順序におけるこのピボットグループのインデックスを返します。
`getPivotTable()`	`PivotTable`	このグループが属する `PivotTable` を返します。
`getSourceDataColumn()`	`Integer`	このグループが要約するソースデータ列の数を返します。
`getSourceDataSourceColumn()`	`DataSourceColumn`	ピボットグループが操作するデータソース列を返します。
`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 - 日時のグループ化ルール。

承認

このメソッドを使用するスクリプトには、次のスコープの 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 - ピボットグループの上限。

承認

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

承認

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