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.

interface CharacterData {
    ATTRIBUTE_NODE: number;
    CDATA_SECTION_NODE: number;
    COMMENT_NODE: number;
    DOCUMENT_FRAGMENT_NODE: number;
    DOCUMENT_NODE: number;
    DOCUMENT_POSITION_CONTAINED_BY: number;
    DOCUMENT_POSITION_CONTAINS: number;
    DOCUMENT_POSITION_DISCONNECTED: number;
    DOCUMENT_POSITION_FOLLOWING: number;
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
    DOCUMENT_POSITION_PRECEDING: number;
    DOCUMENT_TYPE_NODE: number;
    ELEMENT_NODE: number;
    ENTITY_NODE: number;
    ENTITY_REFERENCE_NODE: number;
    NOTATION_NODE: number;
    PROCESSING_INSTRUCTION_NODE: number;
    TEXT_NODE: number;
    baseURI: string;
    childNodes: NodeListOf<ChildNode>;
    data: string;
    firstChild: ChildNode;
    isConnected: boolean;
    lastChild: ChildNode;
    length: number;
    nextElementSibling: Element;
    nextSibling: ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: string;
    ownerDocument: Document;
    parentElement: HTMLElement;
    parentNode: ParentNode;
    previousElementSibling: Element;
    previousSibling: ChildNode;
    textContent: string;
    addEventListener(type, callback, options?): void;
    after(...nodes): void;
    appendChild<T>(node): T;
    appendData(data): void;
    before(...nodes): void;
    cloneNode(deep?): Node;
    compareDocumentPosition(other): number;
    contains(other): boolean;
    deleteData(offset, count): void;
    dispatchEvent(event): boolean;
    getRootNode(options?): Node;
    hasChildNodes(): boolean;
    insertBefore<T>(node, child): T;
    insertData(offset, data): void;
    isDefaultNamespace(namespace): boolean;
    isEqualNode(otherNode): boolean;
    isSameNode(otherNode): boolean;
    lookupNamespaceURI(prefix): string;
    lookupPrefix(namespace): string;
    normalize(): void;
    remove(): void;
    removeChild<T>(child): T;
    removeEventListener(type, callback, options?): void;
    replaceChild<T>(node, child): T;
    replaceData(offset, count, data): void;
    replaceWith(...nodes): void;
    substringData(offset, count): string;
}

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

Readonly CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

node is a CDATASection node.

Readonly COMMENT_NODE

COMMENT_NODE: number

node is a Comment node.

Readonly DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

Readonly DOCUMENT_NODE

DOCUMENT_NODE: number

node is a document.

Readonly DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

Readonly DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

Readonly DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

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

Readonly DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

Readonly DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

Readonly DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

node is a doctype.

Readonly ELEMENT_NODE

ELEMENT_NODE: number

node is an element.

Readonly ENTITY_NODE

ENTITY_NODE: number

Readonly ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

Readonly NOTATION_NODE

NOTATION_NODE: number

Readonly PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

Readonly TEXT_NODE

TEXT_NODE: number

node is a Text node.

Readonly baseURI

baseURI: string

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

Readonly childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

data

data: string

Readonly firstChild

firstChild: ChildNode

Returns the first child.

Readonly isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

Readonly lastChild

lastChild: ChildNode

Returns the last child.

Readonly length

length: number

Readonly nextElementSibling

nextElementSibling: Element

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

Readonly nextSibling

nextSibling: 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: string

Readonly ownerDocument

ownerDocument: Document

Returns the node document. Returns null for documents.

Readonly parentElement

parentElement: HTMLElement

Returns the parent element.

Readonly parentNode

parentNode: ParentNode

Returns the parent.

Readonly previousElementSibling

previousElementSibling: Element

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

Readonly previousSibling

previousSibling: ChildNode

Returns the previous sibling.

textContent

textContent: string

Methods

addEventListener

  • addEventListener(type, callback, options?): 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

    Returns void

after

  • after(...nodes): 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

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

    Returns void

appendChild

  • appendChild<T>(node): T

  • Type Parameters

    Parameters

    • node: T

    Returns T

appendData

  • appendData(data): void

  • Parameters

    • data: string

    Returns void

before

  • before(...nodes): 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

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

    Returns void

cloneNode

  • cloneNode(deep?): Node

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

    Parameters

    • Optional deep: boolean

    Returns Node

compareDocumentPosition

  • compareDocumentPosition(other): number

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

    Parameters

    Returns number

contains

  • contains(other): boolean

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

    Parameters

    Returns boolean

deleteData

  • deleteData(offset, count): void

  • Parameters

    • offset: number
    • count: number

    Returns void

dispatchEvent

  • dispatchEvent(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

getRootNode

  • getRootNode(options?): Node

  • Returns node's root.

    Parameters

    Returns Node

hasChildNodes

  • hasChildNodes(): boolean

  • Returns whether node has children.

    Returns boolean

insertBefore

  • insertBefore<T>(node, child): T

  • Type Parameters

    Parameters

    Returns T

insertData

  • insertData(offset, data): void

  • Parameters

    • offset: number
    • data: string

    Returns void

isDefaultNamespace

  • isDefaultNamespace(namespace): boolean

  • Parameters

    • namespace: string

    Returns boolean

isEqualNode

  • isEqualNode(otherNode): boolean

  • Returns whether node and otherNode have the same properties.

    Parameters

    Returns boolean

isSameNode

  • isSameNode(otherNode): boolean

  • Parameters

    Returns boolean

lookupNamespaceURI

  • lookupNamespaceURI(prefix): string

  • Parameters

    • prefix: string

    Returns string

lookupPrefix

  • lookupPrefix(namespace): string

  • Parameters

    • namespace: string

    Returns 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

remove

  • remove(): void

  • Removes node.

    Returns void

removeChild

  • removeChild<T>(child): T

  • Type Parameters

    Parameters

    • child: T

    Returns T

removeEventListener

  • removeEventListener(type, callback, options?): void

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

    Parameters

    Returns void

replaceChild

  • replaceChild<T>(node, child): T

  • Type Parameters

    Parameters

    Returns T

replaceData

  • replaceData(offset, count, data): void

  • Parameters

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

    Returns void

replaceWith

  • replaceWith(...nodes): 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

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

    Returns void

substringData

  • substringData(offset, count): string

  • Parameters

    • offset: number
    • count: number

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc