Class InlineImage

InlineImage

Un elemento che rappresenta un'immagine incorporata. Un InlineImage può essere contenuto in un ListItem o Paragraph, a meno che ListItem o Paragraph non rientrino Un FootnoteSection. Un elemento InlineImage non può contenere altri elementi. Per Per ulteriori informazioni sulla struttura dei documenti, consulta la guida all'estensione di Documenti Google.

Metodi

MetodoTipo restituitoBreve descrizione
copy()InlineImageRestituisce una copia diretta scollegata dell'elemento corrente.
getAltDescription()StringRestituisce la descrizione alternativa dell'immagine.
getAltTitle()StringRestituisce il titolo alternativo dell'immagine.
getAs(contentType)BlobRestituisce i dati all'interno di questo oggetto come blob convertito nel tipo di contenuto specificato.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getBlob()BlobRestituisce i dati all'interno dell'oggetto sotto forma di blob.
getHeight()IntegerRecupera l'altezza dell'immagine in pixel.
getLinkUrl()StringRecupera l'URL del link.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
getWidth()IntegerRecupera la larghezza dell'immagine, in pixel.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()InlineImageUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()InlineImageRimuove l'elemento da quello principale.
setAltDescription(description)InlineImageConsente di impostare la descrizione alternativa dell'immagine.
setAltTitle(title)InlineImageImposta il titolo alternativo dell'immagine.
setAttributes(attributes)InlineImageConsente di impostare gli attributi dell'elemento.
setHeight(height)InlineImageConsente di impostare l'altezza dell'immagine in pixel.
setLinkUrl(url)InlineImageImposta l'URL del link.
setWidth(width)InlineImageConsente di impostare la larghezza dell'immagine, in pixel.

Documentazione dettagliata

copy()

Restituisce una copia diretta scollegata dell'elemento corrente.

Vengono copiati anche tutti gli elementi secondari presenti nell'elemento. Il nuovo elemento non ha principale.

Invio

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.

Invio

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.

Invio

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 come blob convertito nel tipo di contenuto specificato. Questo aggiunge l'estensione appropriata al nome del file, ad esempio "miofile.pdf". Tuttavia, presuppone che la parte del nome file che segue l'ultimo punto (se presente) sia una un'estensione che deve essere sostituita. Di conseguenza, "ShoppingList.25.12.2014" diventa "ShoppingList.12.25.pdf".

Per visualizzare le quote giornaliere per le conversioni, consulta Quote per Google Servizi. I domini Google Workspace appena creati potrebbero essere temporaneamente soggetti a restrizioni quote.

Parametri

NomeTipoDescrizione
contentTypeStringIl 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, vengono visualizzati anche i valori 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png' valida. Per un documento di Documenti Google è valido anche 'text/markdown'.

Invio

Blob: i dati come blob.

getAttributes()

Recupera gli attributi dell'elemento.

Il risultato è un oggetto contenente una proprietà per ogni attributo di elemento valido in cui nome della proprietà corrisponde a un elemento nell'enumerazione 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]);
}

Invio

Object: gli 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 dell'oggetto sotto forma di blob.

Invio

Blob: i dati come blob.

getHeight()

Recupera l'altezza dell'immagine in pixel.

Invio

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.

Invio

String: l'URL del link o null se l'elemento contiene più valori per questo .

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'altro elemento di pari livello ha lo stesso elemento principale e segue l'elemento corrente.

Invio

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.

Invio

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.

Invio

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 il valore ElementType dell'elemento.

Usa getType() per determinare il tipo esatto di un determinato elemento. 

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

Invio

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.

Invio

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.

Invio

Boolean: se l'elemento si trova alla fine della scheda.

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 elementi dello stesso elemento ElementType. Qualsiasi elemento secondario contenuto in gli elementi correnti vengono spostati all'elemento di pari livello precedente.

L'elemento corrente viene rimosso dal documento. 

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

Invio

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 da quello principale. 

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

Invio

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)

Consente di impostare la descrizione alternativa dell'immagine. Se il titolo specificato è null, imposta la alla stringa vuota.

Parametri

NomeTipoDescrizione
descriptionStringil titolo alternativo

Invio

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, imposta il titolo su stringa vuota.

Parametri

NomeTipoDescrizione
titleStringil titolo alternativo

Invio

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)

Consente di impostare gli attributi dell'elemento.

Il parametro degli attributi specificato deve essere un oggetto in cui ogni nome di proprietà è un elemento in l'enumerazione DocumentApp.Attribute e il valore di ogni proprietà è il nuovo valore da applicati. 

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

Parametri

NomeTipoDescrizione
attributesObjectGli attributi dell'elemento.

Invio

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)

Consente di impostare l'altezza dell'immagine in pixel.

Parametri

NomeTipoDescrizione
heightIntegerl'altezza dell'immagine, in pixel

Invio

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 crea un link con un URL vuoto che potrebbe essere visualizzato come "Link non valido" in Documenti Google.

Parametri

NomeTipoDescrizione
urlStringl'URL del link

Invio

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)

Consente di impostare la larghezza dell'immagine, in pixel.

Parametri

NomeTipoDescrizione
widthIntegerla larghezza dell'immagine, in pixel

Invio

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