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

Class OverGridImage

Представляет изображение поверх сетки в электронной таблице.

Методы

Метод	Тип возврата	Краткое описание
`assign Script(functionName)`	`Over Grid Image`	Назначает функцию с указанным именем функции этому изображению.
`get Alt Text Description()`	`String`	Возвращает альтернативное текстовое описание для этого изображения.
`get Alt Text Title()`	`String`	Возвращает замещающий текстовый заголовок для этого изображения.
`get Anchor Cell()`	`Range`	Возвращает ячейку, к которой привязано изображение.
`get Anchor Cell XOffset()`	`Integer`	Возвращает смещение по горизонтали в пикселях от ячейки привязки.
`get Anchor Cell YOffset()`	`Integer`	Возвращает смещение пикселя по вертикали от ячейки привязки.
`get Height()`	`Integer`	Возвращает фактическую высоту этого изображения в пикселях.
`get Inherent Height()`	`Integer`	Возвращает внутреннюю высоту этого изображения в пикселях.
`get Inherent Width()`	`Integer`	Возвращает внутреннюю высоту этого изображения в пикселях.
`get Script()`	`String`	Возвращает имя функции, назначенной этому изображению.
`get Sheet()`	`Sheet`	Возвращает лист, на котором находится это изображение.
`get Width()`	`Integer`	Возвращает фактическую ширину этого изображения в пикселях.
`remove()`	`void`	Удаляет это изображение из электронной таблицы.
`replace(blob)`	`Over Grid Image`	Заменяет это изображение изображением, указанным в предоставленном `Blob Source` .
`replace(url)`	`Over Grid Image`	Заменяет это изображение изображением по указанному URL.
`reset Size()`	`Over Grid Image`	Возвращает изображение к его собственным размерам.
`set Alt Text Description(description)`	`Over Grid Image`	Устанавливает альтернативное текстовое описание для этого изображения.
`set Alt Text Title(title)`	`Over Grid Image`	Устанавливает замещающий текстовый заголовок для этого изображения.
`set Anchor Cell(cell)`	`Over Grid Image`	Устанавливает ячейку, к которой привязано изображение.
`set Anchor Cell XOffset(offset)`	`Over Grid Image`	Устанавливает горизонтальное смещение пикселей от опорной ячейки.
`set Anchor Cell YOffset(offset)`	`Over Grid Image`	Устанавливает вертикальное смещение пикселей от опорной ячейки.
`set Height(height)`	`Over Grid Image`	Устанавливает фактическую высоту этого изображения в пикселях.
`set Width(width)`	`Over Grid Image`	Устанавливает фактическую ширину этого изображения в пикселях.

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

Метод	Тип возврата	Краткое описание
`get Url()`	`String`	Получает исходный URL-адрес изображения.

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

`assign Script(functionName)`

Назначает функцию с указанным именем функции этому изображению.

Параметры

Имя	Тип	Описание
`function Name`	`String`	Имя указанной функции. Это должна быть общедоступная функция верхнего уровня, а не функция, заканчивающаяся подчеркиванием, например, `private Function_` .

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

Over Grid Image — это изображение для объединения в цепочку.

Авторизация

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

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

`get Alt Text Description()`

Возвращает альтернативное текстовое описание для этого изображения.

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

String — описание альтернативного текста.

Авторизация

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

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

`get Alt Text Title()`

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

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

String — заголовок альтернативного текста.

Авторизация

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

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

`get Anchor Cell()`

Возвращает ячейку, к которой привязано изображение.

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

Range — ячейка привязки.

Авторизация

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

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

`get Anchor Cell XOffset()`

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

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

Integer — Горизонтальное смещение пикселя.

Авторизация

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

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

`get Anchor Cell YOffset()`

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

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

Integer — Смещение пикселя по вертикали.

Авторизация

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

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

`get Height()`

Возвращает фактическую высоту этого изображения в пикселях.

// Logs the height of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let 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

`get Inherent Height()`

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

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

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

Авторизация

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

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

`get Inherent Width()`

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

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

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

Авторизация

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

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

`get Script()`

Возвращает имя функции, назначенной этому изображению.

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

String — Имя функции.

Авторизация

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

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

`get Sheet()`

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

// Logs the parent sheet of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let 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

`get Width()`

Возвращает фактическую ширину этого изображения в пикселях.

// Logs the width of all images in a spreadsheet
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let 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
const images = SpreadsheetApp.getActiveSpreadsheet().getImages();
for (let i = 0; i < images.length; i++) {
  images[i].remove();
}

Авторизация

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

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

`replace(blob)`

Заменяет это изображение изображением, указанным в предоставленном Blob Source . Максимальный поддерживаемый размер большого двоичного объекта — 2 МБ.

Параметры

Имя	Тип	Описание
`blob`	`Blob Source`	Новое изображение в виде Blob.

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

Over Grid Image — это изображение для объединения в цепочку.

Авторизация

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

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

`replace(url)`

Заменяет это изображение изображением по указанному URL.

Параметры

Имя	Тип	Описание
`url`	`String`	URL-адрес нового изображения.

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

Over Grid Image — это изображение для объединения в цепочку.

Авторизация

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

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

`reset Size()`

Возвращает изображение к его собственным размерам.

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

Over Grid Image — это изображение для объединения в цепочку.

Авторизация

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

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

`set Alt Text Description(description)`

Устанавливает альтернативное текстовое описание для этого изображения.

Параметры

Имя	Тип	Описание
`description`	`String`	Новое альтернативное текстовое описание изображения.

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

Over Grid Image — это изображение для объединения в цепочку.

Авторизация

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

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

`set Alt Text Title(title)`

Устанавливает замещающий текстовый заголовок для этого изображения.

Параметры

Имя	Тип	Описание
`title`	`String`	Новый замещающий текстовый заголовок для изображения.

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

Over Grid Image — это изображение для объединения в цепочку.

Авторизация

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

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

`set Anchor Cell(cell)`

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

Параметры

Имя	Тип	Описание
`cell`	`Range`	Новая якорная ячейка.

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

Over Grid Image — это изображение для объединения в цепочку.

Авторизация

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

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

`set Anchor Cell XOffset(offset)`

Устанавливает горизонтальное смещение пикселей от опорной ячейки.

Параметры

Имя	Тип	Описание
`offset`	`Integer`	Новое смещение пикселей по горизонтали.

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

Over Grid Image — это изображение для объединения в цепочку.

Авторизация

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

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

`set Anchor Cell YOffset(offset)`

Устанавливает вертикальное смещение пикселей от опорной ячейки.

Параметры

Имя	Тип	Описание
`offset`	`Integer`	Новое вертикальное смещение пикселей.

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

Over Grid Image — это изображение для объединения в цепочку.

Авторизация

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

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

`set Height(height)`

Устанавливает фактическую высоту этого изображения в пикселях.

Параметры

Имя	Тип	Описание
`height`	`Integer`	Желаемая высота в пикселях.

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

Over Grid Image — изображение для объединения в цепочку.

Авторизация

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

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

`set Width(width)`

Устанавливает фактическую ширину этого изображения в пикселях.

Параметры

Имя	Тип	Описание
`width`	`Integer`	Желаемая ширина в пикселях.

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

Over Grid Image — изображение для объединения в цепочку.

Авторизация

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

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

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

`get Url()`

Устарело. Для большинства недавно вставленных изображений исходный URL-адрес недоступен.

Получает исходный URL-адрес изображения. Возвращает пустую строку, если URL-адрес недоступен. Для большинства вновь вставленных изображений исходный URL-адрес недоступен независимо от того, как вставлено изображение.

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

String — исходный URL-адрес изображения, если он доступен; в противном случае возвращает пустую строку.

Авторизация

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

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