Interface Element

Элемент

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

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

Имя Краткое описание
Body Содержимое вкладки в документе Google Docs.
Container Element Обобщенный элемент, который может содержать другие элементы.
Date Элемент, представляющий отформатированную дату.
Equation Элемент, представляющий математическое выражение.
Equation Function Элемент, представляющий функцию в математическом Equation .
Equation Function Argument Separator Элемент, представляющий собой разделитель функций в математическом Equation .
Equation Symbol Элемент, представляющий собой символ в математическом Equation .
Footer Section Элемент, представляющий собой нижний колонтитул.
Footnote Элемент, представляющий собой сноску.
Footnote Section Элемент, представляющий собой раздел сносок.
Header Section Элемент, представляющий собой раздел заголовка.
Horizontal Rule Элемент, представляющий собой горизонтальную линию.
Inline Drawing Элемент, представляющий собой встроенный рисунок.
Inline Image Элемент, представляющий собой встроенное изображение.
List Item Элемент, представляющий собой элемент списка.
Page Break Элемент, обозначающий разрыв страницы.
Paragraph Элемент, представляющий собой абзац.
Person Элемент, представляющий собой ссылку на человека.
Rich Link Элемент, представляющий собой ссылку на ресурс Google, например, на файл в Google Диска или видео на YouTube.
Table Элемент, представляющий собой таблицу.
Table Cell Элемент, представляющий ячейку таблицы.
Table Of Contents Элемент, содержащий оглавление.
Table Row Элемент, представляющий собой строку таблицы.
Text Элемент, представляющий собой область с расширенным текстовым содержимым.
Unsupported Element Элемент, представляющий собой область, которая неизвестна или не может быть затронута скриптом, например, номер страницы.

Методы

Метод Тип возвращаемого значения Краткое описание
as Body() Body Возвращает текущий элемент в виде Body .
as Date() Date Возвращает текущий элемент в виде Date .
as Equation() Equation Возвращает текущий элемент в виде Equation .
as Equation Function() Equation Function Возвращает текущий элемент в виде Equation Function .
as Equation Function Argument Separator() Equation Function Argument Separator Возвращает текущий элемент в виде Equation Function Argument Separator .
as Equation Symbol() Equation Symbol Возвращает текущий элемент в виде Equation Symbol .
as Footer Section() Footer Section Возвращает текущий элемент в качестве Footer Section .
as Footnote() Footnote Возвращает текущий элемент в виде Footnote .
as Footnote Section() Footnote Section Возвращает текущий элемент в виде Footnote Section .
as Header Section() Header Section Возвращает текущий элемент в виде Header Section .
as Horizontal Rule() Horizontal Rule Возвращает текущий элемент в виде Horizontal Rule .
as Inline Drawing() Inline Drawing Возвращает текущий элемент в виде Inline Drawing .
as Inline Image() Inline Image Возвращает текущий элемент в виде Inline Image .
as List Item() List Item Возвращает текущий элемент в виде List Item .
as Page Break() Page Break Возвращает текущий элемент в качестве Page Break .
as Paragraph() Paragraph Возвращает текущий элемент в виде Paragraph .
as Person() Person Возвращает текущий элемент в виде Person .
as Rich Link() Rich Link Возвращает текущий элемент в виде Rich Link , например, ссылку на файл Google Sheets.
as Table() Table Возвращает текущий элемент в виде Table .
as Table Cell() Table Cell Возвращает текущий элемент в виде Table Cell .
as Table Of Contents() Table Of Contents Возвращает текущий элемент в виде Table Of Contents .
as Table Row() Table Row Возвращает текущий элемент в виде Table Row .
as Text() Text Возвращает текущий элемент в виде Text .
copy() Element Возвращает отсоединенную, глубокую копию текущего элемента.
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 .
merge() Element |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove From Parent() Element |null Удаляет элемент из родительского элемента.
set Attributes(attributes) Element Задает атрибуты элемента.

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

asBody()

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

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

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

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

Авторизация

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

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

asDate()

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

Если вы знаете, что элемент имеет Date , используйте этот метод, чтобы установить его тип как Date . Это позволит функции автозаполнения в редакторе Apps Script показывать вам методы, которые можно использовать с 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. Это позволит функции автозаполнения в редакторе Apps Script показывать вам методы, которые можно использовать с элементом типа Person.

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

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

Авторизация

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

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

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

Если вы знаете, что элемент является RichLink , используйте этот метод, чтобы установить его тип как RichLink . Это позволит функции автозаполнения в редакторе Apps Script показывать вам методы, которые можно использовать с 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 .

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

merge()

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

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

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

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();

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

Element |null — Объединенный элемент.

Авторизация

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

  • 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();
}

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

Element |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 Атрибуты элемента.

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

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

Авторизация

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

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