Class Group

Gruppe

Auf Tabellengruppen zugreifen und diese ändern. Gruppen sind eine Verbindung 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 eine Ein/Aus-Schaltfläche für die Steuerung in der Zeile oder Spalte direkt vor oder nach der Gruppe. (je nach Einstellungen), über die die Gruppe insgesamt 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 bezieht sich darauf, ob die Gruppe sollte minimiert oder maximiert bleiben, nachdem eine übergeordnete Gruppe maximiert wurde. Außerdem können Sie wenn eine Gruppe minimiert oder maximiert wird, werden die Zeilen oder Spalten in der Gruppe ausgeblendet oder auf „Sichtbar“ gesetzt, obwohl einzelne Zeilen oder Spalten unabhängig vom minimiert.

Methoden

MethodeRückgabetypKurzbeschreibung
collapse()GroupMinimiert diese Gruppe.
expand()GroupMaximiert diese Gruppe.
getControlIndex()IntegerGibt den Umschaltindex 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 Gruppentiefe von range um eins.

Detaillierte Dokumentation

collapse()

Minimiert diese Gruppe. 

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

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

Rückflug

Group – diese Gruppe zur Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

expand()

Maximiert diese Gruppe. 

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

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

Rückflug

Group – diese Gruppe zur Verkettung

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getControlIndex()

Gibt den Umschaltindex dieser Gruppe zurück Dies ist der Index direkt vor dem Bereich, wird die Ein/Aus-Schaltfläche für die Steuerung vor der Gruppe angezeigt, andernfalls der Index direkt nach dem Bereich. 

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

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

Rückflug

Integer – der Ein/Aus-Schaltfläche-Index dieser Gruppe

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getDepth()

Gibt die Tiefe dieser Gruppe zurück. 

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

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

Rückflug

Integer – die Tiefe dieser Gruppe

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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. 

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var 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

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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. 

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

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

Rückflug

Boolean: true, wenn die Gruppe minimiert ist. gibt ansonsten false zurück

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

remove()

Entfernt diese Gruppe aus dem Tabellenblatt und verringert die Gruppentiefe von range um eins. Dadurch können andere Gruppen geändert werden. Nach dem Aufrufen kann das Gruppenobjekt nicht mehr verwendet werden. 

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

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

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

Weitere Informationen