Text

The textual content of Element or Attr. If an element has no markup within its content, it has a single child implementing Text that contains the element's text. However, if the element contains markup, it is parsed into information items and Text nodes that form its children.

interface Text {
    charging?: boolean;
    chargingTime?: number;
    dischargingTime?: number;
    level?: number;
    data: string;
    length: number;
    ownerDocument: Document;
    appendData(data: string): void;
    deleteData(offset: number, count: number): void;
    insertData(offset: number, data: string): void;
    replaceData(offset: number, count: number, data: string): void;
    substringData(offset: number, count: number): string;
    after(...nodes: (string | Node)[]): void;
    before(...nodes: (string | Node)[]): void;
    remove(): void;
    replaceWith(...nodes: (string | Node)[]): void;
    addEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    dispatchEvent(event: Event): boolean;
    removeEventListener(
        type: string,
        callback: null | EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    baseURI: string;
    childNodes: NodeListOf<ChildNode>;
    firstChild: null | ChildNode;
    isConnected: boolean;
    lastChild: null | ChildNode;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    previousSibling: null | ChildNode;
    textContent: null | string;
    appendChild<T extends Node>(node: T): T;
    cloneNode(subtree?: boolean): Node;
    compareDocumentPosition(other: Node): number;
    contains(other: null | Node): boolean;
    getRootNode(options?: GetRootNodeOptions): Node;
    hasChildNodes(): boolean;
    insertBefore<T extends Node>(node: T, child: null | Node): T;
    isDefaultNamespace(namespace: null | string): boolean;
    isEqualNode(otherNode: null | Node): boolean;
    isSameNode(otherNode: null | Node): boolean;
    lookupNamespaceURI(prefix: null | string): null | string;
    lookupPrefix(namespace: null | string): null | string;
    normalize(): void;
    removeChild<T extends Node>(child: T): T;
    replaceChild<T extends Node>(node: Node, child: T): T;
    ELEMENT_NODE: 1;
    ATTRIBUTE_NODE: 2;
    TEXT_NODE: 3;
    CDATA_SECTION_NODE: 4;
    ENTITY_REFERENCE_NODE: 5;
    ENTITY_NODE: 6;
    PROCESSING_INSTRUCTION_NODE: 7;
    COMMENT_NODE: 8;
    DOCUMENT_NODE: 9;
    DOCUMENT_TYPE_NODE: 10;
    DOCUMENT_FRAGMENT_NODE: 11;
    NOTATION_NODE: 12;
    DOCUMENT_POSITION_DISCONNECTED: 1;
    DOCUMENT_POSITION_PRECEDING: 2;
    DOCUMENT_POSITION_FOLLOWING: 4;
    DOCUMENT_POSITION_CONTAINS: 8;
    DOCUMENT_POSITION_CONTAINED_BY: 16;
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
    nextElementSibling: null | Element;
    previousElementSibling: null | Element;
    assignedSlot: null | HTMLSlotElement;
    wholeText: string;
    splitText(offset: number): Text;
}

Hierarchy (View Summary)

CharacterData
Slottable
- Text
  - CDATASection

Index

Properties

<internal>.Text.charging <internal>.Text.chargingTime <internal>.Text.dischargingTime <internal>.Text.level <internal>.Text.data <internal>.Text.length <internal>.Text.ownerDocument <internal>.Text.baseURI <internal>.Text.childNodes <internal>.Text.firstChild <internal>.Text.isConnected <internal>.Text.lastChild <internal>.Text.nextSibling <internal>.Text.nodeName <internal>.Text.nodeType <internal>.Text.nodeValue <internal>.Text.parentElement <internal>.Text.parentNode <internal>.Text.previousSibling <internal>.Text.textContent <internal>.Text.ELEMENT_NODE <internal>.Text.ATTRIBUTE_NODE <internal>.Text.TEXT_NODE <internal>.Text.CDATA_SECTION_NODE <internal>.Text.ENTITY_REFERENCE_NODE <internal>.Text.ENTITY_NODE <internal>.Text.PROCESSING_INSTRUCTION_NODE <internal>.Text.COMMENT_NODE <internal>.Text.DOCUMENT_NODE <internal>.Text.DOCUMENT_TYPE_NODE <internal>.Text.DOCUMENT_FRAGMENT_NODE <internal>.Text.NOTATION_NODE <internal>.Text.DOCUMENT_POSITION_DISCONNECTED <internal>.Text.DOCUMENT_POSITION_PRECEDING <internal>.Text.DOCUMENT_POSITION_FOLLOWING <internal>.Text.DOCUMENT_POSITION_CONTAINS <internal>.Text.DOCUMENT_POSITION_CONTAINED_BY <internal>.Text.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC <internal>.Text.nextElementSibling <internal>.Text.previousElementSibling <internal>.Text.assignedSlot <internal>.Text.wholeText

Properties

`Optional`charging

charging?: boolean

`Optional`chargingTime

chargingTime?: number

`Optional`dischargingTime

dischargingTime?: number

`Optional`level

level?: number

data

data: string

`Readonly`length

length: number

`Readonly`ownerDocument

ownerDocument: Document

Returns the node document. Returns null for documents.

`Readonly`baseURI

baseURI: string

Returns node's node document's document base URL.

`Readonly`childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

`Readonly`firstChild

firstChild: null | ChildNode

Returns the first child.

`Readonly`isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

`Readonly`lastChild

lastChild: null | ChildNode

Returns the last child.

`Readonly`nextSibling

nextSibling: null | ChildNode

Returns the next sibling.

`Readonly`nodeName

nodeName: string

Returns a string appropriate for the type of node.

`Readonly`nodeType

nodeType: number

Returns the type of node.

nodeValue

nodeValue: null | string

`Readonly`parentElement

parentElement: null | HTMLElement

Returns the parent element.

`Readonly`parentNode

parentNode: null | ParentNode

Returns the parent.

`Readonly`previousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

textContent

textContent: null | string

`Readonly`ELEMENT_NODE

ELEMENT_NODE: 1

node is an element.

`Readonly`ATTRIBUTE_NODE

ATTRIBUTE_NODE: 2

`Readonly`TEXT_NODE

TEXT_NODE: 3

node is a Text node.

`Readonly`CDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

`Readonly`ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5

`Readonly`ENTITY_NODE

ENTITY_NODE: 6

`Readonly`PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

`Readonly`COMMENT_NODE

COMMENT_NODE: 8

node is a Comment node.

`Readonly`DOCUMENT_NODE

DOCUMENT_NODE: 9

node is a document.

`Readonly`DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10

node is a doctype.

`Readonly`DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

`Readonly`NOTATION_NODE

NOTATION_NODE: 12

`Readonly`DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1

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

`Readonly`DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

`Readonly`DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

`Readonly`DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

`Readonly`DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

`Readonly`DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

`Readonly`nextElementSibling

nextElementSibling: null | Element

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

`Readonly`previousElementSibling

previousElementSibling: null | Element

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

`Readonly`assignedSlot

assignedSlot: null | HTMLSlotElement

`Readonly`wholeText

wholeText: string

Returns the combined data of all direct Text node siblings.

Methods

appendData

appendData(data: string): void

Parameters

```
data: string
```

Returns void

deleteData

deleteData(offset: number, count: number): void

Parameters

```
offset: number
```
```
count: number
```

Returns void

insertData

insertData(offset: number, data: string): void

Parameters

```
offset: number
```
```
data: string
```

Returns void

replaceData

replaceData(offset: number, count: number, data: string): void

Parameters

```
offset: number
```
```
count: number
```
```
data: string
```

Returns void

substringData

substringData(offset: number, count: number): string

Parameters

```
offset: number
```
```
count: number
```

Returns string

after

after(...nodes: (string | Node)[]): void

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

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters

```
…nodes: (string | Node)[]
```

Returns void

before

before(...nodes: (string | Node)[]): void

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

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters

```
…nodes: (string | Node)[]
```

Returns void

remove

remove(): void

Removes node.

Returns void

replaceWith

replaceWith(...nodes: (string | Node)[]): void

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

Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

Parameters

```
…nodes: (string | Node)[]
```

Returns void

addEventListener

addEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

Parameters

```
type: string
```

callback: null | EventListenerOrEventListenerObject

Optionaloptions: boolean | AddEventListenerOptions

Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Parameters

```
event: Event
```

Returns boolean

removeEventListener

removeEventListener(
    type: string,
    callback: null | EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void

Removes the event listener in target's event listener list with the same type, callback, and options.

Parameters

```
type: string
```

callback: null | EventListenerOrEventListenerObject

Optionaloptions: boolean | EventListenerOptions

Returns void

appendChild

appendChild<T extends Node>(node: T): T

Type Parameters

T extends Node

Parameters

```
node: T
```

Returns T

cloneNode

cloneNode(subtree?: boolean): Node

Returns a copy of node. If deep is true, the copy also includes the node's descendants.

Parameters

```
Optionalsubtree: boolean
```

Returns Node

compareDocumentPosition

compareDocumentPosition(other: Node): number

Returns a bitmask indicating the position of other relative to node.

Parameters

```
other: Node
```

Returns number

contains

contains(other: null | Node): boolean

Returns true if other is an inclusive descendant of node, and false otherwise.

Parameters

```
other: null | Node
```

Returns boolean

getRootNode

getRootNode(options?: GetRootNodeOptions): Node

Returns node's root.

Parameters

```
Optionaloptions: GetRootNodeOptions
```

Returns Node

hasChildNodes

hasChildNodes(): boolean

Returns whether node has children.

Returns boolean

insertBefore

insertBefore<T extends Node>(node: T, child: null | Node): T

Type Parameters

T extends Node

Parameters

```
node: T
```
```
child: null | Node
```

Returns T

isDefaultNamespace

isDefaultNamespace(namespace: null | string): boolean

Parameters

```
namespace: null | string
```

Returns boolean

isEqualNode

isEqualNode(otherNode: null | Node): boolean

Returns whether node and otherNode have the same properties.

Parameters

```
otherNode: null | Node
```

Returns boolean

isSameNode

isSameNode(otherNode: null | Node): boolean

Parameters

```
otherNode: null | Node
```

Returns boolean

lookupNamespaceURI

lookupNamespaceURI(prefix: null | string): null | string

Parameters

```
prefix: null | string
```

Returns null | string

lookupPrefix

lookupPrefix(namespace: null | string): null | string

Parameters

```
namespace: null | string
```

Returns null | string

normalize

normalize(): void

Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

Returns void

removeChild

removeChild<T extends Node>(child: T): T

Type Parameters

T extends Node

Parameters

```
child: T
```

Returns T

replaceChild

replaceChild<T extends Node>(node: Node, child: T): T

Type Parameters

T extends Node

Parameters

```
node: Node
```
```
child: T
```

Returns T

splitText

splitText(offset: number): Text

Splits data at the given offset and returns the remainder as Text node.

Parameters

```
offset: number
```

Returns Text