Элемент, представляющий встроенный рисунок. Inline Drawing может содержаться внутри List Item или Paragraph , если только List Item или Paragraph не находится внутри Footnote Section . Inline Drawing сам по себе не может содержать никаких других элементов. Подробнее о структуре документа см. в руководстве по расширению Google Docs .
Методы
| Метод | Тип возврата | Краткое описание |
|---|---|---|
copy() | Inline Drawing | Возвращает отдельную, глубокую копию текущего элемента. |
get Alt Description() | String | Возвращает альтернативное описание чертежа. |
get Alt Title() | String | Возвращает альтернативное название рисунка. |
get Attributes() | Object | Извлекает атрибуты элемента. |
get Next Sibling() | Element | Возвращает следующий родственный элемент элемента. |
get Parent() | Container Element | Возвращает родительский элемент элемента. |
get Previous Sibling() | Element | Возвращает предыдущий родственный элемент элемента. |
get Type() | Element Type | Возвращает Element Type элемента. |
is At Document End() | Boolean | Определяет, находится ли элемент в конце Document . |
merge() | Inline Drawing | Объединяет элемент с предшествующим родственным элементом того же типа. |
remove From Parent() | Inline Drawing | Удаляет элемент из его родителя. |
set Alt Description(description) | Inline Drawing | Задает альтернативное описание чертежа. |
set Alt Title(title) | Inline Drawing | Задает альтернативное название чертежа. |
set Attributes(attributes) | Inline Drawing | Устанавливает атрибуты элемента. |
Подробная документация
copy()
Возвращает отдельную, глубокую копию текущего элемента.
Все дочерние элементы, присутствующие в элементе, также копируются. У нового элемента нет родительского элемента.
Возвращаться
Inline Drawing — новая копия.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
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 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 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
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 Drawing — объединенный элемент.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
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 Drawing — Удаленный элемент.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Alt Description(description)
Задаёт альтернативное описание чертежа. Если заданное описание равно null , задаёт пустую строку.
Параметры
| Имя | Тип | Описание |
|---|---|---|
description | String | Альтернативное описание. |
Возвращаться
Inline Drawing — текущий объект.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Alt Title(title)
Задаёт альтернативное название чертежа. Если заданное название равно null , задаёт название пустой строкой.
Параметры
| Имя | Тип | Описание |
|---|---|---|
title | String | Альтернативное название. |
Возвращаться
Inline Drawing — текущий объект.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
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 Drawing — текущий элемент.
Авторизация
Скрипты, использующие этот метод, требуют авторизации в одной или нескольких из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents