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 網域可能暫時會受到較嚴格的配額限制。

參數

名稱類型說明
contentTypeString要轉換成的 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，則會將說明設為空字串。

參數

名稱類型說明
descriptionString替代說明。

回攻員

InlineImage：目前的物件。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權：

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

setAltTitle(title)

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

參數

名稱類型說明
titleString替代標題。

回攻員

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);

參數

名稱類型說明
attributesObject元素的屬性。

回攻員

InlineImage：目前的元素。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權：

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

setHeight(height)

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

參數

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

回攻員

InlineImage - 目前物件

授權

使用這個方法的指令碼需要一或多個下列範圍的授權：

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

setLinkUrl(url)

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

參數

名稱類型說明
urlString連結網址。

回攻員

InlineImage：目前的物件。

授權

使用這個方法的指令碼需要一或多個下列範圍的授權：

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

setWidth(width)

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

參數

名稱類型說明
widthInteger圖片的寬度 (以像素為單位)

回攻員

InlineImage - 目前物件

授權

使用這個方法的指令碼需要一或多個下列範圍的授權：

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