Text extension type

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

To understand what a text node is, consider the following document:

<html lang="en" class="e">
  <head>
    <title>Aliens?</title>
  </head>
  <body>
    Why yes.
  </body>
</html>

In that document, there are five text nodes, with the following contents:

  • "\n " (after the <head> start tag, a newline followed by four spaces)
  • "Aliens?" (the contents of the title element)
  • "\n " (after the </head> end tag, a newline followed by two spaces)
  • "\n " (after the <body> start tag, a newline followed by two spaces)
  • "\n Why yes.\n \n\n" (the contents of the body element)

Each of those text nodes is an object that has the properties and methods documented in this article.

API documentation sourced from MDN Web Docs.

on
Implemented types
Available extensions

Constructors

Text([String data])
factory

Properties

assignedSlot → HTMLSlotElement?
The read-only assignedSlot property of the Text interface returns the HTMLSlotElement object associated with the element.
no setter
baseURI → String
The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node.
no setterinherited
childNodes → NodeList
The read-only childNodes property of the Node interface returns a live NodeList of child Node of the given element where the first child node is assigned index 0. Child nodes include elements, text and comments.
no setterinherited
data ↔ String
The data property of the CharacterData interface represent the value of the current object's data.
getter/setter pairinherited
firstChild → Node?
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.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
isConnected → bool
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.
no setterinherited
lastChild → Node?
The read-only lastChild property of the Node interface returns the last child of the node, or null if there are no child nodes.
no setterinherited
length → int
The read-only CharacterData.length property returns the number of characters in the contained data, as a positive integer.
no setterinherited
nextElementSibling → Element?
The read-only nextElementSibling property of the CharacterData interface returns the first Element node following the specified one in its parent's children list, or null if the specified element is the last one in the list.
no setterinherited
nextSibling → Node?
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.
no setterinherited
nodeName → String
The read-only nodeName property of Node returns the name of the current node as a string.
no setterinherited
nodeType → int
The read-only nodeType property of a Node interface is an integer that identifies what the node is. It distinguishes different kind of nodes from each other, such as Element, Text and Comment.
no setterinherited
nodeValue ↔ String?
The nodeValue property of the Node interface returns or sets the value of the current node.
getter/setter pairinherited
ownerDocument → Document?
The read-only ownerDocument property of the Node interface returns the top-level document object of the node.
no setterinherited
parentElement → Element?
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.
no setterinherited
parentNode → Node?
The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree.
no setterinherited
previousElementSibling → Element?
The read-only previousElementSibling property of the CharacterData interface returns the first Element before the current node in its parent's children list, or null if there is none.
no setterinherited
previousSibling → Node?
The read-only previousSibling property of the Node interface returns the node immediately preceding the specified one in its parent's Node.childNodes list, or null if the specified node is the first in that list.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
textContent ↔ String?
The textContent property of the Node interface represents the text content of the node and its descendants.
getter/setter pairinherited
wholeText → String
The read-only wholeText property of the Text interface returns the full text of all Text nodes logically adjacent to the node. The text is concatenated in document order. This allows specifying any text node and obtaining all adjacent text as a single string.
no setter

Methods

addEventListener(String type, EventListener? callback, [JSAny options]) → void
The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.
inherited
after(JSAny nodes) → void
The after() method of the CharacterData interface inserts a set of Node objects or strings in the children list of the object's parent, just after the object itself.
inherited
appendChild(Node node) → Node
The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node.
inherited
appendData(String data) → void
The appendData() method of the CharacterData interface adds the provided data to the end of the node's current data.
inherited
before(JSAny nodes) → void
The before() method of the CharacterData interface inserts a set of Node objects and strings in the children list of the CharacterData's parent, just before the CharacterData node.
inherited
cloneNode([bool deep]) → 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 a node is also cloned or not.
inherited
compareDocumentPosition(Node other) → int
The compareDocumentPosition() method of the Node interface reports the position of its argument node relative to the node on which it is called.
inherited
contains(Node? other) → bool
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.
inherited
deleteData(int offset, int count) → void
The deleteData() method of the CharacterData interface removes all or part of the data from this CharacterData node.
inherited
dispatchEvent(Event event) → bool
The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().
inherited
getRootNode([GetRootNodeOptions options]) → Node
The getRootNode() method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.
inherited
hasChildNodes() → bool
The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.
inherited
insertBefore(Node node, Node? child) → Node
The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node.
inherited
insertData(int offset, String data) → void
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.
inherited
isDefaultNamespace(String? namespace) → bool
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.
inherited
isEqualNode(Node? otherNode) → bool
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.
inherited
isSameNode(Node? otherNode) → bool
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).
inherited
lookupNamespaceURI(String? prefix) → 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).
inherited
lookupPrefix(String? namespace) → 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.
inherited
normalize() → void
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.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
remove() → void
The remove() method of the CharacterData removes the text contained in the node.
inherited
removeChild(Node child) → Node
The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node.
inherited
removeEventListener(String type, EventListener? callback, [JSAny options]) → void
The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.
inherited
replaceChild(Node node, Node child) → Node
The replaceChild() method of the Node interface replaces a child node within the given (parent) node.
inherited
replaceData(int offset, int count, String data) → void
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.
inherited
replaceWith(JSAny nodes) → void
The replaceWith() method of the CharacterData interface replaces this node in the children list of its parent with a set of Node objects or string.
inherited
splitText(int offset) → 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.
substringData(int offset, int count) → 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.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited