Interface Element

Elemento

Es un elemento genérico. El contenido de Document se representa como elementos. Por ejemplo, ListItem, Paragraph y Table son elementos y heredan todos los métodos definidos por Element, como getType().

Implementación de clases

NombreDescripción breve
BodyEs el contenido de una pestaña en un documento de Documentos de Google.
ContainerElementEs un elemento genérico que puede contener otros elementos.
DateUn elemento que representa una fecha con formato
EquationEs un elemento que representa una expresión matemática.
EquationFunctionEs un elemento que representa una función en un Equation matemático.
EquationFunctionArgumentSeparatorEs un elemento que representa un separador de funciones en un Equation matemático.
EquationSymbolEs un elemento que representa un símbolo en un Equation matemático.
FooterSectionEs un elemento que representa una sección de pie de página.
FootnoteEs un elemento que representa una nota al pie.
FootnoteSectionEs un elemento que representa una sección de notas al pie.
HeaderSectionEs un elemento que representa una sección de encabezado.
HorizontalRuleEs un elemento que representa una regla horizontal.
InlineDrawingEs un elemento que representa un dibujo incorporado.
InlineImageEs un elemento que representa una imagen incorporada.
ListItemEs un elemento que representa un elemento de lista.
PageBreakEs un elemento que representa un salto de página.
ParagraphEs un elemento que representa un párrafo.
PersonEs un elemento que representa un vínculo a una persona.
RichLinkEs un elemento que representa un vínculo a un recurso de Google, como un archivo de Drive o un video de YouTube.
TableEs un elemento que representa una tabla.
TableCellEs un elemento que representa una celda de tabla.
TableOfContentsEs un elemento que contiene un índice.
TableRowEs un elemento que representa una fila de la tabla.
TextEs un elemento que representa una región de texto enriquecido.
UnsupportedElementEs un elemento que representa una región desconocida o que no puede verse afectada por una secuencia de comandos, como un número de página.

Métodos

MétodoTipo de datos que se muestraDescripción breve
asBody()BodyDevuelve el elemento actual como un Body.
asDate()DateDevuelve el elemento actual como un Date.
asEquation()EquationDevuelve el elemento actual como un Equation.
asEquationFunction()EquationFunctionDevuelve el elemento actual como un EquationFunction.
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorDevuelve el elemento actual como un EquationFunctionArgumentSeparator.
asEquationSymbol()EquationSymbolDevuelve el elemento actual como un EquationSymbol.
asFooterSection()FooterSectionDevuelve el elemento actual como un FooterSection.
asFootnote()FootnoteDevuelve el elemento actual como un Footnote.
asFootnoteSection()FootnoteSectionDevuelve el elemento actual como un FootnoteSection.
asHeaderSection()HeaderSectionDevuelve el elemento actual como un HeaderSection.
asHorizontalRule()HorizontalRuleDevuelve el elemento actual como un HorizontalRule.
asInlineDrawing()InlineDrawingDevuelve el elemento actual como un InlineDrawing.
asInlineImage()InlineImageDevuelve el elemento actual como un InlineImage.
asListItem()ListItemDevuelve el elemento actual como un ListItem.
asPageBreak()PageBreakDevuelve el elemento actual como un PageBreak.
asParagraph()ParagraphDevuelve el elemento actual como un Paragraph.
asPerson()PersonDevuelve el elemento actual como un Person.
asRichLink()RichLinkDevuelve el elemento actual como un RichLink, por ejemplo, un vínculo a un archivo de Hojas de cálculo de Google.
asTable()TableDevuelve el elemento actual como un Table.
asTableCell()TableCellDevuelve el elemento actual como un TableCell.
asTableOfContents()TableOfContentsDevuelve el elemento actual como un TableOfContents.
asTableRow()TableRowDevuelve el elemento actual como un TableRow.
asText()TextDevuelve el elemento actual como un Text.
copy()ElementDevuelve una copia profunda y separada del elemento actual.
getAttributes()ObjectRecupera los atributos del elemento.
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.
isAtDocumentEnd()BooleanDetermina si el elemento está al final de Document.
merge()Element|nullCombina el elemento con el hermano anterior del mismo tipo.
removeFromParent()Element|nullQuita el elemento de su elemento superior.
setAttributes(attributes)ElementEstablece los atributos del elemento.

Documentación detallada

asBody()

Devuelve el elemento actual como un Body.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asDate()

Devuelve el elemento actual como un Date.

Cuando sepas que un elemento es un Date, usa este método para establecer su tipo como Date. Si lo haces, el autocompletado en el editor de Apps Script te mostrará los métodos que puedes usar con un Date.

Volver

Date: Es el elemento actual con su tipo establecido como Date.

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

asEquation()

Devuelve el elemento actual como un Equation.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asEquationFunction()

Devuelve el elemento actual como un EquationFunction.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asEquationFunctionArgumentSeparator()

Devuelve el elemento actual como un EquationFunctionArgumentSeparator.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asEquationSymbol()

Devuelve el elemento actual como un EquationSymbol.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asFooterSection()

Devuelve el elemento actual como un FooterSection.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asFootnote()

Devuelve el elemento actual como un Footnote.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asFootnoteSection()

Devuelve el elemento actual como un FootnoteSection.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asHeaderSection()

Devuelve el elemento actual como un HeaderSection.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asHorizontalRule()

Devuelve el elemento actual como un HorizontalRule.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asInlineDrawing()

Devuelve el elemento actual como un InlineDrawing.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asInlineImage()

Devuelve el elemento actual como un InlineImage.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

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

asListItem()

Devuelve el elemento actual como un ListItem.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asPageBreak()

Devuelve el elemento actual como un PageBreak.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asParagraph()

Devuelve el elemento actual como un Paragraph.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asPerson()

Devuelve el elemento actual como un Person.

Cuando sepas que un elemento es un Person, usa este método para establecer su tipo como persona. Si lo haces, la función de autocompletar del editor de Apps Script te mostrará los métodos que puedes usar con un elemento de persona.

Volver

Person: Es el elemento actual con su tipo establecido como Person.

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

Devuelve el elemento actual como un RichLink, por ejemplo, un vínculo a un archivo de Hojas de cálculo de Google.

Cuando sepas que un elemento es un RichLink, usa este método para establecer su tipo como RichLink. Si lo haces, la función de autocompletar del editor de Apps Script te mostrará los métodos que puedes usar con un RichLink.

Volver

RichLink: Es el elemento actual con su tipo establecido como RichLink.

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

asTable()

Devuelve el elemento actual como un Table.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asTableCell()

Devuelve el elemento actual como un TableCell.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asTableOfContents()

Devuelve el elemento actual como un TableOfContents.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asTableRow()

Devuelve el elemento actual como un TableRow.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

asText()

Devuelve el elemento actual como un Text.

Usa este método para ayudar al autocompletado cuando se sabe que un elemento determinado es de un tipo específico.

Volver

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

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

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

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

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

isAtDocumentEnd()

Determina si el elemento está al final de Document.

Volver

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

Element|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

Element|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

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

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