Interface CharacterData

The CharacterData abstract interface represents a Node object that contains characters. This is an abstract interface, meaning there aren't any object of type CharacterData: it is implemented by other interfaces, like Text, Comment, or ProcessingInstruction which aren't abstract.

MDN Reference

Hierarchy

Properties

ATTRIBUTE_NODE CDATA_SECTION_NODE COMMENT_NODE DOCUMENT_FRAGMENT_NODE DOCUMENT_NODE DOCUMENT_POSITION_CONTAINED_BY DOCUMENT_POSITION_CONTAINS DOCUMENT_POSITION_DISCONNECTED DOCUMENT_POSITION_FOLLOWING DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC DOCUMENT_POSITION_PRECEDING DOCUMENT_TYPE_NODE ELEMENT_NODE ENTITY_NODE ENTITY_REFERENCE_NODE NOTATION_NODE PROCESSING_INSTRUCTION_NODE TEXT_NODE baseURI childNodes data firstChild isConnected lastChild length nextElementSibling nextSibling nodeName nodeType nodeValue ownerDocument parentElement parentNode previousElementSibling previousSibling textContent

Methods

addEventListener after appendChild appendData before cloneNode compareDocumentPosition contains deleteData dispatchEvent getRootNode hasChildNodes insertBefore insertData isDefaultNamespace isEqualNode isSameNode lookupNamespaceURI lookupPrefix normalize remove removeChild removeEventListener replaceChild replaceData replaceWith substringData

Properties

Readonly ATTRIBUTE_NODE

ATTRIBUTE_NODE: 2

Readonly CDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

Readonly COMMENT_NODE

COMMENT_NODE: 8

node is a Comment node.

Readonly DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

Readonly DOCUMENT_NODE

DOCUMENT_NODE: 9

node is a document.

Readonly DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

Readonly DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

Readonly DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1

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

Readonly DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

Readonly DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

Readonly DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10

node is a doctype.

Readonly ELEMENT_NODE

ELEMENT_NODE: 1

node is an element.

Readonly ENTITY_NODE

ENTITY_NODE: 6

Readonly ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5

Readonly NOTATION_NODE

NOTATION_NODE: 12

Readonly PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

Readonly TEXT_NODE

TEXT_NODE: 3

node is a Text node.

Readonly baseURI

baseURI: string

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

MDN Reference

Readonly childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

data

data: string

MDN Reference

Readonly firstChild

firstChild: null | ChildNode

Returns the first child.

MDN Reference

Readonly isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

Readonly lastChild

lastChild: null | ChildNode

Returns the last child.

MDN Reference

Readonly length

length: number

MDN Reference

Readonly nextElementSibling

nextElementSibling: null | Element

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

MDN Reference

Readonly nextSibling

nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

Readonly nodeName

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

Readonly nodeType

nodeType: number

Returns the type of node.

MDN Reference

nodeValue

nodeValue: null | string

MDN Reference

Readonly ownerDocument

ownerDocument: Document

Returns the node document. Returns null for documents.

MDN Reference

Readonly parentElement

parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

Readonly parentNode

parentNode: null | ParentNode

Returns the parent.

MDN Reference

Readonly previousElementSibling

previousElementSibling: null | Element

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

MDN Reference

Readonly previousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

textContent

textContent: null | string

MDN Reference

Methods

addEventListener

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

    MDN Reference

    Parameters

    Returns void

after

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

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

appendChild

  • MDN Reference

    Type Parameters

    Parameters

    • node: T

    Returns T

appendData

  • MDN Reference

    Parameters

    • data: string

    Returns void

before

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

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

cloneNode

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

    MDN Reference

    Parameters

    • Optional deep: boolean

    Returns Node

compareDocumentPosition

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

    MDN Reference

    Parameters

    Returns number

contains

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

    MDN Reference

    Parameters

    Returns boolean

deleteData

  • MDN Reference

    Parameters

    • offset: number
    • count: number

    Returns void

dispatchEvent

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

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

getRootNode

hasChildNodes

  • Returns whether node has children.

    MDN Reference

    Returns boolean

insertBefore

  • MDN Reference

    Type Parameters

    Parameters

    • node: T
    • child: null | Node

    Returns T

insertData

  • MDN Reference

    Parameters

    • offset: number
    • data: string

    Returns void

isDefaultNamespace

  • MDN Reference

    Parameters

    • namespace: null | string

    Returns boolean

isEqualNode

  • Returns whether node and otherNode have the same properties.

    MDN Reference

    Parameters

    • otherNode: null | Node

    Returns boolean

isSameNode

  • MDN Reference

    Parameters

    • otherNode: null | Node

    Returns boolean

lookupNamespaceURI

  • MDN Reference

    Parameters

    • prefix: null | string

    Returns null | string

lookupPrefix

  • MDN Reference

    Parameters

    • namespace: null | string

    Returns null | string

normalize

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

    MDN Reference

    Returns void

remove

  • Removes node.

    MDN Reference

    Returns void

removeChild

  • MDN Reference

    Type Parameters

    Parameters

    • child: T

    Returns T

removeEventListener

replaceChild

replaceData

  • MDN Reference

    Parameters

    • offset: number
    • count: number
    • data: string

    Returns void

replaceWith

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

    MDN Reference

    Parameters

    • Rest ...nodes: (string | Node)[]

    Returns void

substringData

  • MDN Reference

    Parameters

    • offset: number
    • count: number

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc