Class Group

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Группа

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

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

Методы

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

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

collapse()

Сворачивает эту группу.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var 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()

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var 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()

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlAfter(true);
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var group = sheet.getRowGroup(2, 1);

// Returns 4
var controlIndex = group.getControlIndex();

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

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

Авторизация

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

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

getDepth()

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var group = sheet.getRowGroup(2, 1);

// Returns 1 if the group is at depth 1.
var depth = group.getDepth();

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

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

Авторизация

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

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

getRange()

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var 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 , если эта группа свернута.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var group = sheet.getRowGroup(2, 1);

// Returns true if the group is collapsed.
var isCollapsed = group.isCollapsed();

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

Booleantrue , если эта группа свернута; возвращает false иначе

Авторизация

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

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

remove()

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
var range = sheet.getRange(2:3);
range.shiftRowGroupDepth(1);
var group = sheet.getRowGroup(2, 1);

// Removes this group
var range = group.remove();

Авторизация

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

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

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