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 的形式傳回這個物件中的資料，做為轉換成指定內容類型的 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 的形式傳回這個物件中的資料，做為轉換成指定內容類型的 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