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: string;
        ariaAutoComplete: string;
        ariaBrailleLabel: string;
        ariaBrailleRoleDescription: string;
        ariaBusy: string;
        ariaChecked: string;
        ariaColCount: string;
        ariaColIndex: string;
        ariaColSpan: string;
        ariaCurrent: string;
        ariaDescription: string;
        ariaDisabled: string;
        ariaExpanded: string;
        ariaHasPopup: string;
        ariaHidden: string;
        ariaInvalid: string;
        ariaKeyShortcuts: string;
        ariaLabel: string;
        ariaLevel: string;
        ariaLive: string;
        ariaModal: string;
        ariaMultiLine: string;
        ariaMultiSelectable: string;
        ariaOrientation: string;
        ariaPlaceholder: string;
        ariaPosInSet: string;
        ariaPressed: string;
        ariaReadOnly: string;
        ariaRequired: string;
        ariaRoleDescription: string;
        ariaRowCount: string;
        ariaRowIndex: string;
        ariaRowSpan: string;
        ariaSelected: string;
        ariaSetSize: string;
        ariaSort: string;
        ariaValueMax: string;
        ariaValueMin: string;
        ariaValueNow: string;
        ariaValueText: string;
        assignedSlot: 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;
        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: ChildNode;
        firstElementChild: Element;
        id: string;
        innerHTML: string;
        isConnected: boolean;
        lastChild: ChildNode;
        lastElementChild: Element;
        localName: string;
        namespaceURI: string;
        nextElementSibling: Element;
        nextSibling: ChildNode;
        nodeName: string;
        nodeType: number;
        nodeValue: string;
        NOTATION_NODE: 12;
        onfullscreenchange: ((this: Element, ev: Event) => any);
        onfullscreenerror: ((this: Element, ev: Event) => any);
        outerHTML: string;
        ownerDocument: Document;
        parentElement: HTMLElement;
        parentNode: ParentNode;
        part: DOMTokenList;
        prefix: string;
        previousElementSibling: Element;
        previousSibling: ChildNode;
        PROCESSING_INSTRUCTION_NODE: 7;
        role: string;
        scrollHeight: number;
        scrollLeft: number;
        scrollTop: number;
        scrollWidth: number;
        shadowRoot: ShadowRoot;
        slot: string;
        tagName: string;
        TEXT_NODE: 3;
        textContent: string;
        addEventListener<K>(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: PropertyIndexedKeyframes | Keyframe[], options?: number | KeyframeAnimationOptions): Animation;
        append(...nodes: (string | Node)[]): void;
        appendChild<T>(node: T): T;
        attachShadow(init: ShadowRootInit): ShadowRoot;
        before(...nodes: (string | Node)[]): void;
        checkVisibility(options?: CheckVisibilityOptions): boolean;
        cloneNode(deep?: boolean): Node;
        closest<K>(selector: K): HTMLElementTagNameMap[K];
        closest<K>(selector: K): SVGElementTagNameMap[K];
        closest<K>(selector: K): MathMLElementTagNameMap[K];
        closest<E>(selectors: string): E;
        compareDocumentPosition(other: Node): number;
        computedStyleMap(): StylePropertyMapReadOnly;
        contains(other: Node): boolean;
        dispatchEvent(event: Event): boolean;
        getAnimations(options?: GetAnimationsOptions): Animation[];
        getAttribute(qualifiedName: string): string;
        getAttributeNames(): string[];
        getAttributeNode(qualifiedName: string): Attr;
        getAttributeNodeNS(namespace: string, localName: string): Attr;
        getAttributeNS(namespace: string, localName: string): string;
        getBoundingClientRect(): DOMRect;
        getClientRects(): DOMRectList;
        getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
        getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>;
        getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>;
        getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<MathMLElementTagNameMap[K]>;
        getElementsByTagName<K>(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: string, localName: string): HTMLCollectionOf<Element>;
        getHTML(options?: GetHTMLOptions): string;
        getRootNode(options?: GetRootNodeOptions): Node;
        hasAttribute(qualifiedName: string): boolean;
        hasAttributeNS(namespace: string, localName: string): boolean;
        hasAttributes(): boolean;
        hasChildNodes(): boolean;
        hasPointerCapture(pointerId: number): boolean;
        insertAdjacentElement(where: InsertPosition, element: Element): Element;
        insertAdjacentHTML(position: InsertPosition, string: string): void;
        insertAdjacentText(where: InsertPosition, data: string): void;
        insertBefore<T>(node: T, child: Node): T;
        isDefaultNamespace(namespace: string): boolean;
        isEqualNode(otherNode: Node): boolean;
        isSameNode(otherNode: Node): boolean;
        lookupNamespaceURI(prefix: string): string;
        lookupPrefix(namespace: string): string;
        matches(selectors: string): boolean;
        normalize(): void;
        prepend(...nodes: (string | Node)[]): void;
        querySelector<K>(selectors: K): HTMLElementTagNameMap[K];
        querySelector<K>(selectors: K): SVGElementTagNameMap[K];
        querySelector<K>(selectors: K): MathMLElementTagNameMap[K];
        querySelector<K>(selectors: K): HTMLElementDeprecatedTagNameMap[K];
        querySelector<E>(selectors: string): E;
        querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>;
        querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>;
        querySelectorAll<K>(selectors: K): NodeListOf<MathMLElementTagNameMap[K]>;
        querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
        querySelectorAll<E>(selectors: string): NodeListOf<E>;
        releasePointerCapture(pointerId: number): void;
        remove(): void;
        removeAttribute(qualifiedName: string): void;
        removeAttributeNode(attr: Attr): Attr;
        removeAttributeNS(namespace: string, localName: string): void;
        removeChild<T>(child: T): T;
        removeEventListener<K>(type: K, listener: ((this: Element, ev: ElementEventMap[K]) => any), options?: boolean | EventListenerOptions): void;
        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
        replaceChild<T>(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): Attr;
        setAttributeNodeNS(attr: Attr): Attr;
        setAttributeNS(namespace: 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

    Properties

    Methods

    Properties

    ariaAtomic: string
    ariaAutoComplete: string
    ariaBrailleLabel: string
    ariaBrailleRoleDescription: string
    ariaBusy: string
    ariaChecked: string
    ariaColCount: string
    ariaColIndex: string
    ariaColSpan: string
    ariaCurrent: string
    ariaDescription: string
    ariaDisabled: string
    ariaExpanded: string
    ariaHasPopup: string
    ariaHidden: string
    ariaInvalid: string
    ariaKeyShortcuts: string
    ariaLabel: string
    ariaLevel: string
    ariaLive: string
    ariaModal: string
    ariaMultiLine: string
    ariaMultiSelectable: string
    ariaOrientation: string
    ariaPlaceholder: string
    ariaPosInSet: string
    ariaPressed: string
    ariaReadOnly: string
    ariaRequired: string
    ariaRoleDescription: string
    ariaRowCount: string
    ariaRowIndex: string
    ariaRowSpan: string
    ariaSelected: string
    ariaSetSize: string
    ariaSort: string
    ariaValueMax: string
    ariaValueMin: string
    ariaValueNow: string
    ariaValueText: string
    assignedSlot: HTMLSlotElement
    ATTRIBUTE_NODE: 2
    attributes: NamedNodeMap
    baseURI: string

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

    MDN Reference

    CDATA_SECTION_NODE: 4

    node is a CDATASection node.

    childElementCount: number
    childNodes: NodeListOf<ChildNode>

    Returns the children.

    MDN Reference

    children: HTMLCollection

    Returns the child elements.

    MDN Reference

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

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

    MDN Reference

    clientHeight: number
    clientLeft: number
    clientTop: number
    clientWidth: number
    COMMENT_NODE: 8

    node is a Comment node.

    DOCUMENT_FRAGMENT_NODE: 11

    node is a DocumentFragment node.

    DOCUMENT_NODE: 9

    node is a document.

    DOCUMENT_POSITION_CONTAINED_BY: 16

    Set when other is a descendant of node.

    DOCUMENT_POSITION_CONTAINS: 8

    Set when other is an ancestor of node.

    DOCUMENT_POSITION_DISCONNECTED: 1

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

    DOCUMENT_POSITION_FOLLOWING: 4

    Set when other is following node.

    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32
    DOCUMENT_POSITION_PRECEDING: 2

    Set when other is preceding node.

    DOCUMENT_TYPE_NODE: 10

    node is a doctype.

    ELEMENT_NODE: 1

    node is an element.

    ENTITY_NODE: 6
    ENTITY_REFERENCE_NODE: 5
    firstChild: ChildNode

    Returns the first child.

    MDN Reference

    firstElementChild: Element

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

    MDN Reference

    id: string

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

    MDN Reference

    innerHTML: string
    isConnected: boolean

    Returns true if node is connected and false otherwise.

    MDN Reference

    lastChild: ChildNode

    Returns the last child.

    MDN Reference

    lastElementChild: Element

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

    MDN Reference

    localName: string

    Returns the local name.

    MDN Reference

    namespaceURI: string

    Returns the namespace.

    MDN Reference

    nextElementSibling: Element

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

    MDN Reference

    nextSibling: ChildNode

    Returns the next sibling.

    MDN Reference

    nodeName: string

    Returns a string appropriate for the type of node.

    MDN Reference

    nodeType: number

    Returns the type of node.

    MDN Reference

    nodeValue: string
    NOTATION_NODE: 12
    onfullscreenchange: ((this: Element, ev: Event) => any)
    onfullscreenerror: ((this: Element, ev: Event) => any)
    outerHTML: string
    ownerDocument: Document

    Returns the node document. Returns null for documents.

    MDN Reference

    parentElement: HTMLElement

    Returns the parent element.

    MDN Reference

    parentNode: ParentNode

    Returns the parent.

    MDN Reference

    prefix: string

    Returns the namespace prefix.

    MDN Reference

    previousElementSibling: Element

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

    MDN Reference

    previousSibling: ChildNode

    Returns the previous sibling.

    MDN Reference

    PROCESSING_INSTRUCTION_NODE: 7

    node is a ProcessingInstruction node.

    role: string
    scrollHeight: number
    scrollLeft: number
    scrollTop: number
    scrollWidth: number
    shadowRoot: ShadowRoot

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

    MDN Reference

    slot: string

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

    MDN Reference

    tagName: string

    Returns the HTML-uppercased qualified name.

    MDN Reference

    TEXT_NODE: 3

    node is a Text node.

    textContent: string

    Methods

    • 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

    • 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

    • 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

    • 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

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

      Returns 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

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

      Returns void

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

      MDN Reference

      Parameters

      • Optionaldeep: boolean

      Returns Node

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

      MDN Reference

      Parameters

      Returns 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

      Returns boolean

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

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

      MDN Reference

      Returns string[]

    • Parameters

      • namespace: string
      • localName: string

      Returns Attr

    • 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: string
      • localName: string

      Returns string

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

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

      MDN Reference

      Parameters

      • qualifiedName: string

      Returns boolean

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

      MDN Reference

      Parameters

      • namespace: string
      • localName: string

      Returns boolean

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

      MDN Reference

      Returns boolean

    • Parameters

      • pointerId: number

      Returns boolean

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

      MDN Reference

      Parameters

      • selectors: string

      Returns boolean

    • 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

    • 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

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

      Returns void

    • Parameters

      • pointerId: number

      Returns void

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

      MDN Reference

      Parameters

      • qualifiedName: string

      Returns void

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

      MDN Reference

      Parameters

      • namespace: string
      • localName: string

      Returns 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

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

      Returns 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

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

      Returns 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>

    • Parameters

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns void

    • Parameters

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns 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

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

      MDN Reference

      Parameters

      • namespace: string
      • qualifiedName: string
      • value: string

      Returns void

    • Parameters

      • html: string

      Returns void

    • Parameters

      • pointerId: number

      Returns void

    • 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

    • Parameters

      • selectors: string

      Returns boolean

      This is a legacy alias of matches.

      MDN Reference