Un elemento che rappresenta un'immagine incorporata. Un InlineImage
può essere contenuto all'interno di ListItem
o Paragraph
, a meno che ListItem
o Paragraph
non siano all'interno di FootnoteSection
. Un elemento InlineImage
non può contenere altri elementi. Per ulteriori informazioni sulla struttura dei documenti, consulta la guida all'estensione di Documenti Google.
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
copy() | InlineImage | Restituisce una copia separata e approfondita dell'elemento corrente. |
getAltDescription() | String | Restituisce la descrizione alternativa dell'immagine. |
getAltTitle() | String | Restituisce il titolo alternativo dell'immagine. |
getAs(contentType) | Blob | Restituisce i dati all'interno di questo oggetto sotto forma di blob convertito nel tipo di contenuto specificato. |
getAttributes() | Object | Recupera gli attributi dell'elemento. |
getBlob() | Blob | Restituisce i dati all'interno di questo oggetto sotto forma di blob. |
getHeight() | Integer | Recupera l'altezza dell'immagine in pixel. |
getLinkUrl() | String | Recupera l'URL del link. |
getNextSibling() | Element | Recupera l'elemento di pari livello successivo dell'elemento. |
getParent() | ContainerElement | Recupera l'elemento principale dell'elemento. |
getPreviousSibling() | Element | Recupera l'elemento di pari livello precedente dell'elemento. |
getType() | ElementType | Recupera l'elemento ElementType dell'elemento. |
getWidth() | Integer | Recupera la larghezza dell'immagine in pixel. |
isAtDocumentEnd() | Boolean | Determina se l'elemento si trova alla fine di Document . |
merge() | InlineImage | Unisce l'elemento con l'elemento di pari livello precedente dello stesso tipo. |
removeFromParent() | InlineImage | Rimuove l'elemento dal relativo elemento principale. |
setAltDescription(description) | InlineImage | Imposta la descrizione alternativa dell'immagine. |
setAltTitle(title) | InlineImage | Imposta il titolo alternativo dell'immagine. |
setAttributes(attributes) | InlineImage | Imposta gli attributi dell'elemento. |
setHeight(height) | InlineImage | Imposta l'altezza dell'immagine in pixel. |
setLinkUrl(url) | InlineImage | Imposta l'URL del link. |
setWidth(width) | InlineImage | Imposta la larghezza dell'immagine in pixel. |
Documentazione dettagliata
copy()
Restituisce una copia separata e approfondita dell'elemento corrente.
Vengono copiati anche tutti gli elementi secondari presenti nell'elemento. Il nuovo elemento non ha un elemento padre.
Ritorni
InlineImage
: la nuova copia.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAltDescription()
Restituisce la descrizione alternativa dell'immagine.
Ritorni
String
: il titolo alternativo o null
se l'elemento non ha un titolo alternativo.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAltTitle()
Restituisce il titolo alternativo dell'immagine.
Ritorni
String
: il titolo alternativo o null
se l'elemento non ha un titolo alternativo.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(contentType)
Restituisce i dati all'interno di questo oggetto sotto forma di blob convertito nel tipo di contenuto specificato. Questo metodo aggiunge l'estensione appropriata al nome del file, ad esempio "myfile.pdf". Tuttavia, si presuppone che la parte del nome del file che segue l'ultimo punto (se presente) sia un'estensione esistente che deve essere sostituita. Di conseguenza, "ShoppingList.12.25.2014" diventa "ShoppingList.12.25.pdf".
Per visualizzare le quote giornaliere per le conversioni, consulta Quote per i servizi Google. I domini Google Workspace appena creati potrebbero essere temporaneamente soggetti a quote più severe.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
contentType | String | Il tipo MIME in cui eseguire la conversione. Per la maggior parte dei blob, 'application/pdf' è l'unica opzione valida. Per le immagini in formato BMP, GIF, JPEG o PNG, è valido anche qualsiasi formato 'image/bmp' , 'image/gif' , 'image/jpeg' o 'image/png' . |
Ritorni
Blob
: i dati sotto forma di blob.
getAttributes()
Recupera gli attributi dell'elemento.
Il risultato è un oggetto contenente una proprietà per ogni attributo valido dell'elemento in cui ogni nome della proprietà corrisponde a un elemento nell'enumerazione DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().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]); }
Ritorni
Object
: attributi dell'elemento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBlob()
Restituisce i dati all'interno di questo oggetto sotto forma di blob.
Ritorni
Blob
: i dati sotto forma di blob.
getHeight()
Recupera l'altezza dell'immagine in pixel.
Ritorni
Integer
: l'altezza dell'immagine, in pixel.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
Recupera l'URL del link.
Ritorni
String
: URL del link oppure null
se l'elemento contiene più valori per questo
attributo.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Recupera l'elemento di pari livello successivo dell'elemento.
L'elemento di pari livello successivo ha lo stesso elemento principale e segue l'elemento corrente.
Ritorni
Element
: l'elemento di pari livello successivo.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Recupera l'elemento principale dell'elemento.
L'elemento principale contiene l'elemento corrente.
Ritorni
ContainerElement
: l'elemento principale.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
Recupera l'elemento di pari livello precedente dell'elemento.
L'elemento di pari livello precedente ha lo stesso elemento principale e precede l'elemento corrente.
Ritorni
Element
: l'elemento di pari livello precedente.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Recupera l'elemento ElementType
dell'elemento.
Utilizza getType()
per determinare il tipo esatto di un determinato elemento.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document 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.'); }
Ritorni
ElementType
: il tipo di elemento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getWidth()
Recupera la larghezza dell'immagine in pixel.
Ritorni
Integer
: la larghezza dell'immagine, in pixel.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Determina se l'elemento si trova alla fine di Document
.
Ritorni
Boolean
: indica se l'elemento si trova alla fine del documento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Unisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
È possibile unire solo gli elementi dello stesso ElementType
. Tutti gli elementi secondari contenuti nell'elemento corrente vengono spostati nell'elemento di pari livello precedente.
L'elemento corrente viene rimosso dal documento.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. 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();
Ritorni
InlineImage
: l'elemento unito.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Rimuove l'elemento dal relativo elemento principale.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Ritorni
InlineImage
: l'elemento rimosso.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAltDescription(description)
Imposta la descrizione alternativa dell'immagine. Se il titolo specificato è null
, imposta
la descrizione sulla stringa vuota.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
description | String | il titolo alternativo |
Ritorni
InlineImage
: l'oggetto corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAltTitle(title)
Imposta il titolo alternativo dell'immagine. Se il titolo specificato è null
, lo imposta sulla stringa vuota.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
title | String | il titolo alternativo |
Ritorni
InlineImage
: l'oggetto corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Imposta gli attributi dell'elemento.
Il parametro degli attributi specificato deve essere un oggetto in cui ogni nome proprietà è un elemento nell'enumerazione DocumentApp.Attribute
e ogni valore di proprietà è il nuovo valore da applicare.
var body = DocumentApp.getActiveDocument().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);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
attributes | Object | Gli attributi dell'elemento. |
Ritorni
InlineImage
: l'elemento corrente.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeight(height)
Imposta l'altezza dell'immagine in pixel.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
height | Integer | l'altezza dell'immagine, in pixel. |
Ritorni
InlineImage
: l'oggetto corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Imposta l'URL del link. Se l'URL specificato è null
o una stringa vuota, questo metodo creerà un link con un URL vuoto che potrebbe essere visualizzato come "Link non valido" in Documenti Google.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
url | String | l'URL del link |
Ritorni
InlineImage
: l'oggetto corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setWidth(width)
Imposta la larghezza dell'immagine in pixel.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
width | Integer | La larghezza dell'immagine, in pixel. |
Ritorni
InlineImage
: l'oggetto corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents