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」になります。

変換の 1 日あたりの割り当てについては、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 - 画像の高さ（ピクセル単位）

承認

このメソッドを使用するスクリプトには、次の 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