Элемент, представляющий функцию в математическом Equation
. Equation Function
может содержать Equation Function
, Equation Function Argument Separator
, Equation Symbol
и Text
элементы. Дополнительную информацию о структуре документа см. в руководстве по расширению Google Docs .
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
clear() | Equation Function | Очищает содержимое элемента. |
copy() | Equation Function | Возвращает отдельную глубокую копию текущего элемента. |
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 Attributes() | Object | Получает атрибуты элемента. |
get Child(childIndex) | Element | Извлекает дочерний элемент по указанному дочернему индексу. |
get Child Index(child) | Integer | Получает дочерний индекс для указанного дочернего элемента. |
get Code() | String | Получает код, соответствующий функции уравнения. |
get Link Url() | String | Получает URL-адрес ссылки. |
get Next Sibling() | Element | Извлекает следующий родственный элемент элемента. |
get Num Children() | Integer | Получает количество детей. |
get Parent() | Container Element | Извлекает родительский элемент элемента. |
get Previous Sibling() | Element | Извлекает предыдущий родственный элемент элемента. |
get Text() | String | Извлекает содержимое элемента в виде текстовой строки. |
get Text Alignment() | Text Alignment | Получает выравнивание текста. |
get Type() | Element Type | Получает Element Type элемента. |
is At Document End() | Boolean | Определяет, находится ли элемент в конце Document . |
merge() | Equation Function | Объединяет элемент с предыдущим одноуровневым элементом того же типа. |
remove From Parent() | Equation Function | Удаляет элемент из его родителя. |
replace Text(searchPattern, replacement) | Element | Заменяет все вхождения данного текстового шаблона заданной строкой замены, используя регулярные выражения. |
set Attributes(attributes) | Equation Function | Устанавливает атрибуты элемента. |
set Link Url(url) | Equation Function | Устанавливает URL-адрес ссылки. |
set Text Alignment(textAlignment) | Equation Function | Устанавливает выравнивание текста. |
Подробная документация
clear()
copy()
Возвращает отдельную глубокую копию текущего элемента.
Любые дочерние элементы, присутствующие в элементе, также копируются. У нового элемента нет родителя.
Возвращаться
Equation Function
— Новая копия.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 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 Code()
Получает код, соответствующий функции уравнения.
Возвращаться
String
— код функции
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 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 Previous Sibling()
Извлекает предыдущий родственный элемент элемента.
Предыдущий родственный элемент имеет того же родителя и предшествует текущему элементу.
Возвращаться
Element
— предыдущий родственный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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
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();
Возвращаться
Equation Function
— объединенный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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(); }
Возвращаться
Equation Function
— удаленный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 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 | Атрибуты элемента. |
Возвращаться
Equation Function
— текущий элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Link Url(url)
Устанавливает URL-адрес ссылки.
Параметры
Имя | Тип | Описание |
---|---|---|
url | String | URL-адрес ссылки |
Возвращаться
Equation Function
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
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 | тип выравнивания текста, который необходимо применить |
Возвращаться
Equation Function
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации с одной или несколькими из следующих областей :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents