Class PositionedImage

PositionedImage

Paragraph に固定された位置の画像。InlineImage とは異なり、PositionedImageElement ではありません。親や兄弟の Element はありません。代わりに、Paragraph または ListItem に固定され、そのアンカーからのオフセットを介して配置されます。PositionedImage には参照に使用できる ID があります。

var body = DocumentApp.getActiveDocument().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);

Methods

メソッド戻り値の型概要
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」になります。

コンバージョンの 1 日あたりの割り当てを確認するには、Google サービスの割り当てをご覧ください。新しく作成された Google Workspace ドメインには、一時的に割り当てが厳しくなることがあります。

パラメータ

名前説明
contentTypeString変換先の MIME タイプ。ほとんどの blob では、有効なオプションは 'application/pdf' のみです。BMP、GIF、JPEG、PNG 形式の画像の場合は、'image/bmp''image/gif''image/jpeg''image/png' のいずれかも有効です。

リターン

Blob - blob としてのデータ。


getBlob()

このオブジェクト内のデータを blob として返します。

リターン

Blob - blob としてのデータ。


getHeight()

画像の高さ(ピクセル単位)を取得します。

リターン

Integer - 画像の高さ(ピクセル単位)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getId()

画像の ID を取得します。

リターン

String - 画像 ID

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getLayout()

画像のレイアウト方法を表す列挙値を取得します。

リターン

PositionedLayout - 画像レイアウト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getLeftOffset()

段落の左から画像のオフセット(ポイント単位)を取得します。

リターン

Number - 左段落の左からの画像オフセット

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getParagraph()

画像が固定されている Paragraph を取得します。

リターン

Paragraph - 親段落

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getTopOffset()

段落の上部から画像のオフセット(ポイント単位)を取得します。

リターン

Number - 左段落の上端からの画像オフセット

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getWidth()

画像の幅(ピクセル単位)を取得します。

リターン

Integer - 画像の幅(ピクセル単位)。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setHeight(height)

画像の高さをピクセル単位で設定します。

パラメータ

名前説明
heightInteger画像の高さ(ピクセル単位)

リターン

PositionedImage - 現在のオブジェクト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setLayout(layout)

画像の配置の定義を設定します。

パラメータ

名前説明
layoutPositionedLayoutレイアウト モードを表す列挙型

リターン

PositionedImage - チェーン用のこのオブジェクト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setLeftOffset(offset)

段落の左からの画像のオフセットをポイント単位で設定します。

パラメータ

名前説明
offsetNumber段落の左からのオフセット

リターン

PositionedImage - チェーン用のこのオブジェクト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setTopOffset(offset)

段落の上部からの画像のオフセットをポイント単位で設定します。

パラメータ

名前説明
offsetNumber段落の先頭からのオフセット

リターン

PositionedImage - チェーン用のこのオブジェクト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setWidth(width)

画像の幅をピクセル単位で設定します。

パラメータ

名前説明
widthInteger画像の幅(ピクセル単位)

リターン

PositionedImage - 現在のオブジェクト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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