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)

Задает свойство border с цветом и/или стилем для каждого 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 в списке диапазонов. Заданная формула должна быть представлена ​​в формате A1. 

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 в списке диапазонов.

Допустимые шаблоны форматирования описаны в руководстве по форматированию дат и чисел в Google 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