本頁面由 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`	擷取連結網址。
`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`	設定連結網址。
`setWidth(width)`	`InlineImage`	設定圖片的寬度，以像素為單位。

內容詳盡的說明文件

`copy()`

傳回目前元素的已解除連結深層複本。

元素中任何子元素也會一併複製。新元素沒有父項。

回攻員

InlineImage：新副本。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getAltDescription()`

傳回圖片的替代說明。

回攻員

String：備用標題，如果元素沒有備用標題，則為 null

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getAltTitle()`

回傳圖片的替代標題。

回攻員

String：備用標題，如果元素沒有備用標題，則為 null

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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」。

如要查看轉換的每日配額，請參閱「Google 服務的配額」。新建立的 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 列舉中的項目。

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

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

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

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

回攻員

Object：元素的屬性。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getBlob()`

將此物件內的資料以 blob 格式傳回。

回攻員

Blob：資料為 Blob。

`getHeight()`

擷取圖片的高度 (以像素為單位)。

回攻員

Integer：圖片的高度 (以像素為單位)

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getLinkUrl()`

擷取連結網址。

回攻員

String：連結網址，如果元素包含這項屬性的多個值，則為 null。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getNextSibling()`

擷取元素的下一個同層元素。

下一個同層元素具有相同的父項，且位於目前元素之後。

回攻員

Element：下一個同層元素。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getParent()`

擷取元素的父項元素。

父項元素包含目前元素。

回攻員

ContainerElement：父項元素。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getPreviousSibling()`

擷取元素的上一個同層元素。

上一個同層元素具有相同的父項，且位於目前元素之前。

回攻員

Element：上一個同層元素。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getType()`

擷取元素的 ElementType。

使用 getType() 判斷特定元素的確切類型。

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

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

const 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：元素類型。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`isAtDocumentEnd()`

判斷元素是否位於 Document 的結尾。

回攻員

Boolean：元素是否位於分頁結尾。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`merge()`

將元素與相同類型的前一個同胞元素合併。

只能合併相同 ElementType 的元素。目前元素中包含的任何子項元素都會移至前一個同層元素。

系統會從文件中移除目前的元素。

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

回攻員

InlineImage：已合併的元素。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`removeFromParent()`

從父項移除元素。

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

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

回攻員

InlineImage：已移除的元素。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setAltDescription(description)`

設定圖片的替代說明。如果指定的標題為 null，則將說明設為空字串。

參數

名稱	類型	說明
`description`	`String`	替代標題

回攻員

InlineImage：目前的物件

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setAltTitle(title)`

設定圖片的替代標題。如果指定的標題為 null，則將標題設為空字串。

參數

名稱	類型	說明
`title`	`String`	替代標題

回攻員

InlineImage：目前的物件

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setAttributes(attributes)`

設定元素的屬性。

指定的屬性參數必須是物件，其中每個屬性名稱都是 DocumentApp.Attribute 列舉中的項目，每個屬性值則是要套用的新值。

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

// Define a custom paragraph style.
const 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.
const par = body.appendParagraph('A paragraph with custom style.');

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

參數

名稱	類型	說明
`attributes`	`Object`	元素的屬性。

回攻員

InlineImage：目前的元素。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setHeight(height)`

設定圖片的高度 (以像素為單位)。

參數

名稱	類型	說明
`height`	`Integer`	圖片的高度 (以像素為單位)

回攻員

InlineImage：目前的物件

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setLinkUrl(url)`

設定連結網址。如果指定的網址為 null 或空字串，這個方法會建立一個空網址連結，在 Google 文件中可能會顯示為「無效連結」。

參數

名稱	類型	說明
`url`	`String`	連結網址。

回攻員

InlineImage：目前的物件

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setWidth(width)`

設定圖片的寬度，以像素為單位。

參數

名稱	類型	說明
`width`	`Integer`	圖片的寬度，以像素為單位

回攻員

InlineImage：目前的物件

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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