このページは Cloud Translation API によって翻訳されました。

Class InlineImage

埋め込み画像を表す要素。InlineImage は、 ListItem または Paragraph（ListItem または Paragraph が次の範囲内にある場合を除く） FootnoteSection。InlineImage 自体に他の要素を含めることはできません。対象ドキュメント構造について詳しくは、Google ドキュメントの拡張ガイドをご覧ください。

メソッド

メソッド	戻り値の型	概要
`copy()`	`InlineImage`	現在の要素の分離されたディープコピーを返します。
`getAltDescription()`	`String`	画像の代替説明を返します。
`getAltTitle()`	`String`	画像の代替タイトルを返します。
`getAs(contentType)`	`Blob`	このオブジェクト内のデータを、指定されたコンテンツタイプに変換された blob として返します。
`getAttributes()`	`Object`	要素の属性を取得します。
`getBlob()`	`Blob`	このオブジェクト内のデータを blob として返します。
`getHeight()`	`Integer`	画像の高さ（ピクセル単位）を取得します。
`getLinkUrl()`	`String`	リンクの URL を取得します。
`getNextSibling()`	`Element`	要素の次の兄弟要素を取得します。
`getParent()`	`ContainerElement`	要素の親要素を取得します。
`getPreviousSibling()`	`Element`	要素の前の兄弟要素を取得します。
`getType()`	`ElementType`	要素の `ElementType` を取得します。
`getWidth()`	`Integer`	画像の幅（ピクセル単位）を取得します。
`isAtDocumentEnd()`	`Boolean`	要素が `Document` の最後にあるかどうかを決定します。
`merge()`	`InlineImage`	要素を、先行する同じ型の兄弟要素と結合します。
`removeFromParent()`	`InlineImage`	要素を親から削除します。
`setAltDescription(description)`	`InlineImage`	画像の代替説明を設定します。
`setAltTitle(title)`	`InlineImage`	画像の代替タイトルを設定します。
`setAttributes(attributes)`	`InlineImage`	要素の属性を設定します。
`setHeight(height)`	`InlineImage`	画像の高さをピクセル単位で設定します。
`setLinkUrl(url)`	`InlineImage`	リンクの URL を設定します。
`setWidth(width)`	`InlineImage`	画像の幅をピクセル単位で設定します。

詳細なドキュメント

`copy()`

現在の要素の分離されたディープコピーを返します。

その要素に含まれている子要素もすべてコピーされます。新しい要素にはできます。

戻る

InlineImage - 新しいコピー。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`getAltDescription()`

画像の代替説明を返します。

戻る

String - 代替タイトル。要素に代替タイトルがない場合は null

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`getAltTitle()`

画像の代替タイトルを返します。

戻る

String - 代替タイトル。要素に代替タイトルがない場合は null

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`getAs(contentType)`

このオブジェクト内のデータを、指定されたコンテンツタイプに変換された blob として返します。このメソッドにより、ファイル名に適切な拡張子（例: myfile.pdf）が追加されます。ただし、ファイル名の最後のピリオド（ある場合）に続く部分は、指定します。したがって、「ShoppingList.12.25.2014」となります。が以下に変換される: 「ShoppingList.12.25.pdf」

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

パラメータ

名前	型	説明
`contentType`	`String`	変換先の MIME タイプ。ほとんどの blob の場合、`'application/pdf'` は次のようになります。唯一の有効な選択肢となりますBMP、GIF、JPEG、PNG 形式の画像の場合は、`'image/bmp'`、`'image/gif'`、`'image/jpeg'`、`'image/png'` のいずれかも可有効です。Google ドキュメントのドキュメントの場合は、`'text/markdown'` も有効です。

戻る

Blob - blob としてのデータ。

`getAttributes()`

要素の属性を取得します。

その結果は、各有効な要素属性のプロパティを含むオブジェクトとなり、プロパティ名は、DocumentApp.Attribute 列挙型の項目に対応しています。

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

戻る

Object - 要素の属性。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`getBlob()`

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

戻る

Blob - blob としてのデータ。

`getHeight()`

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

戻る

Integer - 画像の高さ（ピクセル単位）

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`getLinkUrl()`

リンクの URL を取得します。

戻る

String - リンクの URL。要素に複数の値が含まれている場合は null 属性です。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`getNextSibling()`

要素の次の兄弟要素を取得します。

次の兄弟要素は同じ親を持ち、現在の要素に従います。

戻る

Element - 次の兄弟要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`getParent()`

要素の親要素を取得します。

親要素には現在の要素が含まれます。

戻る

ContainerElement - 親要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`getPreviousSibling()`

要素の前の兄弟要素を取得します。

前の兄弟要素は、同じ親を持ち、現在の要素の前に配置されます。

戻る

Element - 前の兄弟要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`getType()`

要素の ElementType を取得します。

getType() を使用して、指定された要素の正確な型を特定します。

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's body.

var firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

戻る

ElementType - 要素のタイプ。

承認

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

`isAtDocumentEnd()`

要素が Document の最後にあるかどうかを決定します。

戻る

Boolean - 要素がタブの最後にあるかどうか。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`merge()`

要素を、先行する同じ型の兄弟要素と結合します。

結合できるのは同じ ElementType の要素のみです。Deployment に含まれる子要素は、現在の要素は前の兄弟要素に移動されます。

現在の要素がドキュメントから削除されます。

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

戻る

InlineImage - マージされた要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`removeFromParent()`

要素を親から削除します。

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab()
var body = documentTab.getBody();

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

戻る

InlineImage - 削除された要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`setAltDescription(description)`

画像の代替説明を設定します。指定されたタイトルが null の場合、 description を空の文字列に変更します。

パラメータ

名前	型	説明
`description`	`String`	代替タイトル

戻る

InlineImage - 現在のオブジェクト

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`setAltTitle(title)`

画像の代替タイトルを設定します。指定されたタイトルが null の場合、タイトルを空の文字列を返します。

パラメータ

名前	型	説明
`title`	`String`	代替タイトル

戻る

InlineImage - 現在のオブジェクト

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`setAttributes(attributes)`

要素の属性を設定します。

指定する属性パラメータは、各プロパティ名がアイテムのアイテムである DocumentApp.Attribute 列挙値。各プロパティ値は新しい値になります。適用されました。

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Define a custom paragraph style.
var style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

パラメータ

名前	型	説明
`attributes`	`Object`	要素の属性。

戻る

InlineImage - 現在の要素。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`setHeight(height)`

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

パラメータ

名前	型	説明
`height`	`Integer`	画像の高さ（ピクセル単位）

戻る

InlineImage - 現在のオブジェクト

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`setLinkUrl(url)`

リンクの URL を設定します。指定された URL が null または空の文字列の場合、このメソッドにより URL が空のリンクで「無効なリンク」と表示される場合がある編集することもできます。

パラメータ

名前	型	説明
`url`	`String`	リンク URL です。

戻る

InlineImage - 現在のオブジェクト

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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

`setWidth(width)`

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

パラメータ

名前	型	説明
`width`	`Integer`	画像の幅（ピクセル単位）

戻る

InlineImage - 現在のオブジェクト

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。

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