Элемент, представляющий элемент списка. List Item
— это Paragraph
, связанный с идентификатором списка. List Item
может содержать элементы Equation
, Footnote
, Horizontal Rule
, Inline Drawing
, Inline Image
, Page Break
» и Text
. Дополнительную информацию о структуре документа см. в руководстве по расширению Google Docs .
List Items
не могут содержать символы новой строки. Символы новой строки («\n») преобразуются в символы разрыва строки («\r»).
List Items
с одинаковым идентификатором списка принадлежат к одному и тому же списку и имеют соответствующую нумерацию. List Items
для данного списка не обязательно должны располагаться рядом на вкладке или даже иметь один и тот же родительский элемент. Два элемента, принадлежащие одному и тому же списку, могут находиться в любом месте вкладки, сохраняя при этом последовательную нумерацию, как показано в следующем примере:
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a new list item to the body. const item1 = body.appendListItem('Item 1'); // Log the new list item's list ID. Logger.log(item1.getListId()); // Append a table after the list item. body.appendTable([['Cell 1', 'Cell 2']]); // Append a second list item with the same list ID. The two items are treated as // the same list, despite not being consecutive. const item2 = body.appendListItem('Item 2'); item2.setListId(item1);
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
add Positioned Image(image) | Positioned Image | Создает и вставляет новое Positioned Image из указанного BLOB-объекта изображения. |
append Horizontal Rule() | Horizontal Rule | Создает и добавляет новое Horizontal Rule . |
append Inline Image(image) | Inline Image | Создает и добавляет новое Inline Image из указанного BLOB-объекта изображения. |
append Inline Image(image) | Inline Image | Добавляет данное Inline Image . |
append Page Break() | Page Break | Создает и добавляет новый Page Break . |
append Page Break(pageBreak) | Page Break | Добавляет заданный Page Break . |
append Text(text) | Text | Создает и добавляет новый элемент Text с указанным содержимым. |
append Text(text) | Text | Добавляет заданный элемент Text . |
clear() | List Item | Очищает содержимое элемента. |
copy() | List Item | Возвращает отдельную глубокую копию текущего элемента. |
edit As Text() | Text | Получает Text версию текущего элемента для редактирования. |
find Element(elementType) | Range Element | Ищет в содержимом элемента потомка указанного типа. |
find Element(elementType, from) | Range Element | Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element . |
find Text(searchPattern) | Range Element | Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений. |
find Text(searchPattern, from) | Range Element | Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска. |
get Alignment() | Horizontal Alignment | Получает Horizontal Alignment . |
get Attributes() | Object | Получает атрибуты элемента. |
get Child(childIndex) | Element | Извлекает дочерний элемент по указанному дочернему индексу. |
get Child Index(child) | Integer | Получает дочерний индекс для указанного дочернего элемента. |
get Glyph Type() | Glyph Type | Получает Glyph Type элемента списка. |
get Heading() | Paragraph Heading | Получает Paragraph Heading . |
get Indent End() | Number | Получает конечный отступ в пунктах. |
get Indent First Line() | Number | Получает отступ первой строки в пунктах. |
get Indent Start() | Number | Получает начальный отступ. |
get Line Spacing() | Number | Получает межстрочный интервал в пунктах. |
get Link Url() | String | Получает URL-адрес ссылки. |
get List Id() | String | Получает идентификатор списка. |
get Nesting Level() | Integer | Получает уровень вложенности элемента списка. |
get Next Sibling() | Element | Извлекает следующий родственный элемент элемента. |
get Num Children() | Integer | Получает количество детей. |
get Parent() | Container Element | Извлекает родительский элемент элемента. |
get Positioned Image(id) | Positioned Image | Получает Positioned Image по идентификатору изображения. |
get Positioned Images() | Positioned Image[] | Получает все объекты Positioned Image привязанные к абзацу. |
get Previous Sibling() | Element | Извлекает предыдущий родственный элемент элемента. |
get Spacing After() | Number | Получает расстояние после элемента в пунктах. |
get Spacing Before() | Number | Получает расстояние перед элементом в пунктах. |
get Text() | String | Извлекает содержимое элемента в виде текстовой строки. |
get Text Alignment() | Text Alignment | Получает выравнивание текста. |
get Type() | Element Type | Получает Element Type элемента. |
insert Horizontal Rule(childIndex) | Horizontal Rule | Создает и вставляет Horizontal Rule по указанному индексу. |
insert Inline Image(childIndex, image) | Inline Image | Создает и вставляет новое Inline Image из указанного большого двоичного объекта изображения по указанному индексу. |
insert Inline Image(childIndex, image) | Inline Image | Вставляет заданное Inline Image по указанному индексу. |
insert Page Break(childIndex) | Page Break | Создает и вставляет новый Page Break по указанному индексу. |
insert Page Break(childIndex, pageBreak) | Page Break | Вставляет заданный Page Break по указанному индексу. |
insert Text(childIndex, text) | Text | Создает и вставляет новый текстовый элемент по указанному индексу. |
insert Text(childIndex, text) | Text | Вставляет заданный элемент Text по указанному индексу с указанным текстовым содержимым. |
is At Document End() | Boolean | Определяет, находится ли элемент в конце Document . |
is Left To Right() | Boolean | Получает настройку слева направо. |
merge() | List Item | Объединяет элемент с предыдущим одноуровневым элементом того же типа. |
remove Child(child) | List Item | Удаляет указанный дочерний элемент. |
remove From Parent() | List Item | Удаляет элемент из его родителя. |
remove Positioned Image(id) | Boolean | Удаляет Positioned Image по идентификатору изображения. |
replace Text(searchPattern, replacement) | Element | Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения. |
set Alignment(alignment) | List Item | Устанавливает Horizontal Alignment . |
set Attributes(attributes) | List Item | Устанавливает атрибуты элемента. |
set Glyph Type(glyphType) | List Item | Устанавливает Glyph Type элемента списка. |
set Heading(heading) | List Item | Устанавливает Paragraph Heading . |
set Indent End(indentEnd) | List Item | Устанавливает конечный отступ в пунктах. |
set Indent First Line(indentFirstLine) | List Item | Устанавливает отступ первой строки в пунктах. |
set Indent Start(indentStart) | List Item | Устанавливает начальный отступ в пунктах. |
set Left To Right(leftToRight) | List Item | Устанавливает настройку слева направо. |
set Line Spacing(multiplier) | List Item | Устанавливает межстрочный интервал как величину, указывающую количество строк, используемых в качестве интервала. |
set Link Url(url) | List Item | Устанавливает URL-адрес ссылки. |
set List Id(listItem) | List Item | Устанавливает идентификатор списка. |
set Nesting Level(nestingLevel) | List Item | Устанавливает уровень вложенности элемента списка. |
set Spacing After(spacingAfter) | List Item | Устанавливает интервал после элемента в пунктах. |
set Spacing Before(spacingBefore) | List Item | Устанавливает интервал перед элементом в пунктах. |
set Text(text) | void | Устанавливает содержимое элемента списка в виде текста. |
set Text Alignment(textAlignment) | List Item | Устанавливает выравнивание текста. |
Подробная документация
add Positioned Image(image)
Создает и вставляет новое Positioned Image
из указанного BLOB-объекта изображения.
Параметры
Имя | Тип | Описание |
---|---|---|
image | Blob Source | данные изображения |
Возвращаться
Positioned Image
— новое позиционированное изображение.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Horizontal Rule()
Создает и добавляет новое Horizontal Rule
.
Возвращаться
Horizontal Rule
— новое горизонтальное правило
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Inline Image(image)
Создает и добавляет новое Inline Image
из указанного BLOB-объекта изображения.
Параметры
Имя | Тип | Описание |
---|---|---|
image | Blob Source | данные изображения |
Возвращаться
Inline Image
— добавленное изображение.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Inline Image(image)
Добавляет данное Inline Image
.
Параметры
Имя | Тип | Описание |
---|---|---|
image | Inline Image | данные изображения |
Возвращаться
Inline Image
— добавленное изображение.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Page Break()
Создает и добавляет новый Page Break
.
Примечание. Page Breaks
не могут содержаться в Table Cells
. Если текущий элемент содержится в ячейке таблицы, будет выдано исключение.
Возвращаться
Page Break
— новый элемент разрыва страницы.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Page Break(pageBreak)
Добавляет заданный Page Break
.
Примечание. Page Breaks
не могут содержаться в Table Cells
. Если текущий элемент содержится в ячейке таблицы, будет выдано исключение.
Параметры
Имя | Тип | Описание |
---|---|---|
page Break | Page Break | разрыв страницы для добавления |
Возвращаться
Page Break
— добавленный элемент разрыва страницы.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Text(text)
Создает и добавляет новый элемент Text
с указанным содержимым.
Параметры
Имя | Тип | Описание |
---|---|---|
text | String | текстовое содержимое |
Возвращаться
Text
— новый текстовый элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Text(text)
Добавляет заданный элемент Text
.
Параметры
Имя | Тип | Описание |
---|---|---|
text | Text | текстовый элемент для добавления |
Возвращаться
Text
— добавленный текстовый элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
Возвращает отдельную глубокую копию текущего элемента.
Любые дочерние элементы, присутствующие в элементе, также копируются. У нового элемента нет родителя.
Возвращаться
List Item
— новая копия.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
edit As Text()
Получает Text
версию текущего элемента для редактирования.
Используйте edit As Text
для управления содержимым элементов в виде форматированного текста. Режим edit As Text
игнорирует нетекстовые элементы (такие как Inline Image
и Horizontal Rule
).
Дочерние элементы, полностью содержащиеся в удаленном текстовом диапазоне, удаляются из элемента.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Возвращаться
Text
— текстовая версия текущего элемента.
find Element(elementType)
Ищет в содержимом элемента потомка указанного типа.
Параметры
Имя | Тип | Описание |
---|---|---|
element Type | Element Type | Тип элемента для поиска. |
Возвращаться
Range Element
— результат поиска, указывающий положение элемента поиска.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Element(elementType, from)
Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element
.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
Параметры
Имя | Тип | Описание |
---|---|---|
element Type | Element Type | Тип элемента для поиска. |
from | Range Element | Результат поиска, по которому осуществляется поиск. |
Возвращаться
Range Element
— результат поиска, указывающий следующую позицию элемента поиска.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern)
Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
Некоторые функции регулярных выражений JavaScript, такие как группы захвата и модификаторы режима, поддерживаются не полностью.
Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.
Параметры
Имя | Тип | Описание |
---|---|---|
search Pattern | String | образец для поиска |
Возвращаться
Range Element
— результат поиска, указывающий позицию искомого текста, или значение NULL, если совпадений нет.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
Некоторые функции регулярных выражений JavaScript, такие как группы захвата и модификаторы режима, поддерживаются не полностью.
Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.
Параметры
Имя | Тип | Описание |
---|---|---|
search Pattern | String | образец для поиска |
from | Range Element | результат поиска для поиска |
Возвращаться
Range Element
— результат поиска, указывающий следующую позицию искомого текста или ноль, если совпадений нет.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Alignment()
Получает Horizontal Alignment
.
Возвращаться
Horizontal Alignment
— выравнивание
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 Child(childIndex)
Извлекает дочерний элемент по указанному дочернему индексу.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }
Параметры
Имя | Тип | Описание |
---|---|---|
child Index | Integer | Индекс дочернего элемента, который требуется получить. |
Возвращаться
Element
— Дочерний элемент по указанному индексу.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Child Index(child)
Получает дочерний индекс для указанного дочернего элемента.
Параметры
Имя | Тип | Описание |
---|---|---|
child | Element | Дочерний элемент, для которого нужно получить индекс. |
Возвращаться
Integer
— Дочерний индекс.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Glyph Type()
Получает Glyph Type
элемента списка.
Возвращаться
Glyph Type
— тип глифа.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Heading()
Получает Paragraph Heading
.
Возвращаться
Paragraph Heading
— заголовок
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Indent End()
Получает конечный отступ в пунктах.
Возвращаться
Number
— конечный отступ, в пунктах
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Indent First Line()
Получает отступ первой строки в пунктах.
Возвращаться
Number
— отступ первой строки, в пунктах
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Indent Start()
Получает начальный отступ.
Возвращаться
Number
— начальный отступ
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Line Spacing()
Получает межстрочный интервал в пунктах.
Возвращаться
Number
— межстрочный интервал, в пунктах
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Link Url()
Получает URL-адрес ссылки.
Возвращаться
String
— URL-адрес ссылки или значение NULL, если элемент содержит несколько значений для этого атрибута.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get List Id()
Получает идентификатор списка.
Возвращаться
String
— идентификатор списка
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Nesting Level()
Получает уровень вложенности элемента списка.
По умолчанию элементы списка имеют нулевой уровень вложенности. Уровень вложенности определяет глиф, используемый элементом списка.
Возвращаться
Integer
— уровень вложенности
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 Num Children()
Получает количество детей.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
Возвращаться
Integer
— количество детей.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 Positioned Image(id)
Получает Positioned Image
по идентификатору изображения.
Параметры
Имя | Тип | Описание |
---|---|---|
id | String | идентификатор изображения |
Возвращаться
Positioned Image
— позиционированное изображение.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Positioned Images()
Получает все объекты Positioned Image
привязанные к абзацу.
Возвращаться
Positioned Image[]
— список позиционированных изображений
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 Spacing After()
Получает расстояние после элемента в пунктах.
Возвращаться
Number
— расстояние после элемента, в пунктах.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Spacing Before()
Получает расстояние перед элементом в пунктах.
Возвращаться
Number
— расстояние перед элементом, в пунктах.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text()
Извлекает содержимое элемента в виде текстовой строки.
Возвращаться
String
— содержимое элемента в виде текстовой строки.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text Alignment()
Получает выравнивание текста. Доступными типами выравнивания являются Document App.TextAlignment.NORMAL
, Document App.TextAlignment.SUBSCRIPT
и Document App.TextAlignment.SUPERSCRIPT
.
Возвращаться
Text Alignment
— тип выравнивания текста или null
, если текст содержит несколько типов выравнивания текста или если выравнивание текста никогда не устанавливалось.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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
insert Horizontal Rule(childIndex)
Создает и вставляет Horizontal Rule
по указанному индексу.
Параметры
Имя | Тип | Описание |
---|---|---|
child Index | Integer | индекс, по которому вставляется элемент |
Возвращаться
Horizontal Rule
— новый элемент горизонтального правила.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Inline Image(childIndex, image)
Создает и вставляет новое Inline Image
из указанного большого двоичного объекта изображения по указанному индексу.
Параметры
Имя | Тип | Описание |
---|---|---|
child Index | Integer | индекс, по которому вставляется элемент |
image | Blob Source | данные изображения |
Возвращаться
Inline Image
— вставленный элемент встроенного изображения.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Inline Image(childIndex, image)
Вставляет заданное Inline Image
по указанному индексу.
Параметры
Имя | Тип | Описание |
---|---|---|
child Index | Integer | индекс, по которому вставляется элемент |
image | Inline Image | данные изображения |
Возвращаться
Inline Image
— вставленный элемент встроенного изображения.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Page Break(childIndex)
Создает и вставляет новый Page Break
по указанному индексу.
Примечание. Page Breaks
не могут содержаться в Table Cells
. Если текущий элемент содержится в ячейке таблицы, будет выдано исключение.
Параметры
Имя | Тип | Описание |
---|---|---|
child Index | Integer | индекс, по которому вставляется элемент |
Возвращаться
Page Break
— новый элемент разрыва страницы.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Page Break(childIndex, pageBreak)
Вставляет заданный Page Break
по указанному индексу.
Примечание. Page Breaks
не могут содержаться в Table Cells
. Если текущий элемент содержится в ячейке таблицы, будет выдано исключение.
Параметры
Имя | Тип | Описание |
---|---|---|
child Index | Integer | индекс, по которому вставляется элемент |
page Break | Page Break | разрыв страницы, чтобы вставить |
Возвращаться
Page Break
— вставленный элемент разрыва страницы.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Text(childIndex, text)
Создает и вставляет новый текстовый элемент по указанному индексу.
Параметры
Имя | Тип | Описание |
---|---|---|
child Index | Integer | индекс, по которому вставляется элемент |
text | String | текстовое содержимое |
Возвращаться
Text
— новый текстовый элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Text(childIndex, text)
Вставляет заданный элемент Text
по указанному индексу с указанным текстовым содержимым.
Параметры
Имя | Тип | Описание |
---|---|---|
child Index | Integer | индекс, по которому вставляется элемент |
text | Text | текстовый элемент для вставки |
Возвращаться
Text
— вставленный текстовый элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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
is Left To Right()
Получает настройку слева направо.
Возвращаться
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();
Возвращаться
List Item
— объединенный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Child(child)
Удаляет указанный дочерний элемент.
Параметры
Имя | Тип | Описание |
---|---|---|
child | Element | дочерний элемент для удаления |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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(); }
Возвращаться
List Item
— удаленный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Positioned Image(id)
Удаляет Positioned Image
по идентификатору изображения.
Параметры
Имя | Тип | Описание |
---|---|---|
id | String |
Возвращаться
Boolean
— было ли удалено указанное изображение.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replace Text(searchPattern, replacement)
Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения.
Шаблон поиска передается как строка, а не как объект регулярного выражения JavaScript. По этой причине вам необходимо избегать любых обратных косых черт в шаблоне.
В этом методе используется библиотека регулярных выражений Google RE2 , которая ограничивает поддерживаемый синтаксис .
Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
Параметры
Имя | Тип | Описание |
---|---|---|
search Pattern | String | шаблон регулярного выражения для поиска |
replacement | String | текст, который будет использоваться в качестве замены |
Возвращаться
Element
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Alignment(alignment)
Устанавливает Horizontal Alignment
.
Параметры
Имя | Тип | Описание |
---|---|---|
alignment | Horizontal Alignment | горизонтальное выравнивание |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 | Атрибуты элемента. |
Возвращаться
List Item
— текущий элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Glyph Type(glyphType)
Устанавливает Glyph Type
элемента списка.
Параметры
Имя | Тип | Описание |
---|---|---|
glyph Type | Glyph Type | тип глифа |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Heading(heading)
Устанавливает Paragraph Heading
.
Параметры
Имя | Тип | Описание |
---|---|---|
heading | Paragraph Heading | заголовок |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Indent End(indentEnd)
Устанавливает конечный отступ в пунктах.
Параметры
Имя | Тип | Описание |
---|---|---|
indent End | Number | конечный отступ, в пунктах |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Indent First Line(indentFirstLine)
Устанавливает отступ первой строки в пунктах.
Параметры
Имя | Тип | Описание |
---|---|---|
indent First Line | Number | отступ первой строки, в пунктах |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Indent Start(indentStart)
Устанавливает начальный отступ в пунктах.
Параметры
Имя | Тип | Описание |
---|---|---|
indent Start | Number | начальный отступ, в пунктах |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Left To Right(leftToRight)
Устанавливает настройку слева направо.
Параметры
Имя | Тип | Описание |
---|---|---|
left To Right | Boolean | настройка слева направо |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Line Spacing(multiplier)
Устанавливает межстрочный интервал как величину, указывающую количество строк, используемых в качестве интервала.
Параметры
Имя | Тип | Описание |
---|---|---|
multiplier | Number | количество строк |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Link Url(url)
Устанавливает URL-адрес ссылки.
Параметры
Имя | Тип | Описание |
---|---|---|
url | String | URL-адрес ссылки |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set List Id(listItem)
Устанавливает идентификатор списка.
Идентификатору списка присваивается то же значение, что и для указанного List Item
. Два List Items
будут рассматриваться как члены одного списка.
Параметры
Имя | Тип | Описание |
---|---|---|
list Item | List Item | элемент списка, идентификатор списка которого следует использовать |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Nesting Level(nestingLevel)
Устанавливает уровень вложенности элемента списка.
По умолчанию элементы списка имеют нулевой уровень вложенности. Уровень вложенности определяет глиф, используемый элементом списка.
Параметры
Имя | Тип | Описание |
---|---|---|
nesting Level | Integer | уровень вложенности |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Spacing After(spacingAfter)
Устанавливает интервал после элемента в пунктах.
Параметры
Имя | Тип | Описание |
---|---|---|
spacing After | Number | расстояние после элемента, в пунктах |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Spacing Before(spacingBefore)
Устанавливает интервал перед элементом в пунктах.
Параметры
Имя | Тип | Описание |
---|---|---|
spacing Before | Number | расстояние перед элементом, в пунктах |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text(text)
Устанавливает содержимое элемента списка в виде текста.
Примечание: существующее содержимое будет удалено.
Параметры
Имя | Тип | Описание |
---|---|---|
text | String | новое текстовое содержание |
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
Устанавливает выравнивание текста. Доступными типами выравнивания являются Document App.TextAlignment.NORMAL
, Document App.TextAlignment.SUBSCRIPT
и Document App.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Параметры
Имя | Тип | Описание |
---|---|---|
text Alignment | Text Alignment | тип выравнивания текста, который нужно применить |
Возвращаться
List Item
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents