Class Group

Grupa

uzyskiwać dostęp do grup arkuszy kalkulacyjnych i je modyfikować; Grupy to powiązanie odstępu między ciągłymi wierszami lub kolumnami, które można rozwijać i zwijać jako całość, aby ukrywać lub wyświetlać wiersze lub kolumny. Każda grupa ma przełącznik w wierszu lub kolumnie bezpośrednio przed nią lub za nią (w zależności od ustawień), który umożliwia jej rozwinięcie lub zwinięcie.

Głębokość grupy odnosi się do jej zagnieżdżenia oraz liczby większych grup, które ją zawierają. Stan zwinięty grupy określa, czy grupa powinna pozostać zwinięta czy rozwinięta po rozwinięciu grupy nadrzędnej. Dodatkowo, gdy grupa jest złożona lub rozwinięta, wiersze lub kolumny w niej są ukryte lub widoczne, ale poszczególne wiersze lub kolumny mogą być ukryte lub widoczne niezależnie od stanu złożenia.

Metody

MetodaZwracany typKrótki opis
collapse()GroupZwija tę grupę.
expand()GroupRozwija tę grupę.
getControlIndex()IntegerZwraca indeks przełącznika kontrolnego tej grupy.
getDepth()IntegerZwraca głębokość tej grupy.
getRange()RangeZwraca zakres, w którym istnieje ta grupa.
isCollapsed()BooleanZwraca wartość true, jeśli ta grupa jest zwinięta.
remove()voidUsuwa tę grupę z arkusza, zmniejszając głębokość grupy range o 1.

Szczegółowa dokumentacja

collapse()

Zwija tę grupę. 

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();

Powrót

Group – ta grupa, do łańcucha;

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

expand()

Rozwija tę grupę. 

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();

Powrót

Group – ta grupa, do łańcucha;

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getControlIndex()

Zwraca indeks przełącznika kontrolnego tej grupy. Jest to indeks tuż przed zakresem, gdy przełącznik kontrolny jest wyświetlany przed grupą, lub indeks tuż po zakresie, jeśli jest inaczej. 

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();

Powrót

Integer – indeks przełącznika kontrolnego tej grupy

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getDepth()

Zwraca głębokość tej grupy. 

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();

Powrót

Integer – głębokość tej grupy

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getRange()

Zwraca zakres, w którym istnieje ta grupa. 

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();

Powrót

Range – zakres, w którym istnieje grupa

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

isCollapsed()

Zwraca wartość true, jeśli ta grupa jest zwinięta. 

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();

Powrót

Boolean – true, jeśli ta grupa jest zwinięta, w przeciwnym razie zwraca false

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

remove()

Usuwa tę grupę z arkusza, zmniejszając głębokość grupy range o 1. Może to zmodyfikować inne grupy. Po wywołaniu tej metody obiekt grupy staje się nieprawidłowy. 

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();

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

Zobacz też