Interface Element

Элемент

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

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

Имя Краткое описание
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, например файл на Диске или видео 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 Извлекает следующий родственный элемент элемента.
get Parent() Container Element Извлекает родительский элемент элемента.
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Type() Element Type Получает Element Type элемента.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Element Объединяет элемент с предыдущим одноуровневым элементом того же типа.
remove From Parent() Element Удаляет элемент из его родителя.
set Attributes(attributes) Element Устанавливает атрибуты элемента.

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

as Body()

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

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

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

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

Авторизация

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

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

as Date()

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

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

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

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

Авторизация

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

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

as Equation()

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

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

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

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

Авторизация

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

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

as Equation Function()

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

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

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

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

Авторизация

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

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

as Equation Function Argument Separator()

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

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

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

Equation Function Argument Separator — текущий элемент.

Авторизация

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

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

as Equation Symbol()

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

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

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

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

Авторизация

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

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

as Footer Section()

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

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

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

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

Авторизация

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

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

as Footnote()

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

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

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

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

Авторизация

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

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

as Footnote Section()

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

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

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

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

Авторизация

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

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

as Header Section()

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

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

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

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

Авторизация

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

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

as Horizontal Rule()

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

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

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

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

Авторизация

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

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

as Inline Drawing()

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

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

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

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

Авторизация

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

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

as Inline Image()

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

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

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

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

Авторизация

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

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

as List Item()

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

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

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

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

Авторизация

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

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

as Page Break()

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

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

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

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

Авторизация

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

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

as Paragraph()

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

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

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

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

Авторизация

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

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

as Person()

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

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

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

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

Авторизация

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

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

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

Если вы знаете, что элемент является Rich Link , используйте этот метод, чтобы установить его тип как Rich Link . Это позволит автозаполнению в редакторе Apps Script показать вам методы, которые можно использовать с Rich Link .

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

Rich Link — текущий элемент с типом Rich Link .

Авторизация

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

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

as Table()

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

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

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

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

Авторизация

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

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

as Table Cell()

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

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

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

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

Авторизация

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

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

as Table Of Contents()

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

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

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

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

Авторизация

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

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

as Table Row()

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

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

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

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

Авторизация

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

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

as Text()

Возвращает текущий элемент как 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

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

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

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

Авторизация

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

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

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

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

Авторизация

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

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

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

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

Авторизация

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

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