Class PivotGroup

PivotGroup

Auf Aufschlüsselungsgruppen für Pivot-Tabellen zugreifen und diese ändern

Methoden

MethodeRückgabetypKurzbeschreibung
addManualGroupingRule(groupName, groupMembers)PivotGroupFügt eine manuelle Gruppierungsregel für diese Pivot-Gruppe hinzu.
areLabelsRepeated()BooleanGibt zurück, ob Labels wiederholt angezeigt werden.
clearGroupingRule()PivotGroupEntfernt alle Gruppierungsregeln aus dieser Pivot-Gruppe.
clearSort()PivotGroupEntfernt alle Sortierungen, die auf diese Gruppe angewendet wurden.
getDateTimeGroupingRule()DateTimeGroupingRule|nullGibt die Gruppierungsregel vom Typ „Datum/Uhrzeit“ für die Pivot-Gruppe zurück oder null, wenn keine Gruppierungsregel vom Typ „Datum/Uhrzeit“ festgelegt ist.
getDimension()DimensionGibt zurück, ob es sich um eine Zeilen- oder Spaltengruppe handelt.
getGroupLimit()PivotGroupLimit|nullGibt das Limit für die Pivot-Gruppe für die Pivot-Gruppe zurück.
getIndex()IntegerGibt den Index dieser Pivot-Gruppe in der aktuellen Gruppenreihenfolge zurück.
getPivotTable()PivotTableGibt die PivotTable zurück, zu der diese Gruppierung gehört.
getSourceDataColumn()IntegerGibt die Nummer der Quelldatenspalte zurück, die in dieser Gruppe zusammengefasst wird.
getSourceDataSourceColumn()DataSourceColumn|nullGibt die Datenquellen-Spalte zurück, auf die sich die Pivot-Gruppe bezieht.
hideRepeatedLabels()PivotGroupWiederholte Labels für diese Gruppierung werden ausgeblendet.
isSortAscending()BooleanGibt true zurück, wenn die Sortierung aufsteigend ist, und false, wenn die Sortierfolge absteigend ist.
moveToIndex(index)PivotGroupVerschiebt diese Gruppe an die angegebene Position in der aktuellen Liste der Zeilen- oder Spaltengruppen.
remove()voidEntfernt diese Pivot-Gruppe aus der Tabelle.
removeManualGroupingRule(groupName)PivotGroupEntfernt die manuelle Gruppierungsregel mit der angegebenen groupName.
resetDisplayName()PivotGroupSetzt den Anzeigenamen dieser Gruppe in der Pivot-Tabelle auf den Standardwert zurück.
setDateTimeGroupingRule(dateTimeGroupingRuleType)PivotGroupLegt die Gruppierungsregel vom Typ „Datum/Uhrzeit“ für die Pivot-Gruppe fest.
setDisplayName(name)PivotGroupLegt den Anzeigenamen dieser Gruppe in der Pivot-Tabelle fest.
setGroupLimit(countLimit)PivotGroupLegt das Limit für die Pivot-Gruppe fest.
setHistogramGroupingRule(minValue, maxValue, intervalSize)PivotGroupLegt eine Histogramm-Gruppierungsregel für diese Pivot-Gruppe fest.
showRepeatedLabels()PivotGroupWenn es mehr als eine Zeilen- oder Spaltengruppierung gibt, wird mit dieser Methode das Label der Gruppierung für jeden Eintrag der nachfolgenden Gruppierung angezeigt.
showTotals(showTotals)PivotGroupLegt fest, ob Summenwerte für diese Pivot-Gruppe in der Tabelle angezeigt werden sollen.
sortAscending()PivotGroupLegt die Sortierreihenfolge auf aufsteigend fest.
sortBy(value, oppositeGroupValues)PivotGroupSortiert diese Gruppe nach dem angegebenen PivotValue für die Werte aus dem oppositeGroupValues.
sortDescending()PivotGroupLegt die Sortierreihenfolge auf absteigend fest.
totalsAreShown()BooleanGibt zurück, ob derzeit Gesamtsummenwerte für diese Pivot-Gruppe angezeigt werden.

Detaillierte Dokumentation

addManualGroupingRule(groupName, groupMembers)

Fügt eine manuelle Gruppierungsregel für diese Pivot-Gruppe hinzu.

Parameter

NameTypBeschreibung
groupNameStringDer Name dieser Gruppierungsregel.
groupMembersObject[]Die Werte, die in dieser Gruppierungsregel enthalten sind.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

areLabelsRepeated()

Gibt zurück, ob Labels wiederholt angezeigt werden.

Rückflug

Boolean: true, wenn Labels wiederholt werden. Andernfalls wird false zurückgegeben.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

clearGroupingRule()

Entfernt alle Gruppierungsregeln aus dieser Pivot-Gruppe.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

clearSort()

Entfernt alle Sortierungen, die auf diese Gruppe angewendet wurden.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getDateTimeGroupingRule()

Gibt die Gruppierungsregel vom Typ „Datum/Uhrzeit“ für die Pivot-Gruppe zurück oder null, wenn keine Gruppierungsregel vom Typ „Datum/Uhrzeit“ festgelegt ist.

Rückflug

DateTimeGroupingRule|null – Die Gruppierungsregel vom Typ „Datum/Uhrzeit“.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getDimension()

Gibt zurück, ob es sich um eine Zeilen- oder Spaltengruppe handelt.

Rückflug

Dimension: Die Dimension, die den Typ dieser Gruppe darstellt

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getGroupLimit()

Gibt das Limit für die Pivot-Gruppe für die Pivot-Gruppe zurück. Gibt null zurück, wenn kein Limit für die Pivot-Gruppe festgelegt ist.

Rückflug

PivotGroupLimit|null: Das Limit für die Pivot-Gruppe.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getIndex()

Gibt den Index dieser Pivot-Gruppe in der aktuellen Gruppenreihenfolge zurück.

Rückflug

Integer: Der Index der Pivot-Gruppe

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getPivotTable()

Gibt die PivotTable zurück, zu der diese Gruppierung gehört.

Rückflug

PivotTable: Die Pivot-Tabelle, zu der diese Gruppe gehört.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getSourceDataColumn()

Gibt die Nummer der Quelldatenspalte zurück, die in dieser Gruppe zusammengefasst wird. Dieser Index ist 1-basiert. Wenn in dieser Gruppe Quelldaten in Spalte A der Tabelle zusammengefasst werden, gibt diese Methode 1 zurück.

Rückflug

Integer: Die Nummer der Quelldatenspalte.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

getSourceDataSourceColumn()

Gibt die Datenquellen-Spalte zurück, auf die sich die Pivot-Gruppe bezieht. Gibt null zurück, wenn die Pivot-Tabelle keine {DataSourcePivotTableApi} ist.

Rückflug

DataSourceColumn|null: Die Datenquellenspalte, auf die sich die Pivot-Gruppe bezieht.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

hideRepeatedLabels()

Wiederholte Labels für diese Gruppierung werden ausgeblendet. Wenn Labels bereits ausgeblendet sind, hat dies keine Auswirkungen. Wenn diese Methode aufgerufen wird, bevor mehrere Zeilen- oder Spaltengruppierungen vorhanden sind, werden wiederholte Labels ausgeblendet, wenn eine zusätzliche Gruppierung hinzugefügt wird.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

isSortAscending()

Gibt true zurück, wenn die Sortierung aufsteigend ist, und false, wenn die Sortierfolge absteigend ist.

Rückflug

Boolean – true, wenn die Sortierreihenfolge aufsteigend ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

moveToIndex(index)

Verschiebt diese Gruppe an die angegebene Position in der aktuellen Liste der Zeilen- oder Spaltengruppen. Diese Indexwerte sind nullbasiert. Wenn diese Gruppe beispielsweise an die erste Position verschoben werden soll, sollte diese Methode mit 0 aufgerufen werden.

Parameter

NameTypBeschreibung
indexIntegerDer Index, zu dem diese Gruppierung verschoben werden soll.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

remove()

Entfernt diese Pivot-Gruppe aus der Tabelle.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

removeManualGroupingRule(groupName)

Entfernt die manuelle Gruppierungsregel mit der angegebenen groupName.

Parameter

NameTypBeschreibung
groupNameStringDer Name der zu entfernenden Gruppierungsregel.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

resetDisplayName()

Setzt den Anzeigenamen dieser Gruppe in der Pivot-Tabelle auf den Standardwert zurück.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setDateTimeGroupingRule(dateTimeGroupingRuleType)

Legt die Gruppierungsregel vom Typ „Datum/Uhrzeit“ für die Pivot-Gruppe fest.

Verwenden Sie clearGroupingRule(), um die Regel zu entfernen.

Parameter

NameTypBeschreibung
dateTimeGroupingRuleTypeDateTimeGroupingRuleTypeDer festzulegende Regeltyp.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setDisplayName(name)

Legt den Anzeigenamen dieser Gruppe in der Pivot-Tabelle fest.

Parameter

NameTypBeschreibung
nameStringDer festzulegende Anzeigename.

Rückflug

PivotGroup – die Pivot-Gruppe für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setGroupLimit(countLimit)

Legt das Limit für die Pivot-Gruppe fest. Der Vorgang wird nur für DataSourcePivotTable unterstützt.

Parameter

NameTypBeschreibung
countLimitIntegerDas Limit für die Anzahl der festzulegenden Zeilen oder Spalten. Muss positiv sein.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

setHistogramGroupingRule(minValue, maxValue, intervalSize)

Legt eine Histogramm-Gruppierungsregel für diese Pivot-Gruppe fest. Mit einer Histogrammregel werden Werte in einer Quelldatenspalte in gleich große Klassen unterteilt. Alle Werte von minValue bis maxValue werden in Gruppen der Größe interval eingeteilt. Alle Werte unter minValue werden in einem Bucket zusammengefasst, ebenso alle Werte über maxValue.

Parameter

NameTypBeschreibung
minValueIntegerDer Mindestwert für Elemente, die in Gruppen eingeordnet werden sollen. Werte, die unter diesem Wert liegen, werden in einem einzelnen Bucket zusammengefasst.
maxValueIntegerDer maximale Wert für Elemente, die in Buckets platziert werden sollen. Werte, die größer als dieser Wert sind, werden in einem einzigen Bucket zusammengefasst.
intervalSizeInteger

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

showRepeatedLabels()

Wenn es mehr als eine Zeilen- oder Spaltengruppierung gibt, wird mit dieser Methode das Label der Gruppierung für jeden Eintrag der nachfolgenden Gruppierung angezeigt. Wenn Labels bereits wiederholt werden, hat dies keine Auswirkungen. Wenn diese Methode aufgerufen wird, bevor mehrere Zeilen- oder Spaltengruppierungen vorhanden sind, werden wiederholte Labels angezeigt, wenn eine zusätzliche Gruppierung hinzugefügt wird.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

showTotals(showTotals)

Legt fest, ob Summenwerte für diese Pivot-Gruppe in der Tabelle angezeigt werden sollen.

Parameter

NameTypBeschreibung
showTotalsBooleanGibt an, ob Summen angezeigt werden sollen.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

sortAscending()

Legt die Sortierreihenfolge auf aufsteigend fest.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

sortBy(value, oppositeGroupValues)

Sortiert diese Gruppe nach dem angegebenen PivotValue für die Werte aus dem oppositeGroupValues. 

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

Parameter

NameTypBeschreibung
valuePivotValueDer Pivot-Wert, nach dem sortiert werden soll.
oppositeGroupValuesObject[]Die Werte einer gegenüberliegenden Pivot-Gruppe (einer Spaltengruppe, wenn eine Zeilengruppe sortiert wird, oder einer Zeilengruppe, wenn eine Spaltengruppe sortiert wird), die zum Sortieren verwendet werden. Die Reihenfolge dieser Werte bestimmt die Priorität bei Gleichstand.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

sortDescending()

Legt die Sortierreihenfolge auf absteigend fest.

Rückflug

PivotGroup: Die Pivot-Gruppe für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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

totalsAreShown()

Gibt zurück, ob derzeit Gesamtsummenwerte für diese Pivot-Gruppe angezeigt werden.

Rückflug

Boolean: true, wenn für diese Pivot-Gruppe Gesamtwert angezeigt werden. Andernfalls wird false zurückgegeben.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

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