Class PositionedImage

PositionedImage

将图片锚定到 Paragraph 的固定位置。与 InlineImage 不同，PositionedImage 不是 Element。它没有 父级或同级Element。相反， 它锚定在 Paragraph 或 ListItem 上，并通过 该锚点。PositionedImage 具有可用于引用它的 ID。 

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

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

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

// Add the PositionedImage with offsets (in points).
var 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