Представляет изображение поверх сетки в электронной таблице.
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
assignScript(functionName) | OverGridImage | Назначает функцию с указанным именем функции этому изображению. |
getAltTextDescription() | String | Возвращает альтернативное текстовое описание для этого изображения. |
getAltTextTitle() | String | Возвращает замещающий текстовый заголовок для этого изображения. |
getAnchorCell() | Range | Возвращает ячейку, к которой привязано изображение. |
getAnchorCellXOffset() | Integer | Возвращает смещение по горизонтали в пикселях от ячейки привязки. |
getAnchorCellYOffset() | Integer | Возвращает вертикальное смещение в пикселях от ячейки привязки. |
getHeight() | Integer | Возвращает фактическую высоту этого изображения в пикселях. |
getInherentHeight() | Integer | Возвращает внутреннюю высоту этого изображения в пикселях. |
getInherentWidth() | Integer | Возвращает внутреннюю высоту этого изображения в пикселях. |
getScript() | String | Возвращает имя функции, назначенной этому изображению. |
getSheet() | Sheet | Возвращает лист, на котором находится это изображение. |
getUrl() | String | Получает исходный URL-адрес изображения; возвращает null , если URL-адрес недоступен. |
getWidth() | Integer | Возвращает фактическую ширину этого изображения в пикселях. |
remove() | void | Удаляет это изображение из электронной таблицы. |
replace(blob) | OverGridImage | Заменяет это изображение изображением, указанным в предоставленном BlobSource . |
replace(url) | OverGridImage | Заменяет это изображение изображением по указанному URL. |
resetSize() | OverGridImage | Возвращает изображение к его собственным размерам. |
setAltTextDescription(description) | OverGridImage | Устанавливает альтернативное текстовое описание для этого изображения. |
setAltTextTitle(title) | OverGridImage | Устанавливает замещающий текстовый заголовок для этого изображения. |
setAnchorCell(cell) | OverGridImage | Устанавливает ячейку, к которой привязано изображение. |
setAnchorCellXOffset(offset) | OverGridImage | Устанавливает горизонтальное смещение пикселей от опорной ячейки. |
setAnchorCellYOffset(offset) | OverGridImage | Устанавливает вертикальное смещение пикселей от опорной ячейки. |
setHeight(height) | OverGridImage | Устанавливает фактическую высоту этого изображения в пикселях. |
setWidth(width) | OverGridImage | Устанавливает фактическую ширину этого изображения в пикселях. |
Подробная документация
assignScript(functionName)
Назначает функцию с указанным именем функции этому изображению.
Параметры
Имя | Тип | Описание |
---|---|---|
functionName | String | Имя указанной функции. Это должна быть общедоступная функция верхнего уровня, а не функция, оканчивающаяся подчеркиванием, например, privateFunction_ . |
Возвращаться
OverGridImage
— это изображение для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAltTextDescription()
Возвращает альтернативное текстовое описание для этого изображения.
Возвращаться
String
— описание альтернативного текста.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAltTextTitle()
Возвращает замещающий текстовый заголовок для этого изображения.
Возвращаться
String
— заголовок альтернативного текста.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAnchorCell()
Возвращает ячейку, к которой привязано изображение.
Возвращаться
Range
— ячейка привязки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAnchorCellXOffset()
Возвращает смещение по горизонтали в пикселях от ячейки привязки.
Возвращаться
Integer
— Горизонтальное смещение пикселя.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getAnchorCellYOffset()
Возвращает вертикальное смещение в пикселях от ячейки привязки.
Возвращаться
Integer
— вертикальное смещение пикселей.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getHeight()
Возвращает фактическую высоту этого изображения в пикселях.
// Logs the height of all images in a spreadsheet var images = SpreadsheetApp.getActiveSpreadsheet().getImages(); for (var i = 0; i < images.length; i++) { Logger.log(images[i].getHeight()); }
Возвращаться
Integer
— Высота изображения в пикселях.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getInherentHeight()
Возвращает внутреннюю высоту этого изображения в пикселях.
Возвращаться
Integer
— собственная высота в пикселях.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getInherentWidth()
Возвращает внутреннюю высоту этого изображения в пикселях.
Возвращаться
Integer
— собственная ширина в пикселях.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getScript()
Возвращает имя функции, назначенной этому изображению.
Возвращаться
String
— Имя функции.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getSheet()
Возвращает лист, на котором находится это изображение.
// Logs the parent sheet of all images in a spreadsheet var images = SpreadsheetApp.getActiveSpreadsheet().getImages(); for (var i = 0; i < images.length; i++) { Logger.log(images[i].getSheet()); }
Возвращаться
Sheet
— лист, на котором отображается изображение.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getUrl()
Получает исходный URL-адрес изображения; возвращает null
, если URL-адрес недоступен. Если изображение было вставлено по URL-адресу с использованием API, этот метод возвращает URL-адрес, указанный во время вставки изображения.
Возвращаться
String
— URL-адрес изображения, если он доступен; возвращает null
если изображение недоступно или не имеет исходного URL-адреса.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
getWidth()
Возвращает фактическую ширину этого изображения в пикселях.
// Logs the width of all images in a spreadsheet var images = SpreadsheetApp.getActiveSpreadsheet().getImages(); for (var i = 0; i < images.length; i++) { Logger.log(images[i].getWidth()); }
Возвращаться
Integer
— Ширина изображения в пикселях.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
remove()
Удаляет это изображение из электронной таблицы. Любая дальнейшая операция с изображением приводит к ошибке сценария.
// Deletes all images in a spreadsheet var images = SpreadsheetApp.getActiveSpreadsheet().getImages(); for (var i = 0; i < images.length; i++) { images[i].remove(); }
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
replace(blob)
Заменяет это изображение изображением, указанным в предоставленном BlobSource
. Максимальный поддерживаемый размер большого двоичного объекта — 2 МБ.
Параметры
Имя | Тип | Описание |
---|---|---|
blob | BlobSource | Новое изображение в виде Blob. |
Возвращаться
OverGridImage
— это изображение для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
replace(url)
Заменяет это изображение изображением по указанному URL.
Параметры
Имя | Тип | Описание |
---|---|---|
url | String | URL-адрес нового изображения. |
Возвращаться
OverGridImage
— это изображение для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
resetSize()
Возвращает изображение к его собственным размерам.
Возвращаться
OverGridImage
— это изображение для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAltTextDescription(description)
Устанавливает альтернативное текстовое описание для этого изображения.
Параметры
Имя | Тип | Описание |
---|---|---|
description | String | Новое альтернативное текстовое описание изображения. |
Возвращаться
OverGridImage
— это изображение для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAltTextTitle(title)
Устанавливает замещающий текстовый заголовок для этого изображения.
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | Новый замещающий текстовый заголовок для изображения. |
Возвращаться
OverGridImage
— это изображение для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAnchorCell(cell)
Устанавливает ячейку, к которой привязано изображение.
Параметры
Имя | Тип | Описание |
---|---|---|
cell | Range | Новая якорная ячейка. |
Возвращаться
OverGridImage
— это изображение для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAnchorCellXOffset(offset)
Устанавливает смещение пикселя по горизонтали от ячейки привязки.
Параметры
Имя | Тип | Описание |
---|---|---|
offset | Integer | Новое смещение пикселей по горизонтали. |
Возвращаться
OverGridImage
— это изображение для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setAnchorCellYOffset(offset)
Устанавливает вертикальное смещение пикселей от опорной ячейки.
Параметры
Имя | Тип | Описание |
---|---|---|
offset | Integer | Новое вертикальное смещение пикселей. |
Возвращаться
OverGridImage
— это изображение для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setHeight(height)
Устанавливает фактическую высоту этого изображения в пикселях.
Параметры
Имя | Тип | Описание |
---|---|---|
height | Integer | Желаемая высота в пикселях. |
Возвращаться
OverGridImage
— Изображение для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
setWidth(width)
Устанавливает фактическую ширину этого изображения в пикселях.
Параметры
Имя | Тип | Описание |
---|---|---|
width | Integer | Желаемая ширина в пикселях. |
Возвращаться
OverGridImage
— Изображение для цепочки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets