此页面由 Cloud Translation API 翻译。

Class InlineImage

表示嵌入图片的元素。InlineImage 可包含在 ListItem 或 Paragraph，除非 ListItem 或 Paragraph 介于 FootnoteSection。InlineImage 本身不能包含任何其他元素。对于有关文档结构的更多信息，请参阅扩展 Google 文档指南。

方法

方法	返回类型	简介
`copy()`	`InlineImage`	返回当前元素的分离的深层副本。
`getAltDescription()`	`String`	返回图片的替代说明。
`getAltTitle()`	`String`	返回图片的替代标题。
`getAs(contentType)`	`Blob`	将此对象中的数据作为转换为指定内容类型的 blob 返回。
`getAttributes()`	`Object`	检索元素的属性。
`getBlob()`	`Blob`	将此对象中的数据作为 blob 返回。
`getHeight()`	`Integer`	检索图片的高度（以像素为单位）。
`getLinkUrl()`	`String`	检索链接网址。
`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`	设置链接网址。
`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)`

将此对象中的数据作为转换为指定内容类型的 blob 返回。这个方法会为文件名添加相应的扩展名，例如“myfile.pdf”。不过，最后一个句点之后的文件名部分（如果有）假定存在扩展名。因此，“ShoppingList.12.25.2014”会变为 “ShoppingList.12.25.pdf”。

要查看转化次数的每日配额，请参阅 Google 配额服务。新创建的 Google Workspace 网域可能会暂时适用更严格的条件配额。

参数

名称	类型	说明
`contentType`	`String`	要转换为的 MIME 类型。对于大多数 blob，`'application/pdf'` 为唯一有效的选项对于 BMP、GIF、JPEG 或 PNG 格式的图片，`'image/bmp'`、`'image/gif'`、`'image/jpeg'` 或 `'image/png'` 中的任何一个也有效。对于 Google 文档，`'text/markdown'` 也有效。

Blob - 以 blob 形式表示的数据。

`getAttributes()`

检索元素的属性。

结果会得到一个对象，其中包含每个有效元素属性对应的属性，其中每个属性名称对应于 DocumentApp.Attribute 枚举中的一个项。

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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 返回。

Blob - 以 blob 形式表示的数据。

`getHeight()`

检索图片的高度（以像素为单位）。

Integer - 图片的高度（以像素为单位）

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`getLinkUrl()`

检索链接网址。

String - 链接网址；如果元素包含多个此键的值，则为 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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's 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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab()
var body = documentTab.getBody();

// Remove all images in the active tab's 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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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)`

设置链接网址。如果给定网址为 null 或空字符串，此方法将创建包含空白网址的链接（可能会显示为“无效链接”）。

参数

名称	类型	说明
`url`	`String`	链接网址

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