Text

open class Text(data: String = definedExternally) : CharacterData, Slottable(source)

The Text interface represents a text Node in a DOM tree.

MDN Reference

Inheritors

Constructors

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

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

node is a CDATASection node.

Link copied to clipboard

The read-only childNodes property of the Node interface returns a live the first child node is assigned index 0.

Link copied to clipboard

node is a Comment node.

Link copied to clipboard

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

Link copied to clipboard

node is a DocumentFragment node.

Link copied to clipboard

node is a document.

Link copied to clipboard

Set when other is a descendant of node.

Link copied to clipboard

Set when other is an ancestor of node.

Link copied to clipboard

Set when node and other are not in the same tree.

Link copied to clipboard

Set when other is following node.

Link copied to clipboard

Set when other is preceding node.

Link copied to clipboard

node is a doctype.

Link copied to clipboard

node is an element.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

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

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

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The read-only nodeType property of a Node interface is an integer that identifies what the node is.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
open 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

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

node is a ProcessingInstruction node.

Link copied to clipboard

node is a Text node.

Link copied to clipboard

The textContent property of the Node interface represents the text content of the node and its descendants.

Link copied to clipboard

The read-only wholeText property of the Text interface returns the full text of all Text nodes logically adjacent to the node.

Functions

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

open fun after(vararg nodes: Node)

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

Link copied to clipboard
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
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 fun before(vararg nodes: String)

open fun before(vararg nodes: Node)

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

Link copied to clipboard
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.

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
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 (Node.childNodes), one of the children's direct children, and so on.

Link copied to clipboard
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
Link copied to clipboard
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

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

Link copied to clipboard

The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument.

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

The isEqualNode() method of the Node interface tests whether two nodes are equal.

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

The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator.

Link copied to clipboard

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).

Link copied to clipboard
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.

Link copied to clipboard
fun normalize()

The normalize() method of the Node interface puts the specified node and all of its sub-tree into a normalized form.

Link copied to clipboard
open fun remove()

Removes node.

Link copied to clipboard
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
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
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 fun replaceWith(vararg nodes: String)

open fun replaceWith(vararg nodes: Node)

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

Link copied to clipboard
fun splitText(offset: Int): Text

The splitText() method of the Text interface breaks the Text node into two nodes at the specified offset, keeping both nodes in the tree as siblings.

Link copied to clipboard
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