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

Class Sheet

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

Методы

Метод	Тип возврата	Краткое описание
`activate()`	`Sheet`	Активирует этот лист.
`addDeveloperMetadata(key)`	`Sheet`	Добавляет метаданные разработчика с указанным ключом на лист.
`addDeveloperMetadata(key, visibility)`	`Sheet`	Добавляет метаданные разработчика с указанным ключом и видимостью на лист.
`addDeveloperMetadata(key, value)`	`Sheet`	Добавляет метаданные разработчика с указанным ключом и значением на лист.
`addDeveloperMetadata(key, value, visibility)`	`Sheet`	Добавляет метаданные разработчика с указанным ключом, значением и видимостью на лист.
`appendRow(rowContents)`	`Sheet`	Добавляет строку внизу текущей области данных на листе.
`asDataSourceSheet()`	`DataSourceSheet`	Возвращает лист как `DataSourceSheet` , если лист имеет тип `SheetType.DATASOURCE` или `null` в противном случае.
`autoResizeColumn(columnPosition)`	`Sheet`	Устанавливает ширину данного столбца в соответствии с его содержимым.
`autoResizeColumns(startColumn, numColumns)`	`Sheet`	Устанавливает ширину всех столбцов, начиная с заданной позиции столбца, в соответствии с их содержимым.
`autoResizeRows(startRow, numRows)`	`Sheet`	Устанавливает высоту всех строк, начиная с заданной позиции строки, в соответствии с их содержимым.
`clear()`	`Sheet`	Очищает лист содержимого и информации о форматировании.
`clear(options)`	`Sheet`	Очищает страницу содержимого и/или формата, как указано в заданных дополнительных параметрах.
`clearConditionalFormatRules()`	`void`	Удаляет с листа все правила условного форматирования.
`clearContents()`	`Sheet`	Очищает страницу содержимого, сохраняя при этом информацию о форматировании.
`clearFormats()`	`Sheet`	Очищает лист от форматирования, сохраняя содержимое.
`clearNotes()`	`Sheet`	Очищает лист от всех заметок.
`collapseAllColumnGroups()`	`Sheet`	Сворачивает все группы столбцов на листе.
`collapseAllRowGroups()`	`Sheet`	Сворачивает все группы строк на листе.
`copyTo(spreadsheet)`	`Sheet`	Копирует лист в заданную электронную таблицу, которая может быть той же самой электронной таблицей, что и исходная.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	Возвращает `DeveloperMetadataFinder` для поиска метаданных разработчика в пределах этого листа.
`createTextFinder(findText)`	`TextFinder`	Создает средство поиска текста для листа, которое может находить и заменять текст на листе.
`deleteColumn(columnPosition)`	`Sheet`	Удаляет столбец в заданной позиции столбца.
`deleteColumns(columnPosition, howMany)`	`void`	Удаляет несколько столбцов, начиная с заданной позиции столбца.
`deleteRow(rowPosition)`	`Sheet`	Удаляет строку в заданной позиции.
`deleteRows(rowPosition, howMany)`	`void`	Удаляет несколько строк, начиная с заданной позиции строки.
`expandAllColumnGroups()`	`Sheet`	Разворачивает все группы столбцов на листе.
`expandAllRowGroups()`	`Sheet`	Разворачивает все группы строк на листе.
`expandColumnGroupsUpToDepth(groupDepth)`	`Sheet`	Разворачивает все группы столбцов до заданной глубины и сворачивает все остальные.
`expandRowGroupsUpToDepth(groupDepth)`	`Sheet`	Расширяет все группы строк до заданной глубины и сворачивает все остальные.
`getActiveCell()`	`Range`	Возвращает активную ячейку на этом листе.
`getActiveRange()`	`Range`	Возвращает выбранный диапазон на активном листе или `null` , если активного диапазона нет.
`getActiveRangeList()`	`RangeList`	Возвращает список активных диапазонов на активном листе или `null` , если активных диапазонов нет.
`getBandings()`	`Banding[]`	Возвращает все полосы на этом листе.
`getCharts()`	`EmbeddedChart[]`	Возвращает массив диаграмм на этом листе.
`getColumnGroup(columnIndex, groupDepth)`	`Group`	Возвращает группу столбцов с заданным индексом и глубиной группы.
`getColumnGroupControlPosition()`	`GroupControlTogglePosition`	Возвращает `GroupControlTogglePosition` для всех групп столбцов на листе.
`getColumnGroupDepth(columnIndex)`	`Integer`	Возвращает глубину группы столбца по заданному индексу.
`getColumnWidth(columnPosition)`	`Integer`	Получает ширину в пикселях данного столбца.
`getConditionalFormatRules()`	`ConditionalFormatRule[]`	Получите все правила условного форматирования на этом листе.
`getCurrentCell()`	`Range`	Возвращает текущую ячейку на активном листе или `null` если текущей ячейки нет.
`getDataRange()`	`Range`	Возвращает `Range` соответствующий измерениям, в которых присутствуют данные.
`getDataSourceFormulas()`	`DataSourceFormula[]`	Получает все формулы источника данных.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Получает все сводные таблицы источника данных.
`getDataSourceTables()`	`DataSourceTable[]`	Получает все таблицы источников данных.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Получите все метаданные разработчика, связанные с этим листом.
`getDrawings()`	`Drawing[]`	Возвращает массив рисунков на листе.
`getFilter()`	`Filter`	Возвращает фильтр на этом листе или `null` , если фильтр отсутствует.
`getFormUrl()`	`String`	Возвращает URL-адрес формы, которая отправляет ответы на этот лист, или `null` если с этим листом нет связанной формы.
`getFrozenColumns()`	`Integer`	Возвращает количество замороженных столбцов.
`getFrozenRows()`	`Integer`	Возвращает количество замороженных строк.
`getImages()`	`OverGridImage[]`	Возвращает все изображения поверх сетки на листе.
`getIndex()`	`Integer`	Получает положение листа в родительской электронной таблице.
`getLastColumn()`	`Integer`	Возвращает позицию последнего столбца с содержимым.
`getLastRow()`	`Integer`	Возвращает позицию последней строки, содержащей контент.
`getMaxColumns()`	`Integer`	Возвращает текущее количество столбцов на листе независимо от содержимого.
`getMaxRows()`	`Integer`	Возвращает текущее количество строк на листе независимо от содержимого.
`getName()`	`String`	Возвращает имя листа.
`getNamedRanges()`	`NamedRange[]`	Получает все именованные диапазоны на этом листе.
`getParent()`	`Spreadsheet`	Возвращает `Spreadsheet` , содержащую этот лист.
`getPivotTables()`	`PivotTable[]`	Возвращает все сводные таблицы на этом листе.
`getProtections(type)`	`Protection[]`	Получает массив объектов, представляющих все защищенные диапазоны на листе, или массив из одного элемента, представляющий защиту на самом листе.
`getRange(row, column)`	`Range`	Возвращает диапазон с верхней левой ячейкой по заданным координатам.
`getRange(row, column, numRows)`	`Range`	Возвращает диапазон с верхней левой ячейкой по заданным координатам и заданным количеством строк.
`getRange(row, column, numRows, numColumns)`	`Range`	Возвращает диапазон с верхней левой ячейкой по заданным координатам с заданным количеством строк и столбцов.
`getRange(a1Notation)`	`Range`	Возвращает диапазон, указанный в нотации A1 или нотации R1C1.
`getRangeList(a1Notations)`	`RangeList`	Возвращает коллекцию `RangeList` , представляющую диапазоны на одном листе, заданные непустым списком нотаций A1 или нотаций R1C1.
`getRowGroup(rowIndex, groupDepth)`	`Group`	Возвращает группу строк с заданным индексом и глубиной группы.
`getRowGroupControlPosition()`	`GroupControlTogglePosition`	Возвращает `GroupControlTogglePosition` для всех групп строк на листе.
`getRowGroupDepth(rowIndex)`	`Integer`	Возвращает глубину группы строки по заданному индексу.
`getRowHeight(rowPosition)`	`Integer`	Получает высоту в пикселях данной строки.
`getSelection()`	`Selection`	Возвращает текущий `Selection` в электронной таблице.
`getSheetId()`	`Integer`	Возвращает идентификатор листа, представленного этим объектом.
`getSheetName()`	`String`	Возвращает имя листа.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	Возвращает прямоугольную сетку значений для этого диапазона, начиная с заданных координат.
`getSlicers()`	`Slicer[]`	Возвращает массив срезов на листе.
`getTabColorObject()`	`Color`	Получает цвет вкладки листа или `null` , если вкладка листа не имеет цвета.
`getType()`	`SheetType`	Возвращает тип листа.
`hasHiddenGridlines()`	`Boolean`	Возвращает `true` если линии сетки листа скрыты; в противном случае возвращает `false` .
`hideColumn(column)`	`void`	Скрывает столбец или столбцы в заданном диапазоне.
`hideColumns(columnIndex)`	`void`	Скрывает один столбец по заданному индексу.
`hideColumns(columnIndex, numColumns)`	`void`	Скрывает один или несколько последовательных столбцов, начиная с заданного индекса.
`hideRow(row)`	`void`	Скрывает строки в заданном диапазоне.
`hideRows(rowIndex)`	`void`	Скрывает строку по заданному индексу.
`hideRows(rowIndex, numRows)`	`void`	Скрывает одну или несколько последовательных строк, начиная с заданного индекса.
`hideSheet()`	`Sheet`	Скрывает этот лист.
`insertChart(chart)`	`void`	Добавляет новую диаграмму на этот лист.
`insertColumnAfter(afterPosition)`	`Sheet`	Вставляет столбец после заданной позиции столбца.
`insertColumnBefore(beforePosition)`	`Sheet`	Вставляет столбец перед заданной позицией столбца.
`insertColumns(columnIndex)`	`void`	Вставляет пустой столбец на лист в указанное место.
`insertColumns(columnIndex, numColumns)`	`void`	Вставляет один или несколько последовательных пустых столбцов в лист, начиная с указанного места.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	Вставляет заданное количество столбцов после заданной позиции столбца.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	Вставляет несколько столбцов перед заданной позицией столбца.
`insertImage(blobSource, column, row)`	`OverGridImage`	Вставляет `BlobSource` как изображение в документ в заданную строку и столбец.
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	Вставляет `BlobSource` как изображение в документ в заданную строку и столбец со смещением в пикселях.
`insertImage(url, column, row)`	`OverGridImage`	Вставляет изображение в документ в заданную строку и столбец.
`insertImage(url, column, row, offsetX, offsetY)`	`OverGridImage`	Вставляет изображение в документ в заданную строку и столбец со смещением в пикселях.
`insertRowAfter(afterPosition)`	`Sheet`	Вставляет строку после заданной позиции строки.
`insertRowBefore(beforePosition)`	`Sheet`	Вставляет строку перед заданной позицией строки.
`insertRows(rowIndex)`	`void`	Вставляет пустую строку на лист в указанное место.
`insertRows(rowIndex, numRows)`	`void`	Вставляет одну или несколько последовательных пустых строк в лист, начиная с указанного места.
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	Вставляет несколько строк после заданной позиции строки.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	Вставляет несколько строк перед заданной позицией строки.
`insertSlicer(range, anchorRowPos, anchorColPos)`	`Slicer`	Добавляет новый срез на этот лист.
`insertSlicer(range, anchorRowPos, anchorColPos, offsetX, offsetY)`	`Slicer`	Добавляет новый срез на этот лист.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	Возвращает, скрыт ли данный столбец пользователем.
`isRightToLeft()`	`Boolean`	Возвращает `true` , если макет листа расположен справа налево.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	Возвращает, скрыта ли данная строка фильтром (а не представлением фильтра).
`isRowHiddenByUser(rowPosition)`	`Boolean`	Возвращает, скрыта ли данная строка пользователем.
`isSheetHidden()`	`Boolean`	Возвращает `true` если лист в данный момент скрыт.
`moveColumns(columnSpec, destinationIndex)`	`void`	Перемещает столбцы, выбранные в заданном диапазоне, в положение, указанное в месте `destinationIndex` .
`moveRows(rowSpec, destinationIndex)`	`void`	Перемещает строки, выбранные в заданном диапазоне, в позицию, указанную в месте `destinationIndex` .
`newChart()`	`EmbeddedChartBuilder`	Возвращает построитель для создания новой диаграммы для этого листа.
`protect()`	`Protection`	Создает объект, который может защитить лист от редактирования, за исключением пользователей, имеющих разрешение.
`removeChart(chart)`	`void`	Удаляет диаграмму с родительского листа.
`setActiveRange(range)`	`Range`	Устанавливает указанный диапазон в качестве `active range` на активном листе, при этом верхняя левая ячейка диапазона становится `current cell` .
`setActiveRangeList(rangeList)`	`RangeList`	Устанавливает указанный список диапазонов в качестве `active ranges` на активном листе.
`setActiveSelection(range)`	`Range`	Устанавливает активную область выбора для этого листа.
`setActiveSelection(a1Notation)`	`Range`	Устанавливает активный выбор, как указано в нотации A1 или нотации R1C1.
`setColumnGroupControlPosition(position)`	`Sheet`	Задает положение переключателя управления группой столбцов на листе.
`setColumnWidth(columnPosition, width)`	`Sheet`	Устанавливает ширину данного столбца в пикселях.
`setColumnWidths(startColumn, numColumns, width)`	`Sheet`	Устанавливает ширину заданных столбцов в пикселях.
`setConditionalFormatRules(rules)`	`void`	Заменяет все существующие на данный момент правила условного форматирования на листе правилами ввода.
`setCurrentCell(cell)`	`Range`	Устанавливает указанную ячейку в качестве `current cell` .
`setFrozenColumns(columns)`	`void`	Замораживает заданное количество столбцов.
`setFrozenRows(rows)`	`void`	Замораживает заданное количество строк.
`setHiddenGridlines(hideGridlines)`	`Sheet`	Скрывает или показывает линии сетки листа.
`setName(name)`	`Sheet`	Устанавливает имя листа.
`setRightToLeft(rightToLeft)`	`Sheet`	Устанавливает или отменяет настройку макета листа справа налево.
`setRowGroupControlPosition(position)`	`Sheet`	Задает положение переключателя управления группой строк на листе.
`setRowHeight(rowPosition, height)`	`Sheet`	Устанавливает высоту данной строки в пикселях.
`setRowHeights(startRow, numRows, height)`	`Sheet`	Устанавливает высоту заданных строк в пикселях.
`setRowHeightsForced(startRow, numRows, height)`	`Sheet`	Устанавливает высоту заданных строк в пикселях.
`setTabColor(color)`	`Sheet`	Устанавливает цвет вкладки листа.
`setTabColorObject(color)`	`Sheet`	Устанавливает цвет вкладки листа.
`showColumns(columnIndex)`	`void`	Отображает столбец по заданному индексу.
`showColumns(columnIndex, numColumns)`	`void`	Отображает один или несколько последовательных столбцов, начиная с заданного индекса.
`showRows(rowIndex)`	`void`	Отображает строку по заданному индексу.
`showRows(rowIndex, numRows)`	`void`	Отображает одну или несколько последовательных строк, начиная с заданного индекса.
`showSheet()`	`Sheet`	Делает лист видимым.
`sort(columnPosition)`	`Sheet`	Сортирует лист по столбцам по возрастанию.
`sort(columnPosition, ascending)`	`Sheet`	Сортирует лист по столбцу.
`unhideColumn(column)`	`void`	Отображает столбец в заданном диапазоне.
`unhideRow(row)`	`void`	Отображает строку в заданном диапазоне.
`updateChart(chart)`	`void`	Обновляет диаграмму на этом листе.

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

Метод	Тип возврата	Краткое описание
`getSheetProtection()`	`PageProtection`	Возвращает экземпляр `PageProtection` описывающий разрешения для текущего листа.
`getTabColor()`	`String`	Получает цвет вкладки листа или `null` , если вкладка листа не имеет цвета.
`setSheetProtection(permissions)`	`void`	Устанавливает разрешения для текущего листа.

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

`activate()`

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

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

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

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

`addDeveloperMetadata(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

`addDeveloperMetadata(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`	`DeveloperMetadataVisibility`	Видимость новых метаданных разработчика.

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

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

Авторизация

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

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

`addDeveloperMetadata(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

`addDeveloperMetadata(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`	`DeveloperMetadataVisibility`	Видимость новых метаданных разработчика.

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

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

Авторизация

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

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

`appendRow(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']);

Параметры

Имя	Тип	Описание
`rowContents`	`Object[]`	Массив значений, которые нужно вставить после последней строки листа.

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

Sheet — лист, полезный для объединения методов.

Авторизация

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

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

`asDataSourceSheet()`

Возвращает лист как DataSourceSheet , если лист имеет тип SheetType.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());

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

DataSourceSheet — лист источника данных.

Авторизация

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

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

`autoResizeColumn(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);

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Положение данного столбца для изменения размера.

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

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

Авторизация

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

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

`autoResizeColumns(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);

Параметры

Имя	Тип	Описание
`startColumn`	`Integer`	Начальный столбец для автоматического изменения размера.
`numColumns`	`Integer`	Количество столбцов для автоматического изменения размера.

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

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

Авторизация

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

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

`autoResizeRows(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);

Параметры

Имя	Тип	Описание
`startRow`	`Integer`	Начальная строка для автоматического изменения размера.
`numRows`	`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, содержащая расширенные параметры, перечисленные ниже.

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

Имя	Тип	Описание
`contentsOnly`	`Boolean`	Следует ли очищать содержимое.
`formatOnly`	`Boolean`	Очистить ли формат.

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

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

Авторизация

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

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

`clearConditionalFormatRules()`

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

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

Авторизация

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

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

`clearContents()`

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

// 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

`clearFormats()`

Очищает лист от форматирования, сохраняя содержимое.

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

// 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

`clearNotes()`

Очищает лист от всех заметок.

// 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

`collapseAllColumnGroups()`

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

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

`collapseAllRowGroups()`

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

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

`copyTo(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

`createDeveloperMetadataFinder()`

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

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

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

DeveloperMetadataFinder — средство поиска метаданных разработчика для поиска метаданных в пределах этого листа.

`createTextFinder(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');

Параметры

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

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

TextFinder — TextFinder для листа.

`deleteColumn(columnPosition)`

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

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

Параметры

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

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

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

Авторизация

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

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

`deleteColumns(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);

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Позиция первого удаляемого столбца.
`howMany`	`Integer`	Количество столбцов, которые необходимо удалить.

Авторизация

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

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

`deleteRow(rowPosition)`

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

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

Параметры

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

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

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

Авторизация

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

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

`deleteRows(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);

Параметры

Имя	Тип	Описание
`rowPosition`	`Integer`	Позиция первой удаляемой строки.
`howMany`	`Integer`	Количество строк, которые необходимо удалить.

Авторизация

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

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

`expandAllColumnGroups()`

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

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

`expandAllRowGroups()`

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

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

`expandColumnGroupsUpToDepth(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);

Параметры

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

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

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

Авторизация

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

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

`expandRowGroupsUpToDepth(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);

Параметры

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

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

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

Авторизация

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

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

`getActiveCell()`

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

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

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

`getActiveRange()`

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

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

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

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

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

Авторизация

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

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

См. также

setActiveRange(range)

`getActiveRangeList()`

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

Если выбран один диапазон, это действует как вызов getActiveRange() .

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

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

RangeList — список активных диапазонов

Авторизация

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

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

См. также

setActiveRangeList(rangeList)

`getBandings()`

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

// 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

`getCharts()`

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

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
}

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

EmbeddedChart[] — Массив диаграмм.

Авторизация

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

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

`getColumnGroup(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);

Параметры

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

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

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

Авторизация

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

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

`getColumnGroupControlPosition()`

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

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

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

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

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

Авторизация

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

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

`getColumnGroupDepth(columnIndex)`

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

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

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

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

Параметры

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

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

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

Авторизация

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

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

`getColumnWidth(columnPosition)`

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

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

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

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Положение колонны для проверки.

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

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

Авторизация

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

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

`getConditionalFormatRules()`

Получите все правила условного форматирования на этом листе.

// 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);
}

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

ConditionalFormatRule[] — Массив всех правил на листе.

Авторизация

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

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

`getCurrentCell()`

Возвращает текущую ячейку на активном листе или 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

`getDataRange()`

Возвращает 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

`getDataSourceFormulas()`

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

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

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

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

Авторизация

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

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

`getDataSourcePivotTables()`

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

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

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

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

Авторизация

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

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

`getDataSourceTables()`

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

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

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

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

Авторизация

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

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

`getDeveloperMetadata()`

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

// 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());
}

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

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

Авторизация

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

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

`getDrawings()`

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

// 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

`getFilter()`

Возвращает фильтр на этом листе или 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

`getFormUrl()`

Возвращает 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

`getFrozenColumns()`

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

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

`getFrozenRows()`

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

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

`getImages()`

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

// 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());
}

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

OverGridImage[] — Массив изображений поверх сетки.

Авторизация

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

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

`getIndex()`

Получает положение листа в родительской электронной таблице. Начинается с 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

`getLastColumn()`

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

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

`getLastRow()`

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

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

`getMaxColumns()`

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

// 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

`getMaxRows()`

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

// 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

`getName()`

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

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

`getNamedRanges()`

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

// 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());
}

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

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

Авторизация

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

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

`getParent()`

Возвращает 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

`getPivotTables()`

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

// 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());
}

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

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

Авторизация

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

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

`getProtections(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`	`ProtectionType`	Тип защищенной области: `SpreadsheetApp.ProtectionType.RANGE` или `SpreadsheetApp.ProtectionType.SHEET` .

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

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

Авторизация

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

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

`getRange(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

`getRange(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.
`numRows`	`Integer`	Количество возвращаемых строк.

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

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

Авторизация

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

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

`getRange(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.
`numRows`	`Integer`	Количество возвращаемых строк.
`numColumns`	`Integer`	Количество возвращаемых столбцов.

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

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

Авторизация

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

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

`getRange(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

`getRangeList(a1Notations)`

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

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

RangeList — список диапазонов в указанном месте.

Авторизация

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

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

`getRowGroup(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);

Параметры

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

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

Group — группа строк с контрольным индексом и глубиной или выдает исключение, если группа не существует.

Авторизация

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

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

`getRowGroupControlPosition()`

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

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

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

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

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

Авторизация

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

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

`getRowGroupDepth(rowIndex)`

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

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

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

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

Параметры

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

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

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

Авторизация

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

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

`getRowHeight(rowPosition)`

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

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

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

Параметры

Имя	Тип	Описание
`rowPosition`	`Integer`	Положение строки для проверки.

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

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

Авторизация

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

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

`getSelection()`

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

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

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

Selection — текущий выбор

Авторизация

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

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

`getSheetId()`

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

Это уникальный идентификатор листа. Идентификатор — это монотонно возрастающее целое число, присваиваемое во время создания листа и не зависящее от положения листа. Это полезно в сочетании с такими методами, как Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) , которые принимают gridId а не экземпляр 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

`getSheetName()`

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

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

`getSheetValues(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);

Параметры

Имя	Тип	Описание
`startRow`	`Integer`	Положение стартового ряда.
`startColumn`	`Integer`	Положение стартовой колонны.
`numRows`	`Integer`	Количество строк, для которых возвращаются значения.
`numColumns`	`Integer`	Количество столбцов, для которых возвращаются значения.

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

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

Авторизация

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

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

`getSlicers()`

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

// 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

`getTabColorObject()`

Получает цвет вкладки листа или 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

`getType()`

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

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

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

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

SheetType — Тип листа.

Авторизация

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

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

`hasHiddenGridlines()`

Возвращает 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

`hideColumn(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

`hideColumns(columnIndex)`

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

Чтобы скрыть более одного столбца с помощью индекса, используйтеideColumns hideColumns(columnIndex, numColumns) .

Чтобы скрыть более одного столбца с помощью диапазона, используйте hideColumn() .

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

Параметры

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

Авторизация

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

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

`hideColumns(columnIndex, numColumns)`

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

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

Параметры

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

Авторизация

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

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

`hideRow(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

`hideRows(rowIndex)`

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

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

Параметры

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

Авторизация

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

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

`hideRows(rowIndex, numRows)`

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

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

Параметры

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

Авторизация

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

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

`hideSheet()`

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

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

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

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

Авторизация

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

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

`insertChart(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`	`EmbeddedChart`	Диаграмма для вставки.

Авторизация

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

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

`insertColumnAfter(afterPosition)`

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

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

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

Параметры

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

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

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

Авторизация

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

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

`insertColumnBefore(beforePosition)`

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

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

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

Параметры

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

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

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

Авторизация

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

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

`insertColumns(columnIndex)`

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

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

Параметры

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

Авторизация

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

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

`insertColumns(columnIndex, numColumns)`

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

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

Параметры

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

Авторизация

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

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

`insertColumnsAfter(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);

Параметры

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

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

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

Авторизация

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

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

`insertColumnsBefore(beforePosition, howMany)`

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

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

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

Параметры

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

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

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

Авторизация

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

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

`insertImage(blobSource, column, row)`

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

Параметры

Имя	Тип	Описание
`blobSource`	`BlobSource`	Большой двоичный объект, содержащий содержимое изображения, тип MIME и (необязательно) имя.
`column`	`Integer`	Положение столбца.
`row`	`Integer`	Позиция строки.

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

OverGridImage — Вставленное изображение.

Авторизация

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

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

`insertImage(blobSource, column, row, offsetX, offsetY)`

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

Параметры

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

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

OverGridImage — Вставленное изображение.

Авторизация

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

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

`insertImage(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`	Положение строки сетки.

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

OverGridImage — Вставленное изображение.

Авторизация

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

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

`insertImage(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`	Вертикальное смещение от угла ячейки в пикселях.

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

OverGridImage — Вставленное изображение.

Авторизация

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

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

`insertRowAfter(afterPosition)`

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

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

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

Параметры

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

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

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

Авторизация

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

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

`insertRowBefore(beforePosition)`

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

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

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

Параметры

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

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

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

Авторизация

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

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

`insertRows(rowIndex)`

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

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

Параметры

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

Авторизация

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

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

`insertRows(rowIndex, numRows)`

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

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

Параметры

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

Авторизация

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

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

`insertRowsAfter(afterPosition, howMany)`

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

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

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

Параметры

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

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

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

Авторизация

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

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

`insertRowsBefore(beforePosition, howMany)`

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

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

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

Параметры

Имя	Тип	Описание
`beforePosition`	`Integer`	Строка, перед которой должны быть добавлены новые строки.
`howMany`	`Integer`	Количество строк для вставки.

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

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

Авторизация

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

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

`insertSlicer(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`	Диапазон, в котором создается срез.
`anchorRowPos`	`Integer`	Верхняя сторона слайсера закреплена в этом ряду.
`anchorColPos`	`Integer`	Верхняя сторона слайсера закреплена в этом столбце.

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

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

Авторизация

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

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

`insertSlicer(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`	Диапазон, в котором создается срез.
`anchorRowPos`	`Integer`	Верхняя сторона слайсера закреплена в этом ряду.
`anchorColPos`	`Integer`	Верхняя сторона слайсера закреплена в этом столбце.
`offsetX`	`Integer`	Горизонтальное смещение от угла ячейки в пикселях.
`offsetY`	`Integer`	Вертикальное смещение от угла ячейки в пикселях.

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

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

Авторизация

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

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

`isColumnHiddenByUser(columnPosition)`

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

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

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

Параметры

Имя	Тип	Описание
`columnPosition`	`Integer`	Положение колонны для проверки.

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

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

Авторизация

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

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

`isRightToLeft()`

Возвращает 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

`isRowHiddenByFilter(rowPosition)`

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

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

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

Параметры

Имя	Тип	Описание
`rowPosition`	`Integer`	Положение строки для проверки.

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

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

Авторизация

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

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

`isRowHiddenByUser(rowPosition)`

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

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

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

Параметры

Имя	Тип	Описание
`rowPosition`	`Integer`	Положение строки для проверки.

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

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

Авторизация

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

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

`isSheetHidden()`

Возвращает 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

`moveColumns(columnSpec, destinationIndex)`

Перемещает столбцы, выбранные в заданном диапазоне, в положение, указанное в месте destinationIndex . Сам columnSpec не обязательно должен точно представлять весь столбец или группу столбцов для перемещения — он выбирает все столбцы, охватываемые диапазоном.

// 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);

Параметры

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

Авторизация

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

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

`moveRows(rowSpec, destinationIndex)`

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

// 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);

Параметры

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

Авторизация

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

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

`newChart()`

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

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

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

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

EmbeddedChartBuilder — конструктор для создания новой диаграммы.

`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

`removeChart(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`	`EmbeddedChart`	Диаграмма, которую нужно удалить.

Авторизация

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

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

`setActiveRange(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

`setActiveRangeList(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();

Параметры

Имя	Тип	Описание
`rangeList`	`RangeList`	Список диапазонов для выбора.

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

RangeList — вновь выбранный список диапазонов.

Авторизация

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

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

`setActiveSelection(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

`setActiveSelection(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

`setColumnGroupControlPosition(position)`

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

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

Параметры

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

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

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

Авторизация

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

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

`setColumnWidth(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);

Параметры

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

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

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

Авторизация

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

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

`setColumnWidths(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);

Параметры

Имя	Тип	Описание
`startColumn`	`Integer`	Начальная позиция столбца для изменения.
`numColumns`	`Integer`	Количество столбцов для изменения.
`width`	`Integer`	Ширина в пикселях, чтобы установить его на.

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

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

Авторизация

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

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

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

Авторизация

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

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

`setCurrentCell(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

`setFrozenColumns(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

`setFrozenRows(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

`setHiddenGridlines(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);

Параметры

Имя	Тип	Описание
`hideGridlines`	`Boolean`	Если `true` , скрыть сетки в этом листе; В противном случае показать линии сетки.

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

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

Авторизация

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

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

`setName(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

`setRightToLeft(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);

Параметры

Имя	Тип	Описание
`rightToLeft`	`Boolean`	Если `true` , макет листа установлена на правой к лету, с ячейкой A1 в правом верхнем углу. Если `false` , макет листа устанавливается на слева направо по умолчанию, с ячейкой A1 в верхней части левого.

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

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

Авторизация

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

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

`setRowGroupControlPosition(position)`

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

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

Параметры

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

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

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

Авторизация

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

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

`setRowHeight(rowPosition, height)`

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

Параметры

Имя	Тип	Описание
`rowPosition`	`Integer`	Позиция строки для изменения.
`height`	`Integer`	Высота в пикселях, чтобы установить его.

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

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

Авторизация

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

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

`setRowHeights(startRow, numRows, height)`

Устанавливает высоту заданных рядов в пикселях. По умолчанию ряды растут, чтобы соответствовать содержимому ячейки. Если вы хотите заставить ряды до указанной высоты, используйте setRowHeightsForced(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);

Параметры

Имя	Тип	Описание
`startRow`	`Integer`	Начальная позиция строки для изменения.
`numRows`	`Integer`	Количество рядов для изменения.
`height`	`Integer`	Высота в пикселях, чтобы установить его.

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

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

Авторизация

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

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

`setRowHeightsForced(startRow, numRows, height)`

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

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

Параметры

Имя	Тип	Описание
`startRow`	`Integer`	Начальная позиция строки для изменения.
`numRows`	`Integer`	Количество рядов для изменения.
`height`	`Integer`	Высота в пикселях, чтобы установить его.

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

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

Авторизация

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

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

`setTabColor(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

`setTabColorObject(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

`showColumns(columnIndex)`

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

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

Параметры

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

Авторизация

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

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

`showColumns(columnIndex, numColumns)`

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

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

Параметры

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

Авторизация

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

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

`showRows(rowIndex)`

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

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

Параметры

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

Авторизация

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

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

`showRows(rowIndex, numRows)`

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

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

Параметры

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

Авторизация

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

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

`showSheet()`

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

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

Параметры

Имя	Тип	Описание
`columnPosition`	`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);

Параметры

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

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

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

Авторизация

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

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

`unhideColumn(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

`unhideRow(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

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

Авторизация

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

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

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

`getSheetProtection()`

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

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

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

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

PageProtection - объект, описывающий разрешения на доступ к листу

Авторизация

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

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

`getTabColor()`

Устарело. Заменен на getTabColorObject()

Получает цвет вкладки листа или 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

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

Авторизация

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

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