Class InlineImage

InlineImage

An element representing an embedded image. An InlineImage can be contained within a ListItem or Paragraph , unless the ListItem or Paragraph is within a FootnoteSection . An InlineImage cannot itself contain any other element. For more information on document structure, see the guide to extending Google Docs .

Methods

Method Return type Brief description
copy()
InlineImage Returns a detached, deep copy of the current element.
getAltDescription()
String Returns the image's alternate description.
getAltTitle()
String Returns the image's alternate title.
getAs(contentType)
Blob Return the data inside this object as a blob converted to the specified content type.
getAttributes()
Object Retrieves the element's attributes.
getBlob()
Blob Return the data inside this object as a blob.
getHeight()
Integer Retrieves the image's height, in pixels.
getLinkUrl()
String Retrieves the link URL.
getNextSibling()
Element Retrieves the element's next sibling element.
getParent()
ContainerElement Retrieves the element's parent element.
getPreviousSibling()
Element Retrieves the element's previous sibling element.
getType()
ElementType Retrieves the element's ElementType .
getWidth()
Integer Retrieves the image's width, in pixels.
isAtDocumentEnd()
Boolean Determines whether the element is at the end of the Document .
merge()
InlineImage Merges the element with the preceding sibling of the same type.
removeFromParent()
InlineImage Removes the element from its parent.
setAltDescription(description)
InlineImage Sets the image's alternate description.
setAltTitle(title)
InlineImage Sets the image's alternate title.
setAttributes(attributes)
InlineImage Sets the element's attributes.
setHeight(height)
InlineImage Sets the image's height, in pixels.
setLinkUrl(url)
InlineImage Sets the link URL.
setWidth(width)
InlineImage Sets the image's width, in pixels.

Detailed documentation

copy()

Returns a detached, deep copy of the current element.

Any child elements present in the element are also copied. The new element doesn't have a parent.

Return

InlineImage — The new copy.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

getAltDescription()

Returns the image's alternate description.

Return

String — the alternate title, or null if the element does not have an alternate title

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

getAltTitle()

Returns the image's alternate title.

Return

String — the alternate title, or null if the element does not have an alternate title

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

getAs(contentType)

Return the data inside this object as a blob converted to the specified content type. This method adds the appropriate extension to the filename—for example, "myfile.pdf". However, it assumes that the part of the filename that follows the last period (if any) is an existing extension that should be replaced. Consequently, "ShoppingList.12.25.2014" becomes "ShoppingList.12.25.pdf".

To view the daily quotas for conversions, see Quotas for Google Services . Newly created Google Workspace domains might be temporarily subject to stricter quotas.

Parameters

Name Type Description
contentType
String The MIME type to convert to. For most blobs, 'application/pdf' is the only valid option. For images in BMP, GIF, JPEG, or PNG format, any of 'image/bmp' , 'image/gif' , 'image/jpeg' , or 'image/png' are also valid. For a Google Docs document, 'text/markdown' is also valid.

Return

Blob — The data as a blob.

getAttributes()

Retrieves the element's attributes.

The result is an object containing a property for each valid element attribute where each property name corresponds to an item in the DocumentApp.Attribute enumeration.

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

Return

Object — The element's attributes.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

getBlob()

Return the data inside this object as a blob.

Return

Blob — The data as a blob.

getHeight()

Retrieves the image's height, in pixels.

Return

Integer — the image's height, in pixels

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

getLinkUrl()

Retrieves the link URL.

Return

String — the link URL, or null if the element contains multiple values for this attribute.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

getNextSibling()

Retrieves the element's next sibling element.

The next sibling has the same parent and follows the current element.

Return

Element — The next sibling element.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

getParent()

Retrieves the element's parent element.

The parent element contains the current element.

Return

ContainerElement — The parent element.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

getPreviousSibling()

Retrieves the element's previous sibling element.

The previous sibling has the same parent and precedes the current element.

Return

Element — The previous sibling element.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

getType()

Retrieves the element's ElementType .

Use getType() to determine the exact type of a given element.

 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.' 
 ); 
 }

Return

ElementType — The element type.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

getWidth()

Retrieves the image's width, in pixels.

Return

Integer — the image's width, in pixels

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

isAtDocumentEnd()

Determines whether the element is at the end of the Document .

Return

Boolean — Whether the element is at the end of the tab.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

merge()

Merges the element with the preceding sibling of the same type.

Only elements of the same ElementType can be merged. Any child elements contained in the current element are moved to the preceding sibling element.

The current element is removed from the document.

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

Return

InlineImage — The merged element.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

removeFromParent()

Removes the element from its parent.

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

Return

InlineImage — The removed element.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

setAltDescription(description)

Sets the image's alternate description. If the given title is null , sets the description to the empty string.

Parameters

Name Type Description
description
String the alternate title

Return

InlineImage — the current object

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

setAltTitle(title)

Sets the image's alternate title. If the given title is null , sets the title to the empty string.

Parameters

Name Type Description
title
String the alternate title

Return

InlineImage — the current object

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

setAttributes(attributes)

Sets the element's attributes.

The specified attributes parameter must be an object where each property name is an item in the DocumentApp.Attribute enumeration and each property value is the new value to be applied.

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

Parameters

Name Type Description
attributes
Object The element's attributes.

Return

InlineImage — The current element.

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

setHeight(height)

Sets the image's height, in pixels.

Parameters

Name Type Description
height
Integer the image's height, in pixels

Return

InlineImage — the current object

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

setLinkUrl(url)

Sets the link URL. If the given URL is null or an empty string, this method will create a link with an empty URL that may display as "Invalid link" in Google Docs.

Parameters

Name Type Description
url
String the link URL

Return

InlineImage — the current object

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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

setWidth(width)

Sets the image's width, in pixels.

Parameters

Name Type Description
width
Integer the image's width, in pixels

Return

InlineImage — the current object

Authorization

Scripts that use this method require authorization with one or more of the following scopes :

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