Class PositionedImage

PositionedImage

固定位置的图片已锚定到 Paragraph。与 InlineImage 不同，PositionedImage 不是 Element。它没有父级或同级 Element。相反，它锚定到 Paragraph 或 ListItem，并通过相对于该锚点的偏移量放置。PositionedImage 有一个 ID，可用于引用它。 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a new paragraph.
const paragraph = body.appendParagraph('New paragraph to anchor the image to.');

// Get an image in Drive from its ID.
const image = DriveApp.getFileById('ENTER_IMAGE_FILE_ID_HERE').getBlob();

// Add the PositionedImage with offsets (in points).
const posImage =
    paragraph.addPositionedImage(image).setTopOffset(60).setLeftOffset(40);

方法

方法返回值类型简介
getAs(contentType)Blob以转换为指定内容类型的 blob 形式返回此对象内的数据。
getBlob()Blob以 blob 形式返回此对象内的数据。
getHeight()Integer检索图片的高度（以像素为单位）。
getId()String获取图片的 ID。
getLayout()PositionedLayout获取一个枚举值，该值表示图片的布局方式。
getLeftOffset()Number获取图片相对于段落左侧的偏移量（以磅为单位）。
getParagraph()Paragraph获取图片锚定到的 Paragraph。
getTopOffset()Number获取图片相对于段落顶部的偏移量（以磅为单位）。
getWidth()Integer检索图片的宽度（以像素为单位）。
setHeight(height)PositionedImage设置图片的高度（以像素为单位）。
setLayout(layout)PositionedImage设置图片布局方式的定义。
setLeftOffset(offset)PositionedImage设置图片相对于段落左侧的偏移量（以磅为单位）。
setTopOffset(offset)PositionedImage设置图片相对于段落顶部的偏移量（以磅为单位）。
setWidth(width)PositionedImage设置图片的宽度（以像素为单位）。

详细文档

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 形式返回的数据。

getBlob()

以 blob 形式返回此对象内的数据。

返回

Blob - 以 blob 形式返回的数据。

getHeight()

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

返回

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

授权

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

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

getId()

获取图片的 ID。

返回

String - 图片 ID

授权

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

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

getLayout()

获取一个枚举值，该值表示图片的布局方式。

返回

PositionedLayout - 图片布局

授权

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

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

getLeftOffset()

获取图片相对于段落左侧的偏移量（以磅为单位）。

返回

Number - 图片相对于段落左侧的偏移量

授权

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

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

getParagraph()

获取图片锚定到的 Paragraph。

返回

Paragraph - 父级段落

授权

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

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

getTopOffset()

获取图片相对于段落顶部的偏移量（以磅为单位）。

返回

Number - 图片相对于段落顶部的偏移量

授权

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

  • 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

setHeight(height)

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

参数

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

返回

PositionedImage - 当前对象

授权

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

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

setLayout(layout)

设置图片布局方式的定义。

参数

名称类型说明
layoutPositionedLayout表示布局模式的枚举

返回

PositionedImage - 用于链式调用的此对象

授权

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

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

setLeftOffset(offset)

设置图片相对于段落左侧的偏移量（以磅为单位）。

参数

名称类型说明
offsetNumber相对于段落左侧的偏移量

返回

PositionedImage - 用于链式调用的此对象

授权

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

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

setTopOffset(offset)

设置图片相对于段落顶部的偏移量（以磅为单位）。

参数

名称类型说明
offsetNumber相对于段落顶部的偏移量

返回

PositionedImage - 用于链式调用的此对象

授权

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

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

setWidth(width)

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

参数

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

返回

PositionedImage - 当前对象

授权

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

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