Interface Attr

A DOM element's attribute as an object. In most DOM methods, you will probably directly retrieve the attribute as a string (e.g., Element.getAttribute(), but certain functions (e.g., Element.getAttributeNode()) or means of iterating give Attr types.

interface Attr {
    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>;
    firstChild: null | ChildNode;
    isConnected: boolean;
    lastChild: null | ChildNode;
    localName: string;
    name: string;
    namespaceURI: null | string;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    ownerDocument: Document;
    ownerElement: null | Element;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    prefix: null | string;
    previousSibling: null | ChildNode;
    specified: boolean;
    textContent: null | string;
    value: string;
    addEventListener(type: string, callback: null | EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
    appendChild<T>(node: T): T;
    cloneNode(deep?: boolean): Node;
    compareDocumentPosition(other: Node): number;
    contains(other: null | Node): boolean;
    dispatchEvent(event: Event): boolean;
    getRootNode(options?: GetRootNodeOptions): Node;
    hasChildNodes(): boolean;
    insertBefore<T>(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>(child: T): T;
    removeEventListener(type: string, callback: null | EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
    replaceChild<T>(node: Node, child: T): T;
}

Hierarchy (view full)

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 firstChild isConnected lastChild localName name namespaceURI nextSibling nodeName nodeType nodeValue ownerDocument ownerElement parentElement parentNode prefix previousSibling specified textContent value

Methods

addEventListener appendChild cloneNode compareDocumentPosition contains dispatchEvent getRootNode hasChildNodes insertBefore isDefaultNamespace isEqualNode isSameNode lookupNamespaceURI lookupPrefix normalize removeChild removeEventListener replaceChild

Properties

ReadonlyATTRIBUTE_NODE

ATTRIBUTE_NODE: number

ReadonlyCDATA_SECTION_NODE

CDATA_SECTION_NODE: number

node is a CDATASection node.

ReadonlyCOMMENT_NODE

COMMENT_NODE: number

node is a Comment node.

ReadonlyDOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

ReadonlyDOCUMENT_NODE

DOCUMENT_NODE: number

node is a document.

ReadonlyDOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

ReadonlyDOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

ReadonlyDOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

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

ReadonlyDOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

ReadonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

ReadonlyDOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

ReadonlyDOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

node is a doctype.

ReadonlyELEMENT_NODE

ELEMENT_NODE: number

node is an element.

ReadonlyENTITY_NODE

ENTITY_NODE: number

ReadonlyENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

ReadonlyNOTATION_NODE

NOTATION_NODE: number

ReadonlyPROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

ReadonlyTEXT_NODE

TEXT_NODE: number

node is a Text node.

ReadonlybaseURI

baseURI: string

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

ReadonlychildNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

ReadonlyfirstChild

firstChild: null | ChildNode

Returns the first child.

ReadonlyisConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

ReadonlylastChild

lastChild: null | ChildNode

Returns the last child.

ReadonlylocalName

localName: string

Readonlyname

name: string

ReadonlynamespaceURI

namespaceURI: null | string

ReadonlynextSibling

nextSibling: null | ChildNode

Returns the next sibling.

ReadonlynodeName

nodeName: string

Returns a string appropriate for the type of node.

ReadonlynodeType

nodeType: number

Returns the type of node.

nodeValue

nodeValue: null | string

ReadonlyownerDocument

ownerDocument: Document

Returns the node document. Returns null for documents.

ReadonlyownerElement

ownerElement: null | Element

ReadonlyparentElement

parentElement: null | HTMLElement

Returns the parent element.

ReadonlyparentNode

parentNode: null | ParentNode

Returns the parent.

Readonlyprefix

prefix: null | string

ReadonlypreviousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

Readonlyspecified

specified: boolean

Deprecated

textContent

textContent: null | string

value

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

appendChild

  • appendChild<T>(node): T

  • Type Parameters

    Parameters

    • node: T

    Returns T

cloneNode

  • cloneNode(deep?): Node

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

    Parameters

    • Optionaldeep: 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

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

hasChildNodes

  • hasChildNodes(): boolean

  • Returns whether node has children.

    Returns boolean

insertBefore

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

  • Type Parameters

    Parameters

    • node: T
    • child: null | Node

    Returns T

isDefaultNamespace

  • isDefaultNamespace(namespace): boolean

  • Parameters

    • namespace: null | string

    Returns boolean

isEqualNode

  • isEqualNode(otherNode): boolean

  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: null | Node

    Returns boolean

isSameNode

  • isSameNode(otherNode): boolean

  • Parameters

    • otherNode: null | Node

    Returns boolean

lookupNamespaceURI

  • lookupNamespaceURI(prefix): null | string

  • Parameters

    • prefix: null | string

    Returns null | string

lookupPrefix

  • lookupPrefix(namespace): 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>(child): T

  • Type Parameters

    Parameters

    • child: T

    Returns T

removeEventListener

replaceChild

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

  • Type Parameters

    Parameters

    Returns T

Settings

Member Visibility

On This Page

Properties
Methods