Class InlineDrawing

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.
Dibujo intercalado

Un elemento que representa un dibujo incorporado. Un InlineDrawing puede estar dentro de un ListItem o un Paragraph, a menos que ListItem o Paragraph estén dentro de un FootnoteSection. Una InlineDrawing no puede contener ningún otro elemento. Si deseas obtener más información sobre la estructura de los documentos, consulta la guía para extender Documentos de Google.

Métodos

MétodoTipo de datos que se muestraDescripción breve
copy()InlineDrawingMuestra una copia independiente y profunda del elemento actual.
getAltDescription()StringMuestra la descripción alternativa del dibujo.
getAltTitle()StringMuestra el título alternativo del dibujo.
getAttributes()ObjectRecupera los atributos del elemento.
getNextSibling()ElementRecupera el siguiente elemento del mismo nivel del elemento.
getParent()ContainerElementRecupera el elemento principal del elemento.
getPreviousSibling()ElementRecupera el elemento del mismo nivel anterior del elemento.
getType()ElementTypeRecupera el ElementType del elemento.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()InlineDrawingCombina el elemento con el elemento anterior del mismo tipo.
removeFromParent()InlineDrawingQuita el elemento de su elemento superior.
setAltDescription(description)InlineDrawingEstablece la descripción alternativa del dibujo.
setAltTitle(title)InlineDrawingEstablece el título alternativo del dibujo.
setAttributes(attributes)InlineDrawingEstablece los atributos del elemento.

Documentación detallada

copy()

Muestra una copia independiente y profunda del elemento actual.

También se copiarán todos los elementos secundarios que contenga. El nuevo elemento no tiene un elemento principal.

Volver

InlineDrawing: 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 del dibujo.

Volver

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 del dibujo.

Volver

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

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

Volver

Object: 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

getNextSibling()

Recupera el siguiente elemento del mismo nivel del elemento.

El siguiente elemento del mismo nivel tiene el mismo elemento principal y sigue el elemento actual.

Volver

Element: 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 principal contiene el elemento actual.

Volver

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

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

Volver

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

Volver

ElementType: 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

isAtDocumentEnd()

Determina si el elemento está al final de Document.

Volver

Boolean: Indica si el elemento se encuentra 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 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();

Volver

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

Volver

InlineDrawing: 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 del dibujo. Si el título dado es null, establece la descripción en la string vacía.

Parámetros

NombreTipoDescripción
descriptionStringel título alternativo

Volver

InlineDrawing: 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 del dibujo. Si el título dado es null, establece el título en la string vacía.

Parámetros

NombreTipoDescripción
titleStringel título alternativo

Volver

InlineDrawing: 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 en 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

NombreTipoDescripción
attributesObjectLos atributos del elemento.

Volver

InlineDrawing: 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