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

getControlIndex()

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

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

getDepth()

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

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

getRange()

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

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

isCollapsed()

Возвращает 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 если эта группа свернута; 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

См. также