Class Element

Elemento

Es una representación de un nodo Element XML.

// Adds up the values listed in a sample XML document and adds a new element
// with the total.
let xml = '<things>' +
    '<plates>12</plates>' +
    '<bowls>18</bowls>' +
    '<cups>25</cups>' +
    '</things>';
const document = XmlService.parse(xml);
const root = document.getRootElement();
const items = root.getChildren();
let total = 0;
for (let i = 0; i < items.length; i++) {
  total += Number(items[i].getText());
}
const totalElement = XmlService.createElement('total').setText(total);
root.addContent(totalElement);
xml = XmlService.getPrettyFormat().format(document);
Logger.log(xml);

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
addContent(content)	Element	Agrega el nodo determinado como el último elemento secundario del nodo Element.
addContent(index, content)	Element	Inserta el nodo determinado en el índice determinado entre todos los nodos que son hijos inmediatos del nodo Element.
cloneContent()	Content[]	Crea copias no adjuntas de todos los nodos que son secundarios inmediatos del nodo {@code Element}.
detach()	Content|null	Desvincula el nodo de su nodo principal Element.
getAllContent()	Content[]	Obtiene todos los nodos que son secundarios inmediatos del nodo {@code Element}.
getAttribute(name)	Attribute|null	Obtiene el atributo para este nodo Element con el nombre determinado y sin espacio de nombres.
getAttribute(name, namespace)	Attribute|null	Obtiene el atributo para este nodo Element con el nombre y el espacio de nombres determinados.
getAttributes()	Attribute[]	Obtiene todos los atributos de este nodo Element, en el orden en que aparecen en el documento.
getChild(name)	Element|null	Obtiene el primer nodo Element con el nombre determinado y sin espacio de nombres que sea hijo inmediato de este nodo Element.
getChild(name, namespace)	Element|null	Obtiene el primer nodo Element con el nombre y el espacio de nombres determinados que es hijo inmediato de este nodo Element.
getChildText(name)	String|null	Obtiene el valor de texto del nodo con el nombre determinado y sin espacio de nombres, si el nodo es un elemento secundario inmediato del nodo Element.
getChildText(name, namespace)	String|null	Obtiene el valor de texto del nodo con el nombre y el espacio de nombres determinados, si el nodo es un elemento secundario inmediato del nodo Element.
getChildren()	Element[]	Obtiene todos los nodos Element que son elementos secundarios inmediatos de este nodo Element, en el orden en que aparecen en el documento.
getChildren(name)	Element[]	Obtiene todos los nodos Element con el nombre determinado y sin espacio de nombres que son hijos inmediatos de este nodo Element, en el orden en que aparecen en el documento.
getChildren(name, namespace)	Element[]	Obtiene todos los nodos Element con el nombre y el espacio de nombres determinados que son elementos secundarios inmediatos de este nodo Element, en el orden en que aparecen en el documento.
getContent(index)	Content|null	Obtiene el nodo en el índice determinado entre todos los nodos que son hijos inmediatos del nodo {@code Element}.
getContentSize()	Integer	Obtiene la cantidad de nodos que son hijos inmediatos del nodo {@code Element}.
getDescendants()	Content[]	Obtiene todos los nodos que son elementos secundarios directos o indirectos del nodo {@code Element}, en el orden en que aparecen en el documento.
getDocument()	Document	Obtiene el documento XML que contiene el nodo {@code Element}.
getName()	String	Obtiene el nombre local del nodo Element.
getNamespace()	Namespace	Obtiene el espacio de nombres del nodo Element.
getNamespace(prefix)	Namespace	Obtiene el espacio de nombres con el prefijo determinado para el nodo Element.
getParentElement()	Element|null	Obtiene el nodo Element principal del nodo.
getQualifiedName()	String	Obtiene el nombre local y el prefijo del espacio de nombres del nodo Element, en el formato [namespacePrefix]:[localName].
getText()	String	Obtiene el valor de texto del nodo Element.
getValue()	String	Obtiene el valor de texto de todos los nodos que son elementos secundarios directos o indirectos del nodo, en el orden en que aparecen en el documento.
isAncestorOf(other)	Boolean	Determina si este nodo Element es un elemento superior directo o indirecto de un nodo Element determinado.
isRootElement()	Boolean	Determina si el nodo Element es el nodo raíz del documento.
removeAttribute(attribute)	Boolean	Quita el atributo determinado para este nodo Element, si existe tal atributo.
removeAttribute(attributeName)	Boolean	Quita el atributo para este nodo Element con el nombre determinado y sin espacio de nombres, si existe tal atributo.
removeAttribute(attributeName, namespace)	Boolean	Quita el atributo de este nodo Element con el nombre y el espacio de nombres determinados, si existe tal atributo.
removeContent()	Content[]	Quita todos los nodos que son hijos inmediatos del nodo {@code Element}.
removeContent(content)	Boolean	Quita el nodo determinado si este es un elemento secundario inmediato del nodo {@code Element}.
removeContent(index)	Content|null	Quita el nodo en el índice determinado entre todos los nodos que son hijos inmediatos del nodo {@code Element}.
setAttribute(attribute)	Element	Establece el atributo determinado para este nodo Element.
setAttribute(name, value)	Element	Establece el atributo para este nodo Element con el nombre, el valor y el espacio de nombres determinados.
setAttribute(name, value, namespace)	Element	Establece el atributo para este nodo Element con el nombre, el valor y el espacio de nombres determinados.
setName(name)	Element	Establece el nombre local del nodo Element.
setNamespace(namespace)	Element	Establece el espacio de nombres para el nodo Element.
setText(text)	Element	Establece el valor de texto del nodo Element.

Documentación detallada

addContent(content)

Agrega el nodo determinado como el último elemento secundario del nodo Element. El argumento content puede ser un objeto Element o cualquier objeto de nodo que corresponda a un tipo que se enumera en ContentType.

Parámetros

Nombre	Tipo	Descripción
content	Content	Es el nodo que se anexará.

Volver

Element: El nodo Element, para encadenar.

---

addContent(index, content)

Inserta el nodo determinado en el índice determinado entre todos los nodos que son hijos inmediatos del nodo Element. El argumento content puede ser un objeto Element o cualquier objeto de nodo que corresponda a un tipo que se enumera en ContentType.

Parámetros

Nombre	Tipo	Descripción
index	Integer	Índice en el que se insertará el nodo entre todos los nodos que son hijos inmediatos del nodo Element.
content	Content	Es el nodo que se insertará.

Volver

Element: El nodo Element, para encadenar.

---

cloneContent()

Crea copias no adjuntas de todos los nodos que son secundarios inmediatos del nodo {@code Element}.

Volver

Content[]: Es un array de copias no adjuntas de todos los nodos que son elementos secundarios inmediatos del nodo {@code Element}.

---

detach()

Desvincula el nodo de su nodo principal Element. Si el nodo no tiene un elemento superior, este método no tiene efecto.

Volver

Content|null: Es el nodo separado.

---

getAllContent()

Obtiene todos los nodos que son secundarios inmediatos del nodo {@code Element}.

Volver

Content[]: Es un array de todos los nodos que son elementos secundarios inmediatos del nodo {@code Element}.

---

getAttribute(name)

Obtiene el atributo para este nodo Element con el nombre determinado y sin espacio de nombres. Si no existe tal atributo, este método devuelve null.

Parámetros

Nombre	Tipo	Descripción
name	String	Es el nombre del atributo.

Volver

Attribute|null: Es el atributo o null si no hay un atributo con el nombre determinado y ningún espacio de nombres.

---

getAttribute(name, namespace)

Obtiene el atributo para este nodo Element con el nombre y el espacio de nombres determinados. Si no existe tal nodo, este método devuelve null.

Parámetros

Nombre	Tipo	Descripción
name	String	Es el nombre del atributo.
namespace	Namespace	Es el espacio de nombres del atributo.

Volver

Attribute|null: Es el atributo o null si no hay un atributo con el nombre y el espacio de nombres determinados.

---

getAttributes()

Obtiene todos los atributos de este nodo Element, en el orden en que aparecen en el documento.

Volver

Attribute[]: Es un array de todos los atributos de este nodo Element.

---

getChild(name)

Obtiene el primer nodo Element con el nombre determinado y sin espacio de nombres que sea hijo inmediato de este nodo Element. Si no existe tal nodo, este método devuelve null.

Parámetros

Nombre	Tipo	Descripción
name	String	Es el nombre del nodo secundario Element.

Volver

Element|null: Es el nodo Element o null si no hay un nodo Element secundario inmediato con el nombre determinado y sin espacio de nombres.

---

getChild(name, namespace)

Obtiene el primer nodo Element con el nombre y el espacio de nombres determinados que es hijo inmediato de este nodo Element. Si no existe tal nodo, este método devuelve null.

Parámetros

Nombre	Tipo	Descripción
name	String	Es el nombre del nodo secundario Element.
namespace	Namespace	Es el espacio de nombres del nodo secundario Element.

Volver

Element|null: Es el nodo Element o null si no hay un nodo Element secundario inmediato con el nombre y el espacio de nombres determinados.

---

getChildText(name)

Obtiene el valor de texto del nodo con el nombre determinado y sin espacio de nombres, si el nodo es un elemento secundario inmediato del nodo Element. Si no existe tal nodo, este método devuelve null.

Parámetros

Nombre	Tipo	Descripción
name	String	Es el nombre del nodo secundario.

Volver

String|null: Es el valor de texto del nodo secundario o null si no hay un nodo secundario inmediato con el nombre determinado y sin espacio de nombres.

---

getChildText(name, namespace)

Obtiene el valor de texto del nodo con el nombre y el espacio de nombres determinados, si el nodo es un elemento secundario inmediato del nodo Element. Si no existe tal nodo, este método devuelve null.

Parámetros

Nombre	Tipo	Descripción
name	String	Es el nombre del nodo secundario.
namespace	Namespace	Es el espacio de nombres del nodo secundario.

Volver

String|null: Es el valor de texto del nodo secundario o null si no hay un nodo secundario inmediato con el nombre y el espacio de nombres determinados.

---

getChildren()

Obtiene todos los nodos Element que son elementos secundarios inmediatos de este nodo Element, en el orden en que aparecen en el documento.

Volver

Element[]: Es un array de todos los nodos Element que son elementos secundarios inmediatos de este nodo Element.

---

getChildren(name)

Obtiene todos los nodos Element con el nombre determinado y sin espacio de nombres que son hijos inmediatos de este nodo Element, en el orden en que aparecen en el documento.

Parámetros

Nombre	Tipo	Descripción
name	String	Es el nombre de los nodos secundarios Element.

Volver

Element[]: Es un array de todos los nodos Element con el nombre determinado y sin espacio de nombres que son elementos secundarios inmediatos de este nodo Element.

---

getChildren(name, namespace)

Obtiene todos los nodos Element con el nombre y el espacio de nombres determinados que son elementos secundarios inmediatos de este nodo Element, en el orden en que aparecen en el documento.

Parámetros

Nombre	Tipo	Descripción
name	String	Es el nombre de los nodos secundarios Element.
namespace	Namespace	Es el espacio de nombres de los nodos Element secundarios.

Volver

Element[]: Es un array de todos los nodos Element con el nombre y el espacio de nombres determinados que son elementos secundarios inmediatos de este nodo Element.

---

getContent(index)

Obtiene el nodo en el índice determinado entre todos los nodos que son hijos inmediatos del nodo {@code Element}. Si no hay ningún nodo en el índice determinado, este método devuelve null.

Parámetros

Nombre	Tipo	Descripción
index	Integer	Índice del nodo entre todos los nodos que son elementos secundarios inmediatos del nodo {@code Element}.

Volver

Content|null: El nodo o null si no hay ningún nodo en el índice determinado.

---

getContentSize()

Obtiene la cantidad de nodos que son hijos inmediatos del nodo {@code Element}.

Volver

Integer: Es la cantidad de nodos que son hijos inmediatos del nodo {@code Element}.

---

getDescendants()

Obtiene todos los nodos que son elementos secundarios directos o indirectos del nodo {@code Element}, en el orden en que aparecen en el documento.

Volver

Content[]: Es un array de todos los nodos que son elementos secundarios directos o indirectos del nodo {@code Element}.

---

getDocument()

Obtiene el documento XML que contiene el nodo {@code Element}.

Volver

Document: Es el documento que contiene el nodo {@code Element}.

---

getName()

Obtiene el nombre local del nodo Element. Si el nodo tiene un prefijo de espacio de nombres, usa getQualifiedName() o getNamespace().getPrefix() para obtener el prefijo.

Volver

String: Es el nombre local del nodo Element.

---

getNamespace()

Obtiene el espacio de nombres del nodo Element.

Volver

Namespace: Es el espacio de nombres del nodo Element.

---

getNamespace(prefix)

Obtiene el espacio de nombres con el prefijo determinado para el nodo Element.

Parámetros

Nombre	Tipo	Descripción
prefix	String	Es el prefijo del espacio de nombres.

Volver

Namespace: Es el espacio de nombres con el prefijo determinado para el nodo Element.

---

getParentElement()

Obtiene el nodo Element principal del nodo. Si el nodo no tiene un elemento superior, este método devuelve null.

Volver

Element|null: Es el nodo Element principal.

---

getQualifiedName()

Obtiene el nombre local y el prefijo del espacio de nombres del nodo Element, en el formato [namespacePrefix]:[localName]. Si el nodo no tiene un prefijo de espacio de nombres, usa getName().

Volver

String: Es el nombre local y el prefijo del espacio de nombres del nodo Element, con el formato [namespacePrefix]:[localName].

---

getText()

Obtiene el valor de texto del nodo Element.

Volver

String: Es el valor de texto del nodo Element.

---

getValue()

Obtiene el valor de texto de todos los nodos que son elementos secundarios directos o indirectos del nodo, en el orden en que aparecen en el documento.

Volver

String: Es el valor de texto de todos los nodos que son elementos secundarios directos o indirectos del nodo.

---

isAncestorOf(other)

Determina si este nodo Element es un elemento superior directo o indirecto de un nodo Element determinado.

Parámetros

Nombre	Tipo	Descripción
other	Element	El otro nodo Element.

Volver

Boolean: true si este nodo Element es un elemento superior directo o indirecto del nodo Element determinado; false si no lo es.

---

isRootElement()

Determina si el nodo Element es el nodo raíz del documento.

Volver

Boolean: true si el nodo Element es el nodo raíz del documento; false si no lo es.

---

removeAttribute(attribute)

Quita el atributo determinado para este nodo Element, si existe tal atributo.

Parámetros

Nombre	Tipo	Descripción
attribute	Attribute	Es el atributo.

Volver

Boolean: true si el atributo existía y se quitó; false si no.

---

removeAttribute(attributeName)

Quita el atributo para este nodo Element con el nombre determinado y sin espacio de nombres, si existe tal atributo.

Parámetros

Nombre	Tipo	Descripción
attributeName	String	Es el nombre del atributo.

Volver

Boolean: true si el atributo existía y se quitó; false si no.

---

removeAttribute(attributeName, namespace)

Quita el atributo de este nodo Element con el nombre y el espacio de nombres determinados, si existe tal atributo.

Parámetros

Nombre	Tipo	Descripción
attributeName	String	Es el nombre del atributo.
namespace	Namespace	Es el espacio de nombres del atributo.

Volver

Boolean: true si el atributo existía y se quitó; false si no.

---

removeContent()

Quita todos los nodos que son hijos inmediatos del nodo {@code Element}.

Volver

Content[]: Es un array de todos los nodos que eran hijos inmediatos del nodo {@code Element} antes de que se quitaran.

---

removeContent(content)

Quita el nodo determinado si este es un elemento secundario inmediato del nodo {@code Element}. El argumento content puede ser un objeto Element o cualquier objeto de nodo que corresponda a un tipo que se enumera en ContentType.

Parámetros

Nombre	Tipo	Descripción
content	Content	Es el nodo que se quitará.

Volver

Boolean: true si el nodo era un elemento secundario inmediato y se quitó; false si no.

---

removeContent(index)

Quita el nodo en el índice determinado entre todos los nodos que son hijos inmediatos del nodo {@code Element}. Si no hay ningún nodo en el índice determinado, este método devuelve null.

Parámetros

Nombre	Tipo	Descripción
index	Integer	Índice del nodo entre todos los nodos que son elementos secundarios inmediatos del nodo {@code Element}.

Volver

Content|null: Es el nodo que se quitó o null si no hay ningún nodo en el índice determinado.

---

setAttribute(attribute)

Establece el atributo determinado para este nodo Element.

Parámetros

Nombre	Tipo	Descripción
attribute	Attribute	Es el atributo que se establecerá.

Volver

Element: El nodo Element, para encadenar.

---

setAttribute(name, value)

Establece el atributo para este nodo Element con el nombre, el valor y el espacio de nombres determinados.

Parámetros

Nombre	Tipo	Descripción
name	String	Nombre del atributo que se establecerá.
value	String	Es el valor del atributo que se establecerá.

Volver

Element: El nodo Element, para encadenar.

---

setAttribute(name, value, namespace)

Establece el atributo para este nodo Element con el nombre, el valor y el espacio de nombres determinados.

Parámetros

Nombre	Tipo	Descripción
name	String	Nombre del atributo que se establecerá.
value	String	Es el valor del atributo que se establecerá.
namespace	Namespace	Es el espacio de nombres del atributo que se establecerá.

Volver

Element: El nodo Element, para encadenar.

---

setName(name)

Establece el nombre local del nodo Element. Para establecer un prefijo de espacio de nombres para el nodo, usa setNamespace(namespace) junto con XmlService.getNamespace(prefix, uri).

Parámetros

Nombre	Tipo	Descripción
name	String	Es el nombre local que se establecerá.

Volver

Element: El nodo Element, para encadenar.

---

setNamespace(namespace)

Establece el espacio de nombres para el nodo Element.

Parámetros

Nombre	Tipo	Descripción
namespace	Namespace	Es el espacio de nombres que se establecerá.

Volver

Element: El nodo Element, para encadenar.

---

setText(text)

Establece el valor de texto del nodo Element. Si el nodo ya contiene un valor de texto o nodos secundarios, este método reemplaza el contenido anterior. Para agregar o insertar contenido, usa addContent(content) o addContent(index, content).

Parámetros

Nombre	Tipo	Descripción
text	String	Es el texto que se establecerá.

Volver

Element: El nodo Element, para encadenar.