Class Group

Gruppe

Auf Tabellengruppen zugreifen und sie bearbeiten Gruppen sind eine Verknüpfung zwischen einem Intervall von zusammenhängenden Zeilen oder Spalten, die als Einheit maximiert oder minimiert werden können, um die Zeilen oder Spalten auszublenden oder einzublenden. Jede Gruppe hat eine Ein/Aus-Schaltfläche in der Zeile oder Spalte direkt vor oder nach der Gruppe (je nach Einstellungen), mit der 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 sie enthalten. Der Minimierungsstatus einer Gruppe gibt an, ob die Gruppe minimiert bleiben oder maximiert werden soll, nachdem eine übergeordnete Gruppe maximiert wurde. Wenn eine Gruppe minimiert oder maximiert wird, werden die Zeilen oder Spalten innerhalb der Gruppe ausgeblendet oder sichtbar gemacht. Einzelne Zeilen oder Spalten können unabhängig vom minimierten Zustand ausgeblendet oder sichtbar gemacht werden.

Methoden

MethodeRückgabetypKurzbeschreibung
collapse()GroupDiese Gruppe wird minimiert.
expand()GroupMaximiert diese Gruppe.
getControlIndex()IntegerGibt den Index des Ein-/Aus-Schalters 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()voidDiese Gruppe wird aus dem Tabellenblatt entfernt, wodurch die Gruppenebene der range um eins reduziert wird.

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, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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, für die Verkettung

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

getControlIndex()

Gibt den Index des Ein-/Aus-Schalters dieser Gruppe zurück. Das ist der Index direkt vor dem Bereich, wenn die Ein-/Aus-Schaltfläche vor der Gruppe angezeigt wird, andernfalls der Index direkt nach dem Bereich. 

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 für die Ein-/Aus-Schaltfläche dieser Gruppe

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

  • 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, wenn diese Gruppe minimiert ist; andernfalls wird false zurückgegeben.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

remove()

Diese Gruppe wird aus dem Tabellenblatt entfernt, wodurch die Gruppenebene der range um eins reduziert wird. Dies kann sich auf andere Gruppen auswirken. Nach diesem Aufruf kann das Gruppenobjekt nicht mehr verwendet werden. 

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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

Weitere Informationen