Class Group

Gruppe

Auf Tabellengruppen zugreifen und sie ändern Gruppen sind eine Verknüpfung zwischen einem Intervall zusammenhängender Zeilen oder Spalten, die als Einheit maximiert oder minimiert werden können, um die Zeilen oder Spalten ein- oder auszublenden. Jede Gruppe hat in der Zeile oder Spalte direkt vor oder nach der Gruppe (je nach Einstellungen) einen Schalter, mit dem die Gruppe als Ganzes maximiert oder minimiert werden kann.

Die Tiefe einer Gruppe bezieht sich auf die verschachtelte Position der Gruppe und darauf, wie viele größere Gruppen die Gruppe enthalten. Der minimierte Status einer Gruppe gibt an, ob die Gruppe minimiert oder maximiert bleiben soll, nachdem eine übergeordnete Gruppe maximiert wurde. Wenn eine Gruppe minimiert oder maximiert wird, werden die Zeilen oder Spalten in der Gruppe ausgeblendet oder sichtbar gemacht. Einzelne Zeilen oder Spalten können jedoch unabhängig vom minimierten Status ausgeblendet oder sichtbar gemacht werden.

Methoden

MethodeRückgabetypKurzbeschreibung
collapse()GroupDiese Gruppe wird minimiert.
expand()GroupMaximiert diese Gruppe.
getControlIndex()IntegerGibt den Index des Kontroll-Toggles dieser Gruppe zurück.
getDepth()IntegerGibt die Tiefe dieser Gruppe zurück.
getRange()RangeGibt den Bereich zurück, in dem diese Gruppe vorhanden ist.
isCollapsed()BooleanGibt true zurück, wenn diese Gruppe minimiert ist.
remove()voidEntfernt diese Gruppe aus dem Tabellenblatt und verringert die Gruppierungstiefe von range um eins.

Detaillierte Dokumentation

collapse()

Diese Gruppe wird minimiert. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Collapses this group.
group.collapse();

Rückflug

Group – Diese Gruppe zur 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

expand()

Maximiert diese Gruppe. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Expands this group.
group.expand();

Rückflug

Group – Diese Gruppe zur 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

getControlIndex()

Gibt den Index des Kontroll-Toggles dieser Gruppe zurück. Dies ist der Index direkt vor dem Bereich, wenn das Steuerelement vor der Gruppe angezeigt wird, oder der Index direkt nach dem Bereich, wenn das Steuerelement nach der Gruppe angezeigt wird. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlAfter(true);
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns 4
const controlIndex = group.getControlIndex();

Rückflug

Integer: Der Index des Kontrollschalters für diese 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

getDepth()

Gibt die Tiefe dieser Gruppe zurück. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns 1 if the group is at depth 1.
const depth = group.getDepth();

Rückflug

Integer: Die Tiefe dieser 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

getRange()

Gibt den Bereich zurück, in dem diese Gruppe vorhanden ist. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
let range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(1, 1);

// Returns the range 2:3 if the group is over rows 2:3
range = group.getRange();

Rückflug

Range: Der Bereich, in dem die Gruppe vorhanden 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

isCollapsed()

Gibt true zurück, wenn diese Gruppe minimiert ist. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Returns true if the group is collapsed.
const isCollapsed = group.isCollapsed();

Rückflug

Boolean – true: Gibt false zurück, wenn diese Gruppe minimiert ist, andernfalls false.

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 Gruppe aus dem Tabellenblatt und verringert die Gruppierungstiefe von range um eins. Dadurch können sich andere Gruppen ändern. Nach dem Aufrufen dieser Funktion ist das Gruppenobjekt ungültig. 

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
let range = sheet.getRange('2:3');
range.shiftRowGroupDepth(1);
const group = sheet.getRowGroup(2, 1);

// Removes this group
range = group.remove();

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

Weitere Informationen