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

См. также