Class ImageItem

    • ImageItem is a layout item used in Google Forms to display an image.

    • ImageItems can be created or accessed from a Form object in Apps Script.

    • You can set or get properties of an ImageItem such as its title, help text, image data, alignment, and width using various methods.

    • The duplicate() method creates a copy of the ImageItem and adds it to the form.
    ImageItem

    A layout item that displays an image. Items can be accessed or created from a Form .

     // Open a form by ID and add a new image item 
 const 
  
 form 
  
 = 
  
 FormApp 
 . 
 openById 
 ( 
 '1234567890abcdefghijklmnopqrstuvwxyz' 
 ); 
 const 
  
 img 
  
 = 
  
 UrlFetchApp 
 . 
 fetch 
 ( 
 'https://www.google.com/images/srpr/logo4w.png' 
 ); 
 form 
 . 
 addImageItem 
 () 
  
 . 
 setTitle 
 ( 
 'Google' 
 ) 
  
 . 
 setHelpText 
 ( 
 'Google Logo' 
 ) 
  
 // The help text is the image description 
  
 . 
 setImage 
 ( 
 img 
 );

    Methods

    Method Return type Brief description
    duplicate()
    		Image Item Creates a copy of this item and appends it to the end of the form.
    get Alignment()
    		Alignment Gets the image's horizontal alignment.
    get Help Text()
    		String Gets the item's help text (sometimes called description text for layout items like Image Items , Page Break Items , and Section Header Items ).
    get Id()
    		Integer Gets the item's unique identifier.
    get Image()
    		Blob Gets the image that is currently assigned to the item.
    get Index()
    		Integer Gets the index of the item among all the items in the form.
    get Title()
    		String Gets the item's title (sometimes called header text, in the case of a Section Header Item ).
    get Type()
    		Item Type Gets the item's type, represented as an Item Type .
    get Width()
    		Integer Gets the image's width in pixels.
    set Alignment(alignment)
    		Image Item Sets the image's horizontal alignment.
    set Help Text(text)
    		Image Item Sets the item's help text (sometimes called description text for layout items like Image Items , Page Break Items , and Section Header Items ).
    set Image(image)
    		Image Item Sets the image itself.
    set Title(title)
    		Image Item Sets the item's title (sometimes called header text, in the case of a Section Header Item ).
    set Width(width)
    		Image Item Sets the image's width in pixels.

    Detailed documentation

    duplicate()

    Creates a copy of this item and appends it to the end of the form.

    Return

    ImageItem — a duplicate of this ImageItem , for chaining

    Authorization

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

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

    getAlignment()

    Gets the image's horizontal alignment.

    Return

    Alignment — the horizontal alignment

    Authorization

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

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

    getHelpText()

    Gets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ).

    Return

    String — the item's help text or description text

    Authorization

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

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

    getId()

    Gets the item's unique identifier.

    Return

    Integer — the item's ID

    Authorization

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

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

    getImage()

    Gets the image that is currently assigned to the item.

    Return

    Blob — the image data

    Authorization

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

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

    getIndex()

    Gets the index of the item among all the items in the form.

    Return

    Integer — the index of the item

    Authorization

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

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

    getTitle()

    Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem ).

    Return

    String — the item's title or header text

    Authorization

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

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

    getType()

    Gets the item's type, represented as an ItemType .

    Return

    ItemType — the item's type

    Authorization

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

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

    getWidth()

    Gets the image's width in pixels.

    Return

    Integer — the width in pixels

    Authorization

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

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

    setAlignment(alignment)

    Sets the image's horizontal alignment.

    Parameters

    Name Type Description
    alignment
    		Alignment the horizontal alignment

    Return

    ImageItem — this ImageItem , for chaining

    Authorization

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

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

    setHelpText(text)

    Sets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ).

    Parameters

    Name Type Description
    text
    		String the new help text

    Return

    ImageItem — this ImageItem , for chaining

    Authorization

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

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

    setImage(image)

    Sets the image itself.

    Parameters

    Name Type Description
    image
    		Blob Source the image data

    Return

    ImageItem — this ImageItem , for chaining

    Authorization

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

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

    setTitle(title)

    Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem ).

    Parameters

    Name Type Description
    title
    		String the new title or header text

    Return

    ImageItem — this ImageItem , for chaining

    Authorization

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

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

    setWidth(width)

    Sets the image's width in pixels. Only the image's width can be set. Height is set automatically to maintain the image's proportions.

    Parameters

    Name Type Description
    width
    		Integer the width in pixels

    Return

    ImageItem — this ImageItem , for chaining

    Authorization

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

    • https://www.googleapis.com/auth/forms.currentonly
    • https://www.googleapis.com/auth/forms
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: