Class InlineImage

内嵌图片

表示嵌入式图片的元素。InlineImage 可以包含在 ListItem 或 Paragraph 中，除非 ListItem 或 Paragraph 位于 FootnoteSection 中。InlineImage 本身不能包含任何其他元素。如需详细了解文档结构，请参阅扩展 Google 文档指南。

方法

方法返回类型简介
copy()InlineImage返回当前元素的已分离深层副本。
getAltDescription()String|null返回图片的替代说明。
getAltTitle()String|null返回图片的替代标题。
getAs(contentType)Blob以转换为指定内容类型的 blob 形式返回此对象内的数据。
getAttributes()Object检索元素的属性。
getBlob()Blob以 blob 形式返回此对象内的数据。
getHeight()Integer检索图片的高度（以像素为单位）。
getLinkUrl()String|null检索链接网址。
getNextSibling()Element|null检索元素的下一个同级元素。
getParent()ContainerElement|null检索元素的父元素。
getPreviousSibling()Element|null检索元素的前一个同级元素。
getType()ElementType检索元素的 ElementType。
getWidth()Integer检索图片的宽度（以像素为单位）。
isAtDocumentEnd()Boolean确定元素是否位于 Document 的末尾。
merge()InlineImage|null将元素与同一类型的前一个同级元素合并。
removeFromParent()InlineImage|null从其父级中移除元素。
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 - 替代说明，如果元素没有替代说明，则为 null。

授权

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

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

getAltTitle()

返回图片的替代标题。

返回

String|null - 替代标题；如果元素没有替代标题，则为 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 网域可能暂时受到更严格的配额限制。

参数

名称类型说明
contentTypeString要转换成的 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 - 链接网址，如果元素包含此属性的多个值，则为 null。

授权

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

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

getNextSibling()

检索元素的下一个同级元素。

下一个同级元素具有相同的父元素，并且位于当前元素之后。

返回

Element|null - 下一个同级元素。

授权

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

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

getParent()

检索元素的父元素。

父元素包含当前元素。

返回

ContainerElement|null - 父元素。

授权

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

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

getPreviousSibling()

检索元素的前一个同级元素。

上一个同级元素具有相同的父元素，并且位于当前元素之前。

返回

Element|null - 上一个同级元素。

授权

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

  • 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|null - 合并后的元素。

授权

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

  • 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|null - 移除的元素。

授权

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

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

setAltDescription(description)

设置图片的替代说明。如果给定的说明为 null，则将说明设置为空字符串。

参数

名称类型说明
descriptionString替代说明。

返回

InlineImage - 当前对象。

授权

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

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

setAltTitle(title)

设置图片的替代标题。如果给定的标题为 null，则将标题设置为空字符串。

参数

名称类型说明
titleString备选标题。

返回

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

参数

名称类型说明
attributesObject元素的属性。

返回

InlineImage - 当前元素。

授权

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

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

setHeight(height)

设置图片的高度（以像素为单位）。

参数

名称类型说明
heightInteger图片的高度（以像素为单位）

返回

InlineImage - 当前对象

授权

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

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

setLinkUrl(url)

设置链接网址。如果给定的网址为 null 或空字符串，此方法会创建一个网址为空的链接，该链接在 Google 文档中可能会显示为“无效链接”。

参数

名称类型说明
urlString链接网址。

返回

InlineImage - 当前对象。

授权

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

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

setWidth(width)

设置图片的宽度（以像素为单位）。

参数

名称类型说明
widthInteger图片的宽度（以像素为单位）

返回

InlineImage - 当前对象

授权

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

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