Элемент, представляющий встроенное изображение. Inline Image
может содержаться внутри List Item
или Paragraph
, если только List Item
или Paragraph
не находится внутри Footnote Section
. Inline Image
само по себе не может содержать никаких других элементов. Подробнее о структуре документа см. в руководстве по расширению Google Docs .
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
copy() | Inline Image | Возвращает отдельную, глубокую копию текущего элемента. |
get Alt Description() | String | Возвращает альтернативное описание изображения. |
get Alt Title() | String | Возвращает альтернативное название изображения. |
get As(contentType) | Blob | Возвращает данные из этого объекта в виде двоичного двоичного объекта, преобразованного в указанный тип содержимого. |
get Attributes() | Object | Извлекает атрибуты элемента. |
get Blob() | Blob | Возвращает данные из этого объекта в виде большого двоичного объекта. |
get Height() | Integer | Возвращает высоту изображения в пикселях. |
get Link Url() | String | Возвращает URL-адрес ссылки. |
get Next Sibling() | Element | Возвращает следующий родственный элемент элемента. |
get Parent() | Container Element | Возвращает родительский элемент элемента. |
get Previous Sibling() | Element | Возвращает предыдущий родственный элемент элемента. |
get Type() | Element Type | Возвращает Element Type элемента. |
get Width() | Integer | Возвращает ширину изображения в пикселях. |
is At Document End() | Boolean | Определяет, находится ли элемент в конце Document . |
merge() | Inline Image | Объединяет элемент с предшествующим родственным элементом того же типа. |
remove From Parent() | Inline Image | Удаляет элемент из его родителя. |
set Alt Description(description) | Inline Image | Задает альтернативное описание изображения. |
set Alt Title(title) | Inline Image | Задает альтернативное название изображения. |
set Attributes(attributes) | Inline Image | Устанавливает атрибуты элемента. |
set Height(height) | Inline Image | Задает высоту изображения в пикселях. |
set Link Url(url) | Inline Image | Задает URL-адрес ссылки. |
set Width(width) | Inline Image | Задает ширину изображения в пикселях. |
Подробная документация
copy()
Возвращает отдельную, глубокую копию текущего элемента.
Все дочерние элементы, присутствующие в элементе, также копируются. У нового элемента нет родительского элемента.
Возвращаться
Inline Image
— новая копия.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Alt Description()
Возвращает альтернативное описание изображения.
Возвращаться
String
— альтернативное описание или null
, если элемент не имеет альтернативного описания.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Alt Title()
Возвращает альтернативное название изображения.
Возвращаться
String
— альтернативный заголовок или null
, если элемент не имеет альтернативного заголовка.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get As(contentType)
Возвращает данные из этого объекта в виде двоичного двоичного объекта, преобразованного в указанный тип контента. Этот метод добавляет соответствующее расширение к имени файла, например, "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.
get Attributes()
Извлекает атрибуты элемента.
Результатом является объект, содержащий свойство для каждого допустимого атрибута элемента, где каждое имя свойства соответствует элементу в перечислении Document App.Attribute
.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
Возвращаться
Object
— атрибуты элемента.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Blob()
Возвращает данные из этого объекта в виде большого двоичного объекта.
Возвращаться
Blob
— данные в виде blob.
get Height()
Возвращает высоту изображения в пикселях.
Возвращаться
Integer
— высота изображения в пикселях.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Link Url()
Возвращает URL-адрес ссылки.
Возвращаться
String
— URL-адрес ссылки или null
если элемент содержит несколько значений для этого атрибута.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Next Sibling()
Возвращает следующий родственный элемент элемента.
Следующий элемент имеет того же родителя и следует за текущим элементом.
Возвращаться
Element
— Следующий родственный элемент.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Parent()
Возвращает родительский элемент элемента.
Родительский элемент содержит текущий элемент.
Возвращаться
Container Element
— родительский элемент.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Previous Sibling()
Возвращает предыдущий родственный элемент элемента.
Предыдущий родственный элемент имеет того же родителя и предшествует текущему элементу.
Возвращаться
Element
— Предыдущий родственный элемент.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Type()
Возвращает Element Type
элемента.
Используйте get Type()
для определения точного типа заданного элемента.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Возвращаться
Element Type
— Тип элемента.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Width()
Возвращает ширину изображения в пикселях.
Возвращаться
Integer
— ширина изображения в пикселях.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is At Document End()
Определяет, находится ли элемент в конце Document
.
Возвращаться
Boolean
— находится ли элемент в конце вкладки.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Объединяет элемент с предшествующим родственным элементом того же типа.
Объединять можно только элементы одного Element Type
. Все дочерние элементы текущего элемента перемещаются в предшествующий родственный элемент.
Текущий элемент удаляется из документа.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
Возвращаться
Inline Image
— объединенный элемент.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove From Parent()
Удаляет элемент из его родителя.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Возвращаться
Inline Image
— удаленный элемент.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Alt Description(description)
Задаёт альтернативное описание изображения. Если заданное название — null
, задаёт описание пустой строкой.
Параметры
Имя | Тип | Описание |
---|---|---|
description | String | Альтернативное описание. |
Возвращаться
Inline Image
— текущий объект.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Alt Title(title)
Задаёт альтернативный заголовок изображения. Если заданный заголовок равен null
, задаёт заголовок пустой строкой.
Параметры
Имя | Тип | Описание |
---|---|---|
title | String | Альтернативное название. |
Возвращаться
Inline Image
— текущий объект.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Attributes(attributes)
Устанавливает атрибуты элемента.
Указанный параметр атрибутов должен быть объектом, где каждое имя свойства является элементом в перечислении Document App.Attribute
, а каждое значение свойства является новым значением, которое должно быть применено.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Параметры
Имя | Тип | Описание |
---|---|---|
attributes | Object | Атрибуты элемента. |
Возвращаться
Inline Image
— текущий элемент.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Height(height)
Задает высоту изображения в пикселях.
Параметры
Имя | Тип | Описание |
---|---|---|
height | Integer | высота изображения в пикселях |
Возвращаться
Inline Image
— текущий объект
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Link Url(url)
Задаёт URL-адрес ссылки. Если заданный URL-адрес — null
или пустая строка, этот метод создаёт ссылку с пустым URL-адресом, которая может отображаться в Google Docs как «Недопустимая ссылка».
Параметры
Имя | Тип | Описание |
---|---|---|
url | String | URL-адрес ссылки. |
Возвращаться
Inline Image
— текущий объект.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Width(width)
Задает ширину изображения в пикселях.
Параметры
Имя | Тип | Описание |
---|---|---|
width | Integer | ширина изображения в пикселях |
Возвращаться
Inline Image
— текущий объект
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents