Node

Module: JavaScript DOM API

The basic document node.

#include <Node.idl>

Inherits from EventTarget

Inherited by Attr, CharacterData, Document, DocumentFragment, DocumentType, Element

Public Functions

Name
NoderemoveChild(Node oldChild)
remove a child node
NodeappendChild(Node newChild)
append a node as a child
voidappend((Node or DOMString)… newChildren)
append nodes and string objects as children, where the string objects are inserted as equivalent Text nodes
NodereplaceChild(Node newChild, Node oldChild)
replace oldChild with newChild
NodeinsertBefore(Node node, Node? referenceNode)
insert a node before the reference node, as a child of the current node
NodecloneNode(optional boolean deep =false)
booleanisEqualNode(Node? otherNode)
booleanisSameNode(Node? otherNode)
booleanhasChildNodes()
booleancontains(Node? other)
DOMStringlookupPrefix(DOMString? namespace)
booleanisDefaultNamespace(DOMString? namespace)
voidnormalize()
unsigned shortcompareDocumentPosition(Node other)
NodegetRootNode(optional GetRootNodeOptions options)
DOMStringlookupNamespaceURI(DOMString? prefix)

Public Attributes

Name
const unsigned shortELEMENT_NODE
const unsigned shortATTRIBUTE_NODE
const unsigned shortTEXT_NODE
const unsigned shortCDATA_SECTION_NODE
const unsigned shortENTITY_REFERENCE_NODE
const unsigned shortENTITY_NODE
const unsigned shortPROCESSING_INSTRUCTION_NODE
const unsigned shortCOMMENT_NODE
const unsigned shortDOCUMENT_NODE
const unsigned shortDOCUMENT_TYPE_NODE
const unsigned shortDOCUMENT_FRAGMENT_NODE
const unsigned shortNOTATION_NODE
const unsigned shortDOCUMENT_POSITION_DISCONNECTED
const unsigned shortDOCUMENT_POSITION_PRECEDING
const unsigned shortDOCUMENT_POSITION_FOLLOWING
const unsigned shortDOCUMENT_POSITION_CONTAINS
const unsigned shortDOCUMENT_POSITION_CONTAINED_BY
const unsigned shortDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
readonly attribute DOMStringnodeName
attribute DOMStringnodeValue
attribute DOMStringtextContent
readonly attribute unsigned shortnodeType
type of the node
readonly attribute NodeparentNode
parent of the node
readonly attribute ElementparentElement
parent element of the node. If parent is not an Element, returns null.
readonly attribute NodeListchildNodes
list of the children of this node
readonly attribute NodefirstChild
the node’s first child in the tree, or null if the node is childless
readonly attribute NodelastChild
last child of the node, or null if there are no child elements
readonly attribute NodepreviousSibling
the node immediately preceding the specified one in its parent’s children, or null if the specified node is the first in that list
readonly attribute NodenextSibling
the node immediately following the specified one in its parent’s children, or null if the specified node is the last node in that list
readonly attribute DocumentownerDocument
The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.
readonly attribute USVStringbaseURI
readonly attribute booleanisConnected

Additional inherited members

Public Functions inherited from EventTarget

Name
voidaddEventListener(DOMInternedString type, EventListener listener, optional boolean useCapture)
voidremoveEventListener(DOMInternedString type, EventListener listener, optional boolean useCapture)
booleandispatchEvent(Event event)

Public Functions Documentation

function removeChild

Node removeChild(
    Node oldChild
)

remove a child node

Parameters:

  • oldChild the child node to be removed

Return: the removed child node

function appendChild

Node appendChild(
    Node newChild
)

append a node as a child

Parameters:

  • newChild the node to append

Return: the appended child node

function append

void append(
    (Node or DOMString)... newChildren
)

append nodes and string objects as children, where the string objects are inserted as equivalent Text nodes

Parameters:

  • newChildren the nodes or strings to append

function replaceChild

Node replaceChild(
    Node newChild,
    Node oldChild
)

replace oldChild with newChild

Return: the replaced child node

function insertBefore

Node insertBefore(
    Node node,
    Node? referenceNode
)

insert a node before the reference node, as a child of the current node

Parameters:

  • node the new node to be inserted
  • referenceNode the reference node (if null, node will be inserted at the end of the child nodes list)

Return: the inserted node

function cloneNode

Node cloneNode(
    optional boolean deep =false
)

Return: a clone of the node

function isEqualNode

boolean isEqualNode(
    Node? otherNode
)

function isSameNode

boolean isSameNode(
    Node? otherNode
)

function hasChildNodes

boolean hasChildNodes()

function contains

boolean contains(
    Node? other
)

function lookupPrefix

DOMString lookupPrefix(
    DOMString? namespace
)

function isDefaultNamespace

boolean isDefaultNamespace(
    DOMString? namespace
)

function normalize

void normalize()

function compareDocumentPosition

unsigned short compareDocumentPosition(
    Node other
)

function getRootNode

Node getRootNode(
    optional GetRootNodeOptions options
)

function lookupNamespaceURI

DOMString lookupNamespaceURI(
    DOMString? prefix
)

Public Attributes Documentation

variable ELEMENT_NODE

const unsigned short ELEMENT_NODE = 1;

variable ATTRIBUTE_NODE

const unsigned short ATTRIBUTE_NODE = 2;

variable TEXT_NODE

const unsigned short TEXT_NODE = 3;

variable CDATA_SECTION_NODE

const unsigned short CDATA_SECTION_NODE = 4;

variable ENTITY_REFERENCE_NODE

const unsigned short ENTITY_REFERENCE_NODE = 5;

variable ENTITY_NODE

const unsigned short ENTITY_NODE = 6;

variable PROCESSING_INSTRUCTION_NODE

const unsigned short PROCESSING_INSTRUCTION_NODE = 7;

variable COMMENT_NODE

const unsigned short COMMENT_NODE = 8;

variable DOCUMENT_NODE

const unsigned short DOCUMENT_NODE = 9;

variable DOCUMENT_TYPE_NODE

const unsigned short DOCUMENT_TYPE_NODE = 10;

variable DOCUMENT_FRAGMENT_NODE

const unsigned short DOCUMENT_FRAGMENT_NODE = 11;

variable NOTATION_NODE

const unsigned short NOTATION_NODE = 12;

variable DOCUMENT_POSITION_DISCONNECTED

const unsigned short DOCUMENT_POSITION_DISCONNECTED = 0x01;

variable DOCUMENT_POSITION_PRECEDING

const unsigned short DOCUMENT_POSITION_PRECEDING = 0x02;

variable DOCUMENT_POSITION_FOLLOWING

const unsigned short DOCUMENT_POSITION_FOLLOWING = 0x04;

variable DOCUMENT_POSITION_CONTAINS

const unsigned short DOCUMENT_POSITION_CONTAINS = 0x08;

variable DOCUMENT_POSITION_CONTAINED_BY

const unsigned short DOCUMENT_POSITION_CONTAINED_BY = 0x10;

variable DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

const unsigned short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC = 0x20;

variable nodeName

readonly attribute DOMString nodeName;

variable nodeValue

attribute DOMString nodeValue;

variable textContent

attribute DOMString textContent;

variable nodeType

readonly attribute unsigned short nodeType;

type of the node

variable parentNode

readonly attribute Node parentNode;

parent of the node

variable parentElement

readonly attribute Element parentElement;

parent element of the node. If parent is not an Element, returns null.

variable childNodes

readonly attribute NodeList childNodes;

list of the children of this node

variable firstChild

readonly attribute Node firstChild;

the node’s first child in the tree, or null if the node is childless

variable lastChild

readonly attribute Node lastChild;

last child of the node, or null if there are no child elements

variable previousSibling

readonly attribute Node previousSibling;

the node immediately preceding the specified one in its parent’s children, or null if the specified node is the first in that list

variable nextSibling

readonly attribute Node nextSibling;

the node immediately following the specified one in its parent’s children, or null if the specified node is the last node in that list

variable ownerDocument

readonly attribute Document ownerDocument;

The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.

variable baseURI

readonly attribute USVString baseURI;

variable isConnected

readonly attribute boolean isConnected;