Node

Node is an interface from which a number of DOM API object types inherit. It allows those types to be treated similarly; for example, inheriting the same set of methods, or being tested in the same way.

Documentation Node by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See:

Static Members

ELEMENT_NODE: Int

ATTRIBUTE_NODE: Int

TEXT_NODE: Int

CDATA_SECTION_NODE: Int

ENTITY_REFERENCE_NODE: Int

ENTITY_NODE: Int

PROCESSING_INSTRUCTION_NODE: Int

COMMENT_NODE: Int

DOCUMENT_NODE: Int

DOCUMENT_TYPE_NODE: Int

DOCUMENT_FRAGMENT_NODE: Int

NOTATION_NODE: Int

DOCUMENT_POSITION_DISCONNECTED: Int

DOCUMENT_POSITION_PRECEDING: Int

DOCUMENT_POSITION_FOLLOWING: Int

DOCUMENT_POSITION_CONTAINS: Int

DOCUMENT_POSITION_CONTAINED_BY: Int

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: Int

Instance Members

nodeType: Int

Returns an unsigned short representing the type of the node. Possible values are:

Name Value
ELEMENT_NODE 1
ATTRIBUTE_NODE (deprecated) 2
TEXT_NODE 3
CDATA_SECTION_NODE (deprecated) 4
ENTITY_REFERENCE_NODE (deprecated) 5
ENTITY_NODE (deprecated) 6
PROCESSING_INSTRUCTION_NODE 7
COMMENT_NODE 8
DOCUMENT_NODE 9
DOCUMENT_TYPE_NODE 10
DOCUMENT_FRAGMENT_NODE 11
NOTATION_NODE (deprecated) 12

nodeName: String

Returns a DOMString containing the name of the Node. The structure of the name will differ with the node type. E.g. An HTMLElement will contain the name of the corresponding tag, like 'audio' for an HTMLAudioElement, a Text node will have the '#text' string, or a Document node will have the '#document' string.


baseURI: String

Returns a DOMString representing the base URL. The concept of base URL changes from one language to another; in HTML, it corresponds to the protocol, the domain name and the directory structure, that is all until the last '/'.


isConnected: Bool

Returns a boolean indicating whether or not the Node is connected (directly or indirectly) to the context object, e.g. the Document object in the case of the normal DOM, or the ShadowRoot in the case of a shadow DOM.


ownerDocument: HTMLDocument

Returns the Document that this node belongs to. If the node is itself a document, returns null.


parentNode: Node

Returns a Node that is the parent of this node. If there is no such node, like if this node is the top of the tree or if doesn't participate in a tree, this property returns null.


parentElement: Element

Returns an Element that is the parent of this node. If the node has no parent, or if that parent is not an Element, this property returns null.


childNodes: NodeList

Returns a live NodeList containing all the children of this node. NodeList being live means that if the children of the Node change, the NodeList object is automatically updated.


firstChild: Node

Returns a Node representing the first direct child node of the node, or null if the node has no child.


lastChild: Node

Returns a Node representing the last direct child node of the node, or null if the node has no child.


previousSibling: Node

Returns a Node representing the previous node in the tree, or null if there isn't such node.


nextSibling: Node

Returns a Node representing the next node in the tree, or null if there isn't such node.


nodeValue: String

Returns / Sets the value of the current node


textContent: String

Returns / Sets the textual content of an element and all its descendants.


getRootNode(?options: Null<GetRootNodeOptions>): Node

Returns the context object's root which optionally includes the shadow root if it is available.

Name Type Default
options Null<GetRootNodeOptions> (optional)
Returns
Node

hasChildNodes(): Bool

Returns a Boolean indicating if the element has any child nodes, or not.

Returns
Bool

insertBefore(node: Node, child: Node): Node

Inserts a Node before the reference node as a child of a specified parent node.

Name Type
node Node
child Node
Returns
Node

appendChild(node: Node): Node

Adds the specified childNode argument as the last child to the current node.

If the argument referenced an existing node on the DOM tree, the node will be detached from its current position and attached at the new position.

Name Type
node Node
Returns
Node

replaceChild(node: Node, child: Node): Node

Replaces one child Node of the current one with the second one given in parameter.

Name Type
node Node
child Node
Returns
Node

removeChild(child: Node): Node

Removes a child node from the current element, which must be a child of the current node.

Name Type
child Node
Returns
Node

normalize(): Void

Clean up all the text nodes under this element (merge adjacent, remove empty).


cloneNode(?deep: Bool = false): Node

Clone a Node, and optionally, all of its contents. By default, it clones the content of the node.

Name Type Default
deep Bool false
Returns
Node

isSameNode(node: Node): Bool

Returns a Boolean value indicating whether or not the two nodes are the same (that is, they reference the same object).

Name Type
node Node
Returns
Bool

isEqualNode(node: Node): Bool

Returns a Boolean which indicates whether or not two nodes are of the same type and all their defining data points match.

Name Type
node Node
Returns
Bool

compareDocumentPosition(other: Node): Int

Compares the position of the current node against another node in any other document.

Name Type
other Node
Returns
Int

contains(other: Node): Bool

Returns a Boolean value indicating whether a node is a descendant of a given node or not.

Name Type
other Node
Returns
Bool

lookupPrefix(namespace: String): String

Returns a DOMString containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the result is implementation-dependent.

Name Type
namespace String
Returns
String

lookupNamespaceURI(prefix: String): String

Accepts a prefix and returns the namespace URI associated with it on the given node if found (and null if not). Supplying null for the prefix will return the default namespace.

Name Type
prefix String
Returns
String

isDefaultNamespace(namespace: String): Bool

Accepts a namespace URI as an argument and returns a Boolean with a value of true if the namespace is the default namespace on the given node or false if not.

Name Type
namespace String
Returns
Bool