Elemento que representa una imagen incorporada. Un InlineImage
puede estar contenido en una ListItem
o una Paragraph
, a menos que ListItem
o Paragraph
estén dentro de un FootnoteSection
. Una InlineImage
no puede contener ningún otro elemento. Si quieres obtener más información sobre la estructura de los documentos, consulta la guía para extender Documentos de Google.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
copy() | InlineImage | Muestra una copia profunda y separada del elemento actual. |
getAltDescription() | String | Muestra la descripción alternativa de la imagen. |
getAltTitle() | String | Muestra el título alternativo de la imagen. |
getAs(contentType) | Blob | Muestra los datos dentro de este objeto como un BLOB convertido al tipo de contenido especificado. |
getAttributes() | Object | Recupera los atributos del elemento. |
getBlob() | Blob | Muestra los datos dentro de este objeto como un BLOB. |
getHeight() | Integer | Recupera la altura de la imagen en píxeles. |
getLinkUrl() | String | Recupera la URL del vínculo. |
getNextSibling() | Element | Recupera el siguiente elemento del mismo nivel del elemento. |
getParent() | ContainerElement | Recupera el elemento principal del elemento. |
getPreviousSibling() | Element | Recupera el elemento del mismo nivel anterior del elemento. |
getType() | ElementType | Recupera el ElementType del elemento. |
getWidth() | Integer | Recupera el ancho de la imagen en píxeles. |
isAtDocumentEnd() | Boolean | Determina si el elemento se encuentra al final de Document . |
merge() | InlineImage | Combina el elemento con el elemento del mismo nivel anterior del mismo tipo. |
removeFromParent() | InlineImage | Quita el elemento de su elemento superior. |
setAltDescription(description) | InlineImage | Establece la descripción alternativa de la imagen. |
setAltTitle(title) | InlineImage | Establece el título alternativo de la imagen. |
setAttributes(attributes) | InlineImage | Establece los atributos del elemento. |
setHeight(height) | InlineImage | Establece la altura de la imagen en píxeles. |
setLinkUrl(url) | InlineImage | Establece la URL del vínculo. |
setWidth(width) | InlineImage | Establece el ancho de la imagen en píxeles. |
Documentación detallada
copy()
Muestra 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 superior.
Devolvedor
InlineImage
: Es la nueva copia.
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()
Muestra la descripción alternativa de la imagen.
Devolvedor
String
: 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
getAltTitle()
Muestra el título alternativo de la imagen.
Devolvedor
String
: 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)
Muestra 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 de archivo, por ejemplo, “myfile.pdf”. Sin embargo, se supone que la parte del nombre de archivo que sigue al último punto (si existe) es una extensión existente que se debe reemplazar. En consecuencia, “ShoppingList.12.25.2014” se convierte en “ShoppingList.12.25.pdf”.
Para ver las cuotas diarias de las conversiones, consulta Cuotas de los servicios de Google. Los dominios de Google Workspace creados recientemente pueden estar sujetos a cuotas más estrictas de forma temporal.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
contentType | String | El tipo de MIME al que se realizará la conversión. Para la mayoría de los BLOB, 'application/pdf' es la única opción válida. En el caso de las imágenes en formato BMP, GIF, JPEG o PNG, también es válido cualquiera de los valores 'image/bmp' , 'image/gif' , 'image/jpeg' o 'image/png' . |
Devolvedor
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 en la enumeración 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]); }
Devolvedor
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()
getHeight()
Recupera la altura de la imagen en píxeles.
Devolvedor
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.
Devolvedor
String
: Es la URL del vínculo, o bien 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 del mismo nivel del elemento.
El siguiente elemento del mismo nivel tiene el mismo elemento superior y sigue al elemento actual.
Devolvedor
Element
: Es el siguiente elemento del mismo nivel.
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 superior contiene el elemento actual.
Devolvedor
ContainerElement
: Es el elemento superior.
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 del mismo nivel anterior del elemento.
El elemento del mismo nivel anterior tiene el mismo elemento superior y antecede al elemento actual.
Devolvedor
Element
: Es el elemento del mismo nivel 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.
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.'); }
Devolvedor
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.
Devolvedor
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 se encuentra al final de Document
.
Devolvedor
Boolean
: Indica si el elemento está al final del documento.
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 elemento del mismo nivel anterior del mismo tipo.
Solo se pueden combinar elementos del mismo ElementType
. Todos los elementos secundarios contenidos en el elemento actual se mueven al elemento del mismo nivel anterior.
El elemento actual se quita del 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();
Devolvedor
InlineImage
: 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.
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(); }
Devolvedor
InlineImage
: Es el elemento que se quitó.
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 el título dado es null
, establece la descripción como una cadena vacía.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
description | String | el título alternativo |
Devolvedor
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 dado es null
, configúralo con la string vacía.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
title | String | el título alternativo |
Devolvedor
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 especificados 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 valor nuevo que se aplicará.
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);
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
attributes | Object | Los atributos del elemento. |
Devolvedor
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
Nombre | Tipo | Descripción |
---|---|---|
height | Integer | la altura de la imagen en píxeles |
Devolvedor
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. Si la URL proporcionada es null
o una string vacía, este método creará un vínculo con una URL vacía que puede mostrarse como “Vínculo no válido” en Documentos de Google.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
url | String | la URL del vínculo |
Devolvedor
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
Nombre | Tipo | Descripción |
---|---|---|
width | Integer | el ancho de la imagen en píxeles |
Devolvedor
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