Эта страница переведена с помощью Cloud Translation API.

Class Sheet

Доступ к электронным таблицам и их редактирование. Типичные операции включают переименование листа и доступ к диапазонам объектов на листе.

Методы

Метод	Тип возвращаемого значения	Краткое описание
`activate()`	`Sheet`	Активирует этот лист.
`add Developer Metadata(key)`	`Sheet`	Добавляет в таблицу метаданные разработчика с указанным ключом.
`add Developer Metadata(key, visibility)`	`Sheet`	Добавляет в таблицу метаданные разработчика с указанным ключом и уровнем видимости.
`add Developer Metadata(key, value)`	`Sheet`	Добавляет в таблицу метаданные разработчика с указанным ключом и значением.
`add Developer Metadata(key, value, visibility)`	`Sheet`	Добавляет в таблицу метаданные разработчика с указанным ключом, значением и уровнем видимости.
`append Row(rowContents)`	`Sheet`	Добавляет строку в нижнюю часть текущей области данных на листе.
`as Data Source Sheet()`	`Data Source Sheet \|null`	Возвращает лист в качестве `Data Source Sheet` , если лист имеет тип `Sheet Type.DATASOURCE` , или `null` в противном случае.
`auto Resize Column(columnPosition)`	`Sheet`	Задает ширину указанного столбца в соответствии с его содержимым.
`auto Resize Columns(startColumn, numColumns)`	`Sheet`	Задает ширину всех столбцов, начиная с указанной позиции, в соответствии с их содержимым.
`auto Resize Rows(startRow, numRows)`	`Sheet`	Устанавливает высоту всех строк, начиная с заданной позиции, в соответствии с их содержимым.
`clear()`	`Sheet`	Очищает лист от содержимого и информации о форматировании.
`clear(options)`	`Sheet`	Очищает лист от содержимого и/или форматирования в соответствии с заданными расширенными параметрами.
`clear Conditional Format Rules()`	`void`	Удаляет все правила условного форматирования из таблицы.
`clear Contents()`	`Sheet`	Очищает оглавление, сохраняя при этом информацию о форматировании.
`clear Formats()`	`Sheet`	Удаляет форматирование с листа, сохраняя при этом его содержимое.
`clear Notes()`	`Sheet`	Удаляет все заметки с листа.
`collapse All Column Groups()`	`Sheet`	Сворачивает все группы столбцов на листе.
`collapse All Row Groups()`	`Sheet`	Сворачивает все группы строк на листе.
`copy To(spreadsheet)`	`Sheet`	Копирует лист в указанную электронную таблицу, которая может быть той же самой, что и исходная.
`create Developer Metadata Finder()`	`Developer Metadata Finder`	Возвращает `Developer Metadata Finder` для поиска метаданных разработчика в пределах данного листа.
`create Text Finder(findText)`	`Text Finder`	Создает средство поиска текста для листа, которое может находить и заменять текст внутри листа.
`delete Column(columnPosition)`	`Sheet`	Удаляет столбец в указанной позиции.
`delete Columns(columnPosition, howMany)`	`void`	Удаляет несколько столбцов, начиная с указанной позиции.
`delete Row(rowPosition)`	`Sheet`	Удаляет строку в указанной позиции.
`delete Rows(rowPosition, howMany)`	`void`	Удаляет несколько строк, начиная с указанной позиции.
`expand All Column Groups()`	`Sheet`	Разворачивает все группы столбцов на листе.
`expand All Row Groups()`	`Sheet`	Разворачивает все группы строк на листе.
`expand Column Groups Up To Depth(groupDepth)`	`Sheet`	Разворачивает все группы столбцов до заданной глубины и сворачивает все остальные.
`expand Row Groups Up To Depth(groupDepth)`	`Sheet`	Разворачивает все группы строк до заданной глубины и сворачивает все остальные.
`get Active Cell()`	`Range`	Возвращает активную ячейку на этом листе.
`get Active Range()`	`Range`	Возвращает выбранный диапазон на активном листе или `null` , если активного диапазона нет.
`get Active Range List()`	`Range List \|null`	Возвращает список активных диапазонов на активном листе или `null` , если активных диапазонов нет.
`get Bandings()`	`Banding[]`	Возвращает все полосы на этом листе.
`get Charts()`	`Embedded Chart[]`	Возвращает массив диаграмм на этом листе.
`get Column Group(columnIndex, groupDepth)`	`Group \|null`	Возвращает группу столбцов по заданному индексу и глубине группировки.
`get Column Group Control Position()`	`Group Control Toggle Position`	Возвращает `Group Control Toggle Position` для всех групп столбцов на листе.
`get Column Group Depth(columnIndex)`	`Integer`	Возвращает глубину группировки столбца по заданному индексу.
`get Column Width(columnPosition)`	`Integer`	Получает ширину заданного столбца в пикселях.
`get Conditional Format Rules()`	`Conditional Format Rule[]`	В этом листе собраны все правила условного форматирования.
`get Current Cell()`	`Range \|null`	Возвращает текущую ячейку на активном листе или `null` , если текущей ячейки нет.
`get Data Range()`	`Range`	Возвращает `Range` , соответствующий измерениям, в которых присутствуют данные.
`get Data Source Formulas()`	`Data Source Formula[]`	Получает все формулы источника данных.
`get Data Source Pivot Tables()`	`Data Source Pivot Table[]`	Получает все сводные таблицы источников данных.
`get Data Source Tables()`	`Data Source Table[]`	Получает все таблицы источников данных.
`get Developer Metadata()`	`Developer Metadata[]`	Получить все метаданные разработчика, связанные с этим листом.
`get Drawings()`	`Drawing[]`	Возвращает массив рисунков на листе.
`get Filter()`	`Filter \|null`	Возвращает фильтр, используемый в этом листе, или `null` если фильтр отсутствует.
`get Form Url()`	`String\|null`	Возвращает URL-адрес формы, которая отправляет свои ответы на этот лист, или `null` если к этому листу не привязана форма.
`get Frozen Columns()`	`Integer`	Возвращает количество замороженных столбцов.
`get Frozen Rows()`	`Integer`	Возвращает количество замороженных строк.
`get Images()`	`Over Grid Image[]`	Возвращает все изображения, расположенные за пределами сетки на листе.
`get Index()`	`Integer`	Получает позицию листа в родительской электронной таблице.
`get Last Column()`	`Integer`	Возвращает позицию последнего столбца, содержащего контент.
`get Last Row()`	`Integer`	Возвращает позицию последней строки, содержащей контент.
`get Max Columns()`	`Integer`	Возвращает текущее количество столбцов в таблице, независимо от её содержимого.
`get Max Rows()`	`Integer`	Возвращает текущее количество строк в таблице, независимо от её содержимого.
`get Name()`	`String`	Возвращает название листа.
`get Named Ranges()`	`Named Range[]`	Получает все именованные диапазоны на этом листе.
`get Parent()`	`Spreadsheet`	Возвращает `Spreadsheet` , содержащую этот лист.
`get Pivot Tables()`	`Pivot Table[]`	Возвращает все сводные таблицы на этом листе.
`get Protections(type)`	`Protection[]`	Получает массив объектов, представляющих все защищенные диапазоны на листе, или массив из одного элемента, представляющий защиту на самом листе.
`get Range(row, column)`	`Range`	Возвращает диапазон, в котором верхняя левая ячейка находится по заданным координатам.
`get Range(row, column, numRows)`	`Range`	Возвращает диапазон, включающий верхнюю левую ячейку по заданным координатам и с заданным количеством строк.
`get Range(row, column, numRows, numColumns)`	`Range`	Возвращает диапазон, включающий верхнюю левую ячейку по заданным координатам, с заданным количеством строк и столбцов.
`get Range(a1Notation)`	`Range`	Возвращает диапазон, указанный в обозначении A1 или R1C1.
`get Range List(a1Notations)`	`Range List`	Возвращает коллекцию `Range List` , представляющую диапазоны на одном листе, заданные непустым списком обозначений A1 или R1C1.
`get Row Group(rowIndex, groupDepth)`	`Group \|null`	Возвращает группу строк по заданному индексу и глубине группировки.
`get Row Group Control Position()`	`Group Control Toggle Position`	Возвращает `Group Control Toggle Position` для всех групп строк на листе.
`get Row Group Depth(rowIndex)`	`Integer`	Возвращает глубину группировки строки по заданному индексу.
`get Row Height(rowPosition)`	`Integer`	Получает высоту заданной строки в пикселях.
`get Selection()`	`Selection`	Возвращает текущий `Selection` в электронной таблице.
`get Sheet Id()`	`Integer`	Возвращает идентификатор листа, представленного этим объектом.
`get Sheet Name()`	`String`	Возвращает название листа.
`get Sheet Values(startRow, startColumn, numRows, numColumns)`	`Object[][]`	Возвращает прямоугольную сетку значений для данного диапазона, начиная с заданных координат.
`get Slicers()`	`Slicer[]`	Возвращает массив срезов на листе.
`get Tab Color Object()`	`Color \|null`	Получает цвет вкладки листа или `null` , если вкладка листа не имеет цвета.
`get Type()`	`Sheet Type`	Возвращает тип листа.
`has Hidden Gridlines()`	`Boolean`	Возвращает `true` , если линии сетки листа скрыты; в противном случае возвращает `false` .
`hide Column(column)`	`void`	Скрывает столбец или столбцы в заданном диапазоне.
`hide Columns(columnIndex)`	`void`	Скрывает один столбец по заданному индексу.
`hide Columns(columnIndex, numColumns)`	`void`	Скрывает один или несколько последовательных столбцов, начиная с заданного индекса.
`hide Row(row)`	`void`	Скрывает строки в заданном диапазоне.
`hide Rows(rowIndex)`	`void`	Скрывает строку по заданному индексу.
`hide Rows(rowIndex, numRows)`	`void`	Скрывает одну или несколько последовательных строк, начиная с заданного индекса.
`hide Sheet()`	`Sheet`	Скрывает этот лист.
`insert Chart(chart)`	`void`	Добавляет новую диаграмму на этот лист.
`insert Column After(afterPosition)`	`Sheet`	Вставляет столбец после указанной позиции столбца.
`insert Column Before(beforePosition)`	`Sheet`	Вставляет столбец перед указанным столбцом.
`insert Columns(columnIndex)`	`void`	Вставляет пустой столбец на листе в указанное место.
`insert Columns(columnIndex, numColumns)`	`void`	Вставляет один или несколько последовательных пустых столбцов на листе, начиная с указанного места.
`insert Columns After(afterPosition, howMany)`	`Sheet`	Вставляет заданное количество столбцов после заданной позиции столбца.
`insert Columns Before(beforePosition, howMany)`	`Sheet`	Вставляет несколько столбцов перед указанной позицией столбца.
`insert Image(blobSource, column, row)`	`Over Grid Image`	Вставляет объект `Blob Source` в виде изображения в документ в заданную строку и столбец.
`insert Image(blobSource, column, row, offsetX, offsetY)`	`Over Grid Image`	Вставляет объект `Blob Source` в качестве изображения в документ в заданной строке и столбце со смещением в пикселях.
`insert Image(url, column, row)`	`Over Grid Image`	Вставляет изображение в документ в заданную строку и столбец.
`insert Image(url, column, row, offsetX, offsetY)`	`Over Grid Image`	Вставляет изображение в документ в заданную строку и столбец со смещением в пикселях.
`insert Row After(afterPosition)`	`Sheet`	Вставляет строку после указанной позиции.
`insert Row Before(beforePosition)`	`Sheet`	Вставляет строку перед указанной позицией строки.
`insert Rows(rowIndex)`	`void`	Вставляет пустую строку в лист в указанном месте.
`insert Rows(rowIndex, numRows)`	`void`	Вставляет одну или несколько последовательных пустых строк в лист, начиная с указанного места.
`insert Rows After(afterPosition, howMany)`	`Sheet`	Вставляет несколько строк после указанной позиции.
`insert Rows Before(beforePosition, howMany)`	`Sheet`	Вставляет несколько строк перед указанной позицией строки.
`insert Slicer(range, anchorRowPos, anchorColPos)`	`Slicer`	Добавляет новый инструмент для нарезки на этот лист.
`insert Slicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`	`Slicer`	Добавляет новый инструмент для нарезки на этот лист.
`is Column Hidden By User(columnPosition)`	`Boolean`	Возвращает значение, указывающее, скрыт ли указанный столбец пользователем.
`is Right To Left()`	`Boolean`	Возвращает `true` если расположение элементов на этом листе — справа налево.
`is Row Hidden By Filter(rowPosition)`	`Boolean`	Возвращает значение, указывающее, скрыта ли заданная строка фильтром (а не представлением фильтра).
`is Row Hidden By User(rowPosition)`	`Boolean`	Возвращает значение, указывающее, скрыта ли заданная строка пользователем.
`is Sheet Hidden()`	`Boolean`	Возвращает `true` если лист в данный момент скрыт.
`move Columns(columnSpec, destinationIndex)`	`void`	Перемещает столбцы, выбранные заданным диапазоном, в позицию, указанную `destination Index` .
`move Rows(rowSpec, destinationIndex)`	`void`	Перемещает строки, выбранные в заданном диапазоне, в позицию, указанную `destination Index` .
`new Chart()`	`Embedded Chart Builder`	Возвращает конструктор для создания новой диаграммы на этом листе.
`protect()`	`Protection`	Создает объект, который может защитить таблицу от редактирования, за исключением пользователей, имеющих соответствующие разрешения.
`remove Chart(chart)`	`void`	Удаляет диаграмму с родительского листа.
`set Active Range(range)`	`Range`	Устанавливает указанный диапазон в качестве `active range` на активном листе, при этом верхняя левая ячейка в диапазоне становится `current cell` .
`set Active Range List(rangeList)`	`Range List`	Устанавливает указанный список диапазонов в качестве `active ranges` на активном листе.
`set Active Selection(range)`	`Range`	Задает область активного выделения для этого листа.
`set Active Selection(a1Notation)`	`Range`	Устанавливает активный выбор, как указано в обозначении A1 или R1C1.
`set Column Group Control Position(position)`	`Sheet`	Задает положение переключателя группы столбцов на листе.
`set Column Width(columnPosition, width)`	`Sheet`	Задает ширину указанного столбца в пикселях.
`set Column Widths(startColumn, numColumns, width)`	`Sheet`	Задает ширину указанных столбцов в пикселях.
`set Conditional Format Rules(rules)`	`void`	Заменяет все существующие правила условного форматирования в таблице правилами ввода.
`set Current Cell(cell)`	`Range`	Устанавливает указанную ячейку в качестве `current cell` .
`set Frozen Columns(columns)`	`void`	Замораживает заданное количество столбцов.
`set Frozen Rows(rows)`	`void`	Замораживает заданное количество строк.
`set Hidden Gridlines(hideGridlines)`	`Sheet`	Скрывает или отображает линии сетки листа.
`set Name(name)`	`Sheet`	Задает название листа.
`set Right To Left(rightToLeft)`	`Sheet`	Устанавливает или отменяет расположение элементов на листе справа налево.
`set Row Group Control Position(position)`	`Sheet`	Задает положение переключателя группы строк на листе.
`set Row Height(rowPosition, height)`	`Sheet`	Задает высоту строки в пикселях.
`set Row Heights(startRow, numRows, height)`	`Sheet`	Задает высоту заданных строк в пикселях.
`set Row Heights Forced(startRow, numRows, height)`	`Sheet`	Задает высоту заданных строк в пикселях.
`set Tab Color(color)`	`Sheet`	Задает цвет вкладки листа.
`set Tab Color Object(color)`	`Sheet`	Задает цвет вкладки листа.
`show Columns(columnIndex)`	`void`	Отображает столбец по заданному индексу.
`show Columns(columnIndex, numColumns)`	`void`	Отображает один или несколько последовательных столбцов, начиная с заданного индекса.
`show Rows(rowIndex)`	`void`	Отображает строку по заданному индексу.
`show Rows(rowIndex, numRows)`	`void`	Отображает одну или несколько последовательных строк, начиная с заданного индекса.
`show Sheet()`	`Sheet`	Делает лист видимым.
`sort(columnPosition)`	`Sheet`	Сортирует лист по столбцам в порядке возрастания.
`sort(columnPosition, ascending)`	`Sheet`	Сортирует лист по столбцам.
`unhide Column(column)`	`void`	Отображает столбец в заданном диапазоне.
`unhide Row(row)`	`void`	Отображает строку в заданном диапазоне.
`update Chart(chart)`	`void`	Обновляет диаграмму на этом листе.

Устаревшие методы

Метод	Тип возвращаемого значения	Краткое описание
`get Sheet Protection()`	`Page Protection`	Возвращает экземпляр `Page Protection` , описывающий разрешения для текущего листа.
`get Tab Color()`	`String\|null`	Получает цвет вкладки листа или `null` , если вкладка листа не имеет цвета.
`set Sheet Protection(permissions)`	`void`	Устанавливает права доступа для текущего листа.

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

`activate()`

Активирует этот лист. Не изменяет сам лист, а только представление родительского листа об активном листе.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.activate();

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

Sheet — Новый активный лист.

`add Developer Metadata(key)`

Добавляет в таблицу метаданные разработчика с указанным ключом.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'NAME' to the developer metadata for the sheet.
sheet.addDeveloperMetadata('NAME');

// Gets the updated metadata info and logs it to the console.
console.log(sheet.getDeveloperMetadata()[0].getKey());

Параметры

Имя	Тип	Описание
`key`	`String`	Ключ к новым метаданным для разработчиков.

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

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

`add Developer Metadata(key, visibility)`

Добавляет в таблицу метаданные разработчика с указанным ключом и уровнем видимости.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'NAME' and sets the developer metadata visibility to PROJECT
// for the sheet.
sheet.addDeveloperMetadata(
    'NAME',
    SpreadsheetApp.DeveloperMetadataVisibility.PROJECT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getVisibility().toString());

Параметры

Имя	Тип	Описание
`key`	`String`	Ключ к новым метаданным для разработчиков.
`visibility`	`Developer Metadata Visibility`	Видимость новых метаданных разработчика.

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`add Developer Metadata(key, value)`

Добавляет в таблицу метаданные разработчика с указанным ключом и значением.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata for
// the sheet.
sheet.addDeveloperMetadata('COMPANY', 'TECH');

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());

Параметры

Имя	Тип	Описание
`key`	`String`	Ключ к новым метаданным для разработчиков.
`value`	`String`	Значение для новых метаданных разработчика.

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`add Developer Metadata(key, value, visibility)`

Добавляет в таблицу метаданные разработчика с указанным ключом, значением и уровнем видимости.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds the key 'COMPANY' with the value 'TECH' to the developer metadata and
// sets the visibility to DOCUMENT for the sheet.
sheet.addDeveloperMetadata(
    'COMPANY',
    'TECH',
    SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT,
);

// Gets the updated metadata info and logs it to the console.
const developerMetaData = sheet.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(developerMetaData.getValue());
console.log(developerMetaData.getVisibility().toString());

Параметры

Имя	Тип	Описание
`key`	`String`	Ключ к новым метаданным для разработчиков.
`value`	`String`	Значение для новых метаданных разработчика.
`visibility`	`Developer Metadata Visibility`	Видимость новых метаданных разработчика.

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`append Row(rowContents)`

Добавляет строку в конец текущей области данных на листе. Если содержимое ячейки начинается с символа = , это интерпретируется как формула.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(['a man', 'a plan', 'panama']);

Параметры

Имя	Тип	Описание
`row Contents`	`Object[]`	Массив значений для вставки после последней строки в таблице.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`as Data Source Sheet()`

Возвращает лист в качестве Data Source Sheet , если лист имеет тип Sheet Type.DATASOURCE , или null в противном случае.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can useSpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the data source sheet value if the sheet is of type
// SpreadsheetApp.SheetType.DATASOURCE, otherwise this returns a null value.
const dataSourceSheet = sheet.asDataSourceSheet();

// Gets the data source sheet value and logs it to the console.
console.log(dataSourceSheet);
console.log(sheet.getType().toString());

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

Data Source Sheet |null — Лист источника данных.

Авторизация

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

`auto Resize Column(columnPosition)`

Задает ширину указанного столбца в соответствии с его содержимым.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue(
    'Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

Параметры

Имя	Тип	Описание
`column Position`	`Integer`	Положение указанного столбца, размер которого необходимо изменить.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`auto Resize Columns(startColumn, numColumns)`

Задает ширину всех столбцов, начиная с указанной позиции, в соответствии с их содержимым.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first 15 columns to a width that fits their text.
sheet.autoResizeColumns(1, 15);

Параметры

Имя	Тип	Описание
`start Column`	`Integer`	Начальный столбец для автоматического изменения размера.
`num Columns`	`Integer`	Количество столбцов, размер которых будет автоматически изменяться.

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`auto Resize Rows(startRow, numRows)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first 15 rows to a height that fits their text.
sheet.autoResizeRows(1, 15);

Параметры

Имя	Тип	Описание
`start Row`	`Integer`	Начальный ряд для автоматического изменения размера.
`num Rows`	`Integer`	Количество строк, размер которых будет изменяться автоматически.

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`clear()`

Очищает лист от содержимого и информации о форматировании.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clear();

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

Sheet — Очищенный лист.

Авторизация

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

`clear(options)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
sheet.clear({formatOnly: true, contentsOnly: true});

Параметры

Имя	Тип	Описание
`options`	`Object`	Карта на JavaScript с расширенными настройками, перечисленными ниже.

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

Имя	Тип	Описание
`contents Only`	`Boolean`	Очистить ли контент.
`format Only`	`Boolean`	Следует ли очистить формат.

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`clear Conditional Format Rules()`

Удаляет все правила условного форматирования с листа. Эквивалентно вызову set Conditional Format Rules(rules) с пустым массивом в качестве входных данных.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.clearConditionalFormatRules();

Авторизация

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

`clear Contents()`

Очищает оглавление, сохраняя при этом информацию о форматировании.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearContents();

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`clear Formats()`

Удаляет форматирование с листа, сохраняя при этом его содержимое.

Форматирование относится к тому, как данные форматируются в соответствии с параметрами меню «Формат» (например, полужирный шрифт, курсив, условное форматирование), а не к ширине или высоте ячеек.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearFormats();

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`clear Notes()`

Удаляет все заметки с листа.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.clearNotes();

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`collapse All Column Groups()`

Сворачивает все группы столбцов на листе.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups on the sheet are collapsed.
sheet.collapseAllColumnGroups();

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`collapse All Row Groups()`

Сворачивает все группы строк на листе.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups on the sheet are collapsed.
sheet.collapseAllRowGroups();

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`copy To(spreadsheet)`

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

const source = SpreadsheetApp.getActiveSpreadsheet();
const sheet = source.getSheets()[0];

const destination = SpreadsheetApp.openById('ID_GOES HERE');
sheet.copyTo(destination);

Параметры

Имя	Тип	Описание
`spreadsheet`	`Spreadsheet`	Электронная таблица, в которую нужно скопировать этот лист, может быть той же самой, что и исходная таблица.

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

Sheet — новый лист для плетения цепей.

Авторизация

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

`create Developer Metadata Finder()`

Возвращает Developer Metadata Finder для поиска метаданных разработчика в пределах данного листа. Метаданные находятся в пределах конкретного листа, если они либо связаны с самим листом, либо связаны со строкой, столбцом или диапазоном на этом листе.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Creates the developer metadata finder.
const metadatafinder = sheet.createDeveloperMetadataFinder();

// Finds the metadata with value 'PARIS' and displays its key in the console.
console.log(metadatafinder.withValue('PARIS').find()[0].getKey());

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

Developer Metadata Finder — средство поиска метаданных для разработчиков, позволяющее находить данные в рамках данного листа.

`create Text Finder(findText)`

Создает средство поиска текста для листа, которое может находить и заменять текст внутри листа.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Creates  a text finder.
const textFinder = sheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the sheet.
const firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
const numOccurrencesReplaced = firstOccurrence.replaceWith('cat');

Параметры

Имя	Тип	Описание
`find Text`	`String`	Текст для поиска.

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

Text Finder — программа Text Finder на листе.

`delete Column(columnPosition)`

Удаляет столбец в указанной позиции.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

Параметры

Имя	Тип	Описание
`column Position`	`Integer`	Позиция столбца, начиная с 1 для первого столбца.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`delete Columns(columnPosition, howMany)`

Удаляет несколько столбцов, начиная с указанной позиции.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

Параметры

Имя	Тип	Описание
`column Position`	`Integer`	Позиция первого столбца для удаления.
`how Many`	`Integer`	Количество столбцов для удаления.

Авторизация

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

`delete Row(rowPosition)`

Удаляет строку в указанной позиции.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

Параметры

Имя	Тип	Описание
`row Position`	`Integer`	Позиция строки, начиная с 1 для первой строки.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`delete Rows(rowPosition, howMany)`

Удаляет несколько строк, начиная с указанной позиции.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

Параметры

Имя	Тип	Описание
`row Position`	`Integer`	Позиция первой строки, подлежащей удалению.
`how Many`	`Integer`	Количество строк для удаления.

Авторизация

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

`expand All Column Groups()`

Разворачивает все группы столбцов на листе. Для этого метода требуется как минимум одна группа столбцов.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups on the sheet are expanded.
sheet.expandAllColumnGroups();

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`expand All Row Groups()`

Разворачивает все группы строк на листе. Для этого метода требуется как минимум одна группа строк.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups on the sheet are expanded.
sheet.expandAllRowGroups();

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`expand Column Groups Up To Depth(groupDepth)`

Разворачивает все группы столбцов до заданной глубины и сворачивает все остальные.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All column groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandColumnGroupsUpToDepth(2);

Параметры

Имя	Тип	Описание
`group Depth`	`Integer`	Глубина группировки, до которой следует расширять группы столбцов.

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`expand Row Groups Up To Depth(groupDepth)`

Разворачивает все группы строк до заданной глубины и сворачивает все остальные.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// All row groups of depth 2 and lower are expanded, and groups with depth
// 3 and higher are collapsed.
sheet.expandRowGroupsUpToDepth(2);

Параметры

Имя	Тип	Описание
`group Depth`	`Integer`	Глубина группировки, до которой следует расширять группы строк.

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`get Active Cell()`

Возвращает активную ячейку на этом листе.

Примечание: предпочтительнее использовать get Current Cell() , который возвращает текущую выделенную ячейку.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Returns the active cell
const cell = sheet.getActiveCell();

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

Range — Текущая активная ячейка.

Авторизация

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

`get Active Range()`

Возвращает выбранный диапазон на активном листе или null , если активного диапазона нет. Если выбрано несколько диапазонов, этот метод возвращает только последний выбранный диапазон.

Термин «активный диапазон» относится к диапазону, выбранному пользователем на активном листе, но в пользовательской функции он относится к ячейке, которая активно пересчитывается.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const activeRange = sheet.getActiveRange();

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

Range — Активный диапазон.

Авторизация

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

См. также

set Active Range(range)

`get Active Range List()`

Возвращает список активных диапазонов на активном листе или null , если активных диапазонов нет.

Если выбран только один диапазон, это работает как вызов get Active Range() .

const sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
const activeRangeList = sheet.getActiveRangeList();

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

Range List |null — Список активных диапазонов.

Авторизация

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

См. также

set Active Range List(rangeList)

`get Bandings()`

Возвращает все полосы на этом листе.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the banding info for the sheet.
const bandings = sheet.getBandings();

// Gets info on the bandings' second row color and logs it to the console.
for (const banding of bandings) {
  console.log(banding.getSecondRowColor());
}

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

Banding[] — Все полосы на этом листе.

Авторизация

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

`get Charts()`

Возвращает массив диаграмм на этом листе.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const charts = sheet.getCharts();

for (const i in charts) {
  const chart = charts[i];
  // Do something with the chart
}

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

Embedded Chart[] — массив диаграмм.

Авторизация

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

`get Column Group(columnIndex, groupDepth)`

Возвращает группу столбцов по заданному индексу и глубине группировки.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Returns the group whose control index is at column 2 and has a depth of 1, or
// null if the group doesn’t exist.
const columnGroup = sheet.getColumnGroup(2, 1);

Параметры

Имя	Тип	Описание
`column Index`	`Integer`	Индекс столбца переключателя управления группой или индекс внутри группы.
`group Depth`	`Integer`	Глубина группы.

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

Group |null — Группа столбцов по индексу и глубине управления, или генерирует исключение, если группа не существует.

Авторизация

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

`get Column Group Control Position()`

Возвращает Group Control Toggle Position для всех групп столбцов на листе.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// GroupControlTogglePosition.AFTER if the column grouping control toggle is
// shown after the group.
const columnGroupControlPosition = sheet.getColumnGroupControlPosition();

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

Group Control Toggle Position — true если переключатель групповой группировки отображается после группы на этом листе, и false в противном случае.

Авторизация

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

`get Column Group Depth(columnIndex)`

Возвращает глубину группировки столбца по заданному индексу.

Глубина группировки указывает, сколько групп перекрывается с данным столбцом. Это значение может варьироваться от нуля до восьми.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// 1 if there is a group over columns 1 through 3
const groupDepth = sheet.getColumnGroupDepth(1);

Параметры

Имя	Тип	Описание
`column Index`	`Integer`	Указатель колонки.

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

Integer — глубина группы столбца по заданному индексу.

Авторизация

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

`get Column Width(columnPosition)`

Получает ширину заданного столбца в пикселях.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Параметры

Имя	Тип	Описание
`column Position`	`Integer`	Положение исследуемой колонны.

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

Integer — ширина столбца в пикселях.

Авторизация

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

`get Conditional Format Rules()`

В этом листе собраны все правила условного форматирования.

// Logs the conditional format rules in a sheet.
const rules = SpreadsheetApp.getActiveSheet().getConditionalFormatRules();
for (let i = 0; i < rules.length; i++) {
  const rule = rules[i];
  Logger.log(rule);
}

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

Conditional Format Rule[] — массив всех правил на листе.

Авторизация

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

`get Current Cell()`

Возвращает текущую ячейку на активном листе или null , если текущей ячейки нет. Текущая ячейка — это ячейка, находящаяся в фокусе в пользовательском интерфейсе Google Sheets и выделенная темной рамкой. Текущих ячеек никогда не бывает больше одной. Когда пользователь выбирает один или несколько диапазонов ячеек, одна из ячеек в выделении становится текущей.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
const currentCell = sheet.getCurrentCell();

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

Range |null — Текущая ячейка.

Авторизация

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

`get Data Range()`

Возвращает Range , соответствующий измерениям, в которых присутствуют данные.

Это функционально эквивалентно созданию диапазона, ограниченного ячейкой A1 и (Sheet.getLastColumn(), Sheet.getLastRow()).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This represents ALL the data
const range = sheet.getDataRange();
const values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = `${row},`;
  }
  Logger.log(row);
}

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

Range — диапазон, включающий все данные в электронной таблице.

Авторизация

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

`get Data Source Formulas()`

Получает все формулы источника данных.

// Opens the spreadsheet by its ID. If you created your script from within a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

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

Data Source Formula[] — Список формул источников данных.

Авторизация

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

`get Data Source Pivot Tables()`

Получает все сводные таблицы источников данных.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

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

Data Source Pivot Table[] — Список сводных таблиц источников данных.

Авторизация

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

`get Data Source Tables()`

Получает все таблицы источников данных.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

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

Data Source Table[] — Список таблиц источников данных.

Авторизация

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

`get Developer Metadata()`

Получить все метаданные разработчика, связанные с этим листом.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Adds developer metadata for testing.
sheet.addDeveloperMetadata('CITY', 'PARIS');

// Gets all the developer metadata for the sheet.
const developerMetaDataList = sheet.getDeveloperMetadata();

// Logs the developer metadata to the console.
for (const developerMetaData of developerMetaDataList) {
  console.log(developerMetaData.getKey());
}

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

Developer Metadata[] — Метаданные разработчика, связанные с этим листом.

Авторизация

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

`get Drawings()`

Возвращает массив рисунков на листе.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the drawings from the sheet.
const allDrawings = sheet.getDrawings();

// Logs the number of drawings present on the sheet.
console.log(allDrawings.length);

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

Drawing[] — Список рисунков на этом листе.

Авторизация

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

`get Filter()`

Возвращает фильтр, используемый в этом листе, или null если фильтр отсутствует.

// Gets the filter on the active sheet.
const ss = SpreadsheetApp.getActiveSheet();
const filter = ss.getFilter();

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

Filter |null — Фильтр.

Авторизация

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

`get Form Url()`

Возвращает URL-адрес формы, которая отправляет ответы на этот лист, или null если к этому листу не привязана форма. Генерирует исключение, если у пользователя нет разрешения на редактирование электронной таблицы.

const sheet = SpreadsheetApp.getActiveSheet();
const url = sheet.getFormUrl();

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

String|null — URL формы, ответы на которую сохраняются в этом листе, или null если к этому листу не привязана форма.

Авторизация

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

`get Frozen Columns()`

Возвращает количество замороженных столбцов.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen columns: %s', sheet.getFrozenColumns());

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

Integer — количество замороженных столбцов.

Авторизация

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

`get Frozen Rows()`

Возвращает количество замороженных строк.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen rows: %s', sheet.getFrozenRows());

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

Integer — количество замороженных строк.

Авторизация

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

`get Images()`

Возвращает все изображения, расположенные за пределами сетки на листе.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use
// ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
  console.log(image.getAnchorCell().getA1Notation());
}

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

Over Grid Image[] — Массив изображений, выходящих за пределы сетки.

Авторизация

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

`get Index()`

Получает позицию листа в родительской электронной таблице. Начинается с 1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
// Note that the JavaScript index is 0, but this logs 1
const sheet = ss.getSheets()[0];
// ... because spreadsheets are 1-indexed
Logger.log(sheet.getIndex());

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

Integer — Позиция листа в родительской электронной таблице.

Авторизация

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

`get Last Column()`

Возвращает позицию последнего столбца, содержащего контент.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

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

Integer — последний столбец листа, содержащий контент.

Авторизация

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

`get Last Row()`

Возвращает позицию последней строки, содержащей контент.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

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

Integer — последняя строка листа, содержащая контент.

Авторизация

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

`get Max Columns()`

Возвращает текущее количество столбцов в таблице, независимо от её содержимого.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
Logger.log(first.getMaxColumns());

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

Integer — максимальная ширина листа.

Авторизация

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

`get Max Rows()`

Возвращает текущее количество строк в таблице, независимо от её содержимого.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
Logger.log(first.getMaxRows());

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

Integer — максимальная высота листа.

Авторизация

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

`get Name()`

Возвращает название листа.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
Logger.log(sheet.getName());

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

String — Название листа.

Авторизация

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

`get Named Ranges()`

Получает все именованные диапазоны на этом листе.

// The code below logs the name of the first named range.
const namedRanges = SpreadsheetApp.getActiveSheet().getNamedRanges();
if (namedRanges.length > 1) {
  Logger.log(namedRanges[0].getName());
}

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

Named Range[] — массив всех именованных диапазонов на листе.

Авторизация

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

`get Parent()`

Возвращает Spreadsheet , содержащую этот лист.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// parent is identical to ss
const parent = sheet.getParent();

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

Spreadsheet — основная электронная таблица.

Авторизация

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

`get Pivot Tables()`

Возвращает все сводные таблицы на этом листе.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all the pivot table info for the sheet.
const pivotTables = sheet.getPivotTables();

// Logs the pivot tables to the console.
for (const pivotTable of pivotTables) {
  console.log(pivotTable.getSourceDataRange().getValues());
}

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

Pivot Table[] — Сводные таблицы на этом листе.

Авторизация

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

`get Protections(type)`

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

// Remove all range protections in the spreadsheet that the user has permission
// to edit.
const sheet = SpreadsheetApp.getActiveSheet();
const protections = sheet.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

// Remove sheet protection from the active sheet, if the user has permission to
// edit it.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0];
if (protection?.canEdit()) {
  protection.remove();
}

Параметры

Имя	Тип	Описание
`type`	`Protection Type`	Тип защищаемой области: либо `Spreadsheet App.ProtectionType.RANGE` , либо `Spreadsheet App.ProtectionType.SHEET` .

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

Protection[] — массив объектов, представляющий все защищенные диапазоны на листе, или массив из одного элемента, представляющий защиту самого листа.

Авторизация

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

`get Range(row, column)`

Возвращает диапазон, в котором верхняя левая ячейка находится по заданным координатам.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Passing only two arguments returns a "range" with a single cell.
const range = sheet.getRange(1, 1);
const values = range.getValues();
Logger.log(values[0][0]);

Параметры

Имя	Тип	Описание
`row`	`Integer`	Индекс строки ячейки, которую необходимо вернуть; индексация строк начинается с 1.
`column`	`Integer`	Индекс столбца ячейки, которую необходимо вернуть; индексация столбцов начинается с 1.

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

Range — диапазон, содержащий только эту ячейку.

Авторизация

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

`get Range(row, column, numRows)`

Возвращает диапазон, включающий верхнюю левую ячейку по заданным координатам и с заданным количеством строк.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// When the "numRows" argument is used, only a single column of data is
// returned.
const range = sheet.getRange(1, 1, 3);
const values = range.getValues();

// Prints 3 values from the first column, starting from row 1.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Параметры

Имя	Тип	Описание
`row`	`Integer`	Начальный индекс строки диапазона; индексация строк начинается с 1.
`column`	`Integer`	Индекс столбца диапазона; индексация столбцов начинается с 1.
`num Rows`	`Integer`	Количество строк для возврата.

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

Range — диапазон, содержащий один столбец данных с указанным количеством строк.

Авторизация

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

`get Range(row, column, numRows, numColumns)`

Возвращает диапазон, включающий верхнюю левую ячейку по заданным координатам, с заданным количеством строк и столбцов.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
const range = sheet.getRange(1, 1, 3, 3);
const values = range.getValues();

// Print values from a 3x3 box.
for (const row in values) {
  for (const col in values[row]) {
    Logger.log(values[row][col]);
  }
}

Параметры

Имя	Тип	Описание
`row`	`Integer`	Начальный индекс строки диапазона; индексация строк начинается с 1.
`column`	`Integer`	Начальный индекс столбца диапазона; индексация столбцов начинается с 1.
`num Rows`	`Integer`	Количество строк для возврата.
`num Columns`	`Integer`	Количество столбцов для возврата.

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

Range — диапазон, соответствующий указанной области.

Авторизация

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

`get Range(a1Notation)`

Возвращает диапазон, указанный в обозначении A1 или R1C1.

// Get a range A1:D4 on sheet titled "Invoices"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange('Invoices!A1:D4');

// Get cell A1 on the first sheet
const sheet = ss.getSheets()[0];
const cell = sheet.getRange('A1');

Параметры

Имя	Тип	Описание
`a1Notation`	`String`	Возвращаемый диапазон, указанный в обозначении A1 или R1C1.

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

Range — дальность действия в указанном месте.

Авторизация

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

`get Range List(a1Notations)`

Возвращает коллекцию Range List , представляющую диапазоны на одном листе, заданные непустым списком обозначений A1 или R1C1.

// Get a list of ranges A1:D4, F1:H4.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);

Параметры

Имя	Тип	Описание
`a1Notations`	`String[]`	Список диапазонов для возврата, указанный в обозначении A1 или R1C1.

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

Range List — Список дистанции в указанном месте.

Авторизация

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

`get Row Group(rowIndex, groupDepth)`

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// Returns the group whose control index is at row 2 and has a depth of 1, or
// null if the group doesn’t exist.
const rowGroup = sheet.getRowGroup(2, 1);

Параметры

Имя	Тип	Описание
`row Index`	`Integer`	Индекс строки переключателя управления группой или индекс внутри группы.
`group Depth`	`Integer`	Глубина группы.

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

Group |null — Группа строк по индексу и глубине управления, или генерирует исключение, если группа не существует.

Авторизация

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

`get Row Group Control Position()`

Возвращает Group Control Toggle Position для всех групп строк на листе.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// GroupControlTogglePosition.AFTER if the row grouping control toggle is shown
// after the group.
const rowGroupControlPosition = sheet.getRowGroupControlPosition();

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

Group Control Toggle Position — true если переключатель управления группировкой строк отображается после группы на этом листе, и false в противном случае.

Авторизация

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

`get Row Group Depth(rowIndex)`

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

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];

// 1 if there is a group over rows 1 through 3
const groupDepth = sheet.getRowGroupDepth(1);

Параметры

Имя	Тип	Описание
`row Index`	`Integer`	Индекс строки.

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

Integer — глубина группировки строки по заданному индексу.

Авторизация

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

`get Row Height(rowPosition)`

Получает высоту заданной строки в пикселях.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Параметры

Имя	Тип	Описание
`row Position`	`Integer`	Положение строки, подлежащей исследованию.

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

Integer — высота строки в пикселях.

Авторизация

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

`get Selection()`

Возвращает текущий Selection в электронной таблице.

const selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
const currentCell = selection.getCurrentCell();

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

Selection — Текущий состав команды.

Авторизация

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

`get Sheet Id()`

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

Это уникальный идентификатор листа в электронной таблице. Идентификатор представляет собой монотонно возрастающее целое число, присваиваемое при создании листа и не зависящее от его положения. Это полезно в сочетании с такими методами, как Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) которые принимают в качестве параметра grid Id а не экземпляр Sheet .

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

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

Integer — идентификатор листа, уникальный для данной электронной таблицы.

Авторизация

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

`get Sheet Name()`

Возвращает название листа.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

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

String — Название листа.

Авторизация

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

`get Sheet Values(startRow, startColumn, numRows, numColumns)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// The two samples below produce the same output
let values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

const range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Параметры

Имя	Тип	Описание
`start Row`	`Integer`	Положение стартового ряда.
`start Column`	`Integer`	Положение стартовой колонны.
`num Rows`	`Integer`	Количество строк, для которых необходимо вернуть значения.
`num Columns`	`Integer`	Количество столбцов, для которых необходимо вернуть значения.

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

Object[][] — двумерный массив значений.

Авторизация

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

`get Slicers()`

Возвращает массив срезов на листе.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets all slicers in the spreadsheet.
const slicers = sheet.getSlicers();

// Logs the slicer titles to the console.
for (const slicer of slicers) {
  console.log(slicer.getTitle());
}

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

Slicer[] — Список слайсеров на этом листе.

Авторизация

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

`get Tab Color Object()`

Получает цвет вкладки листа или null , если вкладка листа не имеет цвета.

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = first.getTabColorObject();

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

Color |null — Цвет вкладки листа или null , если у вкладки листа нет цвета.

Авторизация

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

`get Type()`

Возвращает тип листа.

Тип листа по умолчанию — Sheet Type.GRID . Лист, содержащий один встроенный объект, например, Embedded Chart является листом Sheet Type.OBJECT .

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
Logger.log(sheet.getType());

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

Sheet Type — Тип листа.

Авторизация

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

`has Hidden Gridlines()`

Возвращает true , если линии сетки листа скрыты; в противном случае возвращает false . Линии сетки видны по умолчанию.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if the spreadsheet has hidden gridelines and logs the result to the
// console.
console.log(sheet.hasHiddenGridlines());

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

Boolean — true если линии сетки скрыты; false в противном случае.

Авторизация

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

`hide Column(column)`

Скрывает столбец или столбцы в заданном диапазоне.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange('A1');
sheet.hideColumn(range);

// This hides the first 3 columns
range = sheet.getRange('A:C');
sheet.hideColumn(range);

Параметры

Имя	Тип	Описание
`column`	`Range`	Диапазон столбцов, которые нужно скрыть.

Авторизация

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

`hide Columns(columnIndex)`

Скрывает один столбец по заданному индексу. Для этого метода используйте индекс 1.

Чтобы скрыть более одного столбца, используя индекс, воспользуйтесь hide Columns(columnIndex, numColumns) .

Чтобы скрыть несколько столбцов, используя диапазон, воспользуйтесь hide Column() .

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first column
sheet.hideColumns(1);

Параметры

Имя	Тип	Описание
`column Index`	`Integer`	Индекс столбца, который нужно скрыть.

Авторизация

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

`hide Columns(columnIndex, numColumns)`

Скрывает один или несколько последовательных столбцов, начиная с заданного индекса. Для этого метода используйте индекс 1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three columns
sheet.hideColumns(1, 3);

Параметры

Имя	Тип	Описание
`column Index`	`Integer`	Начальный индекс столбцов, которые нужно скрыть.
`num Columns`	`Integer`	Количество скрываемых столбцов.

Авторизация

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

`hide Row(row)`

Скрывает строки в заданном диапазоне.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first row
const range = sheet.getRange('A1');
sheet.hideRow(range);

Параметры

Имя	Тип	Описание
`row`	`Range`	Диапазон строк для скрытия.

Авторизация

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

`hide Rows(rowIndex)`

Скрывает строку по заданному индексу.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first row
sheet.hideRows(1);

Параметры

Имя	Тип	Описание
`row Index`	`Integer`	Индекс строки, которую нужно скрыть.

Авторизация

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

`hide Rows(rowIndex, numRows)`

Скрывает одну или несколько последовательных строк, начиная с заданного индекса.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Hides the first three rows
sheet.hideRows(1, 3);

Параметры

Имя	Тип	Описание
`row Index`	`Integer`	Начальный индекс строк, которые нужно скрыть.
`num Rows`	`Integer`	Количество строк, которые нужно скрыть.

Авторизация

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

`hide Sheet()`

Скрывает этот лист. Не оказывает никакого эффекта, если лист уже скрыт. Если этот метод вызывается для единственного видимого листа, он генерирует исключение.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.hideSheet();

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

Sheet — Текущий лист.

Авторизация

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

`insert Chart(chart)`

Добавляет новую диаграмму на этот лист.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This creates a simple bar chart from the first three rows
// of the first two columns of the spreadsheet
const chart = sheet.newChart()
                  .setChartType(Charts.ChartType.BAR)
                  .addRange(sheet.getRange('A1:B4'))
                  .setPosition(5, 5, 0, 0)
                  .setOption('title', 'Dynamic Chart')
                  .build();
sheet.insertChart(chart);

Параметры

Имя	Тип	Описание
`chart`	`Embedded Chart`	Диаграмма для вставки.

Авторизация

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

`insert Column After(afterPosition)`

Вставляет столбец после указанной позиции столбца.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Параметры

Имя	Тип	Описание
`after Position`	`Integer`	Столбец, после которого следует добавить новый столбец.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`insert Column Before(beforePosition)`

Вставляет столбец перед указанным столбцом.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Параметры

Имя	Тип	Описание
`before Position`	`Integer`	Столбец, перед которым следует добавить новый столбец.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`insert Columns(columnIndex)`

Вставляет пустой столбец на листе в указанное место.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by one
sheet.insertColumns(1);

Параметры

Имя	Тип	Описание
`column Index`	`Integer`	Индекс, указывающий место вставки столбца.

Авторизация

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

`insert Columns(columnIndex, numColumns)`

Вставляет один или несколько последовательных пустых столбцов на листе, начиная с указанного места.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all columns by three
sheet.insertColumns(1, 3);

Параметры

Имя	Тип	Описание
`column Index`	`Integer`	Индекс, указывающий место вставки столбца.
`num Columns`	`Integer`	Количество столбцов для вставки.

Авторизация

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

`insert Columns After(afterPosition, howMany)`

Вставляет заданное количество столбцов после заданной позиции столбца.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the
// spreadsheet.
sheet.insertColumnsAfter(1, 2);

Параметры

Имя	Тип	Описание
`after Position`	`Integer`	Столбец, после которого следует добавить новый столбец.
`how Many`	`Integer`	Количество столбцов для вставки.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`insert Columns Before(beforePosition, howMany)`

Вставляет несколько столбцов перед указанной позицией столбца.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Параметры

Имя	Тип	Описание
`before Position`	`Integer`	Столбец, перед которым следует добавить новый столбец.
`how Many`	`Integer`	Количество столбцов для вставки.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`insert Image(blobSource, column, row)`

Вставляет объект Blob Source в качестве изображения в документ в заданную строку и столбец. Размер изображения определяется по содержимому объекта Blob. Максимально поддерживаемый размер объекта Blob составляет 2 МБ.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Параметры

Имя	Тип	Описание
`blob Source`	`Blob Source`	Объект типа BLOB, содержащий содержимое изображения, MIME-тип и (при необходимости) имя.
`column`	`Integer`	Положение колонны.
`row`	`Integer`	Положение в ряду.

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

Over Grid Image — вставленное изображение.

Авторизация

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

`insert Image(blobSource, column, row, offsetX, offsetY)`

Вставляет объект Blob Source в качестве изображения в документ в заданной строке и столбце с пиксельным смещением. Размер изображения определяется по содержимому объекта Blob. Максимально поддерживаемый размер объекта Blob составляет 2 МБ.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Параметры

Имя	Тип	Описание
`blob Source`	`Blob Source`	Объект типа BLOB, содержащий содержимое изображения, MIME-тип и (при необходимости) имя.
`column`	`Integer`	Положение колонны.
`row`	`Integer`	Положение в ряду.
`offsetX`	`Integer`	Горизонтальное смещение от угла ячейки в пикселях.
`offsetY`	`Integer`	Вертикальное смещение от угла ячейки в пикселях.

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

Over Grid Image — вставленное изображение.

Авторизация

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

`insert Image(url, column, row)`

Вставляет изображение в документ в заданную строку и столбец.

Указанный URL-адрес должен быть общедоступным.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage('https://www.google.com/images/srpr/logo3w.png', 1, 1);

Параметры

Имя	Тип	Описание
`url`	`String`	URL изображения.
`column`	`Integer`	Положение столбца сетки.
`row`	`Integer`	Позиция строки сетки.

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

Over Grid Image — вставленное изображение.

Авторизация

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

`insert Image(url, column, row, offsetX, offsetY)`

Вставляет изображение в документ в заданную строку и столбец со смещением в пикселях.

Указанный URL-адрес должен быть общедоступным.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage(
    'https://www.google.com/images/srpr/logo3w.png',
    1,
    1,
    10,
    10,
);

Параметры

Имя	Тип	Описание
`url`	`String`	URL изображения.
`column`	`Integer`	Положение колонны.
`row`	`Integer`	Положение в ряду.
`offsetX`	`Integer`	Горизонтальное смещение от угла ячейки в пикселях.
`offsetY`	`Integer`	Вертикальное смещение от угла ячейки в пикселях.

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

Over Grid Image — вставленное изображение.

Авторизация

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

`insert Row After(afterPosition)`

Вставляет строку после указанной позиции.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Параметры

Имя	Тип	Описание
`after Position`	`Integer`	Строка, после которой следует добавить новую строку.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`insert Row Before(beforePosition)`

Вставляет строку перед указанной позицией строки.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Параметры

Имя	Тип	Описание
`before Position`	`Integer`	Строка, перед которой следует добавить новую строку.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`insert Rows(rowIndex)`

Вставляет пустую строку в лист в указанном месте.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by one
sheet.insertRows(1);

Параметры

Имя	Тип	Описание
`row Index`	`Integer`	Индекс, указывающий место вставки строки.

Авторизация

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

`insert Rows(rowIndex, numRows)`

Вставляет одну или несколько последовательных пустых строк в лист, начиная с указанного места.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Shifts all rows down by three
sheet.insertRows(1, 3);

Параметры

Имя	Тип	Описание
`row Index`	`Integer`	Индекс, указывающий место вставки строки.
`num Rows`	`Integer`	Количество строк для вставки.

Авторизация

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

`insert Rows After(afterPosition, howMany)`

Вставляет несколько строк после указанной позиции.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Параметры

Имя	Тип	Описание
`after Position`	`Integer`	Строка, после которой следует добавлять новые строки.
`how Many`	`Integer`	Количество строк для вставки.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`insert Rows Before(beforePosition, howMany)`

Вставляет несколько строк перед указанной позицией строки.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Параметры

Имя	Тип	Описание
`before Position`	`Integer`	Строка, перед которой следует добавлять новые строки.
`how Many`	`Integer`	Количество строк для вставки.

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

Sheet — это таблица, полезная для организации цепочек методов.

Авторизация

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

`insert Slicer(range, anchorRowPos, anchorColPos)`

Добавляет новый инструмент для нарезки на этот лист.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range of the sheet.
const range = sheet.getRange('A1:D10');

// Inserts the slicer with a random range into the sheet.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

Параметры

Имя	Тип	Описание
`range`	`Range`	Диапазон, в пределах которого создается слайсер.
`anchor Row Pos`	`Integer`	Верхняя сторона слайсера закреплена в этом ряду.
`anchor Col Pos`	`Integer`	Верхняя сторона слайсера закреплена в этом месте.

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

Slicer — недавно установленный слайсер.

Авторизация

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

`insert Slicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`

Добавляет новый инструмент для нарезки на этот лист.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the range.
const range = sheet.getRange('A1:D10');

// Inserts a slicer using the random range function.
const insertSlicers = sheet.insertSlicer(range.randomize(), 1, 10, 0, 0);

// Logs the insert slicer result to the console.
console.log(insertSlicers);

Параметры

Имя	Тип	Описание
`range`	`Range`	Диапазон, в пределах которого создается слайсер.
`anchor Row Pos`	`Integer`	Верхняя сторона слайсера закреплена в этом ряду.
`anchor Col Pos`	`Integer`	Верхняя сторона слайсера закреплена в этом месте.
`offsetX`	`Integer`	Горизонтальное смещение от угла ячейки в пикселях.
`offsetY`	`Integer`	Вертикальное смещение от угла ячейки в пикселях.

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

Slicer — недавно установленный слайсер.

Авторизация

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

`is Column Hidden By User(columnPosition)`

Возвращает значение, указывающее, скрыт ли указанный столбец пользователем.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Параметры

Имя	Тип	Описание
`column Position`	`Integer`	Положение исследуемой колонны.

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

Boolean — true если столбец скрыт, false в противном случае.

Авторизация

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

`is Right To Left()`

Возвращает true если расположение элементов на листе — справа налево. Возвращает false если используется стандартное расположение слева направо.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Checks if a spreadsheet is ordered from right to left and logs the result to
// the console.
console.log(sheet.isRightToLeft());

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

Boolean — true если направление письма справа налево; false в противном случае.

Авторизация

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

`is Row Hidden By Filter(rowPosition)`

Возвращает значение, указывающее, скрыта ли заданная строка фильтром (а не представлением фильтра).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Параметры

Имя	Тип	Описание
`row Position`	`Integer`	Положение строки, подлежащей исследованию.

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

Boolean — true если строка скрыта, false в противном случае.

Авторизация

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

`is Row Hidden By User(rowPosition)`

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Параметры

Имя	Тип	Описание
`row Position`	`Integer`	Положение строки, подлежащей исследованию.

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

Boolean — true если строка скрыта, false в противном случае.

Авторизация

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

`is Sheet Hidden()`

Возвращает true если лист в данный момент скрыт.

const sheet = SpreadsheetApp.getActiveSheet();
if (sheet.isSheetHidden()) {
  // do something...
}

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

Boolean — true если лист скрыт, false в противном случае.

Авторизация

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

`move Columns(columnSpec, destinationIndex)`

Перемещает столбцы, выбранные заданным диапазоном, в позицию, указанную destination Index . Сама column Spec не обязательно должна точно представлять собой весь столбец или группу столбцов для перемещения — она выбирает все столбцы, которые охватывает диапазон.

// The code below moves rows A-B to destination index 5.
// This results in those columns becoming columns C-D.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects column A and column B to be moved.
const columnSpec = sheet.getRange('A1:B1');
sheet.moveColumns(columnSpec, 5);

Параметры

Имя	Тип	Описание
`column Spec`	`Range`	Диапазон, охватывающий столбцы, которые следует переместить.
`destination Index`	`Integer`	Индекс, на который должны быть перемещены столбцы. Обратите внимание, что этот индекс основан на координатах до перемещения столбцов. Существующие данные сдвигаются вправо, чтобы освободить место для перемещенных столбцов, в то время как исходные столбцы удаляются из сетки. Поэтому данные могут оказаться на другом индексе, чем тот, который был указан изначально.

Авторизация

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

`move Rows(rowSpec, destinationIndex)`

Перемещает строки, выбранные заданным диапазоном, в позицию, указанную destination Index . row Spec не обязательно должна точно представлять собой целую строку или группу строк для перемещения — она выбирает все строки, которые охватывает диапазон.

// The code below moves rows 1-2 to destination index 5.
// This results in those rows becoming rows 3-4.
const sheet = SpreadsheetApp.getActiveSheet();
// Selects row 1 and row 2 to be moved.
const rowSpec = sheet.getRange('A1:A2');
sheet.moveRows(rowSpec, 5);

Параметры

Имя	Тип	Описание
`row Spec`	`Range`	Диапазон строк, которые следует переместить.
`destination Index`	`Integer`	Индекс, на который должны быть перемещены строки. Обратите внимание, что этот индекс основан на координатах до перемещения строк. Существующие данные сдвигаются вниз, чтобы освободить место для перемещенных строк, в то время как исходные строки удаляются из сетки. Поэтому данные могут оказаться на другом индексе, чем тот, который был указан изначально.

Авторизация

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

`new Chart()`

Возвращает конструктор для создания новой диаграммы на этом листе.

В этом примере показано, как создать новую диаграмму:

const sheet = SpreadsheetApp.getActiveSheet();
const range = sheet.getRange('A1:B8');
const chartBuilder = sheet.newChart();
chartBuilder.addRange(range)
    .setChartType(Charts.ChartType.LINE)
    .setPosition(2, 2, 0, 0)
    .setOption('title', 'My Line Chart!');
sheet.insertChart(chartBuilder.build());

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

Embedded Chart Builder — инструмент для создания новых диаграмм.

`protect()`

Создает объект, который может защитить лист от редактирования, за исключением пользователей, имеющих соответствующие разрешения. До тех пор, пока скрипт фактически не изменит список редакторов для листа (путем вызова методов Protection.removeEditor(emailAddress) , Protection.removeEditor(user) , Protection.removeEditors(emailAddresses) , Protection.addEditor(emailAddress) , Protection.addEditor(user) , Protection.addEditors(emailAddresses) или установки нового значения для Protection.setDomainEdit(editable) ), разрешения будут соответствовать разрешениям самой электронной таблицы, что фактически означает, что лист остается незащищенным. Если лист уже защищен, этот метод возвращает объект, представляющий его существующие настройки защиты. Защищенный лист может содержать незащищенные области.

// Protect the active sheet, then remove all other users from the list of
// editors.
const sheet = SpreadsheetApp.getActiveSheet();
const protection = sheet.protect().setDescription('Sample protected sheet');

// Ensure the current user is an editor before removing others. Otherwise, if
// the user's edit permission comes from a group, the script throws an exception
// upon removing the group.
const me = Session.getEffectiveUser();
protection.addEditor(me);
protection.removeEditors(protection.getEditors());
if (protection.canDomainEdit()) {
  protection.setDomainEdit(false);
}

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

Protection — объект, представляющий параметры защиты.

Авторизация

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

`remove Chart(chart)`

Удаляет диаграмму с родительского листа.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This removes all the embedded charts from the spreadsheet
const charts = sheet.getCharts();
for (const i in charts) {
  sheet.removeChart(charts[i]);
}

Параметры

Имя	Тип	Описание
`chart`	`Embedded Chart`	Диаграмма, которую нужно удалить.

Авторизация

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

`set Active Range(range)`

Устанавливает указанный диапазон в качестве active range на активном листе, при этом верхняя левая ячейка в диапазоне становится current cell .

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

const selection = sheet.getSelection();
// Current cell: A1
const currentCell = selection.getCurrentCell();
// Active Range: A1:D4
const activeRange = selection.getActiveRange();

Параметры

Имя	Тип	Описание
`range`	`Range`	Диапазон, который следует установить в качестве активного диапазона.

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

Range — недавно введенное в эксплуатацию поле.

Авторизация

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

`set Active Range List(rangeList)`

Устанавливает указанный список диапазонов в качестве active ranges на активном листе. В качестве active range устанавливается последний диапазон в списке.

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

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`	`Range List`	Список диапазонов для выбора.

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

Range List — недавно отобранный список полигонов.

Авторизация

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

`set Active Selection(range)`

Задает область активного выделения для этого листа.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const range = sheet.getRange('A1:D4');
sheet.setActiveSelection(range);

Параметры

Имя	Тип	Описание
`range`	`Range`	Диапазон, который следует установить в качестве активного выделения.

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

Range — недавно введенное в эксплуатацию поле.

Авторизация

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

`set Active Selection(a1Notation)`

Устанавливает активный выбор, как указано в обозначении A1 или R1C1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.setActiveSelection('A1:D4');

Параметры

Имя	Тип	Описание
`a1Notation`	`String`	Диапазон, который следует установить в качестве активного, как указано в обозначении A1 или R1C1.

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

Range — недавно введенное в эксплуатацию поле.

Авторизация

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

`set Column Group Control Position(position)`

Задает положение переключателя группы столбцов на листе.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setColumnGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Параметры

Имя	Тип	Описание
`position`	`Group Control Toggle Position`	Положение переключателя управления группой столбцов.

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

Sheet — Этот лист предназначен для составления цепочек.

Авторизация

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

`set Column Width(columnPosition, width)`

Sets the width of the given column in pixels.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Параметры

Имя	Тип	Описание
`column Position`	`Integer`	The position of the given column to set.
`width`	`Integer`	The width in pixels to set it to.

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

Sheet — The sheet, useful for method chaining.

Авторизация

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

`set Column Widths(startColumn, numColumns, width)`

Sets the width of the given columns in pixels.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three columns to a width of 200 pixels
sheet.setColumnWidths(1, 3, 200);

Параметры

Имя	Тип	Описание
`start Column`	`Integer`	The starting column position to change.
`num Columns`	`Integer`	The number of columns to change.
`width`	`Integer`	The width in pixels to set it to.

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

Sheet — This sheet, for chaining.

Авторизация

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

`set Conditional Format Rules(rules)`

Replaces all currently existing conditional format rules in the sheet with the input rules. Rules are evaluated in their input order.

// Remove one of the existing conditional format rules.
const sheet = SpreadsheetApp.getActiveSheet();
const rules = sheet.getConditionalFormatRules();
rules.splice(1, 1);  // Deletes the 2nd format rule.
sheet.setConditionalFormatRules(rules);

Параметры

Имя	Тип	Описание
`rules`	`Conditional Format Rule[]`	The new conditional format rules.

Авторизация

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

`set Current Cell(cell)`

Sets the specified cell as the current cell .

If the specified cell is present in an already selected range, then that range becomes the active range with the cell as the current cell.

If the specified cell is not present in any selected range, then any existing selection is removed and the cell becomes the current cell and the active range.

Note: The specified Range must consist of one cell, otherwise it throws an exception.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

const selection = sheet.getSelection();
// Current cell: B5
const currentCell = selection.getCurrentCell();

Параметры

Имя	Тип	Описание
`cell`	`Range`	The cell to set as the current cell.

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

Range — The newly set current cell.

Авторизация

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

`set Frozen Columns(columns)`

Freezes the given number of columns. If zero, no columns are frozen.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

Параметры

Имя	Тип	Описание
`columns`	`Integer`	The number of columns to freeze.

Авторизация

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

`set Frozen Rows(rows)`

Freezes the given number of rows. If zero, no rows are frozen.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

Параметры

Имя	Тип	Описание
`rows`	`Integer`	The number of rows to freeze.

Авторизация

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

`set Hidden Gridlines(hideGridlines)`

Hides or reveals the sheet gridlines.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can us eSpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Hides the gridlines in the sheet.
sheet.setHiddenGridlines(true);

Параметры

Имя	Тип	Описание
`hide Gridlines`	`Boolean`	If `true` , hide gridlines in this sheet; otherwise show the gridlines.

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

Sheet — This sheet, for chaining.

Авторизация

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

`set Name(name)`

Sets the sheet name.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setName('not first anymore');

Параметры

Имя	Тип	Описание
`name`	`String`	The new name for the sheet.

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

Sheet — This sheet, for chaining.

Авторизация

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

`set Right To Left(rightToLeft)`

Sets or unsets the sheet layout to right-to-left.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets a sheet by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the sheet layout, so that the sheet is ordered from right to left.
sheet.setRightToLeft(true);

Параметры

Имя	Тип	Описание
`right To Left`	`Boolean`	If `true` , the sheet layout is set to right-to-left, with cell A1 at the top right corner. If `false` , the sheet layout is set to the default left-to-right, with cell A1 at the top left.

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

Sheet — This sheet, for chaining.

Авторизация

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

`set Row Group Control Position(position)`

Sets the position of the row group control toggle on the sheet.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0];
sheet.setRowGroupControlPosition(
    SpreadsheetApp.GroupControlTogglePosition.AFTER,
);

Параметры

Имя	Тип	Описание
`position`	`Group Control Toggle Position`	The position of the row group control toggle.

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

Sheet — This sheet, for chaining.

Авторизация

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

`set Row Height(rowPosition, height)`

Sets the row height of the given row in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use set Row Heights Forced(startRow, numRows, height) .

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Параметры

Имя	Тип	Описание
`row Position`	`Integer`	The row position to change.
`height`	`Integer`	The height in pixels to set it to.

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

Sheet — The sheet, useful for method chaining.

Авторизация

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

`set Row Heights(startRow, numRows, height)`

Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. If you want to force rows to a specified height, use set Row Heights Forced(startRow, numRows, height) .

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three rows to a height of 20 pixels
sheet.setRowHeights(1, 3, 20);

Параметры

Имя	Тип	Описание
`start Row`	`Integer`	The starting row position to change.
`num Rows`	`Integer`	The number of rows to change.
`height`	`Integer`	The height in pixels to set it to.

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

Sheet — This sheet, for chaining.

Авторизация

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

`set Row Heights Forced(startRow, numRows, height)`

Sets the height of the given rows in pixels. By default, rows grow to fit cell contents. When you use set Row Heights Forced , rows are forced to the specified height even if the cell contents are taller than the row height.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first three rows to a height of 5 pixels.
sheet.setRowHeightsForced(1, 3, 5);

Параметры

Имя	Тип	Описание
`start Row`	`Integer`	The starting row position to change.
`num Rows`	`Integer`	The number of rows to change.
`height`	`Integer`	The height in pixels to set it to.

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

Sheet — This sheet, for chaining.

Авторизация

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

`set Tab Color(color)`

Sets the sheet tab color.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
first.setTabColor('ff0000');  // Set the color to red.
first.setTabColor(null);      // Unset the color.

Параметры

Имя	Тип	Описание
`color`	`String`	A color code in CSS notation (like `'#ffffff'` or `'white'` ), or `null` to reset the tab color.

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

Sheet — This sheet, for chaining.

Авторизация

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

`set Tab Color Object(color)`

Sets the sheet tab color.

// This example assumes there is a sheet named "Sheet1"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('Sheet1');
const color = SpreadsheetApp.newColor()
                  .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1)
                  .build();
first.setTabColorObject(color);  // Set the color to theme accent 1.
first.setTabColorObject(null);   // Unset the color.

Параметры

Имя	Тип	Описание
`color`	`Color`	The sheet tab color to set.

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

Sheet — This sheet, for chaining.

Авторизация

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

`show Columns(columnIndex)`

Unhides the column at the given index.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first column
sheet.showColumns(1);

Параметры

Имя	Тип	Описание
`column Index`	`Integer`	The index of the column to unhide.

Авторизация

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

`show Columns(columnIndex, numColumns)`

Unhides one or more consecutive columns starting at the given index.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three columns
sheet.showColumns(1, 3);

Параметры

Имя	Тип	Описание
`column Index`	`Integer`	The starting index of the columns to unhide.
`num Columns`	`Integer`	The number of columns to unhide.

Авторизация

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

`show Rows(rowIndex)`

Unhides the row at the given index.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first row
sheet.showRows(1);

Параметры

Имя	Тип	Описание
`row Index`	`Integer`	The index of the row to unhide.

Авторизация

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

`show Rows(rowIndex, numRows)`

Unhides one or more consecutive rows starting at the given index.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Unhides the first three rows
sheet.showRows(1, 3);

Параметры

Имя	Тип	Описание
`row Index`	`Integer`	The starting index of the rows to unhide.
`num Rows`	`Integer`	The number of rows to unhide.

Авторизация

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

`show Sheet()`

Makes the sheet visible. Has no effect if the sheet is already visible.

const sheet = SpreadsheetApp.getActiveSheet();
sheet.showSheet();

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

Sheet — The current sheet.

Авторизация

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

`sort(columnPosition)`

Sorts a sheet by column, ascending.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Параметры

Имя	Тип	Описание
`column Position`	`Integer`	The column to sort by.

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

Sheet — The sheet, useful for method chaining.

Авторизация

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

`sort(columnPosition, ascending)`

Sorts a sheet by column. Takes a parameter to specify ascending or descending.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Параметры

Имя	Тип	Описание
`column Position`	`Integer`	The column to sort by.
`ascending`	`Boolean`	`true` for ascending sorts, `false` for descending.

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

Sheet — The sheet, useful for method chaining.

Авторизация

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

`unhide Column(column)`

Unhides the column in the given range.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

Параметры

Имя	Тип	Описание
`column`	`Range`	The range to unhide, if hidden.

Авторизация

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

`unhide Row(row)`

Unhides the row in the given range.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

Параметры

Имя	Тип	Описание
`row`	`Range`	The range to unhide, if hidden.

Авторизация

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

`update Chart(chart)`

Updates the chart on this sheet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This code is going to loop through all the charts and change them to
// column charts
const charts = sheet.getCharts();
for (const i in charts) {
  const chart = charts[i];
  const newChart = chart.modify().setChartType(Charts.ChartType.COLUMN).build();
  sheet.updateChart(newChart);
}

Параметры

Имя	Тип	Описание
`chart`	`Embedded Chart`	The chart to update.

Авторизация

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

Устаревшие методы

`get Sheet Protection()`

Deprecated. For spreadsheets created in the newer version of Google Sheets, use get Protections(type) , which returns the more powerful Protection class. Although this method is deprecated, it remains available for compatibility with the older version of Sheets

Returns a Page Protection instance describing the permissions for the current sheet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser('user@example.com');

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
const users = permissions.getUsers();
Logger.log(users);

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

Page Protection — An object describing sheet access permissions.

Авторизация

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

`get Tab Color()`

Deprecated. Replaced by get Tab Color Object()

Gets the sheet tab color, or null if the sheet tab has no color.

// This example assumes there is a sheet named "first"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const first = ss.getSheetByName('first');
const color = first.getTabColor();

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

String|null — Color code in CSS notation (such as '#ffffff' ).

Авторизация

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

`set Sheet Protection(permissions)`

Deprecated. For spreadsheets created in the newer version of Google Sheets, use protect() , which returns the more powerful Protection class. Although this method is deprecated, it remains available for compatibility with the older version of Sheets

Sets the permissions for the current sheet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
const sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

Параметры

Имя	Тип	Описание
`permissions`	`Page Protection`	The access permissions object to set on this sheet.

Авторизация

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

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

Методы

Устаревшие методы

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

activate()

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

add Developer Metadata(key)

Параметры

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

Авторизация

add Developer Metadata(key, visibility)

Параметры

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

Авторизация

add Developer Metadata(key, value)

Параметры

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

Авторизация

add Developer Metadata(key, value, visibility)

Параметры

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

Авторизация

append Row(rowContents)

Параметры

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

Авторизация

as Data Source Sheet()

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

Авторизация

auto Resize Column(columnPosition)

Параметры

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

Авторизация

auto Resize Columns(startColumn, numColumns)

Параметры

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

Авторизация

auto Resize Rows(startRow, numRows)

Параметры

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

Авторизация

clear()

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

Авторизация

clear(options)

Параметры

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

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

Авторизация

clear Conditional Format Rules()

Авторизация

clear Contents()

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

Авторизация

clear Formats()

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

Авторизация

clear Notes()

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

Авторизация

collapse All Column Groups()

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

Авторизация

collapse All Row Groups()

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

Авторизация

copy To(spreadsheet)

Параметры

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

Авторизация

create Developer Metadata Finder()

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

create Text Finder(findText)

Параметры

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

delete Column(columnPosition)

Параметры

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

Авторизация

delete Columns(columnPosition, howMany)

Class Sheet

`activate()`

`add Developer Metadata(key)`

`add Developer Metadata(key, visibility)`

`add Developer Metadata(key, value)`

`add Developer Metadata(key, value, visibility)`

`append Row(rowContents)`

`as Data Source Sheet()`

`auto Resize Column(columnPosition)`

`auto Resize Columns(startColumn, numColumns)`

`auto Resize Rows(startRow, numRows)`

`clear()`

`clear(options)`

`clear Conditional Format Rules()`

`clear Contents()`

`clear Formats()`

`clear Notes()`

`collapse All Column Groups()`

`collapse All Row Groups()`

`copy To(spreadsheet)`

`create Developer Metadata Finder()`

`create Text Finder(findText)`

`delete Column(columnPosition)`

`delete Columns(columnPosition, howMany)`

`delete Row(rowPosition)`

`delete Rows(rowPosition, howMany)`

`expand All Column Groups()`

`expand All Row Groups()`

`expand Column Groups Up To Depth(groupDepth)`

`expand Row Groups Up To Depth(groupDepth)`

`get Active Cell()`

`get Active Range()`

`get Active Range List()`

`get Bandings()`

`get Charts()`

`get Column Group(columnIndex, groupDepth)`

`get Column Group Control Position()`

`get Column Group Depth(columnIndex)`

`get Column Width(columnPosition)`

`get Conditional Format Rules()`

`get Current Cell()`

`get Data Range()`

`get Data Source Formulas()`

`get Data Source Pivot Tables()`