Class TableCell

Ячейка таблицы

Элемент, представляющий ячейку таблицы. Table Cell всегда находится внутри Table Row и может содержать элементы List Item , Paragraph или Table . Для получения дополнительной информации о структуре документа см. руководство по расширению Google Docs .

Методы

Метод Тип возвращаемого значения Краткое описание
append Horizontal Rule() Horizontal Rule Создает и добавляет новую Horizontal Rule .
append Image(image) Inline Image Создает и добавляет новое Inline Image из указанного блока изображений.
append Image(image) Inline Image Добавляет заданное Inline Image .
append List Item(listItem) List Item Добавляет указанный List Item .
append List Item(text) List Item Создает и добавляет новый List Item .
append Paragraph(paragraph) Paragraph Добавляет данный Paragraph .
append Paragraph(text) Paragraph Создает и добавляет новый Paragraph .
append Table() Table Создает и добавляет новую Table .
append Table(cells) Table Добавляет новую Table содержащую указанные ячейки.
append Table(table) Table Добавляет данные Table .
clear() Table Cell Очищает содержимое элемента.
copy() Table Cell Возвращает отсоединенную, глубокую копию текущего элемента.
edit As Text() Text Получает Text версию текущего элемента для редактирования.
find Element(elementType) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element |null Выполняет поиск в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.
find Text(searchPattern, from) Range Element |null Выполняет поиск указанного текстового шаблона в содержимом элемента, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Background Color() String|null Получает цвет фона.
get Child(childIndex) Element Извлекает дочерний элемент по указанному индексу дочернего элемента.
get Child Index(child) Integer Получает индекс дочернего элемента для указанного дочернего элемента.
get Col Span() Integer Получает значение параметра column span, которое представляет собой количество столбцов ячеек таблицы, охватываемых данной ячейкой.
get Link Url() String|null Получает URL-адрес ссылки.
get Next Sibling() Element |null Получает следующий соседний элемент.
get Num Children() Integer Получает количество детей.
get Padding Bottom() Number|null Извлекает нижний отступ в точках.
get Padding Left() Number|null Извлекает левый отступ в пунктах.
get Padding Right() Number|null Извлекает отступ справа в пунктах.
get Padding Top() Number|null Извлекает верхний отступ в пунктах.
get Parent() Container Element |null Получает родительский элемент элемента.
get Parent Row() Table Row |null Извлекает Table Row содержащую текущую Table Cell .
get Parent Table() Table |null Извлекает Table содержащую текущую Table Cell .
get Previous Sibling() Element |null Получает предыдущий соседний элемент.
get Row Span() Integer Получает значение диапазона строк, то есть количество строк ячеек таблицы, которые занимает данная ячейка.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment |null Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
get Vertical Alignment() Vertical Alignment |null Получает значение Vertical Alignment .
get Width() Number|null Извлекает ширину столбца, содержащего ячейку, в пунктах.
insert Horizontal Rule(childIndex) Horizontal Rule Создает и вставляет новую Horizontal Rule по указанному индексу.
insert Image(childIndex, image) Inline Image Создает и вставляет Inline Image из указанного блока изображений по указанному индексу.
insert Image(childIndex, image) Inline Image Вставляет заданное Inline Image по указанному индексу.
insert List Item(childIndex, listItem) List Item Вставляет заданный List Item по указанному индексу.
insert List Item(childIndex, text) List Item Создает и вставляет новый List Item по указанному индексу.
insert Paragraph(childIndex, paragraph) Paragraph Вставляет указанный Paragraph по указанному индексу.
insert Paragraph(childIndex, text) Paragraph Создает и вставляет новый Paragraph по указанному индексу.
insert Table(childIndex) Table Создает и вставляет новую Table по указанному индексу.
insert Table(childIndex, cells) Table Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.
insert Table(childIndex, table) Table Вставляет заданную Table по указанному индексу.
is At Document End() Boolean Определяет, находится ли элемент в конце Document .
merge() Table Cell |null Объединяет элемент с предшествующим соседним элементом того же типа.
remove Child(child) Table Cell Удаляет указанный дочерний элемент.
remove From Parent() Table Cell |null Удаляет элемент из родительского элемента.
replace Text(searchPattern, replacement) Element Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.
set Attributes(attributes) Table Cell Задает атрибуты элемента.
set Background Color(color) Table Cell Задает цвет фона.
set Link Url(url) Table Cell Задает URL-адрес ссылки.
set Padding Bottom(paddingBottom) Table Cell Задает нижний отступ в пунктах.
set Padding Left(paddingLeft) Table Cell Задает левый отступ в пунктах.
set Padding Right(paddingRight) Table Cell Устанавливает правильный отступ в пунктах.
set Padding Top(paddingTop) Table Cell Задает верхний отступ в пунктах.
set Text(text) Table Cell Преобразует содержимое в обычный текст.
set Text Alignment(textAlignment) Table Cell Задает выравнивание текста.
set Vertical Alignment(alignment) Table Cell Задает вертикальное выравнивание.
set Width(width) Table Cell Задает ширину столбца, содержащего текущую ячейку, в пунктах.

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

append Horizontal Rule()

Создает и добавляет новую Horizontal Rule .

Horizontal Rule будет выделена в новый Paragraph .

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

Horizontal Rule — новая горизонтальная линейка

Авторизация

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

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

append Image(image)

Создает и добавляет новое Inline Image из указанного блока изображений.

Inline Image будет помещено в новый Paragraph .

Параметры

Имя Тип Описание
image Blob Source данные изображения

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

Inline Image — новый вид изображения

Авторизация

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

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

append Image(image)

Добавляет заданное Inline Image .

Inline Image будет помещено в новый Paragraph .

Параметры

Имя Тип Описание
image Inline Image данные изображения

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

Inline Image — добавленное изображение

Авторизация

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

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

append List Item(listItem)

Добавляет указанный List Item .

Параметры

Имя Тип Описание
list Item List Item элемент списка для добавления

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

List Item — добавленный элемент списка

Авторизация

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

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

append List Item(text)

Создает и добавляет новый List Item .

Параметры

Имя Тип Описание
text String содержание текста

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

List Item — новый элемент списка

Авторизация

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

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

append Paragraph(paragraph)

Добавляет данный Paragraph .

Параметры

Имя Тип Описание
paragraph Paragraph абзац для добавления

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

Paragraph — прилагаемый параграф

Авторизация

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

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

append Paragraph(text)

Создает и добавляет новый Paragraph .

Параметры

Имя Тип Описание
text String содержание текста

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

Paragraph — новый абзац

Авторизация

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

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

append Table()

Создает и добавляет новую Table .

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

Table — новый стол

Авторизация

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

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

append Table(cells)

Добавляет новую Table содержащую указанные ячейки.

Параметры

Имя Тип Описание
cells String[][] Текстовое содержимое ячеек таблицы, которое нужно добавить в новую таблицу.

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

Table — приложенная таблица

Авторизация

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

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

append Table(table)

Добавляет данные Table .

Параметры

Имя Тип Описание
table Table таблица для добавления

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

Table — приложенная таблица

Авторизация

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

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

clear()

Очищает содержимое элемента.

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

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

copy()

Возвращает отсоединенную, глубокую копию текущего элемента.

Все дочерние элементы, присутствующие в новом элементе, также копируются. У нового элемента нет родителя.

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

Table Cell — Новый экземпляр.

Авторизация

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

  • 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 |null — Результат поиска, указывающий позицию искомого элемента.

Авторизация

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

  • 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 |null — Результат поиска, указывающий следующую позицию искомого элемента.

Авторизация

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

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

find Text(searchPattern)

Выполняет поиск указанного текстового шаблона в содержимом элемента с использованием регулярных выражений.

Некоторые функции регулярных выражений JavaScript поддерживаются не в полной мере, например, группы захвата и модификаторы режима.

Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.

Параметры

Имя Тип Описание
search Pattern String шаблон для поиска

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

Range Element |null — результат поиска, указывающий позицию искомого текста, или 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 |null — результат поиска, указывающий следующую позицию искомого текста, или null, если совпадений нет.

Авторизация

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

  • 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 Background Color()

Получает цвет фона.

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

String|null — цвет фона, отформатированный в CSS-нотациях (например '#ffffff' ).

Авторизация

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

  • 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 Col Span()

Получает значение параметра column span, которое представляет собой количество столбцов ячеек таблицы, охватываемых данной ячейкой. Для необъединенных ячеек значение col span равно 1.

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

Integer — диапазон столбцов или 0 для ячейки, которая перекрывается другой ячейкой.

Авторизация

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

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

get Link Url()

Получает URL-адрес ссылки.

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

String|null — URL ссылки, или null, если элемент содержит несколько значений для этого атрибута.

Авторизация

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

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

get Next Sibling()

Получает следующий соседний элемент.

Следующий элемент-близнец имеет того же родителя и следует за текущим элементом.

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

Element |null — Следующий соседний элемент.

Авторизация

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

  • 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 Padding Bottom()

Извлекает нижний отступ в точках.

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

Number|null — нижний отступ в пунктах

Авторизация

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

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

get Padding Left()

Извлекает левый отступ в пунктах.

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

Number|null — левый отступ, в пунктах

Авторизация

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

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

get Padding Right()

Извлекает отступ справа в пунктах.

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

Number|null — правильный отступ в пунктах

Авторизация

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

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

get Padding Top()

Извлекает верхний отступ в пунктах.

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

Number|null — верхний отступ в пунктах

Авторизация

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

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

get Parent()

Получает родительский элемент элемента.

Родительский элемент содержит текущий элемент.

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

Container Element |null — Родительский элемент.

Авторизация

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

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

get Parent Row()

Извлекает Table Row содержащую текущую Table Cell .

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

Table Row |null — строка таблицы, содержащая текущую ячейку

Авторизация

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

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

get Parent Table()

Извлекает Table содержащую текущую Table Cell .

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

Table |null — таблица, содержащая текущую ячейку

Авторизация

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

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

get Previous Sibling()

Получает предыдущий соседний элемент.

Предыдущий соседний элемент имеет того же родителя и предшествует текущему элементу.

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

Element |null — Предыдущий соседний элемент.

Авторизация

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

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

get Row Span()

Получает значение диапазона строк, то есть количество строк ячеек таблицы, которые занимает данная ячейка. Для необъединенных ячеек диапазон строк равен 1.

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

Integer — диапазон строк или 0 для ячейки, которая перекрывается другой ячейкой.

Авторизация

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

  • 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 — тип выравнивания текста, или 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

get Vertical Alignment()

Получает значение Vertical Alignment .

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

Vertical Alignment |null — вертикальное выравнивание

Авторизация

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

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

get Width()

Извлекает ширину столбца, содержащего ячейку, в пунктах.

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

Number|null — ширина столбца в пунктах

Авторизация

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

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

insert Horizontal Rule(childIndex)

Создает и вставляет новую Horizontal Rule по указанному индексу.

Горизонтальная линия будет выделена в новый Paragraph .

Параметры

Имя Тип Описание
child Index Integer индекс, по которому следует вставить элемент

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

Horizontal Rule — новая горизонтальная линейка

Авторизация

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

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

insert Image(childIndex, image)

Создает и вставляет Inline Image из указанного блока изображений по указанному индексу.

Изображение будет размещено в новом Paragraph .

Параметры

Имя Тип Описание
child Index Integer индекс, по которому следует вставить элемент
image Blob Source данные изображения

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

Inline Image — вставленное встроенное изображение.

Авторизация

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

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

insert Image(childIndex, image)

Вставляет заданное Inline Image по указанному индексу.

Изображение будет размещено в новом Paragraph .

Параметры

Имя Тип Описание
child Index Integer индекс, по которому следует вставить элемент
image Inline Image изображение для вставки

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

Inline Image — вставленное встроенное изображение.

Авторизация

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

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

insert List Item(childIndex, listItem)

Вставляет заданный List Item по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer индекс, по которому следует вставить элемент
list Item List Item элемент списка для вставки

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

List Item — добавлен новый элемент списка

Авторизация

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

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

insert List Item(childIndex, text)

Создает и вставляет новый List Item по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer индекс, по которому следует вставить элемент
text String содержание текста

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

List Item — новый элемент списка

Авторизация

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

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

insert Paragraph(childIndex, paragraph)

Вставляет указанный Paragraph по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer индекс, по которому следует вставить элемент
paragraph Paragraph абзац для вставки

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

Paragraph — вставленный абзац

Авторизация

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

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

insert Paragraph(childIndex, text)

Создает и вставляет новый Paragraph по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer индекс, по которому следует вставить элемент
text String содержание текста

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

Paragraph — новый абзац

Авторизация

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

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

insert Table(childIndex)

Создает и вставляет новую Table по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer индекс, по которому следует вставить элемент

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

Table — новый стол

Авторизация

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

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

insert Table(childIndex, cells)

Создает и вставляет новую Table , содержащую указанные ячейки, по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer индекс, по которому следует вставить
cells String[][] Текстовое содержимое ячеек таблицы, которое нужно добавить в новую таблицу.

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

Table — новый стол

Авторизация

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

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

insert Table(childIndex, table)

Вставляет заданную Table по указанному индексу.

Параметры

Имя Тип Описание
child Index Integer индекс, по которому следует вставить элемент
table Table таблица для вставки

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

Table — вставленная таблица

Авторизация

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

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

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

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

Авторизация

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

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

remove Child(child)

Удаляет указанный дочерний элемент.

Параметры

Имя Тип Описание
child Element дочерний элемент для удаления

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

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

Авторизация

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

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

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

Table Cell |null — Удалённый элемент.

Авторизация

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

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

replace Text(searchPattern, replacement)

Заменяет все вхождения заданного текстового шаблона заданной строкой замены, используя регулярные выражения.

Шаблон поиска передается в виде строки, а не объекта регулярного выражения JavaScript. Поэтому вам потребуется экранировать все обратные косые черты в шаблоне.

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

Предоставленный шаблон регулярного выражения независимо сопоставляется с каждым текстовым блоком, содержащимся в текущем элементе.

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)

Задает атрибуты элемента.

Указанный параметр 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 Атрибуты элемента.

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

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

Авторизация

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

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

set Background Color(color)

Задает цвет фона.

Параметры

Имя Тип Описание
color String Цвет фона, заданный в формате CSS (например '#ffffff' ).

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

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

Авторизация

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

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

set Link Url(url)

Задает URL-адрес ссылки.

Параметры

Имя Тип Описание
url String URL-адрес ссылки

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

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

Авторизация

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

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

set Padding Bottom(paddingBottom)

Задает нижний отступ в пунктах.

Параметры

Имя Тип Описание
padding Bottom Number нижняя подкладка, по точкам

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

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

Авторизация

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

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

set Padding Left(paddingLeft)

Задает левый отступ в пунктах.

Параметры

Имя Тип Описание
padding Left Number левая подкладка, по пунктам

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

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

Авторизация

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

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

set Padding Right(paddingRight)

Устанавливает правильный отступ в пунктах.

Параметры

Имя Тип Описание
padding Right Number Правильный уровень отступа, в пунктах.

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

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

Авторизация

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

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

set Padding Top(paddingTop)

Задает верхний отступ в пунктах.

Параметры

Имя Тип Описание
padding Top Number верхняя набивка, по точкам

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

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

Авторизация

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

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

set Text(text)

Преобразует содержимое в обычный текст.

Примечание: существующее содержимое удалено.

Параметры

Имя Тип Описание
text String новое текстовое содержимое

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

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

Авторизация

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

  • 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 тип выравнивания текста, который следует применить

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

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

Авторизация

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

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

set Vertical Alignment(alignment)

Задает вертикальное выравнивание.

Параметры

Имя Тип Описание
alignment Vertical Alignment вертикальное выравнивание

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

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

Авторизация

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

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

set Width(width)

Задает ширину столбца, содержащего текущую ячейку, в пунктах.

Параметры

Имя Тип Описание
width Number ширина столбца в пунктах

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

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

Авторизация

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

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