Class RangeList

Список диапазонов

Коллекция из одного или нескольких экземпляров Range на одном листе. Вы можете использовать этот класс для применения операций к коллекциям несмежных диапазонов или ячеек.

Методы

Метод Тип возврата Краткое описание
activate() Range List Выбирает список экземпляров Range .
break Apart() Range List Снова разбейте все горизонтально или вертикально объединенные ячейки, содержащиеся в списке диапазонов, на отдельные ячейки.
check() Range List Изменяет состояние флажков в диапазоне на «отмечено».
clear() Range List Очищает диапазон содержимого, форматов и правил проверки данных для каждого Range в списке диапазонов.
clear(options) Range List Очищает диапазон содержимого, формата, правил проверки данных и комментариев, как указано в заданных параметрах.
clear Content() Range List Очищает содержимое каждого Range в списке диапазонов, сохраняя форматирование без изменений.
clear Data Validations() Range List Очищает правила проверки данных для каждого Range в списке диапазонов.
clear Format() Range List Очищает форматирование текста для каждого Range в списке диапазонов.
clear Note() Range List Очищает примечание для каждого Range в списке диапазонов.
get Ranges() Range[] Возвращает список из одного или нескольких экземпляров Range на одном листе.
insert Checkboxes() Range List Вставляет флажки в каждую ячейку диапазона, настроенные как true для отмеченного и false для неотмеченного.
insert Checkboxes(checkedValue) Range List Вставляет флажки в каждую ячейку диапазона, настроенную с пользовательским значением для отмеченного и пустой строкой для неотмеченного.
insert Checkboxes(checkedValue, uncheckedValue) Range List Вставляет флажки в каждую ячейку диапазона с настраиваемыми значениями для отмеченного и неотмеченного состояний.
remove Checkboxes() Range List Удаляет все флажки из диапазона.
set Background(color) Range List Устанавливает цвет фона для каждого Range в списке диапазонов.
set Background RGB(red, green, blue) Range List Устанавливает фон в заданный цвет RGB.
set Border(top, left, bottom, right, vertical, horizontal) Range List Устанавливает свойство границы для каждого Range в списке диапазонов.
set Border(top, left, bottom, right, vertical, horizontal, color, style) Range List Устанавливает свойство границы с цветом и/или стилем для каждого Range в списке диапазонов.
set Font Color(color) Range List Устанавливает цвет шрифта для каждого Range в списке диапазонов.
set Font Family(fontFamily) Range List Устанавливает семейство шрифтов для каждого Range в списке диапазонов.
set Font Line(fontLine) Range List Устанавливает стиль линии шрифта для каждого Range в списке диапазонов.
set Font Size(size) Range List Устанавливает размер шрифта (в пунктах) для каждого Range в списке диапазонов.
set Font Style(fontStyle) Range List Установите стиль шрифта для каждого Range в списке диапазонов.
set Font Weight(fontWeight) Range List Установите толщину шрифта для каждого Range в списке диапазонов.
set Formula(formula) Range List Обновляет формулу для каждого Range в списке диапазонов.
set Formula R1C1(formula) Range List Обновляет формулу для каждого Range в списке диапазонов.
set Horizontal Alignment(alignment) Range List Установите горизонтальное выравнивание для каждого Range в списке диапазонов.
set Note(note) Range List Устанавливает текст примечания для каждого Range в списке диапазонов.
set Number Format(numberFormat) Range List Устанавливает формат числа или даты для каждого Range в списке диапазонов.
set Show Hyperlink(showHyperlink) Range List Устанавливает, должен ли каждый Range в списке диапазонов отображать гиперссылки.
set Text Direction(direction) Range List Задает направление текста для ячеек в каждом Range в списке диапазонов.
set Text Rotation(degrees) Range List Задает параметры поворота текста для ячеек в каждом Range в списке диапазонов.
set Value(value) Range List Устанавливает значение для каждого Range в списке диапазонов.
set Vertical Alignment(alignment) Range List Установите вертикальное выравнивание для каждого Range в списке диапазонов.
set Vertical Text(isVertical) Range List Определяет, следует ли размещать текст в ячейках для каждого Range в списке диапазонов.
set Wrap(isWrapEnabled) Range List Установите перенос текста для каждого Range в списке диапазонов.
set Wrap Strategy(strategy) Range List Устанавливает стратегию переноса текста для каждого Range в списке диапазонов.
trim Whitespace() Range List Обрезает пробелы (например, пробелы, табуляции или новые строки) в каждой ячейке в этом списке диапазонов.
uncheck() Range List Изменяет состояние флажков в диапазоне на «не отмечено».

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

activate()

Выбирает список экземпляров Range . Последний диапазон в списке устанавливается как active range .

Примечание. Это дает возможность множественного выбора нескольких диапазонов.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.activate();

const selection = sheet.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

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

Range List — список активных диапазонов для объединения.

Авторизация

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

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

break Apart()

Снова разбейте все горизонтально или вертикально объединенные ячейки, содержащиеся в списке диапазонов, на отдельные ячейки.

Вызов этой функции для списка диапазонов эквивалентен выбору набора диапазонов и выбору пункта меню «Формат» > «Объединить» > «Разъединить листы».

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.breakApart();

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

check()

Изменяет состояние флажков в диапазоне на «отмечено». Игнорирует ячейки в диапазоне, которые в данный момент не содержат настроенное отмеченное или непроверенное значение.

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the ranges D4 and E6 to 'checked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.check();

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

clear()

Очищает диапазон содержимого, форматов и правил проверки данных для каждого Range в списке диапазонов.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear();

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

clear(options)

Очищает диапазон содержимого, формата, правил проверки данных и комментариев, как указано в заданных параметрах. По умолчанию все данные удаляются.

// The code below clears the contents of the following ranges A:A and C:C in the
// active sheet, but preserves the format, data validation rules, and comments.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear({contentsOnly: true});

Параметры

Имя Тип Описание
options Object Объект JavaScript, задающий дополнительные параметры, как указано ниже.

Расширенные параметры

Имя Тип Описание
comments Only Boolean Очистить ли только комментарии.
contents Only Boolean Очищать ли только содержимое.
format Only Boolean Очистить ли только формат; Обратите внимание, что очистка формата также очищает правила проверки данных.
validations Only Boolean Следует ли очищать только правила проверки данных.
skip Filtered Rows Boolean Следует ли избегать очистки отфильтрованных строк.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

clear Content()

Очищает содержимое каждого Range в списке диапазонов, сохраняя форматирование без изменений.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearContent();

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

clear Data Validations()

Очищает правила проверки данных для каждого Range в списке диапазонов.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearDataValidations();

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

clear Format()

Очищает форматирование текста для каждого Range в списке диапазонов.

При этом форматирование текста для каждого диапазона очищается, но не сбрасываются никакие правила форматирования чисел.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearFormat();

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

clear Note()

Очищает примечание для каждого Range в списке диапазонов.

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clearNote();

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

get Ranges()

Возвращает список из одного или нескольких экземпляров Range на одном листе.

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

Range[] — Список диапазонов.

Авторизация

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

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

insert Checkboxes()

Вставляет флажки в каждую ячейку диапазона, настроенные как true для отмеченного и false для неотмеченного. Устанавливает значение всех ячеек в диапазоне на false . 

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'true' for checked and 'false' for unchecked. Also, sets the value of each
// cell in the ranges D4 and E6 to 'false'.
rangeList.insertCheckboxes();

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

insert Checkboxes(checkedValue)

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

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and the empty string for unchecked. Also, sets the value of
// each cell in the ranges D4 and E6 to the empty string.
rangeList.insertCheckboxes('yes');

Параметры

Имя Тип Описание
checked Value Object Проверенное значение для проверки данных флажка.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

insert Checkboxes(checkedValue, uncheckedValue)

Вставляет флажки в каждую ячейку диапазона с настраиваемыми значениями для отмеченного и неотмеченного состояний. Устанавливает для каждой ячейки диапазона пользовательское непроверенное значение. 

const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);

// Inserts checkboxes into each cell in the ranges D4 and E6 configured with
// 'yes' for checked and 'no' for unchecked. Also, sets the value of each cell
// in the ranges D4 and E6 to 'no'.
rangeList.insertCheckboxes('yes', 'no');

Параметры

Имя Тип Описание
checked Value Object Проверенное значение для проверки данных флажка.
unchecked Value Object Непроверенное значение для проверки данных флажка.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

remove Checkboxes()

Удаляет все флажки из диапазона. Очищает проверку данных каждой ячейки и дополнительно очищает ее значение, если ячейка содержит проверенное или непроверенное значение. 

const range = SpreadsheetApp.getActive().getRange('A1:B10');

// Inserts checkboxes and sets each cell value to 'no' in the range A1:B10.
range.insertCheckboxes('yes', 'no');

const rangeList1 = SpreadsheetApp.getActive().getRangeList(['A1', 'A3']);
rangeList1.setValue('yes');
// Removes the checkbox data validation in cells A1 and A3 and clears their
// value.
rangeList1.removeCheckboxes();

const rangeList2 = SpreadsheetApp.getActive().getRangeList(['A5', 'A7']);
rangeList2.setValue('random');
// Removes the checkbox data validation in cells A5 and A7 but does not clear
// their value.
rangeList2.removeCheckboxes();

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Background(color)

Устанавливает цвет фона для каждого Range в списке диапазонов. Цвет представлен в нотации CSS; например, '#ffffff' или 'white' . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setBackground('red');

Параметры

Имя Тип Описание
color String Код цвета фона в нотации CSS, например '#ffffff' или 'white' ; null значение сбрасывает цвет.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Background RGB(red, green, blue)

Устанавливает фон в заданный цвет RGB. Это удобная оболочка для вызова set Background(color) . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
// Sets the background to red for each range in the range list.
rangeList.setBackgroundRGB(255, 0, 0);

Параметры

Имя Тип Описание
red Integer Значение красного цвета в обозначениях RGB.
green Integer Зелёное значение в обозначениях RGB.
blue Integer Значение синего цвета в обозначениях RGB.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Border(top, left, bottom, right, vertical, horizontal)

Устанавливает свойство границы для каждого Range в списке диапазонов. Допустимые значения: true (включено), false (выключено) и null (без изменений). 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom of the ranges A2:B4 and C1:D4, but leaves
// the left and right unchanged.
rangeList.setBorder(true, null, true, null, false, false);

Параметры

Имя Тип Описание
top Boolean true для границы, false для отсутствия, null для отсутствия изменений.
left Boolean true для границы, false для отсутствия, null для отсутствия изменений.
bottom Boolean true для границы, false для отсутствия, null для отсутствия изменений.
right Boolean true для границы, false для отсутствия, null для отсутствия изменений.
vertical Boolean true для внутренних вертикальных границ, false — нет, null — без изменений.
horizontal Boolean true для внутренних горизонтальных границ, false — если нет, null — без изменений.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Border(top, left, bottom, right, vertical, horizontal, color, style)

Устанавливает свойство границы с цветом и/или стилем для каждого Range в списке диапазонов. Допустимые значения: true (включено), false (выключено) и null (без изменений). Цвет представлен в нотации CSS; например, '#ffffff' или 'white' . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A2:B4', 'C1:D4']);
// Sets borders on the top and bottom, but leaves the left and right unchanged
// of the ranges A2:B4 and C1:D4. Also sets the color to 'red', and the border
// to 'DASHED'.
rangeList.setBorder(
    true,
    null,
    true,
    null,
    false,
    false,
    'red',
    SpreadsheetApp.BorderStyle.DASHED,
);

Параметры

Имя Тип Описание
top Boolean true для границы, false для отсутствия, null для отсутствия изменений.
left Boolean true для границы, false для отсутствия, null для отсутствия изменений.
bottom Boolean true для границы, false для отсутствия, null для отсутствия изменений.
right Boolean true для границы, false для отсутствия, null для отсутствия изменений.
vertical Boolean true для внутренних вертикальных границ, false — нет, null — без изменений.
horizontal Boolean true для внутренних горизонтальных границ, false — если нет, null — без изменений.
color String Цвет границы в нотации CSS, например '#ffffff' или 'white' , null для цвета по умолчанию (черный).
style Border Style Стиль границ, null для стиля по умолчанию (сплошной).

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Font Color(color)

Устанавливает цвет шрифта для каждого Range в списке диапазонов. Цвет представлен в нотации CSS; например, '#ffffff' или 'white' . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontColor('red');

Параметры

Имя Тип Описание
color String Цвет шрифта в обозначениях CSS, например '#ffffff' или 'white' ; null значение сбрасывает цвет.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Font Family(fontFamily)

Устанавливает семейство шрифтов для каждого Range в списке диапазонов. Семейство шрифтов описывается строковым идентификатором, например Arial или Roboto . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontFamily('Roboto');

Параметры

Имя Тип Описание
font Family String Семейство шрифтов, которое необходимо установить; null значение сбрасывает семейство шрифтов.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Font Line(fontLine)

Устанавливает стиль линии шрифта для каждого Range в списке диапазонов. Варианты стилей линий: 'underline' , 'line-through' или 'none' . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontLine('line-through');

Параметры

Имя Тип Описание
font Line String Стиль линии шрифта: 'underline' , 'line-through' или 'none' ; null значение сбрасывает стиль линии шрифта.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Font Size(size)

Устанавливает размер шрифта (в пунктах) для каждого Range в списке диапазонов. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontSize(20);

Параметры

Имя Тип Описание
size Integer Размер шрифта.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Font Style(fontStyle)

Установите стиль шрифта для каждого Range в списке диапазонов. Варианты стиля шрифта: 'italic' или 'normal' . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontStyle('italic');

Параметры

Имя Тип Описание
font Style String Стиль шрифта: 'italic' или 'normal' ; null значение сбрасывает стиль шрифта.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Font Weight(fontWeight)

Установите толщину шрифта для каждого Range в списке диапазонов. Варианты толщины шрифта: 'normal' или 'bold' . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setFontWeight('bold');

Параметры

Имя Тип Описание
font Weight String Начертание шрифта: 'bold' или 'normal' ; null значение сбрасывает вес шрифта.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Formula(formula)

Обновляет формулу для каждого Range в списке диапазонов. Данная формула должна быть в формате А1. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
rangeList.setFormula('=SUM(B1:B10)');

Параметры

Имя Тип Описание
formula String Строка, представляющая формулу для установки.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Formula R1C1(formula)

Обновляет формулу для каждого Range в списке диапазонов. Данная формула должна быть в обозначении R1C1. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A11', 'C11']);
// This sets the formula to be the sum of the 3 rows above B5
rangeList.setFormulaR1C1('=SUM(R[-3]C[0]:R[-1]C[0])');

Параметры

Имя Тип Описание
formula String Строковая формула.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Horizontal Alignment(alignment)

Установите горизонтальное выравнивание для каждого Range в списке диапазонов. Варианты выравнивания: 'left' , 'center' или 'right' . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setHorizontalAlignment('center');

Параметры

Имя Тип Описание
alignment String Выравнивание: 'left' , 'center' или 'normal' ; null значение сбрасывает выравнивание.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Note(note)

Устанавливает текст примечания для каждого Range в списке диапазонов. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setNote('This is a note');

Параметры

Имя Тип Описание
note String Текст заметки, который нужно установить; null значение удаляет примечание.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Number Format(numberFormat)

Устанавливает формат числа или даты для каждого Range в списке диапазонов.

Принятые шаблоны форматирования описаны в руководстве по форматированию даты и чисел Sheets API . 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Always show 3 decimal points for the specified ranges.
rangeList.setNumberFormat('0.000');

Параметры

Имя Тип Описание
number Format String Строка числового формата.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

Устанавливает, должен ли каждый Range в списке диапазонов отображать гиперссылки. 

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
// Show hyperlinks for all the ranges.
rangeList.setShowHyperlink(true);

Параметры

Имя Тип Описание
show Hyperlink Boolean Показывать или нет гиперссылку.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Text Direction(direction)

Задает направление текста для ячеек в каждом Range в списке диапазонов. Если указанное направление имеет null , направление выводится, а затем устанавливается. 

// Sets right-to-left text direction each range in the range list.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);

Параметры

Имя Тип Описание
direction Text Direction Желаемое направление текста; если null направление определяется перед установкой.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Text Rotation(degrees)

Задает параметры поворота текста для ячеек в каждом Range в списке диапазонов. Ввод соответствует углу между стандартной ориентацией текста и желаемой ориентацией. Ввод нуля указывает, что для текста установлена ​​стандартная ориентация.

Для направления текста слева направо положительные углы располагаются против часовой стрелки, тогда как для направления текста справа налево — по часовой стрелке. 

// Sets the cells in the ranges A1:A10 and C1:C10 to have text rotated up 45
// degrees.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['A1:A10', 'C1:C10']);
rangeList.setTextRotation(45);

Параметры

Имя Тип Описание
degrees Integer Желаемый угол между стандартной ориентацией и желаемой ориентацией. Для текста слева направо положительные углы располагаются против часовой стрелки.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Value(value)

Устанавливает значение для каждого Range в списке диапазонов. Значение может быть числовым, строковым, логическим или датой. Если оно начинается с «=", оно интерпретируется как формула. 

const sheet = SpreadsheetApp.getActiveSheet();
// Set value of 100 to each range in the range list.
const rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.setValue(100);

Параметры

Имя Тип Описание
value Object Значение диапазона.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Vertical Alignment(alignment)

Установите вертикальное выравнивание для каждого Range в списке диапазонов. Варианты выравнивания: 'top' , 'middle' или 'bottom' . 

// Sets the vertical alignment to middle for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalAlignment('middle');

Параметры

Имя Тип Описание
alignment String Выравнивание: 'top' , 'middle' или 'bottom' ; null значение сбрасывает выравнивание.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Vertical Text(isVertical)

Определяет, следует ли размещать текст в ячейках для каждого Range в списке диапазонов. Если текст расположен вертикально, настройка поворота текста в градусах игнорируется. 

// Sets all cell's in ranges D4 and B2:D4 to have vertically stacked text.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setVerticalText(true);

Параметры

Имя Тип Описание
is Vertical Boolean Складывать или нет текст.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Wrap(isWrapEnabled)

Установите перенос текста для каждого Range в списке диапазонов. Ячейки с включенной функцией переноса изменяют размер для отображения полного содержимого. Ячейки с отключенным переносом отображают как можно больше в ячейке без изменения размера или разделения на несколько строк. 

// Enable text wrap for the list of ranges.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrap(true);

Параметры

Имя Тип Описание
is Wrap Enabled Boolean Переносить текст или нет.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

set Wrap Strategy(strategy)

Устанавливает стратегию переноса текста для каждого Range в списке диапазонов. 

// Sets the list of ranges to use the clip wrap strategy.
const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
rangeList.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);

Параметры

Имя Тип Описание
strategy Wrap Strategy Желаемая стратегия упаковки.

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

trim Whitespace()

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
const range = sheet.getRange('A1:A4');
range.activate();
range.setValues([
  ' preceding space',
  'following space ',
  'two  middle  spaces',
  '   =SUM(1,2)',
]);

const rangeList = sheet.getRangeList(['A1', 'A2', 'A3', 'A4']);
rangeList.trimWhitespace();

const values = range.getValues();
// Values are ['preceding space', 'following space', 'two middle spaces',
// '=SUM(1,2)']

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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

См. также

uncheck()

Изменяет состояние флажков в диапазоне на «не отмечено». Игнорирует ячейки в диапазоне, которые в данный момент не содержат настроенное отмеченное или непроверенное значение. 

// Changes the state of cells which currently contain either the checked or
// unchecked value configured in the ranges D4 and E6 to 'unchecked'.
const rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.uncheck();

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

Range List — этот список диапазонов для объединения в цепочку.

Авторизация

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

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