Interface Element

Element is the most general base class from which all objects in a Document inherit. It only has methods and properties common to all kinds of elements. More specific classes inherit from Element.

MDN Reference

interface Element {
    ariaAtomic: null | string;
    ariaAutoComplete: null | string;
    ariaBrailleLabel: null | string;
    ariaBrailleRoleDescription: null | string;
    ariaBusy: null | string;
    ariaChecked: null | string;
    ariaColCount: null | string;
    ariaColIndex: null | string;
    ariaColIndexText: null | string;
    ariaColSpan: null | string;
    ariaCurrent: null | string;
    ariaDescription: null | string;
    ariaDisabled: null | string;
    ariaExpanded: null | string;
    ariaHasPopup: null | string;
    ariaHidden: null | string;
    ariaInvalid: null | string;
    ariaKeyShortcuts: null | string;
    ariaLabel: null | string;
    ariaLevel: null | string;
    ariaLive: null | string;
    ariaModal: null | string;
    ariaMultiLine: null | string;
    ariaMultiSelectable: null | string;
    ariaOrientation: null | string;
    ariaPlaceholder: null | string;
    ariaPosInSet: null | string;
    ariaPressed: null | string;
    ariaReadOnly: null | string;
    ariaRequired: null | string;
    ariaRoleDescription: null | string;
    ariaRowCount: null | string;
    ariaRowIndex: null | string;
    ariaRowIndexText: null | string;
    ariaRowSpan: null | string;
    ariaSelected: null | string;
    ariaSetSize: null | string;
    ariaSort: null | string;
    ariaValueMax: null | string;
    ariaValueMin: null | string;
    ariaValueNow: null | string;
    ariaValueText: null | string;
    assignedSlot: null | HTMLSlotElement;
    ATTRIBUTE_NODE: 2;
    attributes: NamedNodeMap;
    baseURI: string;
    CDATA_SECTION_NODE: 4;
    childElementCount: number;
    childNodes: NodeListOf<ChildNode>;
    children: HTMLCollection;
    classList: DOMTokenList;
    className: string;
    clientHeight: number;
    clientLeft: number;
    clientTop: number;
    clientWidth: number;
    COMMENT_NODE: 8;
    currentCSSZoom: number;
    DOCUMENT_FRAGMENT_NODE: 11;
    DOCUMENT_NODE: 9;
    DOCUMENT_POSITION_CONTAINED_BY: 16;
    DOCUMENT_POSITION_CONTAINS: 8;
    DOCUMENT_POSITION_DISCONNECTED: 1;
    DOCUMENT_POSITION_FOLLOWING: 4;
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
    DOCUMENT_POSITION_PRECEDING: 2;
    DOCUMENT_TYPE_NODE: 10;
    ELEMENT_NODE: 1;
    ENTITY_NODE: 6;
    ENTITY_REFERENCE_NODE: 5;
    firstChild: null | ChildNode;
    firstElementChild: null | Element;
    id: string;
    innerHTML: string;
    isConnected: boolean;
    lastChild: null | ChildNode;
    lastElementChild: null | Element;
    localName: string;
    namespaceURI: null | string;
    nextElementSibling: null | Element;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    NOTATION_NODE: 12;
    onfullscreenchange: null | (this: Element, ev: Event) => any;
    onfullscreenerror: null | (this: Element, ev: Event) => any;
    outerHTML: string;
    ownerDocument: Document;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    part: DOMTokenList;
    prefix: null | string;
    previousElementSibling: null | Element;
    previousSibling: null | ChildNode;
    PROCESSING_INSTRUCTION_NODE: 7;
    role: null | string;
    scrollHeight: number;
    scrollLeft: number;
    scrollTop: number;
    scrollWidth: number;
    shadowRoot: null | ShadowRoot;
    slot: string;
    tagName: string;
    TEXT_NODE: 3;
    textContent: null | string;
    addEventListener<K extends keyof ElementEventMap>(
        type: K,
        listener: (this: Element, ev: ElementEventMap[K]) => any,
        options?: boolean | AddEventListenerOptions,
    ): void;
    addEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | AddEventListenerOptions,
    ): void;
    after(...nodes: (string | Node)[]): void;
    animate(
        keyframes: null | PropertyIndexedKeyframes | Keyframe[],
        options?: number | KeyframeAnimationOptions,
    ): Animation;
    append(...nodes: (string | Node)[]): void;
    appendChild<T extends Node>(node: T): T;
    attachShadow(init: ShadowRootInit): ShadowRoot;
    before(...nodes: (string | Node)[]): void;
    checkVisibility(options?: CheckVisibilityOptions): boolean;
    cloneNode(deep?: boolean): Node;
    closest<K extends keyof HTMLElementTagNameMap>(
        selector: K,
    ): null | HTMLElementTagNameMap[K];
    closest<K extends keyof SVGElementTagNameMap>(
        selector: K,
    ): null | SVGElementTagNameMap[K];
    closest<K extends keyof MathMLElementTagNameMap>(
        selector: K,
    ): null | MathMLElementTagNameMap[K];
    closest<E extends Element = Element>(selectors: string): null | E;
    compareDocumentPosition(other: Node): number;
    computedStyleMap(): StylePropertyMapReadOnly;
    contains(other: null | Node): boolean;
    dispatchEvent(event: Event): boolean;
    getAnimations(options?: GetAnimationsOptions): Animation[];
    getAttribute(qualifiedName: string): null | string;
    getAttributeNames(): string[];
    getAttributeNode(qualifiedName: string): null | Attr;
    getAttributeNodeNS(
        namespace: null | string,
        localName: string,
    ): null | Attr;
    getAttributeNS(namespace: null | string, localName: string): null | string;
    getBoundingClientRect(): DOMRect;
    getClientRects(): DOMRectList;
    getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
    getElementsByTagName<K extends keyof HTMLElementTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<HTMLElementTagNameMap[K]>;
    getElementsByTagName<K extends keyof SVGElementTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<SVGElementTagNameMap[K]>;
    getElementsByTagName<K extends keyof MathMLElementTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<MathMLElementTagNameMap[K]>;
    getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;
    getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
    getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/1999/xhtml",
        localName: string,
    ): HTMLCollectionOf<HTMLElement>;
    getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/2000/svg",
        localName: string,
    ): HTMLCollectionOf<SVGElement>;
    getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/1998/Math/MathML",
        localName: string,
    ): HTMLCollectionOf<MathMLElement>;
    getElementsByTagNameNS(
        namespace: null | string,
        localName: string,
    ): HTMLCollectionOf<Element>;
    getHTML(options?: GetHTMLOptions): string;
    getRootNode(options?: GetRootNodeOptions): Node;
    hasAttribute(qualifiedName: string): boolean;
    hasAttributeNS(namespace: null | string, localName: string): boolean;
    hasAttributes(): boolean;
    hasChildNodes(): boolean;
    hasPointerCapture(pointerId: number): boolean;
    insertAdjacentElement(
        where: InsertPosition,
        element: Element,
    ): null | Element;
    insertAdjacentHTML(position: InsertPosition, string: string): void;
    insertAdjacentText(where: InsertPosition, data: string): void;
    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;
    matches(selectors: string): boolean;
    normalize(): void;
    prepend(...nodes: (string | Node)[]): void;
    querySelector<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): null | HTMLElementTagNameMap[K];
    querySelector<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): null | SVGElementTagNameMap[K];
    querySelector<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): null | MathMLElementTagNameMap[K];
    querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): null | HTMLElementDeprecatedTagNameMap[K];
    querySelector<E extends Element = Element>(selectors: string): null | E;
    querySelectorAll<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementTagNameMap[K]>;
    querySelectorAll<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): NodeListOf<SVGElementTagNameMap[K]>;
    querySelectorAll<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): NodeListOf<MathMLElementTagNameMap[K]>;
    querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
    querySelectorAll<E extends Element = Element>(
        selectors: string,
    ): NodeListOf<E>;
    releasePointerCapture(pointerId: number): void;
    remove(): void;
    removeAttribute(qualifiedName: string): void;
    removeAttributeNode(attr: Attr): Attr;
    removeAttributeNS(namespace: null | string, localName: string): void;
    removeChild<T extends Node>(child: T): T;
    removeEventListener<K extends keyof ElementEventMap>(
        type: K,
        listener: (this: Element, ev: ElementEventMap[K]) => any,
        options?: boolean | EventListenerOptions,
    ): void;
    removeEventListener(
        type: string,
        listener: EventListenerOrEventListenerObject,
        options?: boolean | EventListenerOptions,
    ): void;
    replaceChild<T extends Node>(node: Node, child: T): T;
    replaceChildren(...nodes: (string | Node)[]): void;
    replaceWith(...nodes: (string | Node)[]): void;
    requestFullscreen(options?: FullscreenOptions): Promise<void>;
    requestPointerLock(options?: PointerLockOptions): Promise<void>;
    scroll(options?: ScrollToOptions): void;
    scroll(x: number, y: number): void;
    scrollBy(options?: ScrollToOptions): void;
    scrollBy(x: number, y: number): void;
    scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
    scrollTo(options?: ScrollToOptions): void;
    scrollTo(x: number, y: number): void;
    setAttribute(qualifiedName: string, value: string): void;
    setAttributeNode(attr: Attr): null | Attr;
    setAttributeNodeNS(attr: Attr): null | Attr;
    setAttributeNS(
        namespace: null | string,
        qualifiedName: string,
        value: string,
    ): void;
    setHTMLUnsafe(html: string): void;
    setPointerCapture(pointerId: number): void;
    toggleAttribute(qualifiedName: string, force?: boolean): boolean;
    webkitMatchesSelector(selectors: string): boolean;
}

Hierarchy (View Summary)

Properties

ariaAtomic ariaAutoComplete ariaBrailleLabel ariaBrailleRoleDescription ariaBusy ariaChecked ariaColCount ariaColIndex ariaColIndexText ariaColSpan ariaCurrent ariaDescription ariaDisabled ariaExpanded ariaHasPopup ariaHidden ariaInvalid ariaKeyShortcuts ariaLabel ariaLevel ariaLive ariaModal ariaMultiLine ariaMultiSelectable ariaOrientation ariaPlaceholder ariaPosInSet ariaPressed ariaReadOnly ariaRequired ariaRoleDescription ariaRowCount ariaRowIndex ariaRowIndexText ariaRowSpan ariaSelected ariaSetSize ariaSort ariaValueMax ariaValueMin ariaValueNow ariaValueText assignedSlot ATTRIBUTE_NODE attributes baseURI CDATA_SECTION_NODE childElementCount childNodes children classList className clientHeight clientLeft clientTop clientWidth COMMENT_NODE currentCSSZoom 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 firstChild firstElementChild id innerHTML isConnected lastChild lastElementChild localName namespaceURI nextElementSibling nextSibling nodeName nodeType nodeValue NOTATION_NODE onfullscreenchange onfullscreenerror outerHTML ownerDocument parentElement parentNode part prefix previousElementSibling previousSibling PROCESSING_INSTRUCTION_NODE role scrollHeight scrollLeft scrollTop scrollWidth shadowRoot slot tagName TEXT_NODE textContent

Methods

addEventListener after animate append appendChild attachShadow before checkVisibility cloneNode closest compareDocumentPosition computedStyleMap contains dispatchEvent getAnimations getAttribute getAttributeNames getAttributeNode getAttributeNodeNS getAttributeNS getBoundingClientRect getClientRects getElementsByClassName getElementsByTagName getElementsByTagNameNS getHTML getRootNode hasAttribute hasAttributeNS hasAttributes hasChildNodes hasPointerCapture insertAdjacentElement insertAdjacentHTML insertAdjacentText insertBefore isDefaultNamespace isEqualNode isSameNode lookupNamespaceURI lookupPrefix matches normalize prepend querySelector querySelectorAll releasePointerCapture remove removeAttribute removeAttributeNode removeAttributeNS removeChild removeEventListener replaceChild replaceChildren replaceWith requestFullscreen requestPointerLock scroll scrollBy scrollIntoView scrollTo setAttribute setAttributeNode setAttributeNodeNS setAttributeNS setHTMLUnsafe setPointerCapture toggleAttribute webkitMatchesSelector

Properties

ariaAtomic

ariaAtomic: null | string

MDN Reference

ariaAutoComplete

ariaAutoComplete: null | string

MDN Reference

ariaBrailleLabel

ariaBrailleLabel: null | string

MDN Reference

ariaBrailleRoleDescription

ariaBrailleRoleDescription: null | string

MDN Reference

ariaBusy

ariaBusy: null | string

MDN Reference

ariaChecked

ariaChecked: null | string

MDN Reference

ariaColCount

ariaColCount: null | string

MDN Reference

ariaColIndex

ariaColIndex: null | string

MDN Reference

ariaColIndexText

ariaColIndexText: null | string

MDN Reference

ariaColSpan

ariaColSpan: null | string

MDN Reference

ariaCurrent

ariaCurrent: null | string

MDN Reference

ariaDescription

ariaDescription: null | string

MDN Reference

ariaDisabled

ariaDisabled: null | string

MDN Reference

ariaExpanded

ariaExpanded: null | string

MDN Reference

ariaHasPopup

ariaHasPopup: null | string

MDN Reference

ariaHidden

ariaHidden: null | string

MDN Reference

ariaInvalid

ariaInvalid: null | string

ariaKeyShortcuts

ariaKeyShortcuts: null | string

MDN Reference

ariaLabel

ariaLabel: null | string

MDN Reference

ariaLevel

ariaLevel: null | string

MDN Reference

ariaLive

ariaLive: null | string

MDN Reference

ariaModal

ariaModal: null | string

MDN Reference

ariaMultiLine

ariaMultiLine: null | string

MDN Reference

ariaMultiSelectable

ariaMultiSelectable: null | string

MDN Reference

ariaOrientation

ariaOrientation: null | string

MDN Reference

ariaPlaceholder

ariaPlaceholder: null | string

MDN Reference

ariaPosInSet

ariaPosInSet: null | string

MDN Reference

ariaPressed

ariaPressed: null | string

MDN Reference

ariaReadOnly

ariaReadOnly: null | string

MDN Reference

ariaRequired

ariaRequired: null | string

MDN Reference

ariaRoleDescription

ariaRoleDescription: null | string

MDN Reference

ariaRowCount

ariaRowCount: null | string

MDN Reference

ariaRowIndex

ariaRowIndex: null | string

MDN Reference

ariaRowIndexText

ariaRowIndexText: null | string

MDN Reference

ariaRowSpan

ariaRowSpan: null | string

MDN Reference

ariaSelected

ariaSelected: null | string

MDN Reference

ariaSetSize

ariaSetSize: null | string

MDN Reference

ariaSort

ariaSort: null | string

MDN Reference

ariaValueMax

ariaValueMax: null | string

MDN Reference

ariaValueMin

ariaValueMin: null | string

MDN Reference

ariaValueNow

ariaValueNow: null | string

MDN Reference

ariaValueText

ariaValueText: null | string

MDN Reference

ReadonlyassignedSlot

assignedSlot: null | HTMLSlotElement

MDN Reference

ReadonlyATTRIBUTE_NODE

ATTRIBUTE_NODE: 2

Readonlyattributes

attributes: NamedNodeMap

MDN Reference

ReadonlybaseURI

baseURI: string

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

MDN Reference

ReadonlyCDATA_SECTION_NODE

CDATA_SECTION_NODE: 4

node is a CDATASection node.

ReadonlychildElementCount

childElementCount: number

MDN Reference

ReadonlychildNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

Readonlychildren

children: HTMLCollection

Returns the child elements.

MDN Reference

ReadonlyclassList

classList: DOMTokenList

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

MDN Reference

className

className: string

Returns the value of element's class content attribute. Can be set to change it.

MDN Reference

ReadonlyclientHeight

clientHeight: number

MDN Reference

ReadonlyclientLeft

clientLeft: number

MDN Reference

ReadonlyclientTop

clientTop: number

MDN Reference

ReadonlyclientWidth

clientWidth: number

MDN Reference

ReadonlyCOMMENT_NODE

COMMENT_NODE: 8

node is a Comment node.

ReadonlycurrentCSSZoom

currentCSSZoom: number

MDN Reference

ReadonlyDOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

ReadonlyDOCUMENT_NODE

DOCUMENT_NODE: 9

node is a document.

ReadonlyDOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

ReadonlyDOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

ReadonlyDOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: 1

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

ReadonlyDOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

ReadonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

ReadonlyDOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

ReadonlyDOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: 10

node is a doctype.

ReadonlyELEMENT_NODE

ELEMENT_NODE: 1

node is an element.

ReadonlyENTITY_NODE

ENTITY_NODE: 6

ReadonlyENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: 5

ReadonlyfirstChild

firstChild: null | ChildNode

Returns the first child.

MDN Reference

ReadonlyfirstElementChild

firstElementChild: null | Element

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

MDN Reference

id

id: string

Returns the value of element's id content attribute. Can be set to change it.

MDN Reference

innerHTML

innerHTML: string

MDN Reference

ReadonlyisConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

ReadonlylastChild

lastChild: null | ChildNode

Returns the last child.

MDN Reference

ReadonlylastElementChild

lastElementChild: null | Element

Returns the last child that is an element, and null otherwise.

MDN Reference

ReadonlylocalName

localName: string

Returns the local name.

MDN Reference

ReadonlynamespaceURI

namespaceURI: null | string

Returns the namespace.

MDN Reference

ReadonlynextElementSibling

nextElementSibling: null | Element

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

MDN Reference

ReadonlynextSibling

nextSibling: null | ChildNode

Returns the next sibling.

MDN Reference

ReadonlynodeName

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

ReadonlynodeType

nodeType: number

Returns the type of node.

MDN Reference

nodeValue

nodeValue: null | string

MDN Reference

ReadonlyNOTATION_NODE

NOTATION_NODE: 12

onfullscreenchange

onfullscreenchange: null | (this: Element, ev: Event) => any

MDN Reference

onfullscreenerror

onfullscreenerror: null | (this: Element, ev: Event) => any

MDN Reference

outerHTML

outerHTML: string

MDN Reference

ReadonlyownerDocument

ownerDocument: Document

Returns the node document. Returns null for documents.

MDN Reference

ReadonlyparentElement

parentElement: null | HTMLElement

Returns the parent element.

MDN Reference

ReadonlyparentNode

parentNode: null | ParentNode

Returns the parent.

MDN Reference

Readonlypart

part: DOMTokenList

MDN Reference

Readonlyprefix

prefix: null | string

Returns the namespace prefix.

MDN Reference

ReadonlypreviousElementSibling

previousElementSibling: null | Element

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

MDN Reference

ReadonlypreviousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

MDN Reference

ReadonlyPROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

role

role: null | string

ReadonlyscrollHeight

scrollHeight: number

MDN Reference

scrollLeft

scrollLeft: number

MDN Reference

scrollTop

scrollTop: number

MDN Reference

ReadonlyscrollWidth

scrollWidth: number

MDN Reference

ReadonlyshadowRoot

shadowRoot: null | ShadowRoot

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

MDN Reference

slot

slot: string

Returns the value of element's slot content attribute. Can be set to change it.

MDN Reference

ReadonlytagName

tagName: string

Returns the HTML-uppercased qualified name.

MDN Reference

ReadonlyTEXT_NODE

TEXT_NODE: 3

node is a Text node.

textContent

textContent: null | string

MDN Reference

Methods

addEventListener

  • addEventListener<K extends keyof ElementEventMap>(
        type: K,
        listener: (this: Element, ev: ElementEventMap[K]) => any,
        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.

    MDN Reference

    Type Parameters

    Parameters

    Returns void

  • addEventListener(
        type: string,
        listener: 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.

    MDN Reference

    Parameters

    Returns void

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.

    MDN Reference

    Parameters

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

    Returns void

animate

append

  • append(...nodes: (string | Node)[]): void

  • Inserts nodes after the last child of 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

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

    Returns void

appendChild

attachShadow

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.

    MDN Reference

    Parameters

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

    Returns void

checkVisibility

cloneNode

  • cloneNode(deep?: boolean): Node

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

    MDN Reference

    Parameters

    • Optionaldeep: boolean

    Returns Node

closest

compareDocumentPosition

  • compareDocumentPosition(other: Node): number

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

    MDN Reference

    Parameters

    Returns number

computedStyleMap

  • computedStyleMap(): StylePropertyMapReadOnly

  • MDN Reference

    Returns StylePropertyMapReadOnly

contains

  • contains(other: null | Node): boolean

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

    MDN Reference

    Parameters

    Returns boolean

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.

    MDN Reference

    Parameters

    • event: Event

    Returns boolean

getAnimations

getAttribute

  • getAttribute(qualifiedName: string): null | string

  • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns null | string

getAttributeNames

  • getAttributeNames(): string[]

  • Returns the qualified names of all element's attributes. Can contain duplicates.

    MDN Reference

    Returns string[]

getAttributeNode

  • getAttributeNode(qualifiedName: string): null | Attr

  • MDN Reference

    Parameters

    • qualifiedName: string

    Returns null | Attr

getAttributeNodeNS

  • getAttributeNodeNS(namespace: null | string, localName: string): null | Attr

  • MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns null | Attr

getAttributeNS

  • getAttributeNS(namespace: null | string, localName: string): null | string

  • Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns null | string

getBoundingClientRect

getClientRects

  • getClientRects(): DOMRectList

  • MDN Reference

    Returns DOMRectList

getElementsByClassName

  • getElementsByClassName(classNames: string): HTMLCollectionOf<Element>

  • Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes.

    MDN Reference

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

getElementsByTagName

getElementsByTagNameNS

  • getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/1999/xhtml",
        localName: string,
    ): HTMLCollectionOf<HTMLElement>

  • MDN Reference

    Parameters

    • namespaceURI: "http://www.w3.org/1999/xhtml"
    • localName: string

    Returns HTMLCollectionOf<HTMLElement>

  • getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/2000/svg",
        localName: string,
    ): HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • localName: string

    Returns HTMLCollectionOf<SVGElement>

  • getElementsByTagNameNS(
        namespaceURI: "http://www.w3.org/1998/Math/MathML",
        localName: string,
    ): HTMLCollectionOf<MathMLElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/1998/Math/MathML"
    • localName: string

    Returns HTMLCollectionOf<MathMLElement>

  • getElementsByTagNameNS(
        namespace: null | string,
        localName: string,
    ): HTMLCollectionOf<Element>

  • Parameters

    • namespace: null | string
    • localName: string

    Returns HTMLCollectionOf<Element>

getHTML

getRootNode

hasAttribute

  • hasAttribute(qualifiedName: string): boolean

  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • hasAttributeNS(namespace: null | string, localName: string): boolean

  • Returns true if element has an attribute whose namespace is namespace and local name is localName.

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns boolean

hasAttributes

  • hasAttributes(): boolean

  • Returns true if element has attributes, and false otherwise.

    MDN Reference

    Returns boolean

hasChildNodes

  • hasChildNodes(): boolean

  • Returns whether node has children.

    MDN Reference

    Returns boolean

hasPointerCapture

  • hasPointerCapture(pointerId: number): boolean

  • MDN Reference

    Parameters

    • pointerId: number

    Returns boolean

insertAdjacentElement

insertAdjacentHTML

insertAdjacentText

insertBefore

isDefaultNamespace

  • isDefaultNamespace(namespace: null | string): boolean

  • MDN Reference

    Parameters

    • namespace: null | string

    Returns boolean

isEqualNode

  • isEqualNode(otherNode: null | Node): boolean

  • Returns whether node and otherNode have the same properties.

    MDN Reference

    Parameters

    • otherNode: null | Node

    Returns boolean

isSameNode

lookupNamespaceURI

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

  • MDN Reference

    Parameters

    • prefix: null | string

    Returns null | string

lookupPrefix

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

  • MDN Reference

    Parameters

    • namespace: null | string

    Returns null | string

matches

  • matches(selectors: string): boolean

  • Returns true if matching selectors against element's root yields element, and false otherwise.

    MDN Reference

    Parameters

    • selectors: string

    Returns boolean

normalize

  • normalize(): void

  • 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

prepend

  • prepend(...nodes: (string | Node)[]): void

  • Inserts nodes before the first child of 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

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

    Returns void

querySelector

querySelectorAll

releasePointerCapture

  • releasePointerCapture(pointerId: number): void

  • MDN Reference

    Parameters

    • pointerId: number

    Returns void

remove

  • remove(): void

  • Removes node.

    MDN Reference

    Returns void

removeAttribute

  • removeAttribute(qualifiedName: string): void

  • Removes element's first attribute whose qualified name is qualifiedName.

    MDN Reference

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNode

removeAttributeNS

  • removeAttributeNS(namespace: null | string, localName: string): void

  • Removes element's attribute whose namespace is namespace and local name is localName.

    MDN Reference

    Parameters

    • namespace: null | string
    • localName: string

    Returns void

removeChild

removeEventListener

replaceChild

replaceChildren

  • replaceChildren(...nodes: (string | Node)[]): void

  • Replace all children of 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

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

    MDN Reference

    Parameters

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

    Returns void

requestFullscreen

  • requestFullscreen(options?: FullscreenOptions): Promise<void>

  • Displays element fullscreen and resolves promise when done.

    When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference.

    MDN Reference

    Parameters

    Returns Promise<void>

requestPointerLock

scroll

  • scroll(options?: ScrollToOptions): void

  • MDN Reference

    Parameters

    Returns void

  • scroll(x: number, y: number): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollBy

  • scrollBy(options?: ScrollToOptions): void

  • MDN Reference

    Parameters

    Returns void

  • scrollBy(x: number, y: number): void

  • Parameters

    • x: number
    • y: number

    Returns void

scrollIntoView

scrollTo

  • scrollTo(options?: ScrollToOptions): void

  • MDN Reference

    Parameters

    Returns void

  • scrollTo(x: number, y: number): void

  • Parameters

    • x: number
    • y: number

    Returns void

setAttribute

  • setAttribute(qualifiedName: string, value: string): void

  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    MDN Reference

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNode

  • setAttributeNode(attr: Attr): null | Attr

  • MDN Reference

    Parameters

    Returns null | Attr

setAttributeNodeNS

  • setAttributeNodeNS(attr: Attr): null | Attr

  • MDN Reference

    Parameters

    Returns null | Attr

setAttributeNS

  • setAttributeNS(
        namespace: null | string,
        qualifiedName: string,
        value: string,
    ): void

  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    MDN Reference

    Parameters

    • namespace: null | string
    • qualifiedName: string
    • value: string

    Returns void

setHTMLUnsafe

  • setHTMLUnsafe(html: string): void

  • MDN Reference

    Parameters

    • html: string

    Returns void

setPointerCapture

  • setPointerCapture(pointerId: number): void

  • MDN Reference

    Parameters

    • pointerId: number

    Returns void

toggleAttribute

  • toggleAttribute(qualifiedName: string, force?: boolean): boolean

  • If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

    Returns true if qualifiedName is now present, and false otherwise.

    MDN Reference

    Parameters

    • qualifiedName: string
    • Optionalforce: boolean

    Returns boolean

webkitMatchesSelector

  • webkitMatchesSelector(selectors: string): boolean

  • Parameters

    • selectors: string

    Returns boolean

    Deprecated

    This is a legacy alias of matches.

    MDN Reference

Settings

Member Visibility

On This Page

Properties
ariaAtomicariaAutoCompleteariaBrailleLabelariaBrailleRoleDescriptionariaBusyariaCheckedariaColCountariaColIndexariaColIndexTextariaColSpanariaCurrentariaDescriptionariaDisabledariaExpandedariaHasPopupariaHiddenariaInvalidariaKeyShortcutsariaLabelariaLevelariaLiveariaModalariaMultiLineariaMultiSelectableariaOrientationariaPlaceholderariaPosInSetariaPressedariaReadOnlyariaRequiredariaRoleDescriptionariaRowCountariaRowIndexariaRowIndexTextariaRowSpanariaSelectedariaSetSizeariaSortariaValueMaxariaValueMinariaValueNowariaValueTextassignedSlotATTRIBUTE_NODEattributesbaseURICDATA_SECTION_NODEchildElementCountchildNodeschildrenclassListclassNameclientHeightclientLeftclientTopclientWidthCOMMENT_NODEcurrentCSSZoomDOCUMENT_FRAGMENT_NODEDOCUMENT_NODEDOCUMENT_POSITION_CONTAINED_BYDOCUMENT_POSITION_CONTAINSDOCUMENT_POSITION_DISCONNECTEDDOCUMENT_POSITION_FOLLOWINGDOCUMENT_POSITION_IMPLEMENTATION_SPECIFICDOCUMENT_POSITION_PRECEDINGDOCUMENT_TYPE_NODEELEMENT_NODEENTITY_NODEENTITY_REFERENCE_NODEfirstChildfirstElementChildidinnerHTMLisConnectedlastChildlastElementChildlocalNamenamespaceURInextElementSiblingnextSiblingnodeNamenodeTypenodeValueNOTATION_NODEonfullscreenchangeonfullscreenerrorouterHTMLownerDocumentparentElementparentNodepartprefixpreviousElementSiblingpreviousSiblingPROCESSING_INSTRUCTION_NODErolescrollHeightscrollLeftscrollTopscrollWidthshadowRootslottagNameTEXT_NODEtextContent
Methods
addEventListenerafteranimateappendappendChildattachShadowbeforecheckVisibilitycloneNodeclosestcompareDocumentPositioncomputedStyleMapcontainsdispatchEventgetAnimationsgetAttributegetAttributeNamesgetAttributeNodegetAttributeNodeNSgetAttributeNSgetBoundingClientRectgetClientRectsgetElementsByClassNamegetElementsByTagNamegetElementsByTagNameNSgetHTMLgetRootNodehasAttributehasAttributeNShasAttributeshasChildNodeshasPointerCaptureinsertAdjacentElementinsertAdjacentHTMLinsertAdjacentTextinsertBeforeisDefaultNamespaceisEqualNodeisSameNodelookupNamespaceURIlookupPrefixmatchesnormalizeprependquerySelectorquerySelectorAllreleasePointerCaptureremoveremoveAttributeremoveAttributeNoderemoveAttributeNSremoveChildremoveEventListenerreplaceChildreplaceChildrenreplaceWithrequestFullscreenrequestPointerLockscrollscrollByscrollIntoViewscrollTosetAttributesetAttributeNodesetAttributeNodeNSsetAttributeNSsetHTMLUnsafesetPointerCapturetoggleAttributewebkitMatchesSelector