Comment

open class Comment(data: String = definedExternally) : CharacterData(source)

The Comment interface represents textual notations within markup; although it is generally not visually shown, such comments are available to be read in the source view.

MDN Reference

Constructors

Link copied to clipboard
constructor(data: String = definedExternally)

Properties

Link copied to clipboard
external val baseURI: String

The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node.

Link copied to clipboard

The read-only childNodes property of the Node interface returns a live NodeList of child nodes of the given element where the first child node is assigned index 0. Child nodes include elements, text and comments.

Link copied to clipboard
external var data: String

The data property of the CharacterData interface represent the value of the current object's data.

Link copied to clipboard
external val firstChild: ChildNode?

The read-only firstChild property of the Node interface returns the node's first child in the tree, or null if the node has no children.

Link copied to clipboard
external val isConnected: Boolean

The read-only isConnected property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.

Link copied to clipboard
external val lastChild: ChildNode?

The read-only lastChild property of the Node interface returns the last child of the node, or null if there are no child nodes.

Link copied to clipboard
external val length: Int

The read-only CharacterData.length property returns the number of characters in the contained data, as a positive integer.

Link copied to clipboard
open external val nextElementSibling: Element?

Returns the first following sibling that is an element, and null otherwise.

Link copied to clipboard
external val nextSibling: ChildNode?

The read-only nextSibling property of the Node interface returns the node immediately following the specified one in their parent's childNodes, or returns null if the specified node is the last child in the parent element.

Link copied to clipboard
external val nodeName: String

The read-only nodeName property of Node returns the name of the current node as a string.

Link copied to clipboard
external val nodeType: NodeType

The read-only nodeType property of a Node interface is an integer that identifies what the node is. It distinguishes different kinds of nodes from each other, such as elements, text, and comments.

Link copied to clipboard
external var nodeValue: String?

The nodeValue property of the Node interface returns or sets the value of the current node.

Link copied to clipboard
open external override val ownerDocument: Document

The read-only ownerDocument property of the Node interface returns the top-level document object of the node.

Link copied to clipboard
external val parentElement: HTMLElement?

The read-only parentElement property of Node interface returns the DOM node's parent Element, or null if the node either has no parent, or its parent isn't a DOM Element. Node.parentNode on the other hand returns any kind of parent, regardless of its type.

Link copied to clipboard
external val parentNode: ParentNode?

The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree.

Link copied to clipboard
open external val previousElementSibling: Element?

Returns the first preceding sibling that is an element, and null otherwise.

Link copied to clipboard
external val previousSibling: ChildNode?

The read-only previousSibling property of the Node interface returns the node immediately preceding the specified one in its parent's childNodes list, or null if the specified node is the first in that list.

Link copied to clipboard
open external override var textContent: String?

Functions

Link copied to clipboard
open external fun after(vararg nodes: String)
open external fun after(vararg nodes: Node)

Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

Link copied to clipboard
external fun <T : Node> appendChild(node: T): T

The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node.

Link copied to clipboard
external fun appendData(data: String)

The appendData() method of the CharacterData interface adds the provided data to the end of the node's current data.

Link copied to clipboard
open external fun before(vararg nodes: String)
open external fun before(vararg nodes: Node)

Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

Link copied to clipboard
external fun cloneNode(subtree: Boolean = definedExternally): Node

The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in the node is also cloned or not.

Link copied to clipboard

The compareDocumentPosition() method of the Node interface reports the position of its argument node relative to the node on which it is called.

Link copied to clipboard
external fun contains(other: Node?): Boolean

The contains() method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (childNodes), one of the children's direct children, and so on.

Link copied to clipboard
external fun deleteData(offset: Int, count: Int)

The deleteData() method of the CharacterData interface removes all or part of the data from this CharacterData node.

Link copied to clipboard
open external fun dispatchEvent(event: Event): Boolean
Link copied to clipboard
external fun getRootNode(options: GetRootNodeOptions = definedExternally): Node

The getRootNode() method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.

Link copied to clipboard
external fun hasChildNodes(): Boolean

The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.

Link copied to clipboard
external fun <T : Node> insertBefore(node: T, child: Node?): T

The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node.

Link copied to clipboard
external fun insertData(offset: Int, data: String)

The insertData() method of the CharacterData interface inserts the provided data into this CharacterData node's current data, at the provided offset from the start of the existing data. The provided data is spliced into the existing data.

Link copied to clipboard
external fun isDefaultNamespace(namespace: String?): Boolean

The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument. It returns a boolean value that is true if the namespace is the default namespace on the given node and false if not. The default namespace can be retrieved with Node.lookupNamespaceURI() by passing null as the argument.

Link copied to clipboard
external fun isEqualNode(otherNode: Node?): Boolean

The isEqualNode() method of the Node interface tests whether two nodes are equal. Two nodes are equal when they have the same type, defining characteristics (for elements, this would be their ID, number of children, and so forth), its attributes match, and so on. The specific set of data points that must match varies depending on the types of the nodes.

Link copied to clipboard
external fun isSameNode(otherNode: Node?): Boolean

The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).

Link copied to clipboard
external fun lookupNamespaceURI(prefix: String?): String?

The lookupNamespaceURI() method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and null if not). This method's existence allows Node objects to be passed as a namespace resolver to XPathEvaluator.createExpression() and XPathEvaluator.evaluate().

Link copied to clipboard
external fun lookupPrefix(namespace: String?): String?

The lookupPrefix() method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and null if not. When multiple prefixes are possible, the first prefix is returned.

Link copied to clipboard
external fun normalize()

The normalize() method of the Node interface puts the specified node and all of its sub-tree into a normalized form. In a normalized sub-tree, no text nodes in the sub-tree are empty and there are no adjacent text nodes.

Link copied to clipboard
open external fun remove()

Removes node.

Link copied to clipboard
external fun <T : Node> removeChild(child: T): T

The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node.

Link copied to clipboard
external fun <T : Node> replaceChild(node: Node, child: T): T

The replaceChild() method of the Node interface replaces a child node within the given (parent) node.

Link copied to clipboard
external fun replaceData(offset: Int, count: Int, data: String)

The replaceData() method of the CharacterData interface removes a certain number of characters of the existing text in a given CharacterData node and replaces those characters with the text provided.

Link copied to clipboard
open external fun replaceWith(vararg nodes: String)
open external fun replaceWith(vararg nodes: Node)

Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

Link copied to clipboard
external fun substringData(offset: Int, count: Int): String

The substringData() method of the CharacterData interface returns a portion of the existing data, starting at the specified index and extending for a given number of characters afterwards.

Link copied to clipboard
external fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>