Class InlineImage

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.
встроенное изображение

Элемент, представляющий встроенное изображение. InlineImage может содержаться внутри ListItem или Paragraph , если только ListItem или Paragraph не находится в FootnoteSection . InlineImage не может сам содержать какой-либо другой элемент. Дополнительные сведения о структуре документа см. в руководстве по расширению Документов Google .

Методы

Метод Тип возврата Краткое описание
copy() InlineImage Возвращает отдельную, глубокую копию текущего элемента.
getAltDescription() String Возвращает альтернативное описание изображения.
getAltTitle() String Возвращает альтернативный заголовок изображения.
getAs(contentType) Blob Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента.
getAttributes() Object Извлекает атрибуты элемента.
getBlob() Blob Верните данные внутри этого объекта в виде большого двоичного объекта.
getHeight() Integer Получает высоту изображения в пикселях.
getLinkUrl() String Получает URL-адрес ссылки.
getNextSibling() Element Извлекает следующий одноуровневый элемент элемента.
getParent() ContainerElement Извлекает родительский элемент элемента.
getPreviousSibling() Element Извлекает предыдущий родственный элемент элемента.
getType() ElementType Извлекает ElementType элемента.
getWidth() Integer Получает ширину изображения в пикселях.
isAtDocumentEnd() Boolean Определяет, находится ли элемент в конце Document .
merge() InlineImage Объединяет элемент с предыдущим элементом того же типа.
removeFromParent() InlineImage Удаляет элемент из его родителя.
setAltDescription(description) InlineImage Устанавливает альтернативное описание изображения.
setAltTitle(title) InlineImage Устанавливает альтернативный заголовок изображения.
setAttributes(attributes) InlineImage Задает атрибуты элемента.
setHeight(height) InlineImage Устанавливает высоту изображения в пикселях.
setLinkUrl(url) InlineImage Устанавливает URL-адрес ссылки.
setWidth(width) InlineImage Устанавливает ширину изображения в пикселях.

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

copy()

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

Любые дочерние элементы, присутствующие в элементе, также копируются. Новый элемент не имеет родителя.

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

InlineImage — новая копия.

Авторизация

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

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

getAltDescription()

Возвращает альтернативное описание изображения.

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

String — альтернативный заголовок или null , если у элемента нет альтернативного заголовка.

Авторизация

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

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

getAltTitle()

Возвращает альтернативный заголовок изображения.

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

String — альтернативный заголовок или null , если у элемента нет альтернативного заголовка.

Авторизация

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

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

getAs(contentType)

Верните данные внутри этого объекта в виде большого двоичного объекта, преобразованного в указанный тип контента. Этот метод добавляет к имени файла соответствующее расширение, например, «myfile.pdf». Однако предполагается, что часть имени файла, которая следует за последней точкой (если она есть), является существующим расширением, которое следует заменить. Следовательно, «Список покупок.12.25.2014» становится «Список покупок.12.25.pdf».

Чтобы просмотреть дневные квоты на конверсии, см. Квоты для сервисов Google . На вновь созданные домены Google Workspace могут временно распространяться более строгие квоты.

Параметры

Имя Тип Описание
contentType String Тип MIME для преобразования. Для большинства BLOB 'application/pdf' . Для изображений в формате BMP, GIF, JPEG или PNG допустимо любое из значений 'image/bmp' , 'image/gif' , 'image/jpeg' или 'image/png' .

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

Blob — данные в виде большого двоичного объекта.


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

getBlob()

Верните данные внутри этого объекта в виде большого двоичного объекта.

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

Blob — данные в виде большого двоичного объекта.


getHeight()

Получает высоту изображения в пикселях.

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

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

getNextSibling()

Извлекает следующий одноуровневый элемент элемента.

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

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

Element — следующий одноуровневый элемент.

Авторизация

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

  • 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

getPreviousSibling()

Извлекает предыдущий родственный элемент элемента.

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

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

Element — предыдущий одноуровневый элемент.

Авторизация

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

  • 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

getWidth()

Получает ширину изображения в пикселях.

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

Integer — ширина изображения в пикселях.

Авторизация

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

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

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

InlineImage — объединенный элемент.

Авторизация

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

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

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

InlineImage — удаленный элемент.

Авторизация

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

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

setAltDescription(description)

Устанавливает альтернативное описание изображения. Если данный заголовок равен null , устанавливает описание в пустую строку.

Параметры

Имя Тип Описание
description String альтернативное название

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

InlineImage — текущий объект

Авторизация

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

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

setAltTitle(title)

Устанавливает альтернативный заголовок изображения. Если данный заголовок равен null , устанавливает заголовок в пустую строку.

Параметры

Имя Тип Описание
title String альтернативное название

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

InlineImage — текущий объект

Авторизация

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

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

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

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

Авторизация

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

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

setHeight(height)

Устанавливает высоту изображения в пикселях.

Параметры

Имя Тип Описание
height Integer высота изображения в пикселях

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

InlineImage — текущий объект

Авторизация

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

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

setLinkUrl(url)

Устанавливает URL-адрес ссылки. Если заданный URL-адрес имеет значение null или пустую строку, этот метод создаст ссылку с пустым URL-адресом, которая может отображаться как «Недопустимая ссылка» в Документах Google.

Параметры

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

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

InlineImage — текущий объект

Авторизация

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

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

setWidth(width)

Устанавливает ширину изображения в пикселях.

Параметры

Имя Тип Описание
width Integer ширина изображения в пикселях

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

InlineImage — текущий объект

Авторизация

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

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