Class PositionedImage

PositionedImage

Изображение с фиксированным положением, привязанное к Paragraph . В отличие InlineImage , PositionedImage не является Element . У него нет родительского или соседнего Element . Вместо этого оно привязано к Paragraph или ListItem и размещается с помощью смещений относительно этой привязки. PositionedImage имеет идентификатор, который можно использовать для ссылки на него.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a new paragraph.
const paragraph = body.appendParagraph('New paragraph to anchor the image to.');

// Get an image in Drive from its ID.
const image = DriveApp.getFileById('ENTER_IMAGE_FILE_ID_HERE').getBlob();

// Add the PositionedImage with offsets (in points).
const posImage =
    paragraph.addPositionedImage(image).setTopOffset(60).setLeftOffset(40);

Методы

Метод Тип возвращаемого значения Краткое описание
get As(contentType) Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob), преобразованных в указанный тип содержимого.
get Blob() Blob Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob).
get Height() Integer Извлекает высоту изображения в пикселях.
get Id() String Получает идентификатор изображения.
get Layout() Positioned Layout Получает значение перечисления, описывающее способ размещения изображения.
get Left Offset() Number Определяет смещение изображения в пунктах относительно левого края абзаца.
get Paragraph() Paragraph Получает Paragraph к которому привязано изображение.
get Top Offset() Number Получает смещение изображения в пунктах от начала абзаца.
get Width() Integer Получает ширину изображения в пикселях.
set Height(height) Positioned Image Задает высоту изображения в пикселях.
set Layout(layout) Positioned Image Задает параметры компоновки изображения.
set Left Offset(offset) Positioned Image Задает смещение изображения в пунктах от левого края абзаца.
set Top Offset(offset) Positioned Image Задает смещение изображения в пунктах от верхней части абзаца.
set Width(width) Positioned Image Задает ширину изображения в пикселях.

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

getAs(contentType)

Возвращает данные из этого объекта в виде двоичных данных (blob), преобразованных в указанный тип содержимого. Этот метод добавляет соответствующее расширение к имени файла — например, "myfile.pdf". Однако он предполагает, что часть имени файла, следующая за последней точкой (если таковая имеется), является существующим расширением, которое следует заменить. Следовательно, "ShoppingList.12.25.2014" становится "ShoppingList.12.25.pdf".

Чтобы просмотреть ежедневные квоты на конверсии, см. раздел «Квоты для сервисов Google» . На вновь созданные домены Google Workspace могут временно распространяться более строгие квоты.

Параметры

Имя Тип Описание
content Type String MIME-тип для преобразования. Для большинства файлов .blob единственным допустимым вариантом является 'application/pdf' . Для изображений в форматах BMP, GIF, JPEG или PNG также допустимы любые из 'image/bmp' , 'image/gif' , 'image/jpeg' или 'image/png' . Для документа Google Docs также допустим 'text/markdown' .

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

Blob — Данные в виде двоичных данных (blob).

getBlob()

Возвращает данные, содержащиеся в этом объекте, в виде двоичных данных (blob).

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

Blob — Данные в виде двоичных данных (blob).

getHeight()

Извлекает высоту изображения в пикселях.

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

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

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getId()

Получает идентификатор изображения.

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

String — идентификатор изображения

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getLayout()

Получает значение перечисления, описывающее способ размещения изображения.

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

PositionedLayout — макет изображения

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getLeftOffset()

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

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

Number — смещение изображения относительно левого края абзаца.

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getParagraph()

Получает Paragraph к которому привязано изображение.

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

Paragraph — родительский абзац

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTopOffset()

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

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

Number — смещение изображения относительно верхней части левого абзаца.

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getWidth()

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

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

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

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setHeight(height)

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

Параметры

Имя Тип Описание
height Integer высота изображения в пикселях

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

PositionedImage — текущий объект

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setLayout(layout)

Задает параметры компоновки изображения.

Параметры

Имя Тип Описание
layout Positioned Layout перечисление, представляющее режим компоновки

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

PositionedImage — этот объект используется для создания цепочек вызовов.

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setLeftOffset(offset)

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

Параметры

Имя Тип Описание
offset Number смещен слева от абзаца

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

PositionedImage — этот объект используется для создания цепочек вызовов.

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setTopOffset(offset)

Задает смещение изображения в пунктах от верхней части абзаца.

Параметры

Имя Тип Описание
offset Number смещен относительно верхней части абзаца

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

PositionedImage — этот объект используется для создания цепочек вызовов.

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setWidth(width)

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

Параметры

Имя Тип Описание
width Integer ширина изображения в пикселях

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

PositionedImage — текущий объект

Авторизация

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

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents