Эта страница переведена с помощью 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`	Возвращает лист как `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` , если активных диапазонов нет.
`get Bandings()`	`Banding[]`	Возвращает все полосы на этом листе.
`get Charts()`	`Embedded Chart[]`	Возвращает массив диаграмм на этом листе.
`get Column Group(columnIndex, groupDepth)`	`Group`	Возвращает группу столбцов с заданным индексом и глубиной группы.
`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` если текущей ячейки нет.
`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` , если фильтр отсутствует.
`get Form Url()`	`String`	Возвращает 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`	Возвращает группу строк с заданным индексом и глубиной группы.
`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` , если вкладка листа не имеет цвета.
`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` , если вкладка листа не имеет цвета.
`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 — лист источника данных.

Авторизация

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

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 — список активных диапазонов.

Авторизация

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

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 — группа столбцов с контрольным индексом и глубиной или выдает исключение, если группа не существует.

Авторизация

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

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 Таблиц и выделена темной рамкой. Никогда не бывает более одной текущей ячейки. Когда пользователь выбирает один или несколько диапазонов ячеек, одна из выбранных ячеек является текущей.

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

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

Range — текущая ячейка

Авторизация

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

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 — Фильтр.

Авторизация

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

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 — 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 — группа строк с контрольным индексом и глубиной или выдает исключение, если группа не существует.

Авторизация

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

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 , если вкладка листа не имеет цвета.

Авторизация

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

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 в виде изображения в документ в заданную строку и столбец. Размер изображения извлекается из содержимого большого двоичного объекта. Максимальный поддерживаемый размер большого двоичного объекта — 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`	Большой двоичный объект, содержащий содержимое изображения, тип 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 в виде изображения в документ в заданную строку и столбец со смещением в пикселях. Размер изображения извлекается из содержимого большого двоичного объекта. Максимальный поддерживаемый размер большого двоичного объекта — 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`	Большой двоичный объект, содержащий содержимое изображения, тип 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)`

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

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`	Положение данного столбца для установки.
`width`	`Integer`	Ширина в пикселях, чтобы установить его на.

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

Sheet - лист, полезный для цепочки методов

Авторизация

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

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

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

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

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`	Начальная позиция столбца для изменения.
`num Columns`	`Integer`	Количество столбцов для изменения.
`width`	`Integer`	Ширина в пикселях, чтобы установить его на.

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

Sheet - этот лист, для цепочки.

Авторизация

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

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

`set Conditional Format Rules(rules)`

Заменяет все в настоящее время существующие правила условного формата в листе с правилами ввода. Правила оцениваются в их входном порядке.

// 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[]`	Новые правила условного формата.

Авторизация

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

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

`set Current Cell(cell)`

Устанавливает указанную ячейку в качестве current cell .

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

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

Примечание. Указанный Range должен состоять из одной ячейки, в противном случае он бросает исключение.

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`	Ячейка для установки в качестве текущей ячейки.

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

Range - вновь установленная тока ячейка

Авторизация

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

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

`set Frozen Columns(columns)`

Замораживает заданное количество столбцов. Если ноль, колонны не заморожены.

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

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

Параметры

Имя	Тип	Описание
`columns`	`Integer`	Количество столбцов для замораживания.

Авторизация

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

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

`set Frozen Rows(rows)`

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

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

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

Параметры

Имя	Тип	Описание
`rows`	`Integer`	Количество рядов заморозить.

Авторизация

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

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

`set Hidden Gridlines(hideGridlines)`

Скрывает или раскрывает листовые сетки.

// 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`	Если `true` , скрыть сетки в этом листе; В противном случае показать линии сетки.

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

Sheet - этот лист, для цепочки.

Авторизация

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

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

`set Name(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`	Новое название для листа.

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

Sheet - этот лист, для цепочки.

Авторизация

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

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

`set Right To Left(rightToLeft)`

Устанавливает или оставляет макет листа до правого налегих.

// 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`	Если `true` , макет листа установлена на правой к лету, с ячейкой A1 в правом верхнем углу. Если `false` , макет листа устанавливается на слева направо по умолчанию, с ячейкой A1 в верхней части левого.

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

Sheet - этот лист, для цепочки.

Авторизация

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

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

`set Row Group Control Position(position)`

Устанавливает положение управляющего переключения группы строк на листе.

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

Параметры

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

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

Sheet - этот лист, для цепочки.

Авторизация

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

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

`set Row Height(rowPosition, height)`

Устанавливает высоту строки заданного строки в пикселях. По умолчанию ряды растут, чтобы соответствовать содержимому ячейки. Если вы хотите заставить ряды до указанной высоты, используйте 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`	Позиция строки для изменения.
`height`	`Integer`	Высота в пикселях, чтобы установить его.

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

Sheet - Лист, полезный для цепочки методов.

Авторизация

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

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

`set Row Heights(startRow, numRows, height)`

Устанавливает высоту заданных рядов в пикселях. По умолчанию ряды растут, чтобы соответствовать содержимому ячейки. Если вы хотите заставить ряды до указанной высоты, используйте 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`	Начальная позиция строки для изменения.
`num Rows`	`Integer`	Количество рядов для изменения.
`height`	`Integer`	Высота в пикселях, чтобы установить его.

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

Sheet - этот лист, для цепочки.

Авторизация

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

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

`set Row Heights Forced(startRow, numRows, height)`

Устанавливает высоту заданных рядов в пикселях. По умолчанию ряды растут, чтобы соответствовать содержимому ячейки. Когда вы используете set Row Heights Forced , строки вынуждены к указанной высоте, даже если содержимое ячейки выше высоты строки.

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`	Начальная позиция строки для изменения.
`num Rows`	`Integer`	Количество рядов для изменения.
`height`	`Integer`	Высота в пикселях, чтобы установить его.

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

Sheet - этот лист, для цепочки.

Авторизация

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

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

`set Tab Color(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`	Цветовой код в нотации CSS (например `'#ffffff'` или `'white'` ), или `null` , чтобы сбросить цвет вкладки.

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

Sheet - этот лист, для цепочки.

Авторизация

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

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

`set Tab Color Object(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`	Цвет вкладки листа для установки.

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

Sheet - этот лист, для цепочки.

Авторизация

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

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

`show Columns(columnIndex)`

Не приведет к столбцу в данном индексе.

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

Параметры

Имя	Тип	Описание
`column Index`	`Integer`	Индекс столбца в неправомерном.

Авторизация

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

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

`show Columns(columnIndex, numColumns)`

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

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

Параметры

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

Авторизация

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

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

`show Rows(rowIndex)`

Не поддается строку в данном индексе.

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

Параметры

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

Авторизация

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

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

`show Rows(rowIndex, numRows)`

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

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

Параметры

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

Авторизация

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

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

`show Sheet()`

Делает лист видимым. Не имеет никакого эффекта, если лист уже видна.

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

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

Sheet - текущий лист.

Авторизация

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

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

`sort(columnPosition)`

Сортирует лист по столбцу, восходящий.

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

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Параметры

Имя	Тип	Описание
`column Position`	`Integer`	Столбец для сортировки.

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

Sheet - лист, полезный для цепочки методов

Авторизация

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

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

`sort(columnPosition, ascending)`

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

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

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Параметры

Имя	Тип	Описание
`column Position`	`Integer`	Столбец для сортировки.
`ascending`	`Boolean`	`true` для восходящих сортов, `false` для спуска.

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

Sheet - лист, полезный для цепочки методов

Авторизация

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

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

`unhide Column(column)`

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

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`	Диапазон для неправомерного, если скрыт.

Авторизация

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

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

`unhide Row(row)`

Не поддается ряд в данном диапазоне.

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`	Диапазон для неправомерного, если скрыт.

Авторизация

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

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

`update Chart(chart)`

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

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`	Диаграмма для обновления.

Авторизация

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

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

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

`get Sheet Protection()`

Устарел. Для электронных таблиц, созданных в более новой версии Google Sheets, используйте get Protections(type) , которая возвращает более мощный класс Protection . Хотя этот метод устарел, он остается доступным для совместимости с более старой версией листов

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

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 - объект, описывающий разрешения на доступ к листам

Авторизация

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

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

`get Tab Color()`

Устарел. Заменен на get Tab Color Object()

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

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

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

String - цветовой код в нотации CSS (например '#ffffff' ).

Авторизация

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

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

`set Sheet Protection(permissions)`

Устарел. Для электронных таблиц, созданных в более новой версии Google Sheets, используйте protect() , который возвращает более мощный класс Protection . Хотя этот метод устарел, он остается доступным для совместимости с более старой версией листов

Устанавливает разрешения для текущего листа.

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`	Объект доступа разрешений для установки на этом листе.

Авторизация

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

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