Элемент, представляющий строку таблицы. TableRow
всегда содержится в Table
и может содержать только элементы TableCell
. Дополнительные сведения о структуре документа см. в руководстве по расширению Документов Google .
Методы
Метод | Тип возврата | Краткое описание |
---|---|---|
appendTableCell() | TableCell | Создает и добавляет новый TableCell . |
appendTableCell(textContents) | TableCell | Добавляет заданную TableCell , содержащую указанный текст. |
appendTableCell(tableCell) | TableCell | Добавляет заданный TableCell . |
clear() | TableRow | Очищает содержимое элемента. |
copy() | TableRow | Возвращает отдельную, глубокую копию текущего элемента. |
editAsText() | Text | Получает Text версию текущего элемента для редактирования. |
findElement(elementType) | RangeElement | Ищет в содержимом элемента потомка указанного типа. |
findElement(elementType, from) | RangeElement | Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement . |
findText(searchPattern) | RangeElement | Ищет в содержимом элемента указанный текстовый шаблон, используя регулярные выражения. |
findText(searchPattern, from) | RangeElement | Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска. |
getAttributes() | Object | Извлекает атрибуты элемента. |
getCell(cellIndex) | TableCell | Извлекает TableCell по указанному индексу ячейки. |
getChild(childIndex) | Element | Извлекает дочерний элемент по указанному дочернему индексу. |
getChildIndex(child) | Integer | Извлекает дочерний индекс для указанного дочернего элемента. |
getLinkUrl() | String | Получает URL-адрес ссылки. |
getMinimumHeight() | Number | Получает минимальную высоту в пунктах. |
getNextSibling() | Element | Извлекает следующий одноуровневый элемент элемента. |
getNumCells() | Integer | Получает количество ячеек в строке. |
getNumChildren() | Integer | Получает количество детей. |
getParent() | ContainerElement | Извлекает родительский элемент элемента. |
getParentTable() | Table | Извлекает Table , содержащую текущую строку. |
getPreviousSibling() | Element | Извлекает предыдущий родственный элемент элемента. |
getText() | String | Извлекает содержимое элемента в виде текстовой строки. |
getTextAlignment() | TextAlignment | Получает выравнивание текста. |
getType() | ElementType | Извлекает ElementType элемента. |
insertTableCell(childIndex) | TableCell | Создает и вставляет новую TableCell по указанному индексу. |
insertTableCell(childIndex, textContents) | TableCell | Вставляет заданную TableCell по указанному индексу, содержащую заданный текст. |
insertTableCell(childIndex, tableCell) | TableCell | Вставляет заданную TableCell по указанному индексу. |
isAtDocumentEnd() | Boolean | Определяет, находится ли элемент в конце Document . |
merge() | TableRow | Объединяет элемент с предыдущим элементом того же типа. |
removeCell(cellIndex) | TableCell | Удаляет TableCell по указанному индексу ячейки. |
removeChild(child) | TableRow | Удаляет указанный дочерний элемент. |
removeFromParent() | TableRow | Удаляет элемент из его родителя. |
replaceText(searchPattern, replacement) | Element | Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения. |
setAttributes(attributes) | TableRow | Задает атрибуты элемента. |
setLinkUrl(url) | TableRow | Устанавливает URL-адрес ссылки. |
setMinimumHeight(minHeight) | TableRow | Устанавливает минимальную высоту в пунктах. |
setTextAlignment(textAlignment) | TableRow | Устанавливает выравнивание текста. |
Подробная документация
appendTableCell()
appendTableCell(textContents)
Добавляет заданную TableCell
, содержащую указанный текст.
Параметры
Имя | Тип | Описание |
---|---|---|
textContents | String | текстовое содержимое ячейки |
Возвращаться
TableCell
— добавленный элемент ячейки таблицы
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTableCell(tableCell)
Добавляет заданный TableCell
.
Параметры
Имя | Тип | Описание |
---|---|---|
tableCell | TableCell | ячейка таблицы для добавления |
Возвращаться
TableCell
— добавленная ячейка таблицы
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
Возвращает отдельную, глубокую копию текущего элемента.
Любые дочерние элементы, присутствующие в элементе, также копируются. Новый элемент не имеет родителя.
Возвращаться
TableRow
— новая копия.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
Получает Text
версию текущего элемента для редактирования.
Используйте editAsText
для управления содержимым элементов в виде форматированного текста. Режим editAsText
игнорирует нетекстовые элементы (например, InlineImage
и HorizontalRule
).
Дочерние элементы, полностью содержащиеся в удаленном текстовом диапазоне, удаляются из элемента.
var body = DocumentApp.getActiveDocument().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
— текстовая версия текущего элемента.
findElement(elementType)
Ищет в содержимом элемента потомка указанного типа.
Параметры
Имя | Тип | Описание |
---|---|---|
elementType | ElementType | тип элемента для поиска |
Возвращаться
RangeElement
— результат поиска, указывающий позицию элемента поиска.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Ищет в содержимом элемента потомка указанного типа, начиная с указанного RangeElement
.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
Параметры
Имя | Тип | Описание |
---|---|---|
elementType | ElementType | тип элемента для поиска |
from | RangeElement | результат поиска для поиска |
Возвращаться
RangeElement
— результат поиска, указывающий следующую позицию элемента поиска.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
Ищет в содержимом элемента указанный текстовый шаблон, используя регулярные выражения.
Подмножество функций регулярных выражений JavaScript поддерживается не полностью, например, группы захвата и модификаторы режима.
Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.
Параметры
Имя | Тип | Описание |
---|---|---|
searchPattern | String | образец для поиска |
Возвращаться
RangeElement
— результат поиска, указывающий позицию искомого текста, или null, если совпадений нет.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
Подмножество функций регулярных выражений JavaScript поддерживается не полностью, например, группы захвата и модификаторы режима.
Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.
Параметры
Имя | Тип | Описание |
---|---|---|
searchPattern | String | образец для поиска |
from | RangeElement | результат поиска для поиска |
Возвращаться
RangeElement
— результат поиска, указывающий следующую позицию искомого текста, или null, если совпадений нет.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
Извлекает атрибуты элемента.
Результатом является объект, содержащий свойство для каждого допустимого атрибута элемента, где имя каждого свойства соответствует элементу в перечислении DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Возвращаться
Object
— атрибуты элемента.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getCell(cellIndex)
Извлекает TableCell
по указанному индексу ячейки.
Параметры
Имя | Тип | Описание |
---|---|---|
cellIndex | Integer | индекс ячейки для получения |
Возвращаться
TableCell
— ячейка таблицы
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Извлекает дочерний элемент по указанному дочернему индексу.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. var 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."); }
Параметры
Имя | Тип | Описание |
---|---|---|
childIndex | Integer | индекс дочернего элемента для извлечения |
Возвращаться
Element
— дочерний элемент по указанному индексу
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
Извлекает дочерний индекс для указанного дочернего элемента.
Параметры
Имя | Тип | Описание |
---|---|---|
child | Element | дочерний элемент, для которого нужно получить индекс |
Возвращаться
Integer
— дочерний индекс
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
Получает URL-адрес ссылки.
Возвращаться
String
— URL-адрес ссылки или null, если элемент содержит несколько значений для этого атрибута.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMinimumHeight()
Получает минимальную высоту в пунктах.
Возвращаться
Number
— минимальная высота, в пунктах
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Извлекает следующий одноуровневый элемент элемента.
Следующий брат имеет того же родителя и следует за текущим элементом.
Возвращаться
Element
— следующий одноуровневый элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumCells()
Получает количество ячеек в строке.
Возвращаться
Integer
— количество ячеек
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Получает количество детей.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Возвращаться
Integer
— количество детей
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Извлекает родительский элемент элемента.
Родительский элемент содержит текущий элемент.
Возвращаться
ContainerElement
— родительский элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParentTable()
Извлекает Table
, содержащую текущую строку.
Возвращаться
Table
— таблица, содержащая текущую строку
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
Извлекает предыдущий родственный элемент элемента.
Предыдущий родственный элемент имеет того же родителя и предшествует текущему элементу.
Возвращаться
Element
— предыдущий одноуровневый элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getText()
Извлекает содержимое элемента в виде текстовой строки.
Возвращаться
String
— содержимое элемента в виде текстовой строки
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
Получает выравнивание текста. Доступные типы выравнивания: DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
и DocumentApp.TextAlignment.SUPERSCRIPT
.
Возвращаться
TextAlignment
— тип выравнивания текста или null
, если текст содержит несколько типов выравнивания текста или если выравнивание текста никогда не устанавливалось.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Извлекает ElementType
элемента.
Используйте getType()
, чтобы определить точный тип данного элемента.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Возвращаться
ElementType
— Тип элемента.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTableCell(childIndex)
Создает и вставляет новую TableCell
по указанному индексу.
Параметры
Имя | Тип | Описание |
---|---|---|
childIndex | Integer | индекс, по которому нужно вставить элемент |
Возвращаться
TableCell
— новая ячейка таблицы
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTableCell(childIndex, textContents)
Вставляет заданную TableCell
по указанному индексу, содержащую заданный текст.
Параметры
Имя | Тип | Описание |
---|---|---|
childIndex | Integer | индекс, по которому нужно вставить элемент |
textContents | String | текстовое содержимое ячейки |
Возвращаться
TableCell
— вставленная ячейка таблицы
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTableCell(childIndex, tableCell)
Вставляет заданную TableCell
по указанному индексу.
Параметры
Имя | Тип | Описание |
---|---|---|
childIndex | Integer | индекс, по которому нужно вставить элемент |
tableCell | TableCell | ячейка таблицы для вставки |
Возвращаться
TableCell
— вставленная ячейка таблицы
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Определяет, находится ли элемент в конце Document
.
Возвращаться
Boolean
— находится ли элемент в конце документа.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Объединяет элемент с предыдущим элементом того же типа.
Объединять можно только элементы одного и того же ElementType
. Любые дочерние элементы, содержащиеся в текущем элементе, перемещаются в предыдущий родственный элемент.
Текущий элемент удаляется из документа.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Возвращаться
TableRow
— объединенный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeCell(cellIndex)
Удаляет TableCell
по указанному индексу ячейки.
Параметры
Имя | Тип | Описание |
---|---|---|
cellIndex | Integer | индекс удаляемой ячейки |
Возвращаться
TableCell
— удаленная ячейка
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
Удаляет указанный дочерний элемент.
Параметры
Имя | Тип | Описание |
---|---|---|
child | Element | дочерний элемент для удаления |
Возвращаться
TableRow
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Удаляет элемент из его родителя.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Возвращаться
TableRow
— удаленный элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
Шаблон поиска передается в виде строки, а не объекта регулярного выражения JavaScript. Из-за этого вам нужно избегать любых обратных косых черт в шаблоне.
Этот метод использует библиотеку регулярных выражений Google RE2 , которая ограничивает поддерживаемый синтаксис .
Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Параметры
Имя | Тип | Описание |
---|---|---|
searchPattern | String | шаблон регулярного выражения для поиска |
replacement | String | текст для использования в качестве замены |
Возвращаться
Element
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Задает атрибуты элемента.
Указанный параметр атрибутов должен быть объектом, где каждое имя свойства является элементом в перечислении DocumentApp.Attribute
, а каждое значение свойства является новым применяемым значением.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Параметры
Имя | Тип | Описание |
---|---|---|
attributes | Object | Атрибуты элемента. |
Возвращаться
TableRow
— текущий элемент.
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Устанавливает URL-адрес ссылки.
Параметры
Имя | Тип | Описание |
---|---|---|
url | String | URL-адрес ссылки |
Возвращаться
TableRow
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setMinimumHeight(minHeight)
Устанавливает минимальную высоту в пунктах.
Параметры
Имя | Тип | Описание |
---|---|---|
minHeight | Number | минимальная высота, в пунктах |
Возвращаться
TableRow
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
Устанавливает выравнивание текста. Доступные типы выравнивания: DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
и DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Параметры
Имя | Тип | Описание |
---|---|---|
textAlignment | TextAlignment | применяемый тип выравнивания текста |
Возвращаться
TableRow
— текущий элемент
Авторизация
Сценарии, использующие этот метод, требуют авторизации в одной или нескольких следующих областях :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents