Skip to main content

Interface: Element

Element is the most general base class from which all element objects (i.e., objects that represent elements) in a Document inherit.

MDN Reference

Extends

  • Node.ARIAMixin.Animatable.ChildNode.NonDocumentTypeChildNode.ParentNode.Slottable

Properties

__evolv__

__evolv__: MutateContext


ariaActiveDescendantElement

ariaActiveDescendantElement: Element | null

MDN Reference

Inherited from

ARIAMixin.ariaActiveDescendantElement


ariaAtomic

ariaAtomic: string | null

MDN Reference

Inherited from

ARIAMixin.ariaAtomic


ariaAutoComplete

ariaAutoComplete: string | null

MDN Reference

Inherited from

ARIAMixin.ariaAutoComplete


ariaBrailleLabel

ariaBrailleLabel: string | null

MDN Reference

Inherited from

ARIAMixin.ariaBrailleLabel


ariaBrailleRoleDescription

ariaBrailleRoleDescription: string | null

MDN Reference

Inherited from

ARIAMixin.ariaBrailleRoleDescription


ariaBusy

ariaBusy: string | null

MDN Reference

Inherited from

ARIAMixin.ariaBusy


ariaChecked

ariaChecked: string | null

MDN Reference

Inherited from

ARIAMixin.ariaChecked


ariaColCount

ariaColCount: string | null

MDN Reference

Inherited from

ARIAMixin.ariaColCount


ariaColIndex

ariaColIndex: string | null

MDN Reference

Inherited from

ARIAMixin.ariaColIndex


ariaColIndexText

ariaColIndexText: string | null

MDN Reference

Inherited from

ARIAMixin.ariaColIndexText


ariaColSpan

ariaColSpan: string | null

MDN Reference

Inherited from

ARIAMixin.ariaColSpan


ariaControlsElements

ariaControlsElements: readonly Element[] | null

MDN Reference

Inherited from

ARIAMixin.ariaControlsElements


ariaCurrent

ariaCurrent: string | null

MDN Reference

Inherited from

ARIAMixin.ariaCurrent


ariaDescribedByElements

ariaDescribedByElements: readonly Element[] | null

MDN Reference

Inherited from

ARIAMixin.ariaDescribedByElements


ariaDescription

ariaDescription: string | null

MDN Reference

Inherited from

ARIAMixin.ariaDescription


ariaDetailsElements

ariaDetailsElements: readonly Element[] | null

MDN Reference

Inherited from

ARIAMixin.ariaDetailsElements


ariaDisabled

ariaDisabled: string | null

MDN Reference

Inherited from

ARIAMixin.ariaDisabled


ariaErrorMessageElements

ariaErrorMessageElements: readonly Element[] | null

MDN Reference

Inherited from

ARIAMixin.ariaErrorMessageElements


ariaExpanded

ariaExpanded: string | null

MDN Reference

Inherited from

ARIAMixin.ariaExpanded


ariaFlowToElements

ariaFlowToElements: readonly Element[] | null

MDN Reference

Inherited from

ARIAMixin.ariaFlowToElements


ariaHasPopup

ariaHasPopup: string | null

MDN Reference

Inherited from

ARIAMixin.ariaHasPopup


ariaHidden

ariaHidden: string | null

MDN Reference

Inherited from

ARIAMixin.ariaHidden


ariaInvalid

ariaInvalid: string | null

MDN Reference

Inherited from

ARIAMixin.ariaInvalid


ariaKeyShortcuts

ariaKeyShortcuts: string | null

MDN Reference

Inherited from

ARIAMixin.ariaKeyShortcuts


ariaLabel

ariaLabel: string | null

MDN Reference

Inherited from

ARIAMixin.ariaLabel


ariaLabelledByElements

ariaLabelledByElements: readonly Element[] | null

MDN Reference

Inherited from

ARIAMixin.ariaLabelledByElements


ariaLevel

ariaLevel: string | null

MDN Reference

Inherited from

ARIAMixin.ariaLevel


ariaLive

ariaLive: string | null

MDN Reference

Inherited from

ARIAMixin.ariaLive


ariaModal

ariaModal: string | null

MDN Reference

Inherited from

ARIAMixin.ariaModal


ariaMultiLine

ariaMultiLine: string | null

MDN Reference

Inherited from

ARIAMixin.ariaMultiLine


ariaMultiSelectable

ariaMultiSelectable: string | null

MDN Reference

Inherited from

ARIAMixin.ariaMultiSelectable


ariaOrientation

ariaOrientation: string | null

MDN Reference

Inherited from

ARIAMixin.ariaOrientation


ariaOwnsElements

ariaOwnsElements: readonly Element[] | null

MDN Reference

Inherited from

ARIAMixin.ariaOwnsElements


ariaPlaceholder

ariaPlaceholder: string | null

MDN Reference

Inherited from

ARIAMixin.ariaPlaceholder


ariaPosInSet

ariaPosInSet: string | null

MDN Reference

Inherited from

ARIAMixin.ariaPosInSet


ariaPressed

ariaPressed: string | null

MDN Reference

Inherited from

ARIAMixin.ariaPressed


ariaReadOnly

ariaReadOnly: string | null

MDN Reference

Inherited from

ARIAMixin.ariaReadOnly


ariaRelevant

ariaRelevant: string | null

MDN Reference

Inherited from

ARIAMixin.ariaRelevant


ariaRequired

ariaRequired: string | null

MDN Reference

Inherited from

ARIAMixin.ariaRequired


ariaRoleDescription

ariaRoleDescription: string | null

MDN Reference

Inherited from

ARIAMixin.ariaRoleDescription


ariaRowCount

ariaRowCount: string | null

MDN Reference

Inherited from

ARIAMixin.ariaRowCount


ariaRowIndex

ariaRowIndex: string | null

MDN Reference

Inherited from

ARIAMixin.ariaRowIndex


ariaRowIndexText

ariaRowIndexText: string | null

MDN Reference

Inherited from

ARIAMixin.ariaRowIndexText


ariaRowSpan

ariaRowSpan: string | null

MDN Reference

Inherited from

ARIAMixin.ariaRowSpan


ariaSelected

ariaSelected: string | null

MDN Reference

Inherited from

ARIAMixin.ariaSelected


ariaSetSize

ariaSetSize: string | null

MDN Reference

Inherited from

ARIAMixin.ariaSetSize


ariaSort

ariaSort: string | null

MDN Reference

Inherited from

ARIAMixin.ariaSort


ariaValueMax

ariaValueMax: string | null

MDN Reference

Inherited from

ARIAMixin.ariaValueMax


ariaValueMin

ariaValueMin: string | null

MDN Reference

Inherited from

ARIAMixin.ariaValueMin


ariaValueNow

ariaValueNow: string | null

MDN Reference

Inherited from

ARIAMixin.ariaValueNow


ariaValueText

ariaValueText: string | null

MDN Reference

Inherited from

ARIAMixin.ariaValueText


assignedSlot

readonly assignedSlot: HTMLSlotElement | null

MDN Reference

Inherited from

Slottable.assignedSlot


ATTRIBUTE_NODE

readonly ATTRIBUTE_NODE: 2

Inherited from

Node.ATTRIBUTE_NODE


attributes

readonly attributes: NamedNodeMap

The Element.attributes property returns a live collection of all attribute nodes registered to the specified node.

MDN Reference


baseURI

readonly baseURI: string

The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node.

MDN Reference

Inherited from

Node.baseURI


CDATA_SECTION_NODE

readonly CDATA_SECTION_NODE: 4

node is a CDATASection node.

Inherited from

Node.CDATA_SECTION_NODE


childElementCount

readonly childElementCount: number

MDN Reference

Inherited from

ParentNode.childElementCount


childNodes

readonly childNodes: NodeListOf<ChildNode>

The read-only childNodes property of the Node interface returns a live the first child node is assigned index 0.

MDN Reference

Inherited from

Node.childNodes


children

readonly children: HTMLCollection

Returns the child elements.

MDN Reference

Inherited from

ParentNode.children


className

className: string

The className property of the of the specified element.

MDN Reference


clientHeight

readonly clientHeight: number

The clientHeight read-only property of the Element interface is zero for elements with no CSS or inline layout boxes; otherwise, it's the inner height of an element in pixels.

MDN Reference


clientLeft

readonly clientLeft: number

The clientLeft read-only property of the Element interface returns the width of the left border of an element in pixels.

MDN Reference


clientTop

readonly clientTop: number

The clientTop read-only property of the Element interface returns the width of the top border of an element in pixels.

MDN Reference


clientWidth

readonly clientWidth: number

The clientWidth read-only property of the Element interface is zero for inline elements and elements with no CSS; otherwise, it's the inner width of an element in pixels.

MDN Reference


COMMENT_NODE

readonly COMMENT_NODE: 8

node is a Comment node.

Inherited from

Node.COMMENT_NODE


currentCSSZoom

readonly currentCSSZoom: number

The currentCSSZoom read-only property of the Element interface provides the 'effective' CSS zoom of an element, taking into account the zoom applied to the element and all its parent elements.

MDN Reference


dataset

dataset: DOMStringMap


DOCUMENT_FRAGMENT_NODE

readonly DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

Inherited from

Node.DOCUMENT_FRAGMENT_NODE


DOCUMENT_NODE

readonly DOCUMENT_NODE: 9

node is a document.

Inherited from

Node.DOCUMENT_NODE


DOCUMENT_POSITION_CONTAINED_BY

readonly DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

Inherited from

Node.DOCUMENT_POSITION_CONTAINED_BY


DOCUMENT_POSITION_CONTAINS

readonly DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

Inherited from

Node.DOCUMENT_POSITION_CONTAINS


DOCUMENT_POSITION_DISCONNECTED

readonly DOCUMENT_POSITION_DISCONNECTED: 1

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

Inherited from

Node.DOCUMENT_POSITION_DISCONNECTED


DOCUMENT_POSITION_FOLLOWING

readonly DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

Inherited from

Node.DOCUMENT_POSITION_FOLLOWING


DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32

Inherited from

Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC


DOCUMENT_POSITION_PRECEDING

readonly DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

Inherited from

Node.DOCUMENT_POSITION_PRECEDING


DOCUMENT_TYPE_NODE

readonly DOCUMENT_TYPE_NODE: 10

node is a doctype.

Inherited from

Node.DOCUMENT_TYPE_NODE


ELEMENT_NODE

readonly ELEMENT_NODE: 1

node is an element.

Inherited from

Node.ELEMENT_NODE


ENTITY_NODE

readonly ENTITY_NODE: 6

Inherited from

Node.ENTITY_NODE


ENTITY_REFERENCE_NODE

readonly ENTITY_REFERENCE_NODE: 5

Inherited from

Node.ENTITY_REFERENCE_NODE


firstChild

readonly firstChild: ChildNode | null

The read-only firstChild property of the Node interface returns the node's first child in the tree, or null if the node has no children.

MDN Reference

Inherited from

Node.firstChild


firstElementChild

readonly firstElementChild: Element | null

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

MDN Reference

Inherited from

ParentNode.firstElementChild


id

id: string

The id property of the Element interface represents the element's identifier, reflecting the id global attribute.

MDN Reference


innerHTML

innerHTML: string

The innerHTML property of the Element interface gets or sets the HTML or XML markup contained within the element.

MDN Reference


isConnected

readonly isConnected: boolean

The read-only isConnected property of the Node interface returns a boolean indicating whether the node is connected (directly or indirectly) to a Document object.

MDN Reference

Inherited from

Node.isConnected


lastChild

readonly lastChild: ChildNode | null

The read-only lastChild property of the Node interface returns the last child of the node, or null if there are no child nodes.

MDN Reference

Inherited from

Node.lastChild


lastElementChild

readonly lastElementChild: Element | null

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

MDN Reference

Inherited from

ParentNode.lastElementChild


localName

readonly localName: string

The Element.localName read-only property returns the local part of the qualified name of an element.

MDN Reference


namespaceURI

readonly namespaceURI: string | null

The Element.namespaceURI read-only property returns the namespace URI of the element, or null if the element is not in a namespace.

MDN Reference


nextElementSibling

readonly nextElementSibling: Element | null

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

MDN Reference

Inherited from

NonDocumentTypeChildNode.nextElementSibling


nextSibling

readonly nextSibling: ChildNode | null

The read-only nextSibling property of the Node interface returns the node immediately following the specified one in their parent's Node.childNodes, or returns null if the specified node is the last child in the parent element.

MDN Reference

Inherited from

Node.nextSibling


nodeName

readonly nodeName: string

The read-only nodeName property of Node returns the name of the current node as a string.

MDN Reference

Inherited from

Node.nodeName


nodeType

readonly nodeType: number

The read-only nodeType property of a Node interface is an integer that identifies what the node is.

MDN Reference

Inherited from

Node.nodeType


nodeValue

nodeValue: string | null

The nodeValue property of the Node interface returns or sets the value of the current node.

MDN Reference

Inherited from

Node.nodeValue


NOTATION_NODE

readonly NOTATION_NODE: 12

Inherited from

Node.NOTATION_NODE


onfullscreenchange

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

MDN Reference


onfullscreenerror

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

MDN Reference


outerHTML

outerHTML: string

The outerHTML attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.

MDN Reference


ownerDocument

readonly ownerDocument: Document

The read-only ownerDocument property of the Node interface returns the top-level document object of the node.

MDN Reference

Overrides

Node.ownerDocument


parentElement

readonly parentElement: HTMLElement | null

The read-only parentElement property of Node interface returns the DOM node's parent Element, or null if the node either has no parent, or its parent isn't a DOM Element.

MDN Reference

Inherited from

Node.parentElement


parentNode

readonly parentNode: ParentNode | null

The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree.

MDN Reference

Inherited from

Node.parentNode


prefix

readonly prefix: string | null

The Element.prefix read-only property returns the namespace prefix of the specified element, or null if no prefix is specified.

MDN Reference


previousElementSibling

readonly previousElementSibling: Element | null

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

MDN Reference

Inherited from

NonDocumentTypeChildNode.previousElementSibling


previousSibling

readonly previousSibling: ChildNode | null

The read-only previousSibling property of the Node interface returns the node immediately preceding the specified one in its parent's or null if the specified node is the first in that list.

MDN Reference

Inherited from

Node.previousSibling


PROCESSING_INSTRUCTION_NODE

readonly PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

Inherited from

Node.PROCESSING_INSTRUCTION_NODE


role

role: string | null

MDN Reference

Inherited from

ARIAMixin.role


scrollHeight

readonly scrollHeight: number

The scrollHeight read-only property of the Element interface is a measurement of the height of an element's content, including content not visible on the screen due to overflow.

MDN Reference


scrollLeft

scrollLeft: number

The scrollLeft property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its left edge.

MDN Reference


scrollTop

scrollTop: number

The scrollTop property of the Element interface gets or sets the number of pixels by which an element's content is scrolled from its top edge.

MDN Reference


scrollWidth

readonly scrollWidth: number

The scrollWidth read-only property of the Element interface is a measurement of the width of an element's content, including content not visible on the screen due to overflow.

MDN Reference


shadowRoot

readonly shadowRoot: ShadowRoot | null

The Element.shadowRoot read-only property represents the shadow root hosted by the element.

MDN Reference


slot

slot: string

The slot property of the Element interface returns the name of the shadow DOM slot the element is inserted in.

MDN Reference


style

style: CSSStyleDeclaration


tagName

readonly tagName: string

The tagName read-only property of the Element interface returns the tag name of the element on which it's called.

MDN Reference


TEXT_NODE

readonly TEXT_NODE: 3

node is a Text node.

Inherited from

Node.TEXT_NODE

Accessors

classList

Get Signature

get classList(): DOMTokenList

The Element.classList is a read-only property that returns a live DOMTokenList collection of the class attributes of the element.

MDN Reference

Returns

DOMTokenList

Set Signature

set classList(value): void

Parameters
ParameterType
valuestring
Returns

void


part

Get Signature

get part(): DOMTokenList

The part property of the Element interface represents the part identifier(s) of the element (i.e., set using the part attribute), returned as a DOMTokenList.

MDN Reference

Returns

DOMTokenList

Set Signature

set part(value): void

Parameters
ParameterType
valuestring
Returns

void


textContent

Get Signature

get textContent(): string

MDN Reference

Returns

string

Set Signature

set textContent(value): void

The textContent property of the Node interface represents the text content of the node and its descendants.

MDN Reference

Parameters
ParameterType
valuestring | null
Returns

void

Overrides

Node.textContent

Methods

addEventListener()

Call Signature

addEventListener<K>(type, listener, options?): void

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Type Parameters
Type Parameter
K extends keyof ElementEventMap
Parameters
ParameterType
typeK
listener(this, ev) => any
options?boolean | AddEventListenerOptions
Returns

void

Overrides

Node.addEventListener

Call Signature

addEventListener(type, listener, options?): void

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

MDN Reference

Parameters
ParameterType
typestring
listenerEventListenerOrEventListenerObject
options?boolean | AddEventListenerOptions
Returns

void

Overrides

Node.addEventListener


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.

MDN Reference

Parameters

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ChildNode.after


animate()

animate(keyframes, options?): Animation

MDN Reference

Parameters

ParameterType
keyframesKeyframe[] | PropertyIndexedKeyframes | null
options?number | KeyframeAnimationOptions

Returns

Animation

Inherited from

Animatable.animate


append()

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

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ParentNode.append


appendChild()

appendChild<T>(node): T

The appendChild() method of the Node interface adds a node to the end of the list of children of a specified parent node.

MDN Reference

Type Parameters

Type Parameter
T extends Node

Parameters

ParameterType
nodeT

Returns

T

Inherited from

Node.appendChild


attachShadow()

attachShadow(init): ShadowRoot

The Element.attachShadow() method attaches a shadow DOM tree to the specified element and returns a reference to its ShadowRoot.

MDN Reference

Parameters

ParameterType
initShadowRootInit

Returns

ShadowRoot


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.

MDN Reference

Parameters

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ChildNode.before


checkVisibility()

checkVisibility(options?): boolean

The checkVisibility() method of the Element interface checks whether the element is visible.

MDN Reference

Parameters

ParameterType
options?CheckVisibilityOptions

Returns

boolean


cloneNode()

cloneNode(subtree?): Node

The cloneNode() method of the Node interface returns a duplicate of the node on which this method was called.

MDN Reference

Parameters

ParameterType
subtree?boolean

Returns

Node

Inherited from

Node.cloneNode


closest()

Call Signature

closest<K>(selector): HTMLElementTagNameMap[K] | null

The closest() method of the Element interface traverses the element and its parents (heading toward the document root) until it finds a node that matches the specified CSS selector.

MDN Reference

Type Parameters
Type Parameter
K extends keyof HTMLElementTagNameMap
Parameters
ParameterType
selectorK
Returns

HTMLElementTagNameMap[K] | null

Call Signature

closest<K>(selector): SVGElementTagNameMap[K] | null

Type Parameters
Type Parameter
K extends keyof SVGElementTagNameMap
Parameters
ParameterType
selectorK
Returns

SVGElementTagNameMap[K] | null

Call Signature

closest<K>(selector): MathMLElementTagNameMap[K] | null

Type Parameters
Type Parameter
K extends keyof MathMLElementTagNameMap
Parameters
ParameterType
selectorK
Returns

MathMLElementTagNameMap[K] | null

Call Signature

closest<E>(selectors): E | null

Type Parameters
Type ParameterDefault type
E extends ElementElement
Parameters
ParameterType
selectorsstring
Returns

E | null


compareDocumentPosition()

compareDocumentPosition(other): number

The compareDocumentPosition() method of the Node interface reports the position of its argument node relative to the node on which it is called.

MDN Reference

Parameters

ParameterType
otherNode

Returns

number

Inherited from

Node.compareDocumentPosition


computedStyleMap()

computedStyleMap(): StylePropertyMapReadOnly

The computedStyleMap() method of the Element interface returns a StylePropertyMapReadOnly interface which provides a read-only representation of a CSS declaration block that is an alternative to CSSStyleDeclaration.

MDN Reference

Returns

StylePropertyMapReadOnly


contains()

contains(other): boolean

The contains() method of the Node interface returns a boolean value indicating whether a node is a descendant of a given node, that is the node itself, one of its direct children (Node.childNodes), one of the children's direct children, and so on.

MDN Reference

Parameters

ParameterType
otherNode | null

Returns

boolean

Inherited from

Node.contains


dispatchEvent()

dispatchEvent(event): boolean

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

MDN Reference

Parameters

ParameterType
eventEvent

Returns

boolean

Inherited from

Node.dispatchEvent


getAnimations()

getAnimations(options?): Animation[]

MDN Reference

Parameters

ParameterType
options?GetAnimationsOptions

Returns

Animation[]

Inherited from

Animatable.getAnimations


getAttribute()

getAttribute(qualifiedName): string | null

The getAttribute() method of the element.

MDN Reference

Parameters

ParameterType
qualifiedNamestring

Returns

string | null


getAttributeNames()

getAttributeNames(): string[]

The getAttributeNames() method of the array.

MDN Reference

Returns

string[]


getAttributeNode()

getAttributeNode(qualifiedName): Attr | null

Returns the specified attribute of the specified element, as an Attr node.

MDN Reference

Parameters

ParameterType
qualifiedNamestring

Returns

Attr | null


getAttributeNodeNS()

getAttributeNodeNS(namespace, localName): Attr | null

The getAttributeNodeNS() method of the Element interface returns the namespaced Attr node of an element.

MDN Reference

Parameters

ParameterType
namespacestring | null
localNamestring

Returns

Attr | null


getAttributeNS()

getAttributeNS(namespace, localName): string | null

The getAttributeNS() method of the Element interface returns the string value of the attribute with the specified namespace and name.

MDN Reference

Parameters

ParameterType
namespacestring | null
localNamestring

Returns

string | null


getBoundingClientRect()

getBoundingClientRect(): DOMRect

The Element.getBoundingClientRect() method returns a position relative to the viewport.

MDN Reference

Returns

DOMRect


getClientRects()

getClientRects(): DOMRectList

The getClientRects() method of the Element interface returns a collection of DOMRect objects that indicate the bounding rectangles for each CSS border box in a client.

MDN Reference

Returns

DOMRectList


getElementsByClassName()

getElementsByClassName(classNames): HTMLCollectionOf<Element>

The Element method getElementsByClassName() returns a live specified class name or names.

MDN Reference

Parameters

ParameterType
classNamesstring

Returns

HTMLCollectionOf<Element>


getElementsByTagName()

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>

The Element.getElementsByTagName() method returns a live All descendants of the specified element are searched, but not the element itself.

MDN Reference

Type Parameters
Type Parameter
K extends keyof HTMLElementTagNameMap
Parameters
ParameterType
qualifiedNameK
Returns

HTMLCollectionOf<HTMLElementTagNameMap[K]>

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>

Type Parameters
Type Parameter
K extends keyof SVGElementTagNameMap
Parameters
ParameterType
qualifiedNameK
Returns

HTMLCollectionOf<SVGElementTagNameMap[K]>

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<MathMLElementTagNameMap[K]>

Type Parameters
Type Parameter
K extends keyof MathMLElementTagNameMap
Parameters
ParameterType
qualifiedNameK
Returns

HTMLCollectionOf<MathMLElementTagNameMap[K]>

Call Signature

getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

Type Parameters
Type Parameter
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
ParameterType
qualifiedNameK
Returns

HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated

Call Signature

getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>

Parameters
ParameterType
qualifiedNamestring
Returns

HTMLCollectionOf<Element>


getElementsByTagNameNS()

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>

The Element.getElementsByTagNameNS() method returns a live HTMLCollection of elements with the given tag name belonging to the given namespace.

MDN Reference

Parameters
ParameterType
namespaceURI"http://www.w3.org/1999/xhtml"
localNamestring
Returns

HTMLCollectionOf<HTMLElement>

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>

Parameters
ParameterType
namespaceURI"http://www.w3.org/2000/svg"
localNamestring
Returns

HTMLCollectionOf<SVGElement>

Call Signature

getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<MathMLElement>

Parameters
ParameterType
namespaceURI"http://www.w3.org/1998/Math/MathML"
localNamestring
Returns

HTMLCollectionOf<MathMLElement>

Call Signature

getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>

Parameters
ParameterType
namespacestring | null
localNamestring
Returns

HTMLCollectionOf<Element>


getHTML()

getHTML(options?): string

The getHTML() method of the Element interface is used to serialize an element's DOM to an HTML string.

MDN Reference

Parameters

ParameterType
options?GetHTMLOptions

Returns

string


getRootNode()

getRootNode(options?): Node

The getRootNode() method of the Node interface returns the context object's root, which optionally includes the shadow root if it is available.

MDN Reference

Parameters

ParameterType
options?GetRootNodeOptions

Returns

Node

Inherited from

Node.getRootNode


hasAttribute()

hasAttribute(qualifiedName): boolean

The Element.hasAttribute() method returns a Boolean value indicating whether the specified element has the specified attribute or not.

MDN Reference

Parameters

ParameterType
qualifiedNamestring

Returns

boolean


hasAttributeNS()

hasAttributeNS(namespace, localName): boolean

The hasAttributeNS() method of the Element interface returns a boolean value indicating whether the current element has the specified attribute with the specified namespace.

MDN Reference

Parameters

ParameterType
namespacestring | null
localNamestring

Returns

boolean


hasAttributes()

hasAttributes(): boolean

The hasAttributes() method of the Element interface returns a boolean value indicating whether the current element has any attributes or not.

MDN Reference

Returns

boolean


hasChildNodes()

hasChildNodes(): boolean

The hasChildNodes() method of the Node interface returns a boolean value indicating whether the given Node has child nodes or not.

MDN Reference

Returns

boolean

Inherited from

Node.hasChildNodes


hasPointerCapture()

hasPointerCapture(pointerId): boolean

The hasPointerCapture() method of the pointer capture for the pointer identified by the given pointer ID.

MDN Reference

Parameters

ParameterType
pointerIdnumber

Returns

boolean


insertAdjacentElement()

insertAdjacentElement(where, element): Element | null

The insertAdjacentElement() method of the relative to the element it is invoked upon.

MDN Reference

Parameters

ParameterType
whereInsertPosition
elementElement

Returns

Element | null


insertAdjacentHTML()

insertAdjacentHTML(position, string): void

The insertAdjacentHTML() method of the the resulting nodes into the DOM tree at a specified position.

MDN Reference

Parameters

ParameterType
positionInsertPosition
stringstring

Returns

void


insertAdjacentText()

insertAdjacentText(where, data): void

The insertAdjacentText() method of the Element interface, given a relative position and a string, inserts a new text node at the given position relative to the element it is called from.

MDN Reference

Parameters

ParameterType
whereInsertPosition
datastring

Returns

void


insertBefore()

insertBefore<T>(node, child): T

The insertBefore() method of the Node interface inserts a node before a reference node as a child of a specified parent node.

MDN Reference

Type Parameters

Type Parameter
T extends Node

Parameters

ParameterType
nodeT
childNode | null

Returns

T

Inherited from

Node.insertBefore


isDefaultNamespace()

isDefaultNamespace(namespace): boolean

The isDefaultNamespace() method of the Node interface accepts a namespace URI as an argument.

MDN Reference

Parameters

ParameterType
namespacestring | null

Returns

boolean

Inherited from

Node.isDefaultNamespace


isEqualNode()

isEqualNode(otherNode): boolean

The isEqualNode() method of the Node interface tests whether two nodes are equal.

MDN Reference

Parameters

ParameterType
otherNodeNode | null

Returns

boolean

Inherited from

Node.isEqualNode


isSameNode()

isSameNode(otherNode): boolean

The isSameNode() method of the Node interface is a legacy alias the for the === strict equality operator.

MDN Reference

Parameters

ParameterType
otherNodeNode | null

Returns

boolean

Inherited from

Node.isSameNode


lookupNamespaceURI()

lookupNamespaceURI(prefix): string | null

The lookupNamespaceURI() method of the Node interface takes a prefix as parameter and returns the namespace URI associated with it on the given node if found (and null if not).

MDN Reference

Parameters

ParameterType
prefixstring | null

Returns

string | null

Inherited from

Node.lookupNamespaceURI


lookupPrefix()

lookupPrefix(namespace): string | null

The lookupPrefix() method of the Node interface returns a string containing the prefix for a given namespace URI, if present, and null if not.

MDN Reference

Parameters

ParameterType
namespacestring | null

Returns

string | null

Inherited from

Node.lookupPrefix


matches()

matches(selectors): boolean

The matches() method of the Element interface tests whether the element would be selected by the specified CSS selector.

MDN Reference

Parameters

ParameterType
selectorsstring

Returns

boolean


normalize()

normalize(): void

The normalize() method of the Node interface puts the specified node and all of its sub-tree into a normalized form.

MDN Reference

Returns

void

Inherited from

Node.normalize


prepend()

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

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ParentNode.prepend


querySelector()

Call Signature

querySelector<K>(selectors): HTMLElementTagNameMap[K] | null

Returns the first element that is a descendant of node that matches selectors.

MDN Reference

Type Parameters
Type Parameter
K extends keyof HTMLElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

HTMLElementTagNameMap[K] | null

Inherited from

ParentNode.querySelector

Call Signature

querySelector<K>(selectors): SVGElementTagNameMap[K] | null

Type Parameters
Type Parameter
K extends keyof SVGElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

SVGElementTagNameMap[K] | null

Inherited from

ParentNode.querySelector

Call Signature

querySelector<K>(selectors): MathMLElementTagNameMap[K] | null

Type Parameters
Type Parameter
K extends keyof MathMLElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

MathMLElementTagNameMap[K] | null

Inherited from

ParentNode.querySelector

Call Signature

querySelector<K>(selectors): HTMLElementDeprecatedTagNameMap[K] | null

Type Parameters
Type Parameter
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
ParameterType
selectorsK
Returns

HTMLElementDeprecatedTagNameMap[K] | null

Deprecated
Inherited from

ParentNode.querySelector

Call Signature

querySelector<E>(selectors): E | null

Type Parameters
Type ParameterDefault type
E extends ElementElement
Parameters
ParameterType
selectorsstring
Returns

E | null

Inherited from

ParentNode.querySelector


querySelectorAll()

Call Signature

querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>

Returns all element descendants of node that match selectors.

MDN Reference

Type Parameters
Type Parameter
K extends keyof HTMLElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

NodeListOf<HTMLElementTagNameMap[K]>

Inherited from

ParentNode.querySelectorAll

Call Signature

querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>

Type Parameters
Type Parameter
K extends keyof SVGElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

NodeListOf<SVGElementTagNameMap[K]>

Inherited from

ParentNode.querySelectorAll

Call Signature

querySelectorAll<K>(selectors): NodeListOf<MathMLElementTagNameMap[K]>

Type Parameters
Type Parameter
K extends keyof MathMLElementTagNameMap
Parameters
ParameterType
selectorsK
Returns

NodeListOf<MathMLElementTagNameMap[K]>

Inherited from

ParentNode.querySelectorAll

Call Signature

querySelectorAll<K>(selectors): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Type Parameters
Type Parameter
K extends keyof HTMLElementDeprecatedTagNameMap
Parameters
ParameterType
selectorsK
Returns

NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

Deprecated
Inherited from

ParentNode.querySelectorAll

Call Signature

querySelectorAll<E>(selectors): NodeListOf<E>

Type Parameters
Type ParameterDefault type
E extends ElementElement
Parameters
ParameterType
selectorsstring
Returns

NodeListOf<E>

Inherited from

ParentNode.querySelectorAll


releasePointerCapture()

releasePointerCapture(pointerId): void

The releasePointerCapture() method of the previously set for a specific (PointerEvent) pointer.

MDN Reference

Parameters

ParameterType
pointerIdnumber

Returns

void


remove()

remove(): void

Removes node.

MDN Reference

Returns

void

Inherited from

ChildNode.remove


removeAttribute()

removeAttribute(qualifiedName): void

The Element method removeAttribute() removes the attribute with the specified name from the element.

MDN Reference

Parameters

ParameterType
qualifiedNamestring

Returns

void


removeAttributeNode()

removeAttributeNode(attr): Attr

The removeAttributeNode() method of the Element interface removes the specified Attr node from the element.

MDN Reference

Parameters

ParameterType
attrAttr

Returns

Attr


removeAttributeNS()

removeAttributeNS(namespace, localName): void

The removeAttributeNS() method of the If you are working with HTML and you don't need to specify the requested attribute as being part of a specific namespace, use the Element.removeAttribute() method instead.

MDN Reference

Parameters

ParameterType
namespacestring | null
localNamestring

Returns

void


removeChild()

removeChild<T>(child): T

The removeChild() method of the Node interface removes a child node from the DOM and returns the removed node.

MDN Reference

Type Parameters

Type Parameter
T extends Node

Parameters

ParameterType
childT

Returns

T

Inherited from

Node.removeChild


removeEventListener()

Call Signature

removeEventListener<K>(type, listener, options?): void

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference

Type Parameters
Type Parameter
K extends keyof ElementEventMap
Parameters
ParameterType
typeK
listener(this, ev) => any
options?boolean | EventListenerOptions
Returns

void

Overrides

Node.removeEventListener

Call Signature

removeEventListener(type, listener, options?): void

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

MDN Reference

Parameters
ParameterType
typestring
listenerEventListenerOrEventListenerObject
options?boolean | EventListenerOptions
Returns

void

Overrides

Node.removeEventListener


replaceChild()

replaceChild<T>(node, child): T

The replaceChild() method of the Node interface replaces a child node within the given (parent) node.

MDN Reference

Type Parameters

Type Parameter
T extends Node

Parameters

ParameterType
nodeNode
childT

Returns

T

Inherited from

Node.replaceChild


replaceChildren()

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

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ParentNode.replaceChildren


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.

MDN Reference

Parameters

ParameterType
...nodes(string | Node)[]

Returns

void

Inherited from

ChildNode.replaceWith


requestFullscreen()

requestFullscreen(options?): Promise<void>

The Element.requestFullscreen() method issues an asynchronous request to make the element be displayed in fullscreen mode.

MDN Reference

Parameters

ParameterType
options?FullscreenOptions

Returns

Promise<void>


requestPointerLock()

requestPointerLock(options?): Promise<void>

The requestPointerLock() method of the Element interface lets you asynchronously ask for the pointer to be locked on the given element.

MDN Reference

Parameters

ParameterType
options?PointerLockOptions

Returns

Promise<void>


scroll()

Call Signature

scroll(options?): void

The scroll() method of the Element interface scrolls the element to a particular set of coordinates inside a given element.

MDN Reference

Parameters
ParameterType
options?ScrollToOptions
Returns

void

Call Signature

scroll(x, y): void

Parameters
ParameterType
xnumber
ynumber
Returns

void


scrollBy()

Call Signature

scrollBy(options?): void

The scrollBy() method of the Element interface scrolls an element by the given amount.

MDN Reference

Parameters
ParameterType
options?ScrollToOptions
Returns

void

Call Signature

scrollBy(x, y): void

Parameters
ParameterType
xnumber
ynumber
Returns

void


scrollIntoView()

scrollIntoView(arg?): void

The Element interface's scrollIntoView() method scrolls the element's ancestor containers such that the element on which scrollIntoView() is called is visible to the user.

MDN Reference

Parameters

ParameterType
arg?boolean | ScrollIntoViewOptions

Returns

void


scrollTo()

Call Signature

scrollTo(options?): void

The scrollTo() method of the Element interface scrolls to a particular set of coordinates inside a given element.

MDN Reference

Parameters
ParameterType
options?ScrollToOptions
Returns

void

Call Signature

scrollTo(x, y): void

Parameters
ParameterType
xnumber
ynumber
Returns

void


setAttribute()

setAttribute(qualifiedName, value): void

The setAttribute() method of the Element interface sets the value of an attribute on the specified element.

MDN Reference

Parameters

ParameterType
qualifiedNamestring
valuestring

Returns

void


setAttributeNode()

setAttributeNode(attr): Attr | null

The setAttributeNode() method of the Element interface adds a new Attr node to the specified element.

MDN Reference

Parameters

ParameterType
attrAttr

Returns

Attr | null


setAttributeNodeNS()

setAttributeNodeNS(attr): Attr | null

The setAttributeNodeNS() method of the Element interface adds a new namespaced Attr node to an element.

MDN Reference

Parameters

ParameterType
attrAttr

Returns

Attr | null


setAttributeNS()

setAttributeNS(namespace, qualifiedName, value): void

setAttributeNS adds a new attribute or changes the value of an attribute with the given namespace and name.

MDN Reference

Parameters

ParameterType
namespacestring | null
qualifiedNamestring
valuestring

Returns

void


setHTMLUnsafe()

setHTMLUnsafe(html): void

The setHTMLUnsafe() method of the Element interface is used to parse a string of HTML into a DocumentFragment, optionally filtering out unwanted elements and attributes, and those that don't belong in the context, and then using it to replace the element's subtree in the DOM.

MDN Reference

Parameters

ParameterType
htmlstring

Returns

void


setPointerCapture()

setPointerCapture(pointerId): void

The setPointerCapture() method of the capture target of future pointer events.

MDN Reference

Parameters

ParameterType
pointerIdnumber

Returns

void


toggleAttribute()

toggleAttribute(qualifiedName, force?): boolean

The toggleAttribute() method of the present and adding it if it is not present) on the given element.

MDN Reference

Parameters

ParameterType
qualifiedNamestring
force?boolean

Returns

boolean


webkitMatchesSelector()

webkitMatchesSelector(selectors): boolean

Parameters

ParameterType
selectorsstring

Returns

boolean

Deprecated

This is a legacy alias of matches.

MDN Reference