代表內嵌圖片的元素。InlineImage
可以包含在
ListItem
或 Paragraph
,除非 ListItem
或 Paragraph
位於
FootnoteSection
。InlineImage
本身不得包含任何其他元素。適用對象
如要進一步瞭解文件結構,請參閱擴充 Google 文件的指南。
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
copy() | InlineImage | 傳回目前元素的卸離的深度副本。 |
getAltDescription() | String | 傳回圖片的替代說明。 |
getAltTitle() | String | 傳回圖片的替代標題。 |
getAs(contentType) | Blob | 以 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 的形式傳回這個物件中的資料,做為轉換成指定內容類型的 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
列舉中的項目。
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
:元素的屬性。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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()
getParent()
擷取元素的父項元素。
父項元素包含目前元素。
回攻員
ContainerElement
:父項元素。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
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
:元素類型,
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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()
merge()
將元素與前述同類型的同層合併。
只能合併相同 ElementType
的元素。其中包含
目前元素會移至前一個同層元素。
系統隨即會從文件中移除目前的元素。
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
:合併的元素。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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
:已移除的元素。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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
列舉,而每個屬性值都是要
已套用。
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
:目前的元素。
授權
使用這個方法的指令碼需要下列一或多個範圍的授權:
-
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
或空白字串,這個方法會建立
連結含空白網址,可能顯示為「無效連結」。
參數
名稱 | 類型 | 說明 |
---|---|---|
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