Class RangeList

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

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

Методы

Метод Тип возврата Краткое описание
activate() RangeList Выбирает список экземпляров Range .
breakApart() RangeList Снова разбейте все горизонтально или вертикально объединенные ячейки, содержащиеся в списке диапазонов, на отдельные ячейки.
check() RangeList Изменяет состояние флажков в диапазоне на «отмечено».
clear() RangeList Очищает диапазон содержимого, форматов и правил проверки данных для каждого Range в списке диапазонов.
clear(options) RangeList Очищает диапазон содержимого, формата, правил проверки данных и комментариев, как указано в заданных параметрах.
clearContent() RangeList Очищает содержимое каждого Range в списке диапазонов, сохраняя форматирование без изменений.
clearDataValidations() RangeList Очищает правила проверки данных для каждого Range в списке диапазонов.
clearFormat() RangeList Очищает форматирование текста для каждого Range в списке диапазонов.
clearNote() RangeList Очищает примечание для каждого Range в списке диапазонов.
getRanges() Range[] Возвращает список из одного или нескольких экземпляров Range на одном листе.
insertCheckboxes() RangeList Вставляет флажки в каждую ячейку диапазона, настроенные как true для отмеченного и false для неотмеченного.
insertCheckboxes(checkedValue) RangeList Вставляет флажки в каждую ячейку диапазона, настроенную с пользовательским значением для отмеченного и пустой строкой для неотмеченного.
insertCheckboxes(checkedValue, uncheckedValue) RangeList Вставляет флажки в каждую ячейку диапазона с настраиваемыми значениями для отмеченного и неотмеченного состояний.
removeCheckboxes() RangeList Удаляет все флажки из диапазона.
setBackground(color) RangeList Устанавливает цвет фона для каждого Range в списке диапазонов.
setBackgroundRGB(red, green, blue) RangeList Устанавливает фон в заданный цвет RGB.
setBorder(top, left, bottom, right, vertical, horizontal) RangeList Устанавливает свойство границы для каждого Range в списке диапазонов.
setBorder(top, left, bottom, right, vertical, horizontal, color, style) RangeList Устанавливает свойство границы с цветом и/или стилем для каждого Range в списке диапазонов.
setFontColor(color) RangeList Устанавливает цвет шрифта для каждого Range в списке диапазонов.
setFontFamily(fontFamily) RangeList Устанавливает семейство шрифтов для каждого Range в списке диапазонов.
setFontLine(fontLine) RangeList Устанавливает стиль линии шрифта для каждого Range в списке диапазонов.
setFontSize(size) RangeList Устанавливает размер шрифта (в пунктах) для каждого Range в списке диапазонов.
setFontStyle(fontStyle) RangeList Установите стиль шрифта для каждого Range в списке диапазонов.
setFontWeight(fontWeight) RangeList Установите толщину шрифта для каждого Range в списке диапазонов.
setFormula(formula) RangeList Обновляет формулу для каждого Range в списке диапазонов.
setFormulaR1C1(formula) RangeList Обновляет формулу для каждого Range в списке диапазонов.
setHorizontalAlignment(alignment) RangeList Установите горизонтальное выравнивание для каждого Range в списке диапазонов.
setNote(note) RangeList Устанавливает текст примечания для каждого Range в списке диапазонов.
setNumberFormat(numberFormat) RangeList Устанавливает формат числа или даты для каждого Range в списке диапазонов.
setShowHyperlink(showHyperlink) RangeList Устанавливает, должен ли каждый Range в списке диапазонов отображать гиперссылки.
setTextDirection(direction) RangeList Задает направление текста для ячеек в каждом Range в списке диапазонов.
setTextRotation(degrees) RangeList Задает параметры поворота текста для ячеек в каждом Range в списке диапазонов.
setValue(value) RangeList Устанавливает значение для каждого Range в списке диапазонов.
setVerticalAlignment(alignment) RangeList Установите вертикальное выравнивание для каждого Range в списке диапазонов.
setVerticalText(isVertical) RangeList Определяет, следует ли размещать текст в ячейках для каждого Range в списке диапазонов.
setWrap(isWrapEnabled) RangeList Установите перенос текста для каждого Range в списке диапазонов.
setWrapStrategy(strategy) RangeList Устанавливает стратегию переноса текста для каждого Range в списке диапазонов.
trimWhitespace() RangeList Обрезает пробелы (например, пробелы, табуляции или новые строки) в каждой ячейке в этом списке диапазонов.
uncheck() RangeList Изменяет состояние флажков в диапазоне на «не отмечено».

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

activate()

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

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

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

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

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

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

Авторизация

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

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

breakApart()

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

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

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

  • 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'.
var rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.check();

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

clear()

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

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

  • 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.
var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['A:A', 'C:C']);
rangeList.clear({contentsOnly: true});

Параметры

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

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

Имя Тип Описание
commentsOnly Boolean Очистить ли только комментарии.
contentsOnly Boolean Очищать ли только содержимое.
formatOnly Boolean Очистить ли только формат; Обратите внимание, что очистка формата также очищает правила проверки данных.
validationsOnly Boolean Следует ли очищать только правила проверки данных.
skipFilteredRows Boolean Следует ли избегать очистки отфильтрованных строк.

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

clearContent()

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

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

clearDataValidations()

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

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

clearFormat()

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

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

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

clearNote()

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

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

getRanges()

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

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

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

Авторизация

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

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

insertCheckboxes()

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

var 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();

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

insertCheckboxes(checkedValue)

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

var 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');

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

insertCheckboxes(checkedValue, uncheckedValue)

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

var 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');

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

removeCheckboxes()

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

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

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

var 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();

var 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();

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setBackground(color)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setBackgroundRGB(red, green, blue)

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

var sheet = SpreadsheetApp.getActiveSheet();
var 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.

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setBorder(top, left, bottom, right, vertical, horizontal)

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

var sheet = SpreadsheetApp.getActiveSheet();
var 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 — без изменений.

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setBorder(top, left, bottom, right, vertical, horizontal, color, style)

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

var sheet = SpreadsheetApp.getActiveSheet();
var 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 BorderStyle Стиль границ, null для стиля по умолчанию (сплошной).

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setFontColor(color)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setFontFamily(fontFamily)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setFontLine(fontLine)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setFontSize(size)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setFontStyle(fontStyle)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setFontWeight(fontWeight)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setFormula(formula)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setFormulaR1C1(formula)

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

var sheet = SpreadsheetApp.getActiveSheet();
var 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 Строковая формула.

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setHorizontalAlignment(alignment)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setNote(note)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setNumberFormat(numberFormat)

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

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setTextDirection(direction)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setTextRotation(degrees)

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

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setValue(value)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setVerticalAlignment(alignment)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setVerticalText(isVertical)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setWrap(isWrapEnabled)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

setWrapStrategy(strategy)

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

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

Параметры

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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

trimWhitespace()

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

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

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

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

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

  • 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'.
var rangeList = SpreadsheetApp.getActive().getRangeList(['D4', 'E6']);
rangeList.uncheck();

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

RangeList — Этот список диапазонов для объединения.

Авторизация

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

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