Доступ и изменение диапазонов электронных таблиц. Диапазон может представлять собой одну ячейку на листе или группу соседних ячеек на листе.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
activate() | Range | Устанавливает указанный диапазон в качестве active range , при этом верхняя левая ячейка диапазона становится current cell . |
activateAsCurrentCell() | Range | Устанавливает указанную ячейку в качестве current cell . |
addDeveloperMetadata(key) | Range | Добавляет метаданные разработчика с указанным ключом в диапазон. |
addDeveloperMetadata(key, visibility) | Range | Добавляет метаданные разработчика с указанным ключом и видимостью в диапазон. |
addDeveloperMetadata(key, value) | Range | Добавляет метаданные разработчика с указанным ключом и значением в диапазон. |
addDeveloperMetadata(key, value, visibility) | Range | Добавляет метаданные разработчика с указанным ключом, значением и видимостью в диапазон. |
applyColumnBanding() | Banding | Применяет к диапазону тему группировки столбцов по умолчанию. |
applyColumnBanding(bandingTheme) | Banding | Применяет указанную тему объединения столбцов к диапазону. |
applyColumnBanding(bandingTheme, showHeader, showFooter) | Banding | Применяет указанную тему объединения столбцов к диапазону с указанными настройками верхнего и нижнего колонтитула. |
applyRowBanding() | Banding | Применяет к диапазону тему группировки строк по умолчанию. |
applyRowBanding(bandingTheme) | Banding | Применяет указанную тему объединения строк к диапазону. |
applyRowBanding(bandingTheme, showHeader, showFooter) | Banding | Применяет указанную тему объединения строк к диапазону с указанными настройками верхнего и нижнего колонтитула. |
autoFill(destination, series) | void | Заполняет destinationRange данными на основе данных в этом диапазоне. |
autoFillToNeighbor(series) | void | Вычисляет диапазон для заполнения новыми данными на основе соседних ячеек и автоматически заполняет этот диапазон новыми значениями на основе данных, содержащихся в этом диапазоне. |
breakApart() | Range | Снова разбейте все ячейки с несколькими столбцами в диапазоне на отдельные ячейки. |
canEdit() | Boolean | Определяет, имеет ли пользователь разрешение на редактирование каждой ячейки диапазона. |
check() | Range | Изменяет состояние флажков в диапазоне на «отмечено». |
clear() | Range | Очищает диапазон содержимого и форматов. |
clear(options) | Range | Очищает диапазон содержимого, формата, правил проверки данных и/или комментариев, как указано с помощью заданных дополнительных параметров. |
clearContent() | Range | Очищает содержимое диапазона, оставляя форматирование нетронутым. |
clearDataValidations() | Range | Очищает правила проверки данных для диапазона. |
clearFormat() | Range | Очищает форматирование для этого диапазона. |
clearNote() | Range | Очищает заметку в данной ячейке или ячейках. |
collapseGroups() | Range | Сворачивает все группы, которые полностью содержатся в диапазоне. |
copyFormatToRange(gridId, column, columnEnd, row, rowEnd) | void | Скопируйте форматирование диапазона в указанное место. |
copyFormatToRange(sheet, column, columnEnd, row, rowEnd) | void | Скопируйте форматирование диапазона в указанное место. |
copyTo(destination) | void | Копирует данные из диапазона ячеек в другой диапазон ячеек. |
copyTo(destination, copyPasteType, transposed) | void | Копирует данные из диапазона ячеек в другой диапазон ячеек. |
copyTo(destination, options) | void | Копирует данные из диапазона ячеек в другой диапазон ячеек. |
copyValuesToRange(gridId, column, columnEnd, row, rowEnd) | void | Скопируйте содержимое диапазона в указанное место. |
copyValuesToRange(sheet, column, columnEnd, row, rowEnd) | void | Скопируйте содержимое диапазона в указанное место. |
createDataSourcePivotTable(dataSource) | DataSourcePivotTable | Создает пустую сводную таблицу источника данных из источника данных, привязанную к первой ячейке в этом диапазоне. |
createDataSourceTable(dataSource) | DataSourceTable | Создает пустую таблицу источника данных из источника данных, привязанную к первой ячейке в этом диапазоне. |
createDeveloperMetadataFinder() | DeveloperMetadataFinder | Возвращает DeveloperMetadataFinderApi для поиска метаданных разработчика в пределах этого диапазона. |
createFilter() | Filter | Создает фильтр и применяет его к указанному диапазону на листе. |
createPivotTable(sourceData) | PivotTable | Создает пустую сводную таблицу из указанного sourceData , привязанного к первой ячейке в этом диапазоне. |
createTextFinder(findText) | TextFinder | Создает поисковик текста для диапазона, который может находить и заменять текст в этом диапазоне. |
deleteCells(shiftDimension) | void | Удаляет этот диапазон ячеек. |
expandGroups() | Range | Разворачивает свернутые группы, диапазон которых или переключатель управления пересекаются с этим диапазоном. |
getA1Notation() | String | Возвращает строковое описание диапазона в нотации A1. |
getBackground() | String | Возвращает цвет фона верхней левой ячейки диапазона (например, '#ffffff' ). |
getBackgroundObject() | Color | Возвращает цвет фона верхней левой ячейки диапазона. |
getBackgroundObjects() | Color[][] | Возвращает цвета фона ячеек в диапазоне. |
getBackgrounds() | String[][] | Возвращает цвета фона ячеек в диапазоне (например, '#ffffff' ). |
getBandings() | Banding[] | Возвращает все полосы, примененные к любым ячейкам в этом диапазоне. |
getCell(row, column) | Range | Возвращает данную ячейку в диапазоне. |
getColumn() | Integer | Возвращает начальную позицию столбца для этого диапазона. |
getDataRegion() | Range | Возвращает копию диапазона, расширенного по четырем кардинальным Direction , чтобы охватить все соседние ячейки с данными в них. |
getDataRegion(dimension) | Range | Возвращает копию расширенного диапазона Direction.UP и Direction.DOWN , если указанное измерение — Dimension.ROWS , или Direction.NEXT и Direction.PREVIOUS , если измерение — Dimension.COLUMNS . |
getDataSourceFormula() | DataSourceFormula | Возвращает DataSourceFormula для первой ячейки диапазона или null , если ячейка не содержит формулу источника данных. |
getDataSourceFormulas() | DataSourceFormula[] | Возвращает DataSourceFormula для ячеек в диапазоне. |
getDataSourcePivotTables() | DataSourcePivotTable[] | Получает все сводные таблицы источника данных, пересекающие диапазон. |
getDataSourceTables() | DataSourceTable[] | Получает все таблицы источников данных, пересекающие диапазон. |
getDataSourceUrl() | String | Возвращает URL-адрес данных в этом диапазоне, который можно использовать для создания диаграмм и запросов. |
getDataTable() | DataTable | Верните данные внутри этого объекта в виде DataTable. |
getDataTable(firstRowIsHeader) | DataTable | Верните данные внутри этого диапазона в виде DataTable. |
getDataValidation() | DataValidation | Возвращает правило проверки данных для левой верхней ячейки диапазона. |
getDataValidations() | DataValidation[][] | Возвращает правила проверки данных для всех ячеек диапазона. |
getDeveloperMetadata() | DeveloperMetadata[] | Получает метаданные разработчика, связанные с этим диапазоном. |
getDisplayValue() | String | Возвращает отображаемое значение верхней левой ячейки диапазона. |
getDisplayValues() | String[][] | Возвращает прямоугольную сетку значений для этого диапазона. |
getFilter() | Filter | Возвращает фильтр на листе, которому принадлежит этот диапазон, или null , если на листе нет фильтра. |
getFontColorObject() | Color | Возвращает цвет шрифта ячейки в верхнем левом углу диапазона. |
getFontColorObjects() | Color[][] | Возвращает цвета шрифта ячеек в диапазоне. |
getFontFamilies() | String[][] | Возвращает семейства шрифтов ячеек в диапазоне. |
getFontFamily() | String | Возвращает семейство шрифтов ячейки в верхнем левом углу диапазона. |
getFontLine() | String | Получает стиль линии ячейки в верхнем левом углу диапазона ( 'underline' , 'line-through' или 'none' ). |
getFontLines() | String[][] | Получает стиль линии ячеек в диапазоне ( 'underline' , 'line-through' или 'none' ). |
getFontSize() | Integer | Возвращает размер шрифта в пунктах ячейки в верхнем левом углу диапазона. |
getFontSizes() | Integer[][] | Возвращает размеры шрифта ячеек в диапазоне. |
getFontStyle() | String | Возвращает стиль шрифта ( 'italic' или 'normal' ) ячейки в верхнем левом углу диапазона. |
getFontStyles() | String[][] | Возвращает стили шрифта ячеек в диапазоне. |
getFontWeight() | String | Возвращает толщину шрифта (обычный/жирный) ячейки в верхнем левом углу диапазона. |
getFontWeights() | String[][] | Возвращает толщину шрифта ячеек в диапазоне. |
getFormula() | String | Возвращает формулу (нотация A1) для верхней левой ячейки диапазона или пустую строку, если ячейка пуста или не содержит формулы. |
getFormulaR1C1() | String | Возвращает формулу (нотацию R1C1) для данной ячейки или null , если ее нет. |
getFormulas() | String[][] | Возвращает формулы (обозначение A1) для ячеек диапазона. |
getFormulasR1C1() | String[][] | Возвращает формулы (нотация R1C1) для ячеек диапазона. |
getGridId() | Integer | Возвращает идентификатор сетки родительского листа диапазона. |
getHeight() | Integer | Возвращает высоту диапазона. |
getHorizontalAlignment() | String | Возвращает горизонтальное выравнивание текста (слева/по центру/справа) ячейки в верхнем левом углу диапазона. |
getHorizontalAlignments() | String[][] | Возвращает горизонтальное выравнивание ячеек в диапазоне. |
getLastColumn() | Integer | Возвращает конечную позицию столбца. |
getLastRow() | Integer | Возвращает позицию конечной строки. |
getMergedRanges() | Range[] | Возвращает массив объектов Range , представляющих объединенные ячейки, которые либо полностью находятся в текущем диапазоне, либо содержат хотя бы одну ячейку в текущем диапазоне. |
getNextDataCell(direction) | Range | Начиная с ячейки в первом столбце и строке диапазона, возвращает следующую ячейку в заданном направлении, которая является краем непрерывного диапазона ячеек с данными в них, или ячейку на краю электронной таблицы в этом направлении. |
getNote() | String | Возвращает ноту, связанную с заданным диапазоном. |
getNotes() | String[][] | Возвращает примечания, связанные с ячейками диапазона. |
getNumColumns() | Integer | Возвращает количество столбцов в этом диапазоне. |
getNumRows() | Integer | Возвращает количество строк в этом диапазоне. |
getNumberFormat() | String | Получите формат числа или даты в верхней левой ячейке заданного диапазона. |
getNumberFormats() | String[][] | Возвращает форматы чисел или дат для ячеек в диапазоне. |
getRichTextValue() | RichTextValue | Возвращает значение форматированного текста для верхней левой ячейки диапазона или null , если значение ячейки не является текстом. |
getRichTextValues() | RichTextValue[][] | Возвращает значения форматированного текста для ячеек в диапазоне. |
getRow() | Integer | Возвращает позицию строки для этого диапазона. |
getRowIndex() | Integer | Возвращает позицию строки для этого диапазона. |
getSheet() | Sheet | Возвращает лист, которому принадлежит этот диапазон. |
getTextDirection() | TextDirection | Возвращает направление текста для верхней левой ячейки диапазона. |
getTextDirections() | TextDirection[][] | Возвращает направления текста для ячеек в диапазоне. |
getTextRotation() | TextRotation | Возвращает настройки поворота текста для верхней левой ячейки диапазона. |
getTextRotations() | TextRotation[][] | Возвращает настройки поворота текста для ячеек в диапазоне. |
getTextStyle() | TextStyle | Возвращает стиль текста для верхней левой ячейки диапазона. |
getTextStyles() | TextStyle[][] | Возвращает стили текста для ячеек в диапазоне. |
getValue() | Object | Возвращает значение верхней левой ячейки диапазона. |
getValues() | Object[][] | Возвращает прямоугольную сетку значений для этого диапазона. |
getVerticalAlignment() | String | Возвращает вертикальное выравнивание (сверху/среди/снизу) ячейки в верхнем левом углу диапазона. |
getVerticalAlignments() | String[][] | Возвращает вертикальное выравнивание ячеек в диапазоне. |
getWidth() | Integer | Возвращает ширину диапазона в столбцах. |
getWrap() | Boolean | Возвращает, переносится ли текст в ячейке. |
getWrapStrategies() | WrapStrategy[][] | Возвращает стратегии переноса текста для ячеек в диапазоне. |
getWrapStrategy() | WrapStrategy | Возвращает стратегию переноса текста для верхней левой ячейки диапазона. |
getWraps() | Boolean[][] | Возвращает, переносится ли текст в ячейках. |
insertCells(shiftDimension) | Range | Вставляет пустые ячейки в этот диапазон. |
insertCheckboxes() | Range | Вставляет флажки в каждую ячейку диапазона, настроенные как true для отмеченного и false для неотмеченного. |
insertCheckboxes(checkedValue) | Range | Вставляет флажки в каждую ячейку диапазона, настроенную с пользовательским значением для отмеченного и пустой строкой для неотмеченного. |
insertCheckboxes(checkedValue, uncheckedValue) | Range | Вставляет флажки в каждую ячейку диапазона с настраиваемыми значениями для отмеченного и неотмеченного состояний. |
isBlank() | Boolean | Возвращает true , если диапазон полностью пуст. |
isChecked() | Boolean | Возвращает, имеют ли все ячейки в диапазоне состояние флажка «отмечено». |
isEndColumnBounded() | Boolean | Определяет, привязан ли конец диапазона к определенному столбцу. |
isEndRowBounded() | Boolean | Определяет, привязан ли конец диапазона к определенной строке. |
isPartOfMerge() | Boolean | Возвращает true , если ячейки в текущем диапазоне перекрывают любые объединенные ячейки. |
isStartColumnBounded() | Boolean | Определяет, привязано ли начало диапазона к определенному столбцу. |
isStartRowBounded() | Boolean | Определяет, привязано ли начало диапазона к определенной строке. |
merge() | Range | Объединяет ячейки диапазона в один блок. |
mergeAcross() | Range | Объедините ячейки диапазона по столбцам диапазона. |
mergeVertically() | Range | Объединяет ячейки диапазона вместе. |
moveTo(target) | void | Вырежьте и вставьте (как формат, так и значения) из этого диапазона в целевой диапазон. |
offset(rowOffset, columnOffset) | Range | Возвращает новый диапазон, смещенный от этого диапазона на заданное количество строк и столбцов (которое может быть отрицательным). |
offset(rowOffset, columnOffset, numRows) | Range | Возвращает новый диапазон относительно текущего диапазона, верхняя левая точка которого смещена от текущего диапазона на заданные строки и столбцы и имеет заданную высоту в ячейках. |
offset(rowOffset, columnOffset, numRows, numColumns) | Range | Возвращает новый диапазон относительно текущего диапазона, верхняя левая точка которого смещена от текущего диапазона на заданные строки и столбцы и имеет заданную высоту и ширину в ячейках. |
protect() | Protection | Создает объект, который может защитить диапазон от редактирования, за исключением пользователей, имеющих разрешение. |
randomize() | Range | Рандомизирует порядок строк в заданном диапазоне. |
removeCheckboxes() | Range | Удаляет все флажки из диапазона. |
removeDuplicates() | Range | Удаляет строки в этом диапазоне, содержащие значения, которые являются дубликатами значений в любой предыдущей строке. |
removeDuplicates(columnsToCompare) | Range | Удаляет строки в этом диапазоне, содержащие значения в указанных столбцах, которые являются дубликатами значений любой предыдущей строки. |
setBackground(color) | Range | Устанавливает цвет фона всех ячеек в диапазоне в нотации CSS (например, '#ffffff' или 'white' ). |
setBackgroundObject(color) | Range | Устанавливает цвет фона для всех ячеек диапазона. |
setBackgroundObjects(color) | Range | Устанавливает прямоугольную сетку цветов фона (размеры должны соответствовать этому диапазону). |
setBackgroundRGB(red, green, blue) | Range | Устанавливает фон заданного цвета, используя значения RGB (целые числа от 0 до 255 включительно). |
setBackgrounds(color) | Range | Устанавливает прямоугольную сетку цветов фона (размеры должны соответствовать этому диапазону). |
setBorder(top, left, bottom, right, vertical, horizontal) | Range | Устанавливает свойство границы. |
setBorder(top, left, bottom, right, vertical, horizontal, color, style) | Range | Устанавливает свойство границы с цветом и/или стилем. |
setDataValidation(rule) | Range | Устанавливает одно правило проверки данных для всех ячеек диапазона. |
setDataValidations(rules) | Range | Устанавливает правила проверки данных для всех ячеек диапазона. |
setFontColor(color) | Range | Устанавливает цвет шрифта в нотации CSS (например, '#ffffff' или 'white' ). |
setFontColorObject(color) | Range | Устанавливает цвет шрифта данного диапазона. |
setFontColorObjects(colors) | Range | Устанавливает прямоугольную сетку цветов шрифта (размеры должны соответствовать этому диапазону). |
setFontColors(colors) | Range | Устанавливает прямоугольную сетку цветов шрифта (размеры должны соответствовать этому диапазону). |
setFontFamilies(fontFamilies) | Range | Устанавливает прямоугольную сетку семейств шрифтов (размеры должны соответствовать этому диапазону). |
setFontFamily(fontFamily) | Range | Устанавливает семейство шрифтов, например «Arial» или «Helvetica». |
setFontLine(fontLine) | Range | Устанавливает стиль линии шрифта для данного диапазона ( 'underline' , 'line-through' или 'none' ). |
setFontLines(fontLines) | Range | Устанавливает прямоугольную сетку стилей линий (размеры должны соответствовать этому диапазону). |
setFontSize(size) | Range | Устанавливает размер шрифта, при этом размер является размером точки, который будет использоваться. |
setFontSizes(sizes) | Range | Устанавливает прямоугольную сетку размеров шрифта (размеры должны соответствовать этому диапазону). |
setFontStyle(fontStyle) | Range | Установите стиль шрифта для данного диапазона ( 'italic' или 'normal' ). |
setFontStyles(fontStyles) | Range | Устанавливает прямоугольную сетку стилей шрифта (размеры должны соответствовать этому диапазону). |
setFontWeight(fontWeight) | Range | Установите толщину шрифта для данного диапазона (обычный/жирный). |
setFontWeights(fontWeights) | Range | Устанавливает прямоугольную сетку толщины шрифта (размеры должны соответствовать этому диапазону). |
setFormula(formula) | Range | Обновляет формулу для этого диапазона. |
setFormulaR1C1(formula) | Range | Обновляет формулу для этого диапазона. |
setFormulas(formulas) | Range | Устанавливает прямоугольную сетку формул (размеры должны соответствовать этому диапазону). |
setFormulasR1C1(formulas) | Range | Устанавливает прямоугольную сетку формул (размеры должны соответствовать этому диапазону). |
setHorizontalAlignment(alignment) | Range | Установите горизонтальное выравнивание (слева направо) для заданного диапазона (слева/по центру/справа). |
setHorizontalAlignments(alignments) | Range | Устанавливает прямоугольную сетку горизонтальных выравниваний. |
setNote(note) | Range | Устанавливает ноту на заданное значение. |
setNotes(notes) | Range | Устанавливает прямоугольную сетку нот (должна соответствовать размерам этого диапазона). |
setNumberFormat(numberFormat) | Range | Устанавливает формат числа или даты для данной строки форматирования. |
setNumberFormats(numberFormats) | Range | Устанавливает прямоугольную сетку форматов чисел или дат (размеры должны соответствовать этому диапазону). |
setRichTextValue(value) | Range | Устанавливает значение форматированного текста для ячеек в диапазоне. |
setRichTextValues(values) | Range | Устанавливает прямоугольную сетку значений форматированного текста. |
setShowHyperlink(showHyperlink) | Range | Устанавливает, должны ли в диапазоне отображаться гиперссылки. |
setTextDirection(direction) | Range | Задает направление текста для ячеек в диапазоне. |
setTextDirections(directions) | Range | Устанавливает прямоугольную сетку направлений текста. |
setTextRotation(degrees) | Range | Задает настройки поворота текста для ячеек в диапазоне. |
setTextRotation(rotation) | Range | Задает настройки поворота текста для ячеек в диапазоне. |
setTextRotations(rotations) | Range | Устанавливает прямоугольную сетку вращения текста. |
setTextStyle(style) | Range | Устанавливает стиль текста для ячеек в диапазоне. |
setTextStyles(styles) | Range | Устанавливает прямоугольную сетку стилей текста. |
setValue(value) | Range | Устанавливает значение диапазона. |
setValues(values) | Range | Устанавливает прямоугольную сетку значений (размеры должны соответствовать этому диапазону). |
setVerticalAlignment(alignment) | Range | Установите вертикальное выравнивание (сверху вниз) для заданного диапазона (сверху/середине/снизу). |
setVerticalAlignments(alignments) | Range | Устанавливает прямоугольную сетку вертикальных трасс (размеры должны соответствовать этому диапазону). |
setVerticalText(isVertical) | Range | Определяет, следует ли размещать текст в ячейках диапазона. |
setWrap(isWrapEnabled) | Range | Установите перенос ячеек данного диапазона. |
setWrapStrategies(strategies) | Range | Устанавливает прямоугольную сетку стратегий переноса. |
setWrapStrategy(strategy) | Range | Устанавливает стратегию переноса текста для ячеек в диапазоне. |
setWraps(isWrapEnabled) | Range | Устанавливает прямоугольную сетку политик переноса слов (размеры должны соответствовать этому диапазону). |
shiftColumnGroupDepth(delta) | Range | Изменяет глубину группировки столбцов диапазона на указанную величину. |
shiftRowGroupDepth(delta) | Range | Изменяет глубину группировки строк диапазона на указанную величину. |
sort(sortSpecObj) | Range | Сортирует ячейки в заданном диапазоне по указанному столбцу и порядку. |
splitTextToColumns() | void | Разбивает столбец текста на несколько столбцов на основе автоматически определенного разделителя. |
splitTextToColumns(delimiter) | void | Разбивает столбец текста на несколько столбцов, используя указанную строку в качестве пользовательского разделителя. |
splitTextToColumns(delimiter) | void | Разбивает столбец текста на несколько столбцов на основе указанного разделителя. |
trimWhitespace() | Range | Обрезает пробелы (например, пробелы, табуляции или новые строки) в каждой ячейке в этом диапазоне. |
uncheck() | Range | Изменяет состояние флажков в диапазоне на «не отмечено». |
Подробная документация
activate()
Устанавливает указанный диапазон в качестве active range
, при этом верхняя левая ячейка диапазона становится current cell
.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getRange('A1:D10'); range.activate(); var selection = sheet.getSelection(); // Current cell: A1 var currentCell = selection.getCurrentCell(); // Active Range: A1:D10 var activeRange = selection.getActiveRange();
Возвращаться
Range
— этот диапазон для цепочки.
activateAsCurrentCell()
Устанавливает указанную ячейку в качестве current cell
.
Если указанная ячейка присутствует в существующем диапазоне, то этот диапазон становится активным диапазоном, а ячейка — текущей.
Если указанная ячейка отсутствует ни в одном существующем диапазоне, существующий выбор удаляется, и ячейка становится текущей ячейкой и активным диапазоном.
Примечание. Указанный Range
должен состоять из одной ячейки, иначе будет выдано исключение.
// Gets the first sheet of the spreadsheet. var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; // Gets the cell B5 and sets it as the active cell. var range = sheet.getRange('B5'); var currentCell = range.activateAsCurrentCell(); // Logs the activated cell. console.log(currentCell.getA1Notation());
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on the sheet. const range = sheet.getRange('2:2'); // Adds the key 'NAME' to the developer metadata for row 2. range.addDeveloperMetadata('NAME'); // Gets the metadata and logs it to the console. const developerMetaData = range.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey());
Параметры
Имя | Тип | Описание |
---|---|---|
key | String | Ключ для новых метаданных разработчика. |
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on Sheet1. const range = sheet.getRange('2:2'); // Adds the key 'NAME' and sets the developer metadata visibility to 'DOCUMENT' // for row 2 on Sheet1. range.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT); // Gets the updated metadata info and logs it to the console. const developerMetaData = range.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getVisibility().toString());
Параметры
Имя | Тип | Описание |
---|---|---|
key | String | Ключ для новых метаданных разработчика. |
visibility | DeveloperMetadataVisibility | Видимость новых метаданных разработчика. |
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 of Sheet1. const range = sheet.getRange('2:2'); // Adds the key 'NAME' and sets the value to 'GOOGLE' for the metadata of row 2. range.addDeveloperMetadata('NAME', 'GOOGLE'); // Gets the metadata and logs it to the console. const developerMetaData = range.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue());
Параметры
Имя | Тип | Описание |
---|---|---|
key | String | Ключ для новых метаданных разработчика. |
value | String | Значение новых метаданных разработчика. |
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on the sheet. const range = sheet.getRange('2:2'); // Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility // to PROJECT for row 2 on the sheet. range.addDeveloperMetadata( 'NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT); // Gets the updated metadata info and logs it to the console. const developerMetaData = range.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue()); console.log(developerMetaData.getVisibility().toString());
Параметры
Имя | Тип | Описание |
---|---|---|
key | String | Ключ для новых метаданных разработчика. |
value | String | Значение новых метаданных разработчика. |
visibility | DeveloperMetadataVisibility | Видимость новых метаданных разработчика. |
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
applyColumnBanding()
Применяет к диапазону тему группировки столбцов по умолчанию. По умолчанию полоса имеет цвет верхнего колонтитула и не имеет цвета нижнего колонтитула.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on the sheet. const range = sheet.getRange('2:2'); // Applies column banding to row 2. const colBanding = range.applyColumnBanding(); // Gets the first banding on the sheet and logs the color of the header column. console.log(sheet.getBandings()[0].getHeaderColumnColorObject().asRgbColor().asHexString()); // Gets the first banding on the sheet and logs the color of the second column. console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());
Возвращаться
Banding
— новый бандинг.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
applyColumnBanding(bandingTheme)
Применяет указанную тему объединения столбцов к диапазону. По умолчанию полоса имеет цвет верхнего колонтитула и не имеет цвета нижнего колонтитула.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on the sheet. const range = sheet.getRange('2:2'); // Applies the INDIGO color banding theme to the columns in row 2. const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.INDIGO); // Gets the first banding on the sheet and logs the color of the second column. console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString());
Параметры
Имя | Тип | Описание |
---|---|---|
bandingTheme | BandingTheme | Цветовая тема, применяемая к столбцам в диапазоне. |
Возвращаться
Banding
— новый бандинг.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
applyColumnBanding(bandingTheme, showHeader, showFooter)
Применяет указанную тему объединения столбцов к диапазону с указанными настройками верхнего и нижнего колонтитула.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets rows 12-22 on the sheet. const range = sheet.getRange('12:22'); // Applies the BLUE color banding theme to rows 12-22. // Sets the header visibility to false and the footer visibility to true. const colBanding = range.applyColumnBanding(SpreadsheetApp.BandingTheme.BLUE, false, true); // Gets the banding color and logs it to the console. console.log(sheet.getBandings()[0].getSecondColumnColorObject().asRgbColor().asHexString()); // Gets the header color object and logs it to the console. Returns null because the header // visibility is set to false. console.log(sheet.getBandings()[0].getHeaderColumnColorObject()); // Gets the footer color and logs it to the console. console.log(sheet.getBandings()[0].getFooterColumnColorObject().asRgbColor().asHexString());
Параметры
Имя | Тип | Описание |
---|---|---|
bandingTheme | BandingTheme | Цветовая тема, применяемая к столбцам в диапазоне. |
showHeader | Boolean | Если true , цвет заголовка темы полосы применяется к первому столбцу. |
showFooter | Boolean | Если true , цвет нижнего колонтитула темы полосы применяется к последнему столбцу. |
Возвращаться
Banding
— новый бандинг.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
applyRowBanding()
Применяет к диапазону тему группировки строк по умолчанию. По умолчанию полоса имеет цвет верхнего колонтитула и не имеет цвета нижнего колонтитула.
// Opens the spreadsheet 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 rows 1-30 on Sheet1. const range = sheet.getRange('1:30'); // Applies row banding to rows 1-30. range.applyRowBanding(); // Gets the hex color of the second banded row. const secondRowColor = range.getBandings()[0] .getSecondRowColorObject() .asRgbColor() .asHexString(); // Logs the hex color to console. console.log(secondRowColor);
Возвращаться
Banding
— Бандинг.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
applyRowBanding(bandingTheme)
Применяет указанную тему объединения строк к диапазону. По умолчанию полоса имеет цвет верхнего колонтитула и не имеет цвета нижнего колонтитула.
// Opens the spreadsheet 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 rows 1-30 on Sheet1. const range = sheet.getRange('1:30'); // Applies the INDIGO row banding theme to rows 1-30. range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO); // Gets the hex color of the second banded row. const secondRowColor = range.getBandings()[0] .getSecondRowColorObject() .asRgbColor() .asHexString(); // Logs the hex color to console. console.log(secondRowColor);
Параметры
Имя | Тип | Описание |
---|---|---|
bandingTheme | BandingTheme | Цветовая тема, применяемая к строкам в диапазоне. |
Возвращаться
Banding
— новый бандинг.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
applyRowBanding(bandingTheme, showHeader, showFooter)
Применяет указанную тему объединения строк к диапазону с указанными настройками верхнего и нижнего колонтитула.
// Opens the spreadsheet 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 rows 1-30 on Sheet1. const range = sheet.getRange('1:30'); // Applies the INDIGO row banding to rows 1-30 and // specifies to hide the header and show the footer. range.applyRowBanding(SpreadsheetApp.BandingTheme.INDIGO, false, true);
Параметры
Имя | Тип | Описание |
---|---|---|
bandingTheme | BandingTheme | Цветовая тема, применяемая к строкам в диапазоне. |
showHeader | Boolean | Если true , цвет заголовка темы полосирования применяется к первой строке. |
showFooter | Boolean | Если true , цвет нижнего колонтитула темы полосы применяется к последней строке. |
Возвращаться
Banding
— новый бандинг.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoFill(destination, series)
Заполняет destinationRange
данными на основе данных в этом диапазоне. Новые значения также определяются указанным типом series
. Диапазон назначения должен содержать этот диапазон и расширять его только в одном направлении. Например, следующее заполняет A1:A20
серией возрастающих чисел на основе текущих значений в A1:A4
:
var sheet = SpreadsheetApp.getActiveSheet(); // Has values [1, 2, 3, 4]. var sourceRange = sheet.getRange("A1:A4"); // The range to fill with values. var destination = sheet.getRange("A1:A20"); // Inserts new values in A5:A20, continuing the pattern expressed in A1:A4 sourceRange.autoFill(destination, SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);
Параметры
Имя | Тип | Описание |
---|---|---|
destination | Range | Диапазон, который будет автоматически заполнен значениями. Диапазон назначения должен содержать этот диапазон и расширять его только в одном направлении (вверх, вниз, влево или вправо). |
series | AutoFillSeries | Тип серии автозаполнения, которая должна использоваться для расчета новых значений. Эффект этого ряда различается в зависимости от типа и объема исходных данных. |
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
autoFillToNeighbor(series)
Вычисляет диапазон для заполнения новыми данными на основе соседних ячеек и автоматически заполняет этот диапазон новыми значениями на основе данных, содержащихся в этом диапазоне. Эти новые значения также определяются указанным типом series
.
Вычисленный диапазон назначения учитывает окружающие данные, чтобы определить, куда следует вставить новые значения: если есть данные непосредственно слева или справа от столбца, который автоматически заполняется, новые значения распространяются только до этих соседних данных.
Например, если A1:A20
заполнен серией возрастающих чисел и этот метод вызывается для диапазона B1:B4
, который содержит серию дат, новые значения вставляются только в B5:B20
. Таким образом, эти новые значения «прилипают» к ячейкам, содержащим значения в столбце A.
var sheet = SpreadsheetApp.getActiveSheet(); // A1:A20 has values [1, 2, 3, ... 20]. // B1:B4 has values [1/1/2017, 1/2/2017, ...] var sourceRange = sheet.getRange("B1:B4"); // Results in B5:B20 having values [1/5/2017, ... 1/20/2017] sourceRange.autoFillToNeighbor(SpreadsheetApp.AutoFillSeries.DEFAULT_SERIES);
Параметры
Имя | Тип | Описание |
---|---|---|
series | AutoFillSeries | Тип серии автозаполнения, которая должна использоваться для расчета новых значений. Эффект этого ряда различается в зависимости от типа и объема исходных данных. |
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
breakApart()
Снова разбейте все ячейки с несколькими столбцами в диапазоне на отдельные ячейки.
Вызов этой функции для диапазона эквивалентен выбору диапазона и нажатии «Формат» > «Объединить ячейки» > «Разъединить» .
// Opens the spreadsheet 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 range A1:C6 on Sheet1. const range = sheet.getRange('A1:C6'); // Unmerges the range A1:C6 into individual cells. range.breakApart();
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
canEdit()
Определяет, имеет ли пользователь разрешение на редактирование каждой ячейки диапазона. Владелец таблицы всегда может редактировать защищенные диапазоны и листы.
// Opens the spreadsheet 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 range A1:C6 on Sheet1. const range = sheet.getRange('A1:C6'); // Logs whether the user has permission to edit every cell in the range. console.log(range.canEdit());
Возвращаться
Boolean
— true
, если у пользователя есть разрешение на редактирование каждой ячейки диапазона; false
в противном случае.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
check()
Изменяет состояние флажков в диапазоне на «отмечено». Игнорирует ячейки в диапазоне, которые в данный момент не содержат настроенное отмеченное или непроверенное значение.
// Changes the state of cells which currently contain either the checked or unchecked value // configured in the range A1:B10 to 'checked'. var range = SpreadsheetApp.getActive().getRange('A1:B10'); range.check();
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clear()
Очищает диапазон содержимого и форматов.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D10"); range.clear();
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clear(options)
Очищает диапазон содержимого, формата, правил проверки данных и/или комментариев, как указано с помощью заданных дополнительных параметров. По умолчанию все данные удаляются.
// The code below clears range C2:G7 in the active sheet, but preserves the format, // data validation rules, and comments. SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 5).clear({contentsOnly: true});
Параметры
Имя | Тип | Описание |
---|---|---|
options | Object | Объект JavaScript, задающий дополнительные параметры, как указано ниже. |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
commentsOnly | Boolean | Очистить ли только комментарии. |
contentsOnly | Boolean | Очищать ли только содержимое. |
formatOnly | Boolean | Очистить ли только формат; Обратите внимание, что очистка формата также очищает правила проверки данных. |
validationsOnly | Boolean | Следует ли очищать только правила проверки данных. |
skipFilteredRows | Boolean | Следует ли избегать очистки отфильтрованных строк. |
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearContent()
Очищает содержимое диапазона, оставляя форматирование нетронутым.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D10"); range.clearContent();
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearDataValidations()
Очищает правила проверки данных для диапазона.
// Clear the data validation rules for cells A1:B5. var range = SpreadsheetApp.getActive().getRange('A1:B5'); range.clearDataValidations();
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearFormat()
Очищает форматирование для этого диапазона.
При этом форматирование текста для ячейки или ячеек в диапазоне очищается, но не сбрасываются правила форматирования чисел.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D10"); range.clearFormat();
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
clearNote()
Очищает заметку в данной ячейке или ячейках.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D10"); range.clearNote();
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
collapseGroups()
Сворачивает все группы, которые полностью содержатся в диапазоне. Если ни одна группа не находится полностью в пределах диапазона, сворачивается самая глубокая развернутая группа, частично находящаяся в пределах диапазона.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getActiveRange(); // All row and column groups within the range are collapsed. range.collapseGroups();
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
copyFormatToRange(gridId, column, columnEnd, row, rowEnd)
Скопируйте форматирование диапазона в указанное место. Если место назначения больше или меньше исходного диапазона, то источник соответственно повторяется или усекается. Обратите внимание, что этот метод копирует только форматирование.
Подробное описание параметраgridId см. в getGridId()
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var source = ss.getSheets()[0]; var range = source.getRange("B2:D4"); // This copies the formatting in B2:D4 in the source sheet to // D4:F6 in the sheet with gridId 1555299895. Note that you can get the gridId // of a sheet by calling sheet.getSheetId() or range.getGridId(). range.copyFormatToRange(1555299895, 4, 6, 4, 6);
Параметры
Имя | Тип | Описание |
---|---|---|
gridId | Integer | Уникальный идентификатор листа в электронной таблице, независимо от его положения. |
column | Integer | Первый столбец целевого диапазона. |
columnEnd | Integer | Конечный столбец целевого диапазона. |
row | Integer | Начальная строка целевого диапазона. |
rowEnd | Integer | Конечная строка целевого диапазона. |
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
См. также
copyFormatToRange(sheet, column, columnEnd, row, rowEnd)
Скопируйте форматирование диапазона в указанное место. Если место назначения больше или меньше исходного диапазона, то источник соответственно повторяется или усекается. Обратите внимание, что этот метод копирует только форматирование.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var source = ss.getSheets()[0]; var destination = ss.getSheets()[1]; var range = source.getRange("B2:D4"); // This copies the formatting in B2:D4 in the source sheet to // D4:F6 in the second sheet range.copyFormatToRange(destination, 4, 6, 4, 6);
Параметры
Имя | Тип | Описание |
---|---|---|
sheet | Sheet | Целевой лист. |
column | Integer | Первый столбец целевого диапазона. |
columnEnd | Integer | Конечный столбец целевого диапазона. |
row | Integer | Начальная строка целевого диапазона. |
rowEnd | Integer | Конечная строка целевого диапазона. |
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
copyTo(destination)
Копирует данные из диапазона ячеек в другой диапазон ячеек. Копируются как значения, так и форматирование.
// The code below copies the first 5 columns over to the 6th column. var sheet = SpreadsheetApp.getActiveSheet(); var rangeToCopy = sheet.getRange(1, 1, sheet.getMaxRows(), 5); rangeToCopy.copyTo(sheet.getRange(1, 6));
Параметры
Имя | Тип | Описание |
---|---|---|
destination | Range | Диапазон назначения для копирования; важна только позиция верхней левой ячейки. |
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
copyTo(destination, copyPasteType, transposed)
Копирует данные из диапазона ячеек в другой диапазон ячеек.
// The code below copies only the values of the first 5 columns over to the 6th column. var sheet = SpreadsheetApp.getActiveSheet(); sheet.getRange("A:E").copyTo(sheet.getRange("F1"), SpreadsheetApp.CopyPasteType.PASTE_VALUES, false);
Параметры
Имя | Тип | Описание |
---|---|---|
destination | Range | Диапазон назначения для копирования; важна только позиция верхней левой ячейки. |
copyPasteType | CopyPasteType | Тип, указывающий, как содержимое диапазона вставляется в место назначения. |
transposed | Boolean | Следует ли вставлять диапазон в транспонированной ориентации. |
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
copyTo(destination, options)
Копирует данные из диапазона ячеек в другой диапазон ячеек. По умолчанию копируются и значения, и форматирование, но это можно переопределить с помощью дополнительных аргументов.
// The code below copies only the values of the first 5 columns over to the 6th column. var sheet = SpreadsheetApp.getActiveSheet(); sheet.getRange("A:E").copyTo(sheet.getRange("F1"), {contentsOnly:true});
Параметры
Имя | Тип | Описание |
---|---|---|
destination | Range | Диапазон назначения для копирования; важна только позиция верхней левой ячейки. |
options | Object | Объект JavaScript, задающий дополнительные параметры, как указано ниже. |
Расширенные параметры
Имя | Тип | Описание |
---|---|---|
formatOnly | Boolean | означает, что следует копировать только формат |
contentsOnly | Boolean | обозначает, что следует копировать только содержимое |
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
copyValuesToRange(gridId, column, columnEnd, row, rowEnd)
Скопируйте содержимое диапазона в указанное место. Если место назначения больше или меньше исходного диапазона, то источник соответственно повторяется или усекается.
Подробное описание параметраgridId см. в getGridId()
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var source = ss.getSheets()[0]; var range = source.getRange("B2:D4"); // This copies the data in B2:D4 in the source sheet to // D4:F6 in the sheet with gridId 0 range.copyValuesToRange(0, 4, 6, 4, 6);
Параметры
Имя | Тип | Описание |
---|---|---|
gridId | Integer | Уникальный идентификатор листа в электронной таблице, независимо от его положения. |
column | Integer | Первый столбец целевого диапазона. |
columnEnd | Integer | Конечный столбец целевого диапазона. |
row | Integer | Начальная строка целевого диапазона. |
rowEnd | Integer | Конечная строка целевого диапазона. |
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
См. также
copyValuesToRange(sheet, column, columnEnd, row, rowEnd)
Скопируйте содержимое диапазона в указанное место. Если место назначения больше или меньше исходного диапазона, то источник соответственно повторяется или усекается.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var source = ss.getSheets()[0]; var destination = ss.getSheets()[1]; var range = source.getRange("B2:D4"); // This copies the data in B2:D4 in the source sheet to // D4:F6 in the second sheet range.copyValuesToRange(destination, 4, 6, 4, 6);
Параметры
Имя | Тип | Описание |
---|---|---|
sheet | Sheet | Целевой лист. |
column | Integer | Первый столбец целевого диапазона. |
columnEnd | Integer | Конечный столбец целевого диапазона. |
row | Integer | Начальная строка целевого диапазона. |
rowEnd | Integer | Конечная строка целевого диапазона. |
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createDataSourcePivotTable(dataSource)
Создает пустую сводную таблицу источника данных из источника данных, привязанную к первой ячейке в этом диапазоне.
В этом примере показано, как создать и настроить новую сводную таблицу источника данных.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); var anchorCell = spreadsheet.getSheets()[0].getRange('A1'); var dataSource = spreadsheet.getDataSources()[0]; var pivotTable = anchorCell.createDataSourcePivotTable(dataSource); pivotTable.addRowGroup('dataColumnA'); pivotTable.addColumnGroup('dataColumnB'); pivotTable.addPivotValue('dataColumnC', SpreadsheetApp.PivotTableSummarizeFunction.SUM); pivotTable.addFilter('dataColumnA', SpreadsheetApp.newFilterCriteria().whenTextStartsWith('A').build());
Параметры
Имя | Тип | Описание |
---|---|---|
dataSource | DataSource | Источник данных, на основе которого создается сводная таблица. |
Возвращаться
DataSourcePivotTable
— вновь созданная сводная таблица источника данных.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createDataSourceTable(dataSource)
Создает пустую таблицу источника данных из источника данных, привязанную к первой ячейке в этом диапазоне.
В этом примере показано, как создать и настроить новую таблицу источника данных.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet(); var anchorCell = spreadsheet.getSheets()[0].getRange('A1'); var dataSource = spreadsheet.getDataSources()[0]; var dataSourceTable = anchorCell.createDataSourceTable(dataSource); .addColumns('dataColumnA', 'dataColumnB', 'dataColumnC') .addSortSpec('dataColumnA', /* ascending= *\/ true) .addSortSpec('dataColumnB', /* ascending= *\/ false);
Параметры
Имя | Тип | Описание |
---|---|---|
dataSource | DataSource | Источник данных, на основе которого создается сводная таблица. |
Возвращаться
DataSourceTable
— вновь созданная таблица источника данных.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createDeveloperMetadataFinder()
Возвращает DeveloperMetadataFinderApi для поиска метаданных разработчика в пределах этого диапазона. Метаданные находятся в пределах диапазона только в том случае, если они полностью содержатся в этом диапазоне. Например, метаданные, связанные со строкой «3:3», не входят в диапазон «A1:D5», но находятся в пределах диапазона «1:5».
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:C6. const range = sheet.getRange('A1:C6'); // Creates a developer metadata finder to search for metadata in the scope of this range. const developerMetaDataFinder = range.createDeveloperMetadataFinder(); // Logs information about the developer metadata finder to the console. const developerMetaData = developerMetaDataFinder.find()[0]; console.log(developerMetaData.getKey()); console.log(developerMetaData.getValue()); console.log(developerMetaData.getVisibility().toString());
Возвращаться
DeveloperMetadataFinder
— средство поиска метаданных разработчика для поиска метаданных в пределах этого диапазона.
createFilter()
Создает фильтр и применяет его к указанному диапазону на листе. На листе нельзя создать более одного фильтра. Чтобы получить доступ к фильтру и изменить его после его создания, используйте getFilter()
или Sheet.getFilter()
.
let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); // Creates a new filter and applies it to the range A1:C20 on the active sheet. function createFilter() { range.createFilter(); } // Gets the filter and applies criteria that only shows cells that aren't empty. function getFilterAddCriteria() { let filter = range.getFilter(); let criteria = SpreadsheetApp.newFilterCriteria() .whenCellNotEmpty() .build(); filter.setColumnFilterCriteria(2, criteria); }Используйте этот метод для создания фильтров для листов
Grid
— типа листа по умолчанию. Листы сетки — это листы, которые не подключены к базе данных. Чтобы создать другие типы фильтров, обратитесь к следующему:- Создайте фильтр сводной таблицы с помощью
PivotTable.addFilter(sourceDataColumn, filterCriteria)
- Создайте фильтр для листа, подключенного к базе данных, с помощью
DataSourceSheet.addFilter(columnName, filterCriteria)
- Создайте фильтр для сводной таблицы, подключенной к базе данных, с помощью
DataSourcePivotTable.addFilter(columnName, filterCriteria)
Возвращаться
Filter
— Новый фильтр.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createPivotTable(sourceData)
Создает пустую сводную таблицу из указанного sourceData
, привязанного к первой ячейке в этом диапазоне.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets cell A1 as a range in order to place the pivot table. const range = sheet.getRange('A1'); // Gets the range of the source data for the pivot table. const dataRange = sheet.getRange('E12:G20'); // Creates an empty pivot table from the specified source data. const pivotTable = range.createPivotTable(dataRange); // Logs the values from the pivot table's source data to the console. console.log(pivotTable.getSourceDataRange().getValues());
Параметры
Имя | Тип | Описание |
---|---|---|
sourceData | Range | Данные для создания сводной таблицы. |
Возвращаться
PivotTable
— вновь созданная PivotTable
.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
createTextFinder(findText)
Создает поисковик текста для диапазона, который может находить и заменять текст в этом диапазоне.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getActiveRange(); // Creates a text finder for the range. var textFinder = range.createTextFinder('dog'); // Returns the first occurrence of 'dog'. var firstOccurrence = textFinder.findNext(); // Replaces the last found occurrence of 'dog' with 'cat' and returns the number // of occurrences replaced. var numOccurrencesReplaced = textFinder.replaceWith('cat');
Параметры
Имя | Тип | Описание |
---|---|---|
findText | String | Текст для поиска. |
Возвращаться
TextFinder
— TextFinder
для диапазона
deleteCells(shiftDimension)
Удаляет этот диапазон ячеек. Существующие данные на листе по указанному измерению смещаются в сторону удаленного диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D10"); range.deleteCells(SpreadsheetApp.Dimension.COLUMNS);
Параметры
Имя | Тип | Описание |
---|---|---|
shiftDimension | Dimension | Измерение, по которому можно сместить существующие данные. |
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
expandGroups()
Разворачивает свернутые группы, диапазон которых или переключатель управления пересекаются с этим диапазоном. Местоположение переключателя управления — это индекс, по которому отображается переключатель управления, непосредственно до или после группы в зависимости от настроек. Если в одном месте находится более одной группы, расширяется самая мелкая группа.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getActiveRange(); // All row and column groups within the range are expanded. range.expandGroups();
Возвращаться
Range
— этот диапазон для цепочки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getA1Notation()
Возвращает строковое описание диапазона в нотации A1.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange(1, 1, 2, 5); // Logs "A1:E2" Logger.log(range.getA1Notation());
Возвращаться
String
— Строковое описание диапазона в нотации A1.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getBackground()
Возвращает цвет фона верхней левой ячейки диапазона (например, '#ffffff'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B5"); Logger.log(cell.getBackground());
Возвращаться
String
— цветовой код фона.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getBackgroundObject()
Возвращает цвет фона верхней левой ячейки диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B5"); Logger.log(cell.getBackgroundObject().asRgbColor().asHexString());
Возвращаться
Color
— цвет фона верхней левой ячейки диапазона.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getBackgroundObjects()
Возвращает цвета фона ячеек в диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B5:C6"); var bgColors = range.getBackgroundObjects(); for (var i in bgColors) { for (var j in bgColors[i]) { Logger.log(bgColors[i][j].asRgbColor().asHexString()); } }
Возвращаться
Color[][]
— двумерный массив цветов фона.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getBackgrounds()
Возвращает цвета фона ячеек в диапазоне (например, '#ffffff'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B5:C6"); var bgColors = range.getBackgrounds(); for (var i in bgColors) { for (var j in bgColors[i]) { Logger.log(bgColors[i][j]); } }
Возвращаться
String[][]
— Двумерный массив цветовых кодов фона.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Sets a range. const range = sheet.getRange('A1:K50'); // Gets the banding info for the range. const bandings = range.getBandings(); // Logs the second row color for each banding to the console. for (let banding of bandings) { console.log(banding.getSecondRowColor()); }
Возвращаться
Banding[]
— все диапазоны, применяемые к любым ячейкам в этом диапазоне.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getCell(row, column)
Возвращает данную ячейку в диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); // The row and column here are relative to the range // getCell(1,1) in this code returns the cell at B2 var cell = range.getCell(1, 1); Logger.log(cell.getValue());
Параметры
Имя | Тип | Описание |
---|---|---|
row | Integer | Строка ячейки относительно диапазона. |
column | Integer | Столбец ячейки относительно диапазона. |
Возвращаться
Range
— диапазон, содержащий одну ячейку с указанными координатами.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getColumn()
Возвращает начальную позицию столбца для этого диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); // Logs "2.0" Logger.log(range.getColumn());
Возвращаться
Integer
— начальная позиция столбца диапазона в электронной таблице.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataRegion()
Возвращает копию диапазона, расширенного по четырем кардинальным Direction
, чтобы охватить все соседние ячейки с данными в них. Если диапазон окружен пустыми ячейками, не считая ячеек по диагоналям, возвращается сам диапазон. Это похоже на выбор диапазона и нажатие Ctrl+A
в редакторе.
// Assume the active spreadsheet is blank. var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.getRange("C2").setValue(100); sheet.getRange("B3").setValue(100); sheet.getRange("D3").setValue(100); sheet.getRange("C4").setValue(100); // Logs "B2:D4" Logger.log(sheet.getRange("C3").getDataRegion().getA1Notation());
Возвращаться
Range
- область данных диапазона или диапазон для всей электронной таблицы.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataRegion(dimension)
Возвращает копию диапазона расширенного Direction.UP
и Direction.DOWN
Если указанное измерение - Dimension.ROWS
Dimension.COLUMNS
или Direction.NEXT
Direction.PREVIOUS
Расширение диапазона основано на обнаружении данных рядом с диапазоном, который организован как таблица. Расширенный диапазон охватывает все соседние ячейки данных в них вдоль указанного измерения, включая границы таблиц. Если исходный диапазон окружен пустыми ячейками вдоль указанного измерения, сам диапазон возвращается. Этот метод аналогичен выбору диапазона и вводам Ctrl+Space
для столбцов или Shift+Space
для строк в редакторе.
// Assume the active spreadsheet is blank. var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; sheet.getRange("C2").setValue(100); sheet.getRange("B3").setValue(100); sheet.getRange("D3").setValue(100); sheet.getRange("C4").setValue(100); // Logs "C2:C4" Logger.log(sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.ROWS).getA1Notation()); // Logs "B3:D3" Logger.log( sheet.getRange("C3").getDataRegion(SpreadsheetApp.Dimension.COLUMNS).getA1Notation());
Параметры
Имя | Тип | Описание |
---|---|---|
dimension | Dimension | Измерение, в течение которого можно расширить диапазон. |
Возвращаться
Range
- область данных диапазона или диапазон, охватывающий каждый столбец или каждую строку, охватываемой исходным диапазоном.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceFormula()
Возвращает DataSourceFormula
для первой ячейки в диапазоне или null
, если ячейка не содержит формулу источника данных.
// 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 the range A1 on Sheet1. const range = sheet.getRange('A1'); // Gets the data source formula from cell A1. const dataSourceFormula = range.getDataSourceFormula(); // Gets the formula. const formula = dataSourceFormula.getFormula(); // Logs the formula. console.log(formula);
Возвращаться
DataSourceFormula
- DataSourceFormula
для ячейки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceFormulas()
Возвращает DataSourceFormula
S для ячеек в диапазоне.
// 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 the range A1:B5 on Sheet1. const range = sheet.getRange('A1:B5'); // Gets an array of the data source formulas in the range A1:B5. const dataSourceFormulas = range.getDataSourceFormulas(); // Logs the first formula in the array. console.log(dataSourceFormulas[0].getFormula());
Возвращаться
DataSourceFormula[]
- массив 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 the range A1:G50 on Sheet1. const range = sheet.getRange('A1:G50'); // Gets an array of the data source pivot tables in the range A1:G50. const dataSourcePivotTables = range.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 the range A1:G50 on Sheet1. const range = sheet.getRange('A1:G50'); // Gets the first data source table in the range A1:G50. const dataSourceTable = range.getDataSourceTables()[0]; // Logs the time of the last completed data execution on the data source table. console.log(dataSourceTable.getStatus().getLastExecutionTime());
Возвращаться
DataSourceTable[]
- список таблиц источника данных.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataSourceUrl()
Возвращает URL для данных в этом диапазоне, которые можно использовать для создания диаграмм и запросов.
Код.gs
function doGet() { var ss = SpreadsheetApp.openById('1khO6hBWTNNyvyyxvob7aoZTI9ZvlqqASNeq0e29Tw2c'); var sheet = ss.getSheetByName('ContinentData'); var range = sheet.getRange('A1:B8'); var template = HtmlService.createTemplateFromFile('piechart'); template.dataSourceUrl = range.getDataSourceUrl(); return template.evaluate(); }
PieChart.html
<!DOCTYPE html> <html> <head> <!--Load the AJAX API--> <script type="text/javascript" src="https://www.gstatic.com/charts/loader.js"></script> <script type="text/javascript"> // Load the Visualization API and the corechart package. google.charts.load('current', {'packages': ['corechart']}); // Set a callback to run when the Google Visualization API is loaded. google.charts.setOnLoadCallback(queryData); function queryData() { var query = new google.visualization.Query('<?= dataSourceUrl ?>'); query.send(drawChart); } // Callback that creates and populates a data table, // instantiates the pie chart, passes in the data and // draws it. function drawChart(response) { if (response.isError()) { alert('Error: ' + response.getMessage() + ' ' + response.getDetailedMessage()); return; } var data = response.getDataTable(); // Set chart options. var options = { title: 'Population by Continent', width: 400, height: 300 }; // Instantiate and draw the chart, passing in some options. var chart = new google.visualization.PieChart(document.getElementById('chart_div')); chart.draw(data, options); } </script> </head> <body> <!-- Div that holds the pie chart. --> <div id="chart_div"></div> </body> </html>
Возвращаться
String
- URL для этого диапазона в качестве источника данных, который можно передать в другие API, такие как диаграммы.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataTable()
Верните данные внутри этого объекта в качестве данных.
// 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 the range A1:B7 on Sheet1. const range = sheet.getRange('A1:B7'); // Gets the range A1:B7 as a data table. The values in each column must be of the same type. const datatable = range.getDataTable(); // Uses the Charts service to build a bar chart from the data table. // This doesn't build an embedded chart. To do that, use sheet.newChart().addRange() instead. const chart = Charts.newBarChart() .setDataTable(datatable) .setOption('title', 'Your Chart Title Here') .build();
Возвращаться
DataTable
- данные как DataTable.
getDataTable(firstRowIsHeader)
Верните данные внутри этого диапазона в качестве данных.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B7"); // Calling this method with "true" sets the first line to be the title of the axes var datatable = range.getDataTable(true); // Note that this doesn't build an EmbeddedChart, so you can't just use // Sheet#insertChart(). To do that, use sheet.newChart().addRange() instead. var chart = Charts.newBarChart() .setDataTable(datatable) .setOption("title", "Your Title Here") .build();
Параметры
Имя | Тип | Описание |
---|---|---|
firstRowIsHeader | Boolean | Обращаться в первом ряду как к заголовку. |
Возвращаться
DataTable
- данные как DataTable.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataValidation()
Возвращает правило проверки данных для верхней левой ячейки в диапазоне. Если проверка данных не была установлена в ячейке, этот метод возвращает null
.
// Log information about the data validation rule for cell A1. var cell = SpreadsheetApp.getActive().getRange('A1'); var rule = cell.getDataValidation(); if (rule != null) { var criteria = rule.getCriteriaType(); var args = rule.getCriteriaValues(); Logger.log('The data validation rule is %s %s', criteria, args); } else { Logger.log('The cell does not have a data validation rule.') }
Возвращаться
DataValidation
-правило проверки данных для верхней левой ячейки в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDataValidations()
Возвращает правила проверки данных для всех ячеек в диапазоне. Если проверка данных не была установлена на данной ячейке, этот метод возвращает null
для позиции этой ячейки в массиве.
// Change existing data validation rules that require a date in 2013 to require a date in 2014. var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')]; var newDates = [new Date('1/1/2014'), new Date('12/31/2014')]; var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns()); var rules = range.getDataValidations(); for (var i = 0; i < rules.length; i++) { for (var j = 0; j < rules[i].length; j++) { var rule = rules[i][j]; if (rule != null) { var criteria = rule.getCriteriaType(); var args = rule.getCriteriaValues(); if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN && args[0].getTime() == oldDates[0].getTime() && args[1].getTime() == oldDates[1].getTime()) { // Create a builder from the existing rule, then change the dates. rules[i][j] = rule.copy().withCriteria(criteria, newDates).build(); } } } } range.setDataValidations(rules);
Возвращаться
DataValidation[][]
-двухмерный массив правил проверки данных, связанных с ячейками в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets row 2 on Sheet1. const range = sheet.getRange('2:2'); // Adds metadata to row 2. range.addDeveloperMetadata('NAME', 'GOOGLE'); // Logs the metadata to console. for (const metadata of range.getDeveloperMetadata()) { console.log(`${metadata.getKey()}: ${metadata.getValue()}`); }
Возвращаться
DeveloperMetadata[]
- метаданные разработчика, связанные с этим диапазоном.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDisplayValue()
Возвращает отображаемое значение верхней левой ячейки в диапазоне. Значение - это String
. Отображенное значение учитывает дату, форматирование времени и форматирования форматирования времени и валюты, включая форматы, применяемые автоматически в соответствии с настройкой локали электронной таблицы. Пустые ячейки возвращают пустую строку.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets cell A30 and sets its value to 'Test code.' const cell = sheet.getRange('A30'); cell.setValue('Test code'); // Gets the value and logs it to the console. console.log(cell.getDisplayValue());
Возвращаться
String
- отображаемое значение в этой ячейке.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getDisplayValues()
Возвращает прямоугольную сетку значений для этого диапазона.
Возвращает двумерный массив отображаемых значений, проиндексированный по строке, затем по столбцу. Значения являются String
объектами. Отображенное значение учитывает дату, время и форматирование валюты, включая форматы, применяемые автоматически в соответствии с настройкой локали электронной таблицы. Пустые ячейки представлены пустой строкой в массиве. Помните, что в то время как индекс диапазона начинается с 1, 1
, массив JavaScript индексируется из [0][0]
.
// The code below gets the displayed values for the range C2:G8 // in the active spreadsheet. Note that this is a JavaScript array. var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getDisplayValues(); Logger.log(values[0][0]);
Возвращаться
String[][]
-двухмерный массив значений.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFilter()
Возвращает фильтр на листе. Этот диапазон принадлежит или null
, если на листе нет фильтра.
let ss = SpreadsheetApp.getActiveSheet(); let range = ss.getRange("A1:C20"); // Gets the existing filter on the sheet that the given range belongs to. let filter = range.getFilter();
Возвращаться
Filter
- фильтр.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontColorObject()
Возвращает цвет шрифта ячейки в верхнем левом углу диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getFontColorObject().asRgbColor().asHexString());
Возвращаться
Color
-цвет шрифта верхней левой ячейки в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontColorObjects()
Возвращает цвета шрифта ячеек в диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getFontColorObjects(); for (var i in results) { for (var j in results[i]) { Logger.log(results[i][j].asRgbColor().asHexString()); } }
Возвращаться
Color[][]
-двумерный массив цветов шрифтов, связанных с ячейками в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontFamilies()
Возвращает семейства шрифтов клеток в диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getFontFamilies(); for (var i in results) { for (var j in results[i]) { Logger.log(results[i][j]); } }
Возвращаться
String[][]
-двухмерный массив семейств шрифтов, связанных с клетками в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontFamily()
Возвращает семейство шрифтов ячейки в верхнем левом углу диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getFontFamily());
Возвращаться
String
- семейство шрифтов ячейки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontLine()
Получает линейный стиль ячейки в верхнем левом углу диапазона ( 'underline'
, 'line-through'
или 'none'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getFontLine());
Возвращаться
String
- линия шрифта.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontLines()
Получает стиль линии ячеек в диапазоне ( 'underline'
, 'line-through'
или 'none'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getFontLines(); for (var i in results) { for (var j in results[i]) { Logger.log(results[i][j]); } }
Возвращаться
String[][]
-двухмерный массив линий шрифтов, связанных с ячейками в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontSize()
Возвращает размер шрифта в размере точки ячейки в верхнем левом углу диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getFontSize());
Возвращаться
Integer
- размер шрифта в размере точки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontSizes()
Возвращает размеры шрифтов ячеек в диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getFontSizes(); for (var i in results) { for (var j in results[i]) { Logger.log(results[i][j]); } }
Возвращаться
Integer[][]
-двумерный массив размеров шрифтов текста, связанных с ячейками в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontStyle()
Возвращает стиль шрифта ( 'italic'
или 'normal'
) ячейки в верхнем левом углу диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getFontStyle());
Возвращаться
String
- стиль шрифта текста в ячейке.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontStyles()
Возвращает стили шрифта ячеек в диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getFontStyles(); for (var i in results) { for (var j in results[i]) { Logger.log(results[i][j]); } }
Возвращаться
String[][]
-двухмерный массив стилей шрифтов текста, связанных с ячейками в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontWeight()
Возвращает вес шрифта (нормальный/жирный) ячейку в верхнем левом углу диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getFontWeight());
Возвращаться
String
- вес шрифта текста в ячейке.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFontWeights()
Возвращает веса шрифта клеток в диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getFontWeights(); for (var i in results) { for (var j in results[i]) { Logger.log(results[i][j]); } }
Возвращаться
String[][]
-двухмерный массив веса шрифтов текста, связанных с ячеек в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFormula()
Возвращает формулу (обозначения A1) для верхней левой ячейки диапазона или пустой строки, если ячейка пуста или не содержит формулы.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This assumes you have a function in B5 that sums up // B2:B4 var range = sheet.getRange("B5"); // Logs the calculated value and the formula Logger.log("Calculated value: %s Formula: %s", range.getValue(), range.getFormula());
Возвращаться
String
- формула для ячейки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFormulaR1C1()
Возвращает формулу (обозначения R1C1) для данной ячейки или null
, если нет.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B5"); var formula = range.getFormulaR1C1(); Logger.log(formula);
Возвращаться
String
- формула в нотации R1C1.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFormulas()
Возвращает формулы (обозначения A1) для ячеек в диапазоне. Записи в 2D -массиве представляют собой пустые строки для ячеек без формулы.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B5:C6"); var formulas = range.getFormulas(); for (var i in formulas) { for (var j in formulas[i]) { Logger.log(formulas[i][j]); } }
Возвращаться
String[][]
-двумерный массив формул в формате строки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getFormulasR1C1()
Возвращает формулы (обозначения R1C1) для ячеек в диапазоне. Записи в 2D -массиве являются null
для ячеек без формулы.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B5:C6"); var formulas = range.getFormulasR1C1(); for (var i in formulas) { for (var j in formulas[i]) { Logger.log(formulas[i][j]); } }
Возвращаться
String[][]
-двухмерный массив формул в обозначениях R1C1.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getGridId()
Возвращает идентификатор сетки родительского листа диапазона. Идентификаторы являются случайными неотрицательными значениями Int.
// Log the grid ID of the first sheet (by tab position) in the spreadsheet. var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getGridId());
Возвращаться
Integer
- идентификатор сетки родительского листа.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getHeight()
Возвращает высоту диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); // logs 3.0 Logger.log(range.getHeight());
Возвращаться
Integer
- высота диапазона.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getHorizontalAlignment()
Возвращает горизонтальное выравнивание текста (левое/центр/справа) ячейки в верхнем левом углу диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getHorizontalAlignment());
Возвращаться
String
- горизонтальное выравнивание текста в ячейке.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getHorizontalAlignments()
Возвращает горизонтальные выравнивания клеток в диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getHorizontalAlignments(); for (var i in results) { for (var j in results[i]) { Logger.log(results[i][j]); } }
Возвращаться
String[][]
-двухмерный массив горизонтальных выравниваний текста, связанных с ячейками в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getLastColumn()
Возвращает позицию конечного столбца.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); // Logs "4.0" Logger.log(range.getLastColumn());
Возвращаться
Integer
- позиция окончательного столбца диапазона в таблице.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getLastRow()
Возвращает позицию конечного ряда.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); // Logs "4.0" Logger.log(range.getLastRow());
Возвращаться
Integer
- позиция окончательного ряда диапазона в электронной таблице.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getMergedRanges()
Возвращает массив объектов Range
, представляющих объединенные ячейки, которые либо полностью находятся в пределах тока, либо содержат хотя бы одну ячейку в диапазоне тока.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B3"); var mergedRanges = range.getMergedRanges(); for (var i = 0; i < mergedRanges.length; i++) { Logger.log(mergedRanges[i].getA1Notation()); Logger.log(mergedRanges[i].getDisplayValue()); }
Возвращаться
Range[]
- массив объектов Range
, представляющие объединенные ячейки, перекрывающие диапазон.
getNextDataCell(direction)
Начиная с ячейки в первом столбце и строке диапазона, возвращает следующую ячейку в данном направлении, которое является краем смежного диапазона ячеек с данными в них или ячейки на краю электронной таблицы в этом направлении. Это эквивалентно вводу Ctrl+[arrow key]
в редакторе.
// Assume the active spreadsheet is blank. var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("C3:E5"); // Logs "C1" Logger.log(range.getNextDataCell(SpreadsheetApp.Direction.UP).getA1Notation());
Параметры
Имя | Тип | Описание |
---|---|---|
direction | Direction | Направление, в котором можно найти следующую ячейку региона данных. |
Возвращаться
Range
- ячейка края региона данных или ячейка на краю электронной таблицы.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getNote()
Возвращает ноту, связанную с данным диапазоном.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getNote());
Возвращаться
String
- примечание, связанное с данной ячейкой.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getNotes()
Возвращает ноты, связанные с ячейками в диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getNotes(); for (var i in results) { for (var j in results[i]) { Logger.log(results[i][j]); } }
Возвращаться
String[][]
-двухмерный массив нот, связанные с ячеек в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getNumColumns()
Возвращает количество столбцов в этом диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D5"); Logger.log(range.getNumColumns());
Возвращаться
Integer
- количество столбцов в этом диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getNumRows()
Возвращает количество рядов в этом диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D5"); Logger.log(range.getNumRows());
Возвращаться
Integer
- количество рядов в этом диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getNumberFormat()
Получите форматирование номера или даты верхней левой ячейки данного диапазона. Возвращенные шаблоны формата описаны в документации API листов .
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("C4"); Logger.log(cell.getNumberFormat());
Возвращаться
String
-формат чисел верхней левой ячейки диапазона.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getNumberFormats()
Возвращает число или форматы даты для ячеек в диапазоне. Возвращенные шаблоны формата описаны в документации API листов .
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B5:C6"); var formats = range.getNumberFormats(); for (var i in formats) { for (var j in formats[i]) { Logger.log(formats[i][j]); } }
Возвращаться
String[][]
-двумерный массив чисел форматов.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRichTextValue()
Возвращает богатое значение текста для верхней левой ячейки диапазона или null
, если значение ячейки не является текстом.
// Gets the Rich Text value of cell D4. var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("D4:F6"); var richText = range.getRichTextValue(); console.log(richText.getText());
Возвращаться
RichTextValue
- богатое текстовое значение верхней левой ячейки в диапазоне или null
, если значение ячейки не является текстом.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRichTextValues()
Возвращает богатые значения текста для ячеек в диапазоне.
// Gets the Rich Text values for all cells in range B5:C6 var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B5:C6"); var values = range.getRichTextValues(); for (var i = 0; i < values.length; i++) { for (var j = 0; j < values[i].length; j++) { console.log(values[i][j].getText()); } }
Возвращаться
RichTextValue[][]
-двухмерный массив богатых текстовых значений.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRow()
Возвращает позицию строки для этого диапазона. Идентично GetRowIndex () .
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2"); Logger.log(range.getRow());
Возвращаться
Integer
- позиция строки диапазона.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getRowIndex()
Возвращает позицию строки для этого диапазона. Идентично GetRow () .
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2"); Logger.log(range.getRowIndex());
Возвращаться
Integer
- позиция строки диапазона.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
См. также
getSheet()
Возвращает лист, которому принадлежит этот диапазон.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Gets the sheet that the range belongs to. const rangeSheet = range.getSheet(); // Gets the sheet name and logs it to the console. console.log(rangeSheet.getName());
Возвращаться
Sheet
- лист, которому принадлежит этот диапазон.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTextDirection()
Возвращает направление текста для верхней левой ячейки диапазона. Возвращает null
, если направление текста ячейки определяется с помощью автоматического обнаружения.
// Get the text direction of cell B1. var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B1:D4"); Logger.log(range.getTextDirection());
Возвращаться
TextDirection
- направление текста верхней левой ячейки в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTextDirections()
Возвращает текстовые направления для ячеек в диапазоне. Записи в 2D -массиве являются null
для ячеек с использованием автоматического обнаружения.
// Get the text directions for all cells in range B5:C6 var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B5:C6"); var directions = range.getTextDirections(); for (var i = 0; i < directions.length; i++) { for (var j = 0; j < directions[i].length; j++) { Logger.log(directions[i][j]); } }
Возвращаться
TextDirection[][]
-двухмерный массив текстовых направлений.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTextRotation()
Возвращает настройки поворота текста для верхней левой ячейки диапазона.
// Log the text rotation settings for a cell. var sheet = SpreadsheetApp.getActiveSheet(); var cell = sheet.getRange("A1"); Logger.log(cell.getTextRotation());
Возвращаться
TextRotation
- Настройки поворота текста.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTextRotations()
Возвращает настройки поворота текста для ячеек в диапазоне.
var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B2:D4"); var results = range.getTextRotations(); for (var i in results) { for (var j in results[i]) { var rotation = results[i][j]; Logger.log("Cell [%s, %s] has text rotation: %v", i, j, rotation); } }
Возвращаться
TextRotation[][]
-двумерный массив поворотов текста, связанного с ячеек в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTextStyle()
Возвращает стиль текста для верхней левой ячейки диапазона.
// Get the text style of cell D4. var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("D4:F6"); var style = range.getTextStyle(); Logger.log(style);
Возвращаться
TextStyle
- текстовый стиль верхней левой ячейки в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getTextStyles()
Возвращает стили текста для ячеек в диапазоне.
// Get the text styles for all cells in range B5:C6 var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B5:C6"); var styles = range.getTextStyles(); for (var i = 0; i < styles.length; i++) { for (var j = 0; j < styles[i].length; j++) { Logger.log(styles[i][j]); } }
Возвращаться
TextStyle[][]
-двухмерный массив стилей текста.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getValue()
Возвращает значение верхней левой ячейки в диапазоне. Значение может иметь Number
типов, Boolean
, Date
или String
в зависимости от значения ячейки. Пустые ячейки возвращают пустую строку.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Gets the value of the top-left cell in the range and logs it to the console. console.log(range.getValue());
Возвращаться
Object
- значение в этой ячейке.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getValues()
Возвращает прямоугольную сетку значений для этого диапазона.
Возвращает двумерный массив значений, проиндексированный по строке, затем по столбцу. Значения могут иметь Number
типов, Boolean
, Date
или String
, в зависимости от значения ячейки. Пустые ячейки представлены пустой строкой в массиве. Помните, что в то время как индекс диапазона начинается с 1, 1
, массив JavaScript индексируется из [0][0]
.
// The code below gets the values for the range C2:G8 // in the active spreadsheet. Note that this is a JavaScript array. var values = SpreadsheetApp.getActiveSheet().getRange(2, 3, 6, 4).getValues(); Logger.log(values[0][0]);В веб -приложениях значение
Date
не является юридическим параметром. getValues()
не возвращает данные в веб -приложение, если диапазон содержит ячейку со значением Date
. Вместо этого преобразуйте все значения, извлеченные из листа в поддерживаемый примитив JavaScript, как Number
, Boolean
или String
.Возвращаться
Object[][]
-двухмерный массив значений.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getVerticalAlignment()
Возвращает вертикальное выравнивание (верхняя/средняя/нижняя) ячейки в верхнем левом углу диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getVerticalAlignment());
Возвращаться
String
- вертикальное выравнивание текста в ячейке.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getVerticalAlignments()
Возвращает вертикальные выравнивания клеток в диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getVerticalAlignments(); for (var i in results) { for (var j in results[i]) { Logger.log(results[i][j]); } }
Возвращаться
String[][]
-двухмерный массив вертикальных выравниваний текста, связанных с ячейками в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getWidth()
Возвращает ширину диапазона в столбцах.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Gets the width of the range in number of columns and logs it to the console. console.log(range.getWidth());
Возвращаться
Integer
- количество столбцов в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getWrap()
Возвращает ли текст в клеточных обертках. Чтобы получить более детальную стратегию обертывания, используйте getWrapStrategy()
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.getWrap());
Возвращаться
Boolean
- будь то текст в этой ячейке или нет.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getWrapStrategies()
Возвращает стратегии обертки текста для ячеек в диапазоне.
// Get the text wrapping strategies for all cells in range B5:C6 var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B5:C6"); var strategies = range.getWrapStrategies(); for (var i = 0; i < strategies.length; i++) { for (var j = 0; j < strategies[i].length; j++) { Logger.log(strategies[i][j]); } }
Возвращаться
WrapStrategy[][]
-двухмерный массив стратегий обертывания текста.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getWrapStrategy()
Возвращает стратегию обертывания текста для верхней левой ячейки диапазона.
// Get the text wrapping strategy of cell B1. var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B1:D4"); Logger.log(range.getWrapStrategy());
Возвращаться
WrapStrategy
- стратегия обертывания текста верхней левой ячейки в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getWraps()
Возвращает ли текст в ячейках. Чтобы получить более детальную стратегию упаковки, используйте getWrapStrategies()
.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); var results = range.getVerticalAlignments(); for (var i in results) { for (var j in results[i]) { var isWrapped = results[i][j]; if (isWrapped) { Logger.log("Cell [%s, %s] has wrapped text", i, j); } } }
Возвращаться
Boolean[][]
-двумерный массив вертикальных выравниваний текста, связанных с клетками в диапазоне.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertCells(shiftDimension)
Вставляет пустые ячейки в этот диапазон. Новые клетки сохраняют любое форматирование, присутствующее в клетках, ранее занимающих этот диапазон. Существующие данные в листе вдоль предоставленного измерения смещены от вставленного диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:D10"); range.insertCells(SpreadsheetApp.Dimension.COLUMNS);
Параметры
Имя | Тип | Описание |
---|---|---|
shiftDimension | Dimension | Измерение, в течение которого можно сдвинуть существующие данные. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertCheckboxes()
Вставьте флажки в каждую ячейку в диапазоне, настроенные с true
для проверки и false
для неконтролируемой. Устанавливает значение всех ячеек в диапазоне до false
.
var range = SpreadsheetApp.getActive().getRange('A1:B10'); // Inserts checkboxes into each cell in the range A1:B10 configured with 'true' for checked // and 'false' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'false'. range.insertCheckboxes();
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertCheckboxes(checkedValue)
Вставьте флажки в каждую ячейку в диапазоне, настроенные с пользовательским значением для проверенной и пустой строки для неконтролируемой. Устанавливает значение каждой ячейки в диапазоне на пустую строку.
var range = SpreadsheetApp.getActive().getRange('A1:B10'); // Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked // and the empty string for unchecked. Also, sets the value of each cell in the range A1:B10 to // the empty string. range.insertCheckboxes('yes');
Параметры
Имя | Тип | Описание |
---|---|---|
checkedValue | Object | Проверенное значение для проверки данных флажки. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
insertCheckboxes(checkedValue, uncheckedValue)
Вставляют флажки в каждую ячейку в диапазоне, настроенные с пользовательскими значениями для проверенных и неконтролируемых состояний. Устанавливает значение каждой ячейки в диапазоне на пользовательское неконтролируемое значение.
var range = SpreadsheetApp.getActive().getRange('A1:B10'); // Inserts checkboxes into each cell in the range A1:B10 configured with 'yes' for checked // and 'no' for unchecked. Also, sets the value of each cell in the range A1:B10 to 'no'. range.insertCheckboxes('yes', 'no');
Параметры
Имя | Тип | Описание |
---|---|---|
checkedValue | Object | Проверенное значение для проверки данных флажки. |
uncheckedValue | Object | Непропретированное значение для проверки данных флага. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isBlank()
Возвращает true
, если диапазон совершенно пуст.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D4"); Logger.log(range.isBlank());
Возвращаться
Boolean
- true
, если диапазон пуст; false
в противном случае.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isChecked()
Возвращает, есть ли все ячейки в диапазоне имеют свое состояние флага как «проверено». Возвращает null
если некоторые ячейки проверяются, а остальные не контролируются, или если некоторые ячейки не имеют проверки данных флага.
var range = SpreadsheetApp.getActive().getRange('A1:A3'); // Inserts checkboxes and sets each cell value to 'no' in the range A1:A3. range.insertCheckboxes('yes', 'no'); var range1 = SpreadsheetApp.getActive().getRange('A1'); range1.setValue('yes'); // Sets the value of isRange1Checked as true as it contains the checked value. var isRange1Checked = range1.isChecked(); var range2 = SpreadsheetApp.getActive().getRange('A2'); range2.setValue('no'); // Sets the value of isRange2Checked as false as it contains the unchecked value. var isRange2Checked = range2.isChecked(); var range3 = SpreadsheetApp.getActive().getRange('A3'); range3.setValue('random'); // Sets the value of isRange3Checked as null, as it contains an invalid checkbox value. var isRange3Checked = range3.isChecked();
Возвращаться
Boolean
- true
, если все ячейки в диапазоне проверены, false
если все ячейки в диапазоне не контролированы или null
, если какие -либо ячейки не контролированы или не имеют проверки данных флажона.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isEndColumnBounded()
Определяет, связан ли конец диапазона с определенным столбцом. Например, для диапазонов A1:B10
или B:B
, которые связаны с столбцами в конце диапазона, этот метод возвращает true
; Для диапазонов 3:7
или A1:5
, которые связаны только с определенными рядами в конце диапазона, этот метод возвращает 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Determines if the end of the range is bound to a particular column and logs it to the // console. console.log(range.isEndColumnBounded());
Возвращаться
Boolean
- true
, если конец диапазона связан с определенным столбцом; false
в противном случае.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isEndRowBounded()
Определяет, связан ли конец диапазона с определенной строкой. Например, для диапазонов A1:B10
или 3:7
, которые связаны с рядами в конце диапазона, этот метод возвращает true
; Для диапазонов B:B
или A1:C
, которые связаны только с определенными столбцами в конце диапазона, этот метод возвращает 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Determines if the end of the range is bound to a particular row and logs it to the console. console.log(range.isEndRowBounded());
Возвращаться
Boolean
- true
, если конец диапазона связан с определенным рядом; false
в противном случае.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isPartOfMerge()
Возвращает true
, если ячейки в диапазоне тока перекрывают любые объединенные ячейки.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:B3"); // True if any of the cells in A1:B3 is included in a merge. var isPartOfMerge = range.isPartOfMerge();
Возвращаться
Boolean
- true
если диапазон перекрывает любые объединенные ячейки, в противном случае возвращает false
.
isStartColumnBounded()
Определяет, связан ли начало диапазона с определенным столбцом. Например, для диапазонов A1:B10
или B:B
, которые связаны с столбцами в начале диапазона, этот метод возвращает true
; Для диапазона 3:7
, который связан только с строкой в начале диапазона, этот метод возвращает 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Determines if the start of the range is bound to a particular column and logs it to the // console. console.log(range.isStartColumnBounded());
Возвращаться
Boolean
- true
, если начало диапазона связано с определенным столбцом; false
в противном случае.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isStartRowBounded()
Определяет, связан ли начало диапазона с определенной строкой. Например, для диапазонов A1:B10
или 3:7
, которые связаны с рядами в начале диапазона, этот метод возвращает true
; Для диапазона B:B
, который связан только с определенным столбцом в начале диапазона, этот метод возвращает 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets the range A1:D10 on Sheet1. const range = sheet.getRange('A1:D10'); // Determines if the start of the range is bound to a particular row and logs it to the // console. console.log(range.isStartRowBounded());
Возвращаться
Boolean
- true
, если начало диапазона связано с определенной строкой; false
в противном случае.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
merge()
Объединяет ячейки в диапазоне вместе в один блок.
var sheet = SpreadsheetApp.getActiveSheet(); // The code below 2-dimensionally merges the cells in A1 to B3 sheet.getRange('A1:B3').merge();
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
mergeAcross()
Объедините ячейки в диапазоне в колоннах диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The code below merges cells C5:E5 into one cell var range1 = sheet.getRange("C5:E5"); range1.mergeAcross(); // The code below creates 2 horizontal cells, F5:H5 and F6:H6 var range2 = sheet.getRange("F5:H6"); range2.mergeAcross();
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
mergeVertically()
Объединяет клетки в диапазоне вместе.
var sheet = SpreadsheetApp.getActiveSheet(); // The code below vertically merges the cells in A1 to A10 sheet.getRange('A1:A10').mergeVertically(); // The code below creates 3 merged columns: B1 to B10, C1 to C10, and D1 to D10 sheet.getRange('B1:D10').mergeVertically();
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
moveTo(target)
Вырежьте и вставьте (как формат, так и значения) из этого диапазона до целевого диапазона.
// The code below moves the first 5 columns over to the 6th column var sheet = SpreadsheetApp.getActiveSheet() sheet.getRange("A1:E").moveTo(sheet.getRange("F1"));
Параметры
Имя | Тип | Описание |
---|---|---|
target | Range | Целевой диапазон для копирования этого диапазона; Только позиция верхней левой ячейки актуальна. |
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
offset(rowOffset, columnOffset)
Возвращает новый диапазон, который смещен из этого диапазона на заданное количество строк и столбцов (что может быть отрицательным). Новый диапазон имеет тот же размер, что и исходный диапазон.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("A1"); // newCell references B2 var newCell = cell.offset(1, 1);
Параметры
Имя | Тип | Описание |
---|---|---|
rowOffset | Integer | Количество рядов вниз от верхней левой ячейки диапазона; Отрицательные значения представляют ряды из верхней левой ячейки диапазона. |
columnOffset | Integer | Количество столбцов прямо из верхней левой ячейки диапазона; Отрицательные значения представляют столбцы, оставшиеся от верхней левой ячейки диапазона. |
Возвращаться
Range
- этот диапазон, для цепочки.
offset(rowOffset, columnOffset, numRows)
Возвращает новый диапазон, который относится к текущему диапазону, верхняя левая точка которого смещена из диапазона тока данными строками и столбцами, а также с данной высотой в ячейках.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("A1"); // newCell references B2:B3 var newRange = cell.offset(1, 1, 2);
Параметры
Имя | Тип | Описание |
---|---|---|
rowOffset | Integer | Количество рядов вниз от верхней левой ячейки диапазона; Отрицательные значения представляют ряды из верхней левой ячейки диапазона. |
columnOffset | Integer | Количество столбцов прямо из верхней левой ячейки диапазона; Отрицательные значения представляют столбцы, оставшиеся от верхней левой ячейки диапазона. |
numRows | Integer | Высота в рядах нового диапазона. |
Возвращаться
Range
- этот диапазон, для цепочки.
offset(rowOffset, columnOffset, numRows, numColumns)
Возвращает новый диапазон, который относится к текущему диапазону, верхняя левая точка которого смещена из диапазона тока данными строками и столбцами, а также с заданной высотой и шириной в ячейках.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("A1"); // newCell references B2:C3 var newRange = cell.offset(1, 1, 2, 2);
Параметры
Имя | Тип | Описание |
---|---|---|
rowOffset | Integer | Количество рядов вниз от верхней левой ячейки диапазона; Отрицательные значения представляют ряды из верхней левой ячейки диапазона. |
columnOffset | Integer | Количество столбцов прямо из верхней левой ячейки диапазона; Отрицательные значения представляют столбцы, оставшиеся от верхней левой ячейки диапазона. |
numRows | Integer | Высота в рядах нового диапазона. |
numColumns | Integer | Ширина в столбцах нового диапазона. |
Возвращаться
Range
- этот диапазон, для цепочки.
protect()
Создает объект, который может защитить диапазон от редактирования, за исключением пользователей, которые имеют разрешение. До тех пор, пока сценарий фактически не изменит список редакторов для диапазона (по вызову Protection.removeEditor(emailAddress)
, Protection.removeEditor(user)
, Protection.removeEditors(emailAddresses)
, Protection.addEditor(emailAddress)
, Protection.addEditor(user)
, Protection.addEditors(emailAddresses)
или установление нового значения для Protection.setDomainEdit(editable)
), разрешения отражают разрешения самой электронной таблицы, что эффективно означает, что диапазон остается незащищенным. Если диапазон уже защищен, этот метод создает новый защищенный диапазон, который перекрывает существующий. Если ячейка защищена несколькими защищенными диапазонами, и любой из них не позволяет конкретному пользователю редактировать ячейку, то этому пользователю не разрешается редактировать ячейку.
// Protect range A1:B10, then remove all other users from the list of editors. var ss = SpreadsheetApp.getActive(); var range = ss.getRange('A1:B10'); var protection = range.protect().setDescription('Sample protected range'); // 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. var 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
randomize()
Рандомизирует порядок рядов в данном диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:C7"); // Randomizes the range range.randomize();
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeCheckboxes()
Удаляет все флажки из диапазона. Расчитывает проверку данных каждой ячейки и дополнительно очищает его значение, если ячейка содержит либо проверенное, так и неверное значение.
var range = SpreadsheetApp.getActive().getRange('A1:B10'); // Inserts checkboxes and sets each cell value to 'no' in the range A1:B10. range.insertCheckboxes('yes', 'no'); var range1 = SpreadsheetApp.getActive().getRange('A1'); range1.setValue('yes'); // Removes the checkbox data validation in cell A1 and clears its value. range1.removeCheckboxes(); var range2 = SpreadsheetApp.getActive().getRange('A2'); range2.setValue('random'); // Removes the checkbox data validation in cell A2 but does not clear its value. range2.removeCheckboxes();
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeDuplicates()
Удаляет строки в этом диапазоне, которые содержат значения, которые являются дубликатами значений в любой предыдущей строке. Ряды с идентичными значениями, но разными буквами, форматированием или формулами считаются дубликатами. Этот метод также удаляет дубликаты рядов, скрытых от представления (например, из -за фильтра). Контент за пределами этого диапазона не удален.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B1:D7"); // Remove duplicate rows in the range. range.removeDuplicates();
Возвращаться
Range
- полученный диапазон после удаления дубликатов. Размер диапазона уменьшается на ряд для каждой удаленной строки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeDuplicates(columnsToCompare)
Удаляет строки в этом диапазоне, которые содержат значения в указанных столбцах, которые являются дубликатами значений в любой предыдущей строке. Ряды с идентичными значениями, но разными буквами, форматированием или формулами считаются дубликатами. Этот метод также удаляет дубликаты рядов, скрытых от представления (например, из -за фильтра). Контент за пределами этого диапазона не удален.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B1:D7"); // Remove rows which have duplicate values in column B. range.removeDuplicates([2]); // Remove rows which have duplicate values in both columns B and D. range.removeDuplicates([2,4]);
Параметры
Имя | Тип | Описание |
---|---|---|
columnsToCompare | Integer[] | Столбцы для анализа для дублирования значений. Если столбцы не предоставляются, то все столбцы анализируются на дубликаты. |
Возвращаться
Range
- полученный диапазон после удаления дубликатов. Размер диапазона уменьшается на ряд для каждой удаленной строки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setBackground(color)
Устанавливает цвет фона всех ячеек в диапазоне в нотации CSS (например, '#ffffff'
или 'white'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("B2:D5"); range.setBackground("red");
Параметры
Имя | Тип | Описание |
---|---|---|
color | String | Цветовой код в нотации CSS (например, '#ffffff' или 'white' ); null значение сбрасывает цвет. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setBackgroundObject(color)
Устанавливает цвет фона всех ячеек в диапазоне.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var bgColor = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.BACKGROUND) .build(); var range = sheet.getRange("B2:D5"); range.setBackgroundObject(bgColor);
Параметры
Имя | Тип | Описание |
---|---|---|
color | Color | Цвет фона для установки; null значение сбрасывает цвет фона. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setBackgroundObjects(color)
Устанавливает прямоугольную сетку цветов фона (необходимо соответствовать размерам этого диапазона).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var colorAccent1 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1) .build(); var colorAccent2 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2) .build(); var colorAccent3 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3) .build(); var colorAccent4 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4) .build(); var colors = [ [colorAccent1, colorAccent2], [colorAccent3, colorAccent4] ]; var cell = sheet.getRange("B5:C6"); cell.setBackgroundObjects(colors);
Параметры
Имя | Тип | Описание |
---|---|---|
color | Color[][] | Двумерный массив цветов; null значения сбросить цвет. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setBackgroundRGB(red, green, blue)
Устанавливает фон на заданный цвет с использованием значений RGB (целые числа от 0 до 255 включительно).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); // Sets the background to white cell.setBackgroundRGB(255, 255, 255); // Sets the background to red cell.setBackgroundRGB(255, 0, 0);
Параметры
Имя | Тип | Описание |
---|---|---|
red | Integer | Красное значение в обозначениях RGB. |
green | Integer | Зеленое значение в обозначениях RGB. |
blue | Integer | Синее значение в обозначениях RGB. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setBackgrounds(color)
Устанавливает прямоугольную сетку цветов фона (необходимо соответствовать размерам этого диапазона). Цвета в нотации CSS (такие как '#ffffff'
или 'white'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var colors = [ ["red", "white", "blue"], ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents ]; var cell = sheet.getRange("B5:D6"); cell.setBackgrounds(colors);
Параметры
Имя | Тип | Описание |
---|---|---|
color | String[][] | Двумерный массив цветов в нотации CSS (например, '#ffffff' или 'white' ); null значения сбросить цвет. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setBorder(top, left, bottom, right, vertical, horizontal)
Устанавливает собственность границы. Допустимые значения являются true
(ON), false
(OFF) и null
(без изменений).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); // Sets borders on the top and bottom, but leaves the left and right unchanged cell.setBorder(true, null, true, null, false, false);
Параметры
Имя | Тип | Описание |
---|---|---|
top | Boolean | true для границы, false ни для одного, null без изменений. |
left | Boolean | true для границы, false ни для одного, null без изменений. |
bottom | Boolean | true для границы, false ни для одного, null без изменений. |
right | Boolean | true для границы, false ни для одного, null без изменений. |
vertical | Boolean | true для внутренних вертикальных границ, false для ни одного, null без изменений. |
horizontal | Boolean | true для внутренних горизонтальных границ, false ни для одного, null без изменений. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setBorder(top, left, bottom, right, vertical, horizontal, color, style)
Устанавливает свойство границы с цветом и/или стилем. Допустимые значения являются true
(ON), false
(OFF) и null
(без изменений). Для цвета используйте цвет в нотации CSS (например, '#ffffff'
или 'white'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); // Sets borders on the top and bottom, but leaves the left and right unchanged // Also sets the color to "red", and the border to "DASHED". cell.setBorder(true, null, true, null, false, false, "red", SpreadsheetApp.BorderStyle.DASHED);
Параметры
Имя | Тип | Описание |
---|---|---|
top | Boolean | true для границы, false ни для одного, null без изменений. |
left | Boolean | true для границы, false ни для одного, null без изменений. |
bottom | Boolean | true для границы, false ни для одного, null без изменений. |
right | Boolean | true для границы, false ни для одного, null без изменений. |
vertical | Boolean | true для внутренних вертикальных границ, false для ни одного, null без изменений. |
horizontal | Boolean | true для внутренних горизонтальных границ, false ни для одного, null без изменений. |
color | String | Цвет в нотации CSS (например, '#ffffff' или 'white' ), null для цвета по умолчанию (черный). |
style | BorderStyle | Стиль для границ, null для стиля по умолчанию (твердый). |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setDataValidation(rule)
Устанавливает одно правило проверки данных для всех ячеек в диапазоне.
// Set the data validation rule for cell A1 to require a value from B1:B10. var cell = SpreadsheetApp.getActive().getRange('A1'); var range = SpreadsheetApp.getActive().getRange('B1:B10'); var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build(); cell.setDataValidation(rule);
Параметры
Имя | Тип | Описание |
---|---|---|
rule | DataValidation | Правило проверки данных для установки или null для удаления проверки данных. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setDataValidations(rules)
Устанавливает правила проверки данных для всех ячеек в диапазоне. Этот метод принимает двухмерный массив проверки данных, индексируемый по строке, затем по столбцу. Размеры массива должны соответствовать размерам диапазона.
// Set the data validation rules for Sheet1!A1:B5 to require a value from Sheet2!A1:A10. var destinationRange = SpreadsheetApp.getActive().getSheetByName('Sheet1').getRange('A1:B5'); var sourceRange = SpreadsheetApp.getActive().getSheetByName('Sheet2').getRange('A1:A10'); var rule = SpreadsheetApp.newDataValidation().requireValueInRange(sourceRange).build(); var rules = destinationRange.getDataValidations(); for (var i = 0; i < rules.length; i++) { for (var j = 0; j < rules[i].length; j++) { rules[i][j] = rule; } } destinationRange.setDataValidations(rules);
Параметры
Имя | Тип | Описание |
---|---|---|
rules | DataValidation[][] | Двумерный массив правил проверки данных для установки; null значения Удалите проверку данных. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontColor(color)
Устанавливает цвет шрифта в нотации CSS (например, '#ffffff'
или 'white'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); cell.setFontColor("red");
Параметры
Имя | Тип | Описание |
---|---|---|
color | String | Цвет шрифта в нотации CSS (например, '#ffffff' или 'white' ); null значение сбрасывает цвет. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Сценарии, которые используют этот метод, требуют авторизации с одним или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontColorObject(color)
Устанавливает цвет шрифта данного диапазона.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var color = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.TEXT) .build(); var cell = sheet.getRange("B2"); cell.setFontColor(color);
Параметры
Имя | Тип | Описание |
---|---|---|
color | Color | Цвет шрифта для установки; null значение сбрасывает цвет. |
Возвращаться
Range
- этот диапазон, для цепочки.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontColorObjects(colors)
Sets a rectangular grid of font colors (must match dimensions of this range).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var colorAccent1 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT1) .build(); var colorAccent2 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT2) .build(); var colorAccent3 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT3) .build(); var colorAccent4 = SpreadsheetApp.newColor() .setThemeColor(SpreadsheetApp.ThemeColorType.ACCENT4) .build(); var colors = [ [colorAccent1, colorAccent2], [colorAccent3, colorAccent4] ]; var cell = sheet.getRange("B5:C6"); cell.setFontColorObjects(colors);
Параметры
Имя | Тип | Описание |
---|---|---|
colors | Color[][] | A two-dimensional array of colors; null values reset the font color. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontColors(colors)
Sets a rectangular grid of font colors (must match dimensions of this range). The colors are in CSS notation (such as '#ffffff'
or 'white'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var colors = [ ["red", "white", "blue"], ["#FF0000", "#FFFFFF", "#0000FF"] // These are the hex equivalents ]; var cell = sheet.getRange("B5:D6"); cell.setFontColors(colors);
Параметры
Имя | Тип | Описание |
---|---|---|
colors | Object[][] | A two-dimensional array of colors in CSS notation (such as '#ffffff' or 'white' ); null values reset the color. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontFamilies(fontFamilies)
Sets a rectangular grid of font families (must match dimensions of this range). Examples of font families are "Arial" or "Helvetica".
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var fonts = [ ["Arial", "Helvetica", "Verdana"], ["Courier New", "Arial", "Helvetica] ]; var cell = sheet.getRange("B2:D3"); cell.setFontFamilies(fonts);
Параметры
Имя | Тип | Описание |
---|---|---|
fontFamilies | Object[][] | A two-dimensional array of font families; null values reset the font family. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontFamily(fontFamily)
Sets the font family, such as "Arial" or "Helvetica".
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); cell.setFontFamily("Helvetica");
Параметры
Имя | Тип | Описание |
---|---|---|
fontFamily | String | The font family to set; a null value resets the font family. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontLine(fontLine)
Sets the font line style of the given range ( 'underline'
, 'line-through'
, or 'none'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); cell.setFontLine("line-through");
Параметры
Имя | Тип | Описание |
---|---|---|
fontLine | String | The font line style, either 'underline' , 'line-through' , or 'none' ; a null value resets the font line style. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontLines(fontLines)
Sets a rectangular grid of line styles (must match dimensions of this range).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. var fontLines = [ ["underline", "line-through", "none"] ]; var range = sheet.getRange("B2:D2"); range.setFontLines(fontLines);
Параметры
Имя | Тип | Описание |
---|---|---|
fontLines | Object[][] | A two-dimensional array of font line styles ( 'underline' , 'line-through' , or 'none' ); null values reset the font line style. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontSize(size)
Sets the font size, with the size being the point size to use.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); cell.setFontSize(20);
Параметры
Имя | Тип | Описание |
---|---|---|
size | Integer | A font size in point size. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontSizes(sizes)
Sets a rectangular grid of font sizes (must match dimensions of this range). The sizes are in points.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. var fontSizes = [ [16, 20, 24] ]; var range = sheet.getRange("B2:D2"); range.setFontSizes(fontSizes);
Параметры
Имя | Тип | Описание |
---|---|---|
sizes | Object[][] | A two-dimensional array of sizes. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontStyle(fontStyle)
Set the font style for the given range ( 'italic'
or 'normal'
).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); cell.setFontStyle("italic");
Параметры
Имя | Тип | Описание |
---|---|---|
fontStyle | String | The font style, either 'italic' or 'normal' ; a null value resets the font style. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontStyles(fontStyles)
Sets a rectangular grid of font styles (must match dimensions of this range).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. var fontStyles = [ ["italic", "normal"] ]; var range = sheet.getRange("B2:C2"); range.setFontStyles(fontStyles);
Параметры
Имя | Тип | Описание |
---|---|---|
fontStyles | Object[][] | A two-dimensional array of font styles, either 'italic' or 'normal' ; null values reset the font style. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontWeight(fontWeight)
Set the font weight for the given range (normal/bold).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); cell.setFontWeight("bold");
Параметры
Имя | Тип | Описание |
---|---|---|
fontWeight | String | The font weight, either 'bold' or 'normal' ; a null value resets the font weight. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFontWeights(fontWeights)
Sets a rectangular grid of font weights (must match dimensions of this range). An example of a font weight is "bold".
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. var fontStyles = [ [ "bold", "bold", "normal" ] ]; var range = sheet.getRange("B2:D2"); range.setFontWeights(fontStyles);
Параметры
Имя | Тип | Описание |
---|---|---|
fontWeights | Object[][] | A two-dimensional array of font weights, either 'bold' or 'normal' ; null values reset the font weight. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFormula(formula)
Updates the formula for this range. The given formula must be in A1 notation.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B5"); cell.setFormula("=SUM(B3:B4)");
Параметры
Имя | Тип | Описание |
---|---|---|
formula | String | A string representing the formula to set for the cell. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFormulaR1C1(formula)
Updates the formula for this range. The given formula must be in R1C1 notation.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B5"); // This sets the formula to be the sum of the 3 rows above B5 cell.setFormulaR1C1("=SUM(R[-3]C[0]:R[-1]C[0])");
Параметры
Имя | Тип | Описание |
---|---|---|
formula | String | A string formula. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFormulas(formulas)
Sets a rectangular grid of formulas (must match dimensions of this range). The given formulas must be in A1 notation. This method takes a two-dimensional array of formulas, indexed by row, then by column. The array dimensions must correspond to the range dimensions.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This sets the formulas to be a row of sums, followed by a row of averages right below. // The size of the two-dimensional array must match the size of the range. var formulas = [ ["=SUM(B2:B4)", "=SUM(C2:C4)", "=SUM(D2:D4)"], ["=AVERAGE(B2:B4)", "=AVERAGE(C2:C4)", "=AVERAGE(D2:D4)"] ]; var cell = sheet.getRange("B5:D6"); cell.setFormulas(formulas);
Параметры
Имя | Тип | Описание |
---|---|---|
formulas | String[][] | A two-dimensional string array of formulas. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setFormulasR1C1(formulas)
Sets a rectangular grid of formulas (must match dimensions of this range). The given formulas must be in R1C1 notation.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // This creates formulas for a row of sums, followed by a row of averages. var sumOfRowsAbove = "=SUM(R[-3]C[0]:R[-1]C[0])"; var averageOfRowsAbove = "=AVERAGE(R[-4]C[0]:R[-2]C[0])"; // The size of the two-dimensional array must match the size of the range. var formulas = [ [sumOfRowsAbove, sumOfRowsAbove, sumOfRowsAbove], [averageOfRowsAbove, averageOfRowsAbove, averageOfRowsAbove] ]; var cell = sheet.getRange("B5:D6"); // This sets the formula to be the sum of the 3 rows above B5. cell.setFormulasR1C1(formulas);
Параметры
Имя | Тип | Описание |
---|---|---|
formulas | String[][] | A two-dimensional array of formulas in R1C1 format. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setHorizontalAlignment(alignment)
Set the horizontal (left to right) alignment for the given range (left/center/right).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); cell.setHorizontalAlignment("center");
Параметры
Имя | Тип | Описание |
---|---|---|
alignment | String | The alignment, either 'left' , 'center' or 'normal' ; a null value resets the alignment. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setHorizontalAlignments(alignments)
Sets a rectangular grid of horizontal alignments. see setHorizontalAlignment(alignment)
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. var horizontalAlignments = [ [ "left", "right", "center" ] ]; var range = sheet.getRange("B2:D2"); range.setHorizontalAlignments(horizontalAlignments);
Параметры
Имя | Тип | Описание |
---|---|---|
alignments | Object[][] | A two-dimensional array of alignments, either 'left' , 'center' or 'normal' ; a null value resets the alignment. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
См. также
setNote(note)
Sets the note to the given value.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); cell.setNote("This is a note");
Параметры
Имя | Тип | Описание |
---|---|---|
note | String | The note value to set for the range; a null value removes the note. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setNotes(notes)
Sets a rectangular grid of notes (must match dimensions of this range).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. var notes = [ ["it goes", "like this", "the fourth, the fifth"], ["the minor fall", "and the", "major lift"] ]; var cell = sheet.getRange("B2:D3"); cell.setNotes(notes)
Параметры
Имя | Тип | Описание |
---|---|---|
notes | Object[][] | A two-dimensional array of notes; null values remove the note. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
См. также
setNumberFormat(numberFormat)
Sets the number or date format to the given formatting string. The accepted format patterns are described in the Sheets API documentation .
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); // Always show 3 decimal points cell.setNumberFormat("0.000");
Параметры
Имя | Тип | Описание |
---|---|---|
numberFormat | String | A number format string. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setNumberFormats(numberFormats)
Sets a rectangular grid of number or date formats (must match dimensions of this range). The values are format pattern strings as described in the Sheets API documentation .
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. var formats = [ [ "0.000", "0,000,000", "$0.00" ] ]; var range = sheet.getRange("B2:D2"); range.setNumberFormats(formats);
Параметры
Имя | Тип | Описание |
---|---|---|
numberFormats | Object[][] | A two-dimensional array of number formats. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRichTextValue(value)
Sets the Rich Text value for the cells in the range.
// Sets all cells in range B2:D4 to have the text "Hello world", with "Hello" bolded. var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B2:D4"); var bold = SpreadsheetApp.newTextStyle() .setBold(true) .build(); var richText = SpreadsheetApp.newRichTextValue() .setText("Hello world") .setTextStyle(0, 5, bold) .build(); range.setRichTextValue(richText);
Параметры
Имя | Тип | Описание |
---|---|---|
value | RichTextValue | The desired Rich Text value. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setRichTextValues(values)
Sets a rectangular grid of Rich Text values.
// Sets the cells in range A1:A2 to have Rich Text values. var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("A1:A2"); var bold = SpreadsheetApp.newTextStyle() .setBold(true) .build(); var italic = SpreadsheetApp.newTextStyle() .setItalic(true) .build(); var richTextA1 = SpreadsheetApp.newRichTextValue() .setText("This cell is bold") .setTextStyle(bold) .build(); var richTextA2 = SpreadsheetApp.newRichTextValue() .setText("bold words, italic words") .setTextStyle(0, 11, bold) .setTextStyle(12, 24, italic) .build(); range.setRichTextValues([[richTextA1], [richTextA2]]);
Параметры
Имя | Тип | Описание |
---|---|---|
values | RichTextValue[][] | The desired Rich Text values. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setShowHyperlink(showHyperlink)
Sets whether or not the range should show hyperlinks.
// 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 Sheet1 by its name. const sheet = ss.getSheetByName('Sheet1'); // Gets cell A30 and sets its hyperlink value. const range = sheet.getRange('A30'); range.setValue('https://www.example.com'); // Sets cell A30 to show hyperlinks. range.setShowHyperlink(true);
Параметры
Имя | Тип | Описание |
---|---|---|
showHyperlink | Boolean | Whether or not to show the hyperlink. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTextDirection(direction)
Sets the text direction for the cells in the range. If a specified direction is null
, the direction is inferred and then set.
// Sets right-to-left text direction for the range. var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B5:C6"); range.setTextDirection(SpreadsheetApp.TextDirection.RIGHT_TO_LEFT);
Параметры
Имя | Тип | Описание |
---|---|---|
direction | TextDirection | The desired text direction; if null the direction is inferred before setting. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTextDirections(directions)
Sets a rectangular grid of text directions. If a specified direction is null
, the direction is inferred and then set.
// Copies all of the text directions from range A1:B2 over to range C5:D6. var sheet = SpreadsheetApp.getActiveSheet(); var range1 = sheet.getRange("A1:B2"); var range2 = sheet.getRange("C5:D6"); range2.setTextRotations(range1.getTextDirections());
Параметры
Имя | Тип | Описание |
---|---|---|
directions | TextDirection[][] | The desired text directions; if a specified direction is null it is inferred before setting. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTextRotation(degrees)
Sets the text rotation settings for the cells in the range. The input corresponds to the angle between the standard text orientation and the desired orientation. An input of zero indicates that the text is set to the standard orientation.
For left to right text direction, positive angles are in the counterclockwise direction, whereas for right to left they are in the clockwise direction.
// Sets all cell's in range B2:D4 to have text rotated up 45 degrees. var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B2:D4"); range.setTextRotation(45);
Параметры
Имя | Тип | Описание |
---|---|---|
degrees | Integer | The desired angle between the standard orientation and the desired orientation. For left to right text, positive angles are in the counterclockwise direction. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTextRotation(rotation)
Sets the text rotation settings for the cells in the range.
// Sets all cell's in range B2:D4 to have the same text rotation settings as cell A1. var sheet = SpreadsheetApp.getActiveSheet(); var rotation = sheet.getRange("A1").getTextRotation(); sheet.getRange("B2:D4").setTextRotation(rotation);
Параметры
Имя | Тип | Описание |
---|---|---|
rotation | TextRotation | The desired text rotation settings. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTextRotations(rotations)
Sets a rectangular grid of text rotations.
// Copies all of the text rotations from range A1:B2 over to range C5:D6. var sheet = SpreadsheetApp.getActiveSheet(); var range1 = sheet.getRange("A1:B2"); var range2 = sheet.getRange("C5:D6"); range2.setTextRotations(range1.getTextRotations());
Параметры
Имя | Тип | Описание |
---|---|---|
rotations | TextRotation[][] | The desired text rotation settings. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTextStyle(style)
Sets the text style for the cells in the range.
// Sets the cells in range C5:D6 to have underlined size 15 font. var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("C5:D6"); var style = SpreadsheetApp.newTextStyle() .setFontSize(15) .setUnderline(true) .build(); range.setTextStyle(style);
Параметры
Имя | Тип | Описание |
---|---|---|
style | TextStyle | The desired text style. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setTextStyles(styles)
Sets a rectangular grid of text styles.
// Sets text styles for cells in range A1:B2 var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("A1:B2"); var bold = SpreadsheetApp.newTextStyle() .setBold(true) .build(); var otherStyle = SpreadsheetApp.newTextStyle() .setBold(true) .setUnderline(true) .setItalic(true) .setForegroundColor("#335522") .setFontSize(44) .build(); range.setTextStyles([[bold, otherStyle], [otherStyle, bold]]);
Параметры
Имя | Тип | Описание |
---|---|---|
styles | TextStyle[][] | The desired text styles. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setValue(value)
Sets the value of the range. The value can be numeric, string, boolean or date. If it begins with '='
it is interpreted as a formula.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); cell.setValue(100);
Параметры
Имя | Тип | Описание |
---|---|---|
value | Object | The value for the range. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setValues(values)
Sets a rectangular grid of values (must match dimensions of this range). If a value begins with =
, it's interpreted as a formula.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. var values = [ [ "2.000", "1,000,000", "$2.99" ] ]; var range = sheet.getRange("B2:D2"); range.setValues(values);
Параметры
Имя | Тип | Описание |
---|---|---|
values | Object[][] | A two-dimensional array of values. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setVerticalAlignment(alignment)
Set the vertical (top to bottom) alignment for the given range (top/middle/bottom).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); cell.setVerticalAlignment("middle");
Параметры
Имя | Тип | Описание |
---|---|---|
alignment | String | The alignment, either 'top' , 'middle' or 'bottom' ; a null value resets the alignment. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setVerticalAlignments(alignments)
Sets a rectangular grid of vertical alignments (must match dimensions of this range).
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. var alignments = [ [ "top", "middle", "bottom" ] ]; var range = sheet.getRange("B2:D2"); range.setVerticalAlignments(alignments);
Параметры
Имя | Тип | Описание |
---|---|---|
alignments | Object[][] | A two-dimensional array of alignments, either 'top' , 'middle' or 'bottom' ; a null value resets the alignment. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
См. также
setVerticalText(isVertical)
Sets whether or not to stack the text for the cells in the range. If the text is stacked vertically, the degree text rotation setting is ignored.
// Sets all cell's in range B2:D4 to have vertically stacked text. var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B2:D4"); range.setVerticalText(true);
Параметры
Имя | Тип | Описание |
---|---|---|
isVertical | Boolean | Whether or not to stack the text. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setWrap(isWrapEnabled)
Set the cell wrap of the given range.
Cells with wrap enabled (the default) resize to display their full content. Cells with wrap disabled display as much as possible in the cell without resizing or running to multiple lines.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var cell = sheet.getRange("B2"); cell.setWrap(true);
Параметры
Имя | Тип | Описание |
---|---|---|
isWrapEnabled | Boolean | Whether to wrap text or not. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setWrapStrategies(strategies)
Sets a rectangular grid of wrap strategies.
// Copies all of the wrap strategies from range A1:B2 over to range C5:D6. var sheet = SpreadsheetApp.getActiveSheet(); var range1 = sheet.getRange("A1:B2"); var range2 = sheet.getRange("C5:D6"); range2.setWrapStrategies(range1.getWrapStrategies());
Параметры
Имя | Тип | Описание |
---|---|---|
strategies | WrapStrategy[][] | The desired wrapping strategies. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setWrapStrategy(strategy)
Sets the text wrapping strategy for the cells in the range.
// Sets all cells in range B2:D4 to use the clip wrap strategy. var sheet = SpreadsheetApp.getActiveSheet(); var range = sheet.getRange("B2:D4"); range.setWrapStrategy(SpreadsheetApp.WrapStrategy.CLIP);
Параметры
Имя | Тип | Описание |
---|---|---|
strategy | WrapStrategy | The desired wrapping strategy. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setWraps(isWrapEnabled)
Sets a rectangular grid of word wrap policies (must match dimensions of this range). Cells with wrap enabled (the default) resize to display their full content. Cells with wrap disabled display as much as possible in the cell without resizing or running to multiple lines.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; // The size of the two-dimensional array must match the size of the range. var wraps = [ [ true, true, false ] ]; var range = sheet.getRange("B2:D2"); range.setWraps(wraps);
Параметры
Имя | Тип | Описание |
---|---|---|
isWrapEnabled | Object[][] | A two-dimensional array of wrap variables that determine whether to wrap text in a cell or not. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
См. также
shiftColumnGroupDepth(delta)
Changes the column grouping depth of the range by the specified amount.
This has the effect of creating, modifying, or deleting groups that intersect with the range. For positive deltas, groups are created and/or modified; for negative deltas, groups are destroyed and/or modified.
This has no effect when decreasing the group depth below zero or above eight.
If the column group control position
is BEFORE
, this throws an error when attempting to shift the depth of the first row.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getActiveRange(); // The column grouping depth is increased by 1. range.shiftColumnGroupDepth(1); // The column grouping depth is decreased by 1. range.shiftColumnGroupDepth(-1);
Параметры
Имя | Тип | Описание |
---|---|---|
delta | Integer | The amount by which to change the column group depth of this range. |
Возвращаться
Range
— This range, for chaining.
Броски
Error
— when attempting to shift the depth of the first column when the control position is GroupControlTogglePosition.BEFORE
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
shiftRowGroupDepth(delta)
Changes the row grouping depth of the range by the specified amount.
This has the effect of creating, modifying, or deleting groups that intersect with the range. For positive deltas, groups are created and/or modified; for negative deltas, groups are destroyed and/or modified.
This has no effect when decreasing the group depth below zero or above eight.
If the row group control position
is BEFORE
, this throws an error when attempting to shift the depth of the first row.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getActiveRange(); // The row grouping depth is increased by 1. range.shiftRowGroupDepth(1); // The row grouping depth is decreased by 1. range.shiftRowGroupDepth(-1);
Параметры
Имя | Тип | Описание |
---|---|---|
delta | Integer | The amount by which to change the row group depth of this range. |
Возвращаться
Range
— This range, for chaining.
Броски
Error
— when attempting to shift the depth of the first row when the control position is GroupControlTogglePosition.BEFORE
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
sort(sortSpecObj)
Sorts the cells in the given range, by column and order specified.
var ss = SpreadsheetApp.getActiveSpreadsheet(); var sheet = ss.getSheets()[0]; var range = sheet.getRange("A1:C7"); // Sorts by the values in the first column (A) range.sort(1); // Sorts by the values in the second column (B) range.sort(2); // Sorts descending by column B range.sort({column: 2, ascending: false}); // Sorts descending by column B, then ascending by column A // Note the use of an array range.sort([{column: 2, ascending: false}, {column: 1, ascending: true}]); // For rows that are sorted in ascending order, the "ascending" parameter is // optional, and just an integer with the column can be used instead. Note that // in general, keeping the sort specification consistent results in more readable // code. You can express the earlier sort as: range.sort([{column: 2, ascending: false}, 1]); // Alternatively, if you want all columns to be in ascending order, you can use // the following (this makes column 2 ascending) range.sort([2, 1]); // ... which is equivalent to range.sort([{column: 2, ascending: true}, {column: 1, ascending: true}]);
Параметры
Имя | Тип | Описание |
---|---|---|
sortSpecObj | Object | The columns to sort by. |
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
splitTextToColumns()
Splits a column of text into multiple columns based on an auto-detected delimiter.
// A1:A3 has the following values: // A B C // 1 |one,one,one | | | // 2 |two,two,two | | | // 3 |three,three,three| | | var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3"); range.splitTextToColumns(); // Result after spliting the text to columns: // A B C // 1 |one |one |one | // 2 |two |two |two | // 3 |three |three |three |
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
splitTextToColumns(delimiter)
Splits a column of text into multiple columns using the specified string as a custom delimiter.
// A1:A3 has the following values: // A B C // 1 |one#one#one | | | // 2 |two#two#two | | | // 3 |three#three#three| | | var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3"); range.splitTextToColumns('#'); // Result after spliting the text to columns: // A B C // 1 |one |one |one | // 2 |two |two |two | // 3 |three |three |three |
Параметры
Имя | Тип | Описание |
---|---|---|
delimiter | String | The custom delimiter to split on. |
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
splitTextToColumns(delimiter)
Splits a column of text into multiple columns based on the specified delimiter.
// A1:A3 has the following values: // A B C // 1 |one;one;one | | | // 2 |two;two;two | | | // 3 |three;three;three| | | var range = SpreadsheetApp.getActiveSheet().getRange("A1:A3"); range.splitTextToColumns(SpreadsheetApp.TextToColumnsDelimiter.SEMICOLON); // Result after spliting the text to columns: // A B C // 1 |one |one |one | // 2 |two |two |two | // 3 |three |three |three |
Параметры
Имя | Тип | Описание |
---|---|---|
delimiter | TextToColumnsDelimiter | The preset delimiter to split on. |
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
trimWhitespace()
Trims the whitespace (such as spaces, tabs, or new lines) in every cell in this range. Removes all whitespace from the start and end of each cell's text, and reduces any subsequence of remaining whitespace characters to a single space.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0]; var range = sheet.getRange('A1:A4'); range.activate(); range.setValues( [' preceding space', 'following space ', 'two middle spaces', ' =SUM(1,2)']) range.trimWhitespace(); var values = range.getValues(); // Values are ['preceding space', 'following space', 'two middle spaces', '=SUM(1,2)']
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
uncheck()
Changes the state of the checkboxes in the range to “unchecked”. Ignores the cells in the range which currently do not contain either the checked or unchecked value configured.
// Changes the state of cells which currently contain either the checked or unchecked value // configured in the range A1:B10 to 'unchecked'. var range = SpreadsheetApp.getActive().getRange('A1:B10'); range.uncheck();
Возвращаться
Range
— This range, for chaining.
Авторизация
Scripts that use this method require authorization with one or more of the following scopes :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets