Class InlineImage

Immagine in linea

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

Metodi

MetodoTipo restituitoBreve descrizione
copy()InlineImageRestituisce una copia approfondita e 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 contenuti specificato.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getBlob()BlobRestituisce i dati all'interno di questo oggetto come blob.
getHeight()IntegerRecupera l'altezza dell'immagine in pixel.
getLinkUrl()StringRecupera l'URL del link.
getNextSibling()ElementRecupera l'elemento successivo associato all'elemento.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPreviousSibling()ElementRecupera l'elemento precedente associato all'elemento.
getType()ElementTypeRecupera il ElementType dell'elemento.
getWidth()IntegerRecupera la larghezza dell'immagine, in pixel.
isAtDocumentEnd()BooleanDetermina se l'elemento è alla fine del Document.
merge()InlineImageUnisce l'elemento all'elemento precedente dello stesso tipo.
removeFromParent()InlineImageRimuove l'elemento dal relativo elemento principale.
setAltDescription(description)InlineImageImposta la descrizione alternativa dell'immagine.
setAltTitle(title)InlineImageImposta il titolo alternativo dell'immagine.
setAttributes(attributes)InlineImageImposta gli attributi dell'elemento.
setHeight(height)InlineImageImposta l'altezza dell'immagine in pixel.
setLinkUrl(url)InlineImageImposta l'URL del link.
setWidth(width)InlineImageImposta la larghezza dell'immagine in pixel.

Documentazione dettagliata

copy()

Restituisce una copia approfondita e scollegata dell'elemento corrente.

Vengono copiati anche gli eventuali elementi secondari presenti nell'elemento. Il nuovo elemento non ha un elemento primario.

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 contenuti specificato. Questo metodo aggiunge l'estensione appropriata al nome file, ad esempio "myfile.pdf". Tuttavia, assume che la parte del nome 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

NomeTipoDescrizione
contentTypeStringIl tipo MIME a 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, sono validi anche 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'. 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 elemento valido, in cui ogni nome della proprietà corrisponde a un elemento dell'enumerazione 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]}`);
}

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 di questo oggetto come 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 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 successivo associato all'elemento.

L'elemento successivo ha lo stesso elemento principale e segue l'elemento corrente.

Invio

Element: l'elemento successivo associato.

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 precedente associato all'elemento.

L'elemento precedente associato ha lo stesso elemento principale e precede l'elemento corrente.

Invio

Element: l'elemento precedente associato.

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

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

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

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 è alla fine del Document.

Invio

Boolean: indica 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 all'elemento precedente dello stesso tipo.

È possibile unire solo elementi dello stesso ElementType. Tutti gli elementi secondari contenuti nell'elemento corrente vengono spostati nell'elemento precedente associato.

L'elemento corrente viene rimosso dal documento. 

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

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 dal relativo elemento principale. 

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

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)

Imposta la descrizione alternativa dell'immagine. Se il titolo specificato è null, imposta la descrizione sulla 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 sulla 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)

Imposta gli attributi dell'elemento.

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

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

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)

Imposta 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 creerà 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)

Imposta 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