Class Group

Grupa

Dostęp do grup arkuszy kalkulacyjnych i ich modyfikowanie. Grupy to powiązanie między przedziałem sąsiadujących wierszy lub kolumn, które można rozwijać lub zwijać jako całość, aby ukrywać lub wyświetlać wiersze lub kolumny. Każda grupa ma przełącznik sterowania w wierszu lub kolumnie bezpośrednio przed lub za grupą (w zależności od ustawień), który umożliwia rozwinięcie lub zwinięcie całej grupy.

Głębokość grupy odnosi się do jej pozycji w strukturze zagnieżdżonej i liczby większych grup, które ją zawierają. Stan zwinięcia grupy określa, czy grupa powinna pozostać zwinięta czy rozwinięta po rozwinięciu grupy nadrzędnej. Dodatkowo w momencie zwinięcia lub rozwinięcia grupy wiersze lub kolumny w grupie są ukrywane lub ustawiane jako widoczne, chociaż poszczególne wiersze lub kolumny można ukrywać lub ustawiać jako widoczne niezależnie od stanu zwinięcia.

Metody

MetodaZwracany typKrótki opis
collapse()GroupZwija tę grupę.
expand()GroupRozwija tę grupę.
getControlIndex()IntegerZwraca indeks przełącznika sterowania tej grupy.
getDepth()IntegerZwraca głębokość tej grupy.
getRange()RangeZwraca zakres, w którym ta grupa występuje.
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 łączenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 łączenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getControlIndex()

Zwraca indeks przełącznika sterowania tej grupy. Jest to indeks tuż przed zakresem, gdy przełącznik sterujący jest wyświetlany przed grupą, lub indeks tuż po zakresie w innych przypadkach. 

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 sterującego tej grupy.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getRange()

Zwraca zakres, w którym ta grupa występuje. 

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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 grupa jest zwinięta, zwraca wartość false, w przeciwnym razie zwraca wartość false.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 funkcji 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Zobacz też