Interface Element

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Элемент

Общий элемент. Содержимое Document представлено в виде элементов. Например, ListItem , Paragraph и Table являются элементами и наследуют все методы, определенные Element , такие как getType() .

Реализация классов

Имя Краткое описание
Body Элемент, представляющий тело документа.
ContainerElement Общий элемент, который может содержать другие элементы.
Date Элемент, представляющий отформатированную дату
Equation Элемент, представляющий математическое выражение.
EquationFunction Элемент, представляющий функцию в математическом Equation .
EquationFunctionArgumentSeparator Элемент, представляющий разделитель функций в математическом Equation .
EquationSymbol Элемент, представляющий символ в математическом Equation .
FooterSection Элемент, представляющий раздел нижнего колонтитула.
Footnote Элемент, представляющий сноску.
FootnoteSection Элемент, представляющий раздел сноски.
HeaderSection Элемент, представляющий раздел заголовка.
HorizontalRule Элемент, представляющий горизонтальную линейку.
InlineDrawing Элемент, представляющий встроенный чертеж.
InlineImage Элемент, представляющий встроенное изображение.
ListItem Элемент, представляющий элемент списка.
PageBreak Элемент, представляющий разрыв страницы.
Paragraph Элемент, представляющий абзац.
Person Элемент, представляющий ссылку на человека.
RichLink Элемент, представляющий ссылку на ресурс Google, например файл на Диске или видео на YouTube.
Table Элемент, представляющий таблицу.
TableCell Элемент, представляющий ячейку таблицы.
TableOfContents Элемент, содержащий оглавление.
TableRow Элемент, представляющий строку таблицы.
Text Элемент, представляющий область форматированного текста.
UnsupportedElement Элемент, представляющий область, которая неизвестна или не может быть затронута сценарием, например номер страницы.

Методы

Метод Тип возврата Краткое описание
asBody() Body Возвращает текущий элемент как Body .
asDate() Date Возвращает текущий элемент как Date .
asEquation() Equation Возвращает текущий элемент в виде Equation .
asEquationFunction() EquationFunction Возвращает текущий элемент как EquationFunction .
asEquationFunctionArgumentSeparator() EquationFunctionArgumentSeparator Возвращает текущий элемент в виде EquationFunctionArgumentSeparator .
asEquationSymbol() EquationSymbol Возвращает текущий элемент в виде EquationSymbol .
asFooterSection() FooterSection Возвращает текущий элемент в виде FooterSection .
asFootnote() Footnote Возвращает текущий элемент в виде Footnote .
asFootnoteSection() FootnoteSection Возвращает текущий элемент в виде FootnoteSection .
asHeaderSection() HeaderSection Возвращает текущий элемент в виде HeaderSection .
asHorizontalRule() HorizontalRule Возвращает текущий элемент как HorizontalRule .
asInlineDrawing() InlineDrawing Возвращает текущий элемент как InlineDrawing .
asInlineImage() InlineImage Возвращает текущий элемент как InlineImage .
asListItem() ListItem Возвращает текущий элемент как ListItem .
asPageBreak() PageBreak Возвращает текущий элемент как PageBreak .
asParagraph() Paragraph Возвращает текущий элемент как Paragraph .
asPerson() Person Возвращает текущий элемент как Person .
asRichLink() RichLink Возвращает текущий элемент в виде RichLink , например, ссылку на файл Google Sheets.
asTable() Table Возвращает текущий элемент в виде Table .
asTableCell() TableCell Возвращает текущий элемент в виде TableCell .
asTableOfContents() TableOfContents Возвращает текущий элемент как TableOfContents .
asTableRow() TableRow Возвращает текущий элемент в виде TableRow .
asText() Text Возвращает текущий элемент в виде Text .
copy() Element Возвращает отдельную, глубокую копию текущего элемента.
getAttributes() Object Извлекает атрибуты элемента.
getNextSibling() Element Извлекает следующий одноуровневый элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Извлекает ElementType элемента.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() Element Объединяет элемент с предыдущим элементом того же типа.
removeFromParent() Element Удаляет элемент из его родителя.
setAttributes(attributes) Element Задает атрибуты элемента.

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

asBody()

Возвращает текущий элемент как Body .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

Body — Текущий элемент.

Авторизация

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

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

asDate()

Возвращает текущий элемент как Date .

Когда вы знаете, что элемент является Date , используйте этот метод, чтобы установить его тип как Date . Это позволяет автозаполнению в редакторе сценариев приложений показать вам методы, которые вы можете использовать с Date .

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

Date — Текущий элемент с установленным типом Date .

Авторизация

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

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

asEquation()

Возвращает текущий элемент в виде Equation .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

Equation — Текущий элемент.

Авторизация

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

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

asEquationFunction()

Возвращает текущий элемент как EquationFunction .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

EquationFunction — Текущий элемент.

Авторизация

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

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

asEquationFunctionArgumentSeparator()

Возвращает текущий элемент в виде EquationFunctionArgumentSeparator .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

EquationFunctionArgumentSeparator — Текущий элемент.

Авторизация

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

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

asEquationSymbol()

Возвращает текущий элемент в виде EquationSymbol .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

EquationSymbol — Текущий элемент.

Авторизация

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

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

asFooterSection()

Возвращает текущий элемент в виде FooterSection .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

FooterSection — Текущий элемент.

Авторизация

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

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

asFootnote()

Возвращает текущий элемент в виде Footnote .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

Footnote — Текущий элемент.

Авторизация

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

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

asFootnoteSection()

Возвращает текущий элемент в виде FootnoteSection .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

FootnoteSection — Текущий элемент.

Авторизация

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

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

asHeaderSection()

Возвращает текущий элемент в виде HeaderSection .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

HeaderSection — Текущий элемент.

Авторизация

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

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

asHorizontalRule()

Возвращает текущий элемент как HorizontalRule .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

HorizontalRule — Текущий элемент.

Авторизация

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

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

asInlineDrawing()

Возвращает текущий элемент как InlineDrawing .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

InlineDrawing — Текущий элемент.

Авторизация

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

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

asInlineImage()

Возвращает текущий элемент как InlineImage .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

InlineImage — Текущий элемент.

Авторизация

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

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

asListItem()

Возвращает текущий элемент как ListItem .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

ListItem — Текущий элемент.

Авторизация

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

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

asPageBreak()

Возвращает текущий элемент как PageBreak .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

PageBreak — Текущий элемент.

Авторизация

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

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

asParagraph()

Возвращает текущий элемент как Paragraph .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

Paragraph — текущий элемент.

Авторизация

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

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

asPerson()

Возвращает текущий элемент как Person .

Когда вы знаете, что элемент является Person , используйте этот метод, чтобы установить его тип как человека. Это позволяет автозаполнению в редакторе сценариев приложений показать вам методы, которые вы можете использовать с элементом человека.

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

Person — Текущий элемент с установленным типом Person .

Авторизация

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

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

Возвращает текущий элемент в виде RichLink , например, ссылку на файл Google Sheets.

Когда вы знаете, что элемент является RichLink , используйте этот метод, чтобы установить его тип как RichLink . Это позволяет автозаполнению в редакторе сценариев приложений показать вам методы, которые вы можете использовать с RichLink .

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

RichLink — Текущий элемент с установленным типом RichLink .

Авторизация

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

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

asTable()

Возвращает текущий элемент в виде Table .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

Table — Текущий элемент.

Авторизация

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

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

asTableCell()

Возвращает текущий элемент в виде TableCell .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

TableCell — Текущий элемент.

Авторизация

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

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

asTableOfContents()

Возвращает текущий элемент как TableOfContents .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

TableOfContents — Текущий элемент.

Авторизация

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

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

asTableRow()

Возвращает текущий элемент в виде TableRow .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

TableRow — текущий элемент.

Авторизация

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

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

asText()

Возвращает текущий элемент в виде Text .

Используйте этот метод, чтобы помочь автозаполнению, когда известно, что данный элемент относится к определенному типу.

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

Text — Текущий элемент.

Авторизация

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

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

copy()

Возвращает отдельную, глубокую копию текущего элемента.

Любые дочерние элементы, присутствующие в элементе, также копируются. Новый элемент не имеет родителя.

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

Element — Новая копия.

Авторизация

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

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

getAttributes()

Извлекает атрибуты элемента.

Результатом является объект, содержащий свойство для каждого допустимого атрибута элемента, где имя каждого свойства соответствует элементу в перечислении DocumentApp.Attribute .

var body = DocumentApp.getActiveDocument().getBody();

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

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

Object — атрибуты элемента.

Авторизация

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

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

getNextSibling()

Извлекает следующий одноуровневый элемент элемента.

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

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

Element — следующий одноуровневый элемент.

Авторизация

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

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

getParent()

Извлекает родительский элемент элемента.

Родительский элемент содержит текущий элемент.

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

ContainerElement — родительский элемент.

Авторизация

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

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

getPreviousSibling()

Извлекает предыдущий родственный элемент элемента.

Предыдущий родственный элемент имеет того же родителя и предшествует текущему элементу.

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

Element — предыдущий одноуровневый элемент.

Авторизация

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

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

getType()

Извлекает ElementType элемента.

Используйте getType() , чтобы определить точный тип данного элемента.

var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document body.

var 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

merge()

Объединяет элемент с предыдущим элементом того же типа.

Объединять можно только элементы одного и того же ElementType . Любые дочерние элементы, содержащиеся в текущем элементе, перемещаются в предыдущий родственный элемент.

Текущий элемент удаляется из документа.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var 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.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

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

Element — объединенный элемент.

Авторизация

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

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

removeFromParent()

Удаляет элемент из его родителя.

var body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

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

Element — удаленный элемент.

Авторизация

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

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

setAttributes(attributes)

Задает атрибуты элемента.

Указанный параметр атрибутов должен быть объектом, где каждое имя свойства является элементом в перечислении DocumentApp.Attribute , а каждое значение свойства является новым применяемым значением.

var body = DocumentApp.getActiveDocument().getBody();

// Define a custom paragraph style.
var 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.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Параметры

Имя Тип Описание
attributes Object Атрибуты элемента.

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

Element — Текущий элемент.

Авторизация

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

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