Class PivotGroup

PivotGroup

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

Methods

メソッド戻り値の型概要
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指定された PivotValueoppositeGroupValues の値についてこのグループを並べ替えます。
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 - 日時のグループ化ルール。

承認

この方法を使用するスクリプトには、次の 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 を使用してこのメソッドを呼び出します。

パラメータ

名前説明
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 より小さい値と 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)

指定された PivotValueoppositeGroupValues の値についてこのグループを並べ替えます。

// Sorts the item group by the "SUM of Quantity" pivot value for the specified salespersons.
var sheet = SpreadsheetApp.getActiveSheet();
var pivotTable = sheet.getPivotTables()[0];
var itemGroup = pivotTable.getRowGroups()[0];
var 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