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