Se usó la API de Cloud Translation para traducir esta página.

Class InlineImage

Elemento que representa una imagen incorporada. Un InlineImage puede estar contenido dentro de un ListItem o Paragraph, a menos que ListItem o Paragraph estén dentro de un objeto FootnoteSection. Una InlineImage no puede contener ningún otro elemento. Para más información sobre la estructura de los documentos, consulta la guía para ampliar 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 elemento del mismo nivel del elemento.
`getParent()`	`ContainerElement`	Recupera el elemento superior del elemento.
`getPreviousSibling()`	`Element`	Recupera el elemento del mismo nivel anterior.
`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 elemento nuevo no tiene un superior.

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

Muestra la descripción alternativa de la imagen.

Volver

String: Es el título alternativo, o bien null si el elemento no tiene uno.

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.

Volver

String: Es el título alternativo, o bien null si el elemento no tiene uno.

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. Esta 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 corresponde) es una parte extensión que debe reemplazarse. Por lo tanto, "ShoppingList.12.25.2014" se convierte en “ShoppingList.12.25.pdf”.

Para ver las cuotas diarias de las conversiones, consulta Cuotas para Google Servicios Es posible que los dominios de Google Workspace recién creados estén sujetos temporalmente a restricciones y cuotas.

Parámetros

Nombre	Tipo	Descripción
`contentType`	`String`	El tipo de MIME en el que se convertirá. 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 se aplica cualquiera de los siguientes valores: `'image/bmp'`, `'image/gif'`, `'image/jpeg'` o `'image/png'`. válido. `'text/markdown'` también es válido para Documentos de Google.

Volver

Blob: 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 el nombre de la propiedad corresponde a un elemento de la enumeración 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]);
}

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

Muestra los datos dentro de este objeto como un BLOB.

Volver

Blob: Los datos como un BLOB.

`getHeight()`

Recupera la altura de la imagen en píxeles.

Volver

Integer: Es 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: Es la URL del vínculo, o bien null si el elemento contiene varios valores para este valor. .

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 elemento del mismo nivel del elemento.

El elemento del mismo nivel tiene el mismo elemento superior y sigue al elemento actual.

Volver

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 superior del elemento.

El elemento superior contiene el elemento actual.

Volver

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.

El elemento del mismo nivel anterior tiene el mismo elemento superior y precede al elemento actual.

Volver

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

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: Es 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.

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 elemento del mismo nivel anterior del mismo tipo.

Solo se pueden combinar elementos de la misma ElementType. Cualquier elemento secundario que se incluya en El elemento actual se mueve al elemento del mismo nivel anterior.

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

Volver

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

Volver

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 description a la cadena vacía.

Parámetros

Nombre	Tipo	Descripción
`description`	`String`	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

`setAltTitle(title)`

Establece el título alternativo de la imagen. Si el título dado es null, lo configura como una cadena vacía.

Parámetros

Nombre	Tipo	Descripción
`title`	`String`	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 especificados debe ser un objeto en el que cada nombre de propiedad sea un elemento la enumeración DocumentApp.Attribute y el valor de cada propiedad es el nuevo que se debe se aplicó.

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

Parámetros

Nombre	Tipo	Descripción
`attributes`	`Object`	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

Nombre	Tipo	Descripción
`height`	`Integer`	la 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. Si la URL dada es null o una cadena vacía, este método creará un vínculo con una URL vacía que puede aparecer como "Vínculo no válido" en Documentos de Google.

Parámetros

Nombre	Tipo	Descripción
`url`	`String`	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

Nombre	Tipo	Descripción
`width`	`Integer`	el 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