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 из указанного BLOB-объекта изображения.
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 Ищет в содержимом элемента потомка указанного типа.
find Element(elementType, from) Range Element Ищет в содержимом элемента потомка указанного типа, начиная с указанного Range Element .
find Text(searchPattern) Range Element Ищет в содержимом элемента указанный текстовый шаблон с помощью регулярных выражений.
find Text(searchPattern, from) Range Element Ищет в содержимом элемента указанный текстовый шаблон, начиная с заданного результата поиска.
get Attributes() Object Получает атрибуты элемента.
get Background Color() String Получает цвет фона.
get Child(childIndex) Element Извлекает дочерний элемент по указанному дочернему индексу.
get Child Index(child) Integer Получает дочерний индекс для указанного дочернего элемента.
get Col Span() Integer Получает диапазон столбцов, который представляет собой количество столбцов ячеек таблицы, охватываемых этой ячейкой.
get Link Url() String Получает URL-адрес ссылки.
get Next Sibling() Element Извлекает следующий родственный элемент элемента.
get Num Children() Integer Получает количество детей.
get Padding Bottom() Number Получает нижнее отступ в пунктах.
get Padding Left() Number Получает левое дополнение в точках.
get Padding Right() Number Получает правильное дополнение в точках.
get Padding Top() Number Получает верхнее дополнение в точках.
get Parent() Container Element Извлекает родительский элемент элемента.
get Parent Row() Table Row Извлекает Table Row содержащую текущую Table Cell .
get Parent Table() Table Извлекает Table содержащую текущую Table Cell .
get Previous Sibling() Element Извлекает предыдущий родственный элемент элемента.
get Row Span() Integer Извлекает диапазон строк, который представляет собой количество строк ячеек таблицы, охватываемых этой ячейкой.
get Text() String Извлекает содержимое элемента в виде текстовой строки.
get Text Alignment() Text Alignment Получает выравнивание текста.
get Type() Element Type Получает Element Type элемента.
get Vertical Alignment() Vertical Alignment Получает Vertical Alignment .
get Width() Number Получает ширину столбца, содержащего ячейку, в пунктах.
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 Объединяет элемент с предыдущим одноуровневым элементом того же типа.
remove Child(child) Table Cell Удаляет указанный дочерний элемент.
remove From Parent() Table Cell Удаляет элемент из его родителя.
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 из указанного BLOB-объекта изображения.

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

Авторизация

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

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

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

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

String — цвет фона, отформатированный в нотации 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()

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

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

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

Авторизация

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

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

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

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

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

Авторизация

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

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

get Padding Left()

Получает левое дополнение в точках.

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

Number — отступ слева, в пунктах

Авторизация

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

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

get Padding Right()

Получает правильное дополнение в точках.

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

Number — правое отступ, в точках

Авторизация

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

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

get Padding Top()

Получает верхнее дополнение в точках.

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

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

Авторизация

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

  • 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 Parent Row()

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

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

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

Авторизация

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

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

get Parent Table()

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

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

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

Авторизация

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

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

Авторизация

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

  • 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 — вертикальное выравнивание

Авторизация

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

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

get Width()

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

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

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

Авторизация

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

  • 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 — объединенный элемент.

Авторизация

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

  • 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 — удаленный элемент.

Авторизация

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

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

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

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