Class InlineImage

InlineImage

Es un elemento que representa una imagen incorporada. Un InlineImage puede estar contenido dentro de un ListItem o Paragraph, a menos que el ListItem o Paragraph se encuentren dentro de un FootnoteSection. Un InlineImage no puede contener ningún otro elemento. Para obtener más información sobre la estructura del documento, consulta la guía para extender Documentos de Google.

Métodos

MétodoTipo de datos que se devuelveDescripción breve
copy()InlineImageDevuelve una copia profunda y separada del elemento actual.
getAltDescription()String|nullDevuelve la descripción alternativa de la imagen.
getAltTitle()String|nullDevuelve el título alternativo de la imagen.
getAs(contentType)BlobDevuelve los datos dentro de este objeto como un blob convertido al tipo de contenido especificado.
getAttributes()ObjectRecupera los atributos del elemento.
getBlob()BlobDevuelve los datos dentro de este objeto como un blob.
getHeight()IntegerRecupera la altura de la imagen en píxeles.
getLinkUrl()String|nullRecupera la URL del vínculo.
getNextSibling()Element|nullRecupera el siguiente elemento hermano del elemento.
getParent()ContainerElement|nullRecupera el elemento principal del elemento.
getPreviousSibling()Element|nullRecupera el elemento hermano anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
getWidth()IntegerRecupera el ancho de la imagen en píxeles.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()InlineImage|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()InlineImage|nullQuita el elemento de su elemento superior.
setAltDescription(description)InlineImageEstablece la descripción alternativa de la imagen.
setAltTitle(title)InlineImageEstablece el título alternativo de la imagen.
setAttributes(attributes)InlineImageEstablece los atributos del elemento.
setHeight(height)InlineImageEstablece la altura de la imagen en píxeles.
setLinkUrl(url)InlineImageEstablece la URL del vínculo.
setWidth(width)InlineImageEstablece el ancho de la imagen en píxeles.

Documentación detallada

copy()

Devuelve una copia profunda y separada del elemento actual.

También se copian los elementos secundarios presentes en el elemento. El nuevo elemento no tiene un elemento principal.

Volver

InlineImage: Es la copia nueva.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getAltDescription()

Devuelve la descripción alternativa de la imagen.

Volver

String|null: Es la descripción alternativa o null si el elemento no tiene una descripción alternativa.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getAltTitle()

Devuelve el título alternativo de la imagen.

Volver

String|null: Es el título alternativo o null si el elemento no tiene un título alternativo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getAs(contentType)

Devuelve los datos dentro de este objeto como un blob convertido al tipo de contenido especificado. Este método agrega la extensión adecuada al nombre del archivo, por ejemplo, "miarchivo.pdf". Sin embargo, supone que la parte del nombre de archivo que sigue al último punto (si hay alguno) es una extensión existente que se debe reemplazar. Por lo tanto, "ShoppingList.12.25.2014" se convierte en "ShoppingList.12.25.pdf".

Para ver las cuotas diarias de conversiones, consulta Cuotas para los servicios de Google. Es posible que los dominios de Google Workspace recién creados estén sujetos temporalmente a cuotas más estrictas.

Parámetros

NombreTipoDescripción
contentTypeStringEs el tipo de MIME al que se convertirá el archivo. Para la mayoría de los BLOBs, 'application/pdf' es la única opción válida. Para las imágenes en formato BMP, GIF, JPEG o PNG, también son válidos cualquiera de los valores 'image/bmp', 'image/gif', 'image/jpeg' o 'image/png'. En el caso de un documento de Documentos de Google, 'text/markdown' también es un valor válido.

Volver

Blob: Son los datos como un BLOB.

getAttributes()

Recupera los atributos del elemento.

El resultado es un objeto que contiene una propiedad para cada atributo de elemento válido, en el que cada nombre de propiedad corresponde a un elemento de la enumeración 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]}`);
}

Volver

Object: Son los atributos del elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getBlob()

Devuelve los datos dentro de este objeto como un blob.

Volver

Blob: Son los datos como un BLOB.

getHeight()

Recupera la altura de la imagen en píxeles.

Volver

Integer: La altura de la imagen en píxeles

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getLinkUrl()

Recupera la URL del vínculo.

Volver

String|null: Es la URL del vínculo o null si el elemento contiene varios valores para este atributo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getNextSibling()

Recupera el siguiente elemento hermano del elemento.

El siguiente elemento hermano tiene el mismo elemento principal y sigue al elemento actual.

Volver

Element|null: Es el siguiente elemento hermano.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getParent()

Recupera el elemento principal del elemento.

El elemento principal contiene el elemento actual.

Volver

ContainerElement|null: Es el elemento principal.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getPreviousSibling()

Recupera el elemento hermano anterior del elemento.

El elemento hermano anterior tiene el mismo elemento principal y precede al elemento actual.

Volver

Element|null: Es el elemento hermano anterior.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getType()

Recupera el ElementType del elemento.

Usa getType() para determinar el tipo exacto de un elemento determinado. 

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

Volver

ElementType: Es el tipo de elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getWidth()

Recupera el ancho de la imagen en píxeles.

Volver

Integer: El ancho de la imagen en píxeles

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

isAtDocumentEnd()

Determina si el elemento está al final de Document.

Volver

Boolean: Indica si el elemento está al final de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

merge()

Combina el elemento con el hermano anterior del mismo tipo.

Solo se pueden combinar elementos del mismo ElementType. Todos los elementos secundarios incluidos en el elemento actual se mueven al elemento hermano anterior.

Se quita el elemento actual del 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();

Volver

InlineImage|null: Es el elemento combinado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

removeFromParent()

Quita el elemento de su elemento superior. 

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

Volver

InlineImage|null: Es el elemento quitado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setAltDescription(description)

Establece la descripción alternativa de la imagen. Si la descripción proporcionada es null, establece la descripción en la cadena vacía.

Parámetros

NombreTipoDescripción
descriptionStringEs la descripción alternativa.

Volver

InlineImage: Es el objeto actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setAltTitle(title)

Establece el título alternativo de la imagen. Si el título proporcionado es null, se establece el título como una cadena vacía.

Parámetros

NombreTipoDescripción
titleStringEs el título alternativo.

Volver

InlineImage: Es el objeto actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setAttributes(attributes)

Establece los atributos del elemento.

El parámetro de atributos especificado debe ser un objeto en el que cada nombre de propiedad sea un elemento de la enumeración DocumentApp.Attribute y cada valor de propiedad sea el nuevo valor que se aplicará. 

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

Parámetros

NombreTipoDescripción
attributesObjectSon los atributos del elemento.

Volver

InlineImage: Es el elemento actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setHeight(height)

Establece la altura de la imagen en píxeles.

Parámetros

NombreTipoDescripción
heightIntegerLa altura de la imagen en píxeles

Volver

InlineImage: Es el objeto actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setLinkUrl(url)

Establece la URL del vínculo. Cuando la URL proporcionada es null o una cadena vacía, este método crea un vínculo con una URL vacía que puede mostrarse como "Vínculo no válido" en Documentos de Google.

Parámetros

NombreTipoDescripción
urlStringEs la URL del vínculo.

Volver

InlineImage: Es el objeto actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setWidth(width)

Establece el ancho de la imagen en píxeles.

Parámetros

NombreTipoDescripción
widthIntegerEl ancho de la imagen en píxeles

Volver

InlineImage: Es el objeto actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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