Class Group

Группа

Доступ к группам электронных таблиц и их изменение. Группы представляют собой набор смежных строк или столбцов, которые можно развернуть или свернуть как единое целое, чтобы скрыть или отобразить строки или столбцы. У каждой группы есть переключатель управления, расположенный непосредственно перед группой или после неё (в зависимости от настроек), который позволяет развернуть или свернуть всю группу целиком.

Глубина группы определяется уровнем вложенности группы и количеством более крупных групп, содержащих её. Свёрнутое состояние группы определяет, должна ли группа оставаться свёрнутой или развёрнутой после развёртывания родительской группы. Кроме того, при свёртывании или развёртывании группы строки или столбцы внутри неё скрываются или становятся видимыми, хотя отдельные строки или столбцы могут быть скрыты или видны независимо от свёрнутого состояния.

Методы

Метод Тип возврата Краткое описание
collapse() Group Свернуть эту группу.
expand() Group Расширяет эту группу.
get Control Index() Integer Возвращает индекс переключателя управления этой группы.
get Depth() Integer Возвращает глубину этой группы.
get Range() Range Возвращает диапазон, в котором существует эта группа.
is Collapsed() Boolean Возвращает true если эта группа свернута.
remove() void Удаляет эту группу из листа, уменьшая глубину группы range на единицу.

Подробная документация

collapse()

Свернуть эту группу.

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

Возвращаться

Group — Эта группа, для объединения в цепочку.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

expand()

Расширяет эту группу.

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

Возвращаться

Group — Эта группа, для объединения в цепочку.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

get Control Index()

Возвращает индекс переключателя управления этой группы. Это индекс непосредственно перед диапазоном, если переключатель управления отображается перед группой, или индекс непосредственно после диапазона в противном случае.

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

Возвращаться

Integer — индекс переключателя управления этой группы.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

get Depth()

Возвращает глубину этой группы.

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

Возвращаться

Integer — глубина этой группы.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

get Range()

Возвращает диапазон, в котором существует эта группа.

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

Возвращаться

Range — диапазон, в котором существует группа.

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

is Collapsed()

Возвращает true если эта группа свернута.

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

Возвращаться

Boolean — true , если группа свернутa; в противном случае возвращает false .

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

remove()

Удаляет эту группу с листа, уменьшая глубину группы range на единицу. Это может привести к изменению других групп. После вызова объект группы становится недействительным для использования.

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

Авторизация

Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :

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

Смотрите также