此页面由 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 枚举中的项。

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

`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() 确定给定元素的确切类型。

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.');
}

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 的元素才能合并。当前元素包含的所有子元素都会移至前面的同级元素。

当前元素会从文档中移除。

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

InlineImage - 合并后的元素。

授权

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

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

`removeFromParent()`

从其父元素中移除元素。

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

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)`

设置元素的属性。

指定的 attributes 参数必须是对象，其中每个属性名称都是 DocumentApp.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`	元素的属性。

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 或空字符串，此方法将创建一个包含空网址的链接，该链接�� Google 文档中可能会显示为“无效链接”。

参数

名称	类型	说明
`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

Class InlineImage 使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

方法

详细文档

copy()

返回

授权

getAltDescription()

返回

授权

getAltTitle()

返回

授权

getAs(contentType)

参数

返回

getAttributes()

返回

授权

getBlob()

返回

getHeight()

返回

授权

getLinkUrl()

返回

授权

getNextSibling()

返回

授权

getParent()

返回

授权

getPreviousSibling()

返回

授权

getType()

返回

授权

getWidth()

返回

授权

isAtDocumentEnd()

返回

授权

merge()

返回

授权

removeFromParent()

返回

授权

setAltDescription(description)

参数

返回

授权

setAltTitle(title)

参数

返回

授权

setAttributes(attributes)

参数

返回

授权

setHeight(height)

参数

返回

授权

setLinkUrl(url)

参数

返回

授权

setWidth(width)

参数

返回

授权

Class InlineImage
使用集合让一切井井有条根据您的偏好保存内容并对其进行分类。

`copy()`

`getAltDescription()`

`getAltTitle()`

`getAs(contentType)`

`getAttributes()`

`getBlob()`

`getHeight()`

`getLinkUrl()`

`getNextSibling()`

`getParent()`

`getPreviousSibling()`

`getType()`

`getWidth()`

`isAtDocumentEnd()`

`merge()`

`removeFromParent()`

`setAltDescription(description)`

`setAltTitle(title)`

`setAttributes(attributes)`

`setHeight(height)`

`setLinkUrl(url)`

`setWidth(width)`