Элемент, представляющий горизонтальную линию. HorizontalRule может содержаться внутри ListItem или Paragraph , но сам по себе не может содержать никаких других элементов. Для получения дополнительной информации о структуре документа см. руководство по расширению Google Docs .
Методы
| Метод | Тип возвращаемого значения | Краткое описание |
|---|---|---|
copy() | Horizontal Rule | Возвращает отсоединенную, глубокую копию текущего элемента. |
get Attributes() | Object | Получает атрибуты элемента. |
get Next Sibling() | Element |null | Получает следующий соседний элемент. |
get Parent() | Container Element |null | Получает родительский элемент элемента. |
get Previous Sibling() | Element |null | Получает предыдущий соседний элемент. |
get Type() | Element Type | Получает Element Type элемента. |
is At Document End() | Boolean | Определяет, находится ли элемент в конце Document . |
remove From Parent() | Horizontal Rule |null | Удаляет элемент из родительского элемента. |
set Attributes(attributes) | Horizontal Rule | Задает атрибуты элемента. |
Подробная документация
copy()
Возвращает отсоединенную, глубокую копию текущего элемента.
Все дочерние элементы, присутствующие в новом элементе, также копируются. У нового элемента нет родителя.
Возвращаться
HorizontalRule — Новая версия.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getAttributes()
Получает атрибуты элемента.
В результате получается объект, содержащий свойство для каждого допустимого атрибута элемента, где каждое имя свойства соответствует элементу в перечислении DocumentApp.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
getNextSibling()
Получает следующий соседний элемент.
Следующий элемент-близнец имеет того же родителя и следует за текущим элементом.
Возвращаться
Element |null — Следующий соседний элемент.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getParent()
Получает родительский элемент элемента.
Родительский элемент содержит текущий элемент.
Возвращаться
ContainerElement |null — Родительский элемент.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPreviousSibling()
Получает предыдущий соседний элемент.
Предыдущий соседний элемент имеет того же родителя и предшествует текущему элементу.
Возвращаться
Element |null — Предыдущий соседний элемент.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getType()
Получает тип элемента ElementType ).
Используйте getType() для определения точного типа заданного элемента.
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.'); }
Возвращаться
ElementType — Тип элемента.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Определяет, находится ли элемент в конце Document .
Возвращаться
Boolean — указывает, находится ли элемент в конце вкладки.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
removeFromParent()
Удаляет элемент из родительского элемента.
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(); }
Возвращаться
HorizontalRule |null — Удалённый элемент.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Задает атрибуты элемента.
Указанный параметр attributes должен представлять собой объект, где каждое имя свойства является элементом перечисления DocumentApp.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 | Атрибуты элемента. |
Возвращаться
HorizontalRule — Текущий элемент.
Авторизация
Для скриптов, использующих этот метод, требуется авторизация в одной или нескольких из следующих областей действия :
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents