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