Interface: Element
Element is the most general base class from which all element objects (i.e., objects that represent elements) in a Document inherit.
Extends
Node.ARIAMixin.Animatable.ChildNode.NonDocumentTypeChildNode.ParentNode.Slottable
Properties
__evolv__
__evolv__:
MutateContext
ariaActiveDescendantElement
ariaActiveDescendantElement:
Element|null
Inherited from
ARIAMixin.ariaActiveDescendantElement
ariaAtomic
ariaAtomic:
string|null
Inherited from
ARIAMixin.ariaAtomic
ariaAutoComplete
ariaAutoComplete:
string|null
Inherited from
ARIAMixin.ariaAutoComplete
ariaBrailleLabel
ariaBrailleLabel:
string|null
Inherited from
ARIAMixin.ariaBrailleLabel
ariaBrailleRoleDescription
ariaBrailleRoleDescription:
string|null
Inherited from
ARIAMixin.ariaBrailleRoleDescription
ariaBusy
ariaBusy:
string|null
Inherited from
ARIAMixin.ariaBusy
ariaChecked
ariaChecked:
string|null
Inherited from
ARIAMixin.ariaChecked
ariaColCount
ariaColCount:
string|null
Inherited from
ARIAMixin.ariaColCount
ariaColIndex
ariaColIndex:
string|null
Inherited from
ARIAMixin.ariaColIndex
ariaColIndexText
ariaColIndexText:
string|null
Inherited from
ARIAMixin.ariaColIndexText
ariaColSpan
ariaColSpan:
string|null
Inherited from
ARIAMixin.ariaColSpan
ariaControlsElements
ariaControlsElements: readonly
Element[] |null
Inherited from
ARIAMixin.ariaControlsElements
ariaCurrent
ariaCurrent:
string|null
Inherited from
ARIAMixin.ariaCurrent
ariaDescribedByElements
ariaDescribedByElements: readonly
Element[] |null
Inherited from
ARIAMixin.ariaDescribedByElements
ariaDescription
ariaDescription:
string|null
Inherited from
ARIAMixin.ariaDescription
ariaDetailsElements
ariaDetailsElements: readonly
Element[] |null
Inherited from
ARIAMixin.ariaDetailsElements
ariaDisabled
ariaDisabled:
string|null
Inherited from
ARIAMixin.ariaDisabled
ariaErrorMessageElements
ariaErrorMessageElements: readonly
Element[] |null
Inherited from
ARIAMixin.ariaErrorMessageElements
ariaExpanded
ariaExpanded:
string|null
Inherited from
ARIAMixin.ariaExpanded
ariaFlowToElements
ariaFlowToElements: readonly
Element[] |null
Inherited from
ARIAMixin.ariaFlowToElements
ariaHasPopup
ariaHasPopup:
string|null
Inherited from
ARIAMixin.ariaHasPopup
ariaHidden
ariaHidden:
string|null
Inherited from
ARIAMixin.ariaHidden
ariaInvalid
ariaInvalid:
string|null
Inherited from
ARIAMixin.ariaInvalid
ariaKeyShortcuts
ariaKeyShortcuts:
string|null
Inherited from
ARIAMixin.ariaKeyShortcuts
ariaLabel
ariaLabel:
string|null
Inherited from
ARIAMixin.ariaLabel
ariaLabelledByElements
ariaLabelledByElements: readonly
Element[] |null
Inherited from
ARIAMixin.ariaLabelledByElements
ariaLevel
ariaLevel:
string|null
Inherited from
ARIAMixin.ariaLevel
ariaLive
ariaLive:
string|null
Inherited from
ARIAMixin.ariaLive
ariaModal
ariaModal:
string|null
Inherited from
ARIAMixin.ariaModal
ariaMultiLine
ariaMultiLine:
string|null
Inherited from
ARIAMixin.ariaMultiLine
ariaMultiSelectable
ariaMultiSelectable:
string|null
Inherited from
ARIAMixin.ariaMultiSelectable
ariaOrientation
ariaOrientation:
string|null
Inherited from
ARIAMixin.ariaOrientation
ariaOwnsElements
ariaOwnsElements: readonly
Element[] |null
Inherited from
ARIAMixin.ariaOwnsElements
ariaPlaceholder
ariaPlaceholder:
string|null
Inherited from
ARIAMixin.ariaPlaceholder
ariaPosInSet
ariaPosInSet:
string|null
Inherited from
ARIAMixin.ariaPosInSet
ariaPressed
ariaPressed:
string|null
Inherited from
ARIAMixin.ariaPressed
ariaReadOnly
ariaReadOnly:
string|null
Inherited from
ARIAMixin.ariaReadOnly
ariaRelevant
ariaRelevant:
string|null
Inherited from
ARIAMixin.ariaRelevant
ariaRequired
ariaRequired:
string|null
Inherited from
ARIAMixin.ariaRequired
ariaRoleDescription
ariaRoleDescription:
string|null
Inherited from
ARIAMixin.ariaRoleDescription
ariaRowCount
ariaRowCount:
string|null
Inherited from
ARIAMixin.ariaRowCount
ariaRowIndex
ariaRowIndex:
string|null
Inherited from
ARIAMixin.ariaRowIndex
ariaRowIndexText
ariaRowIndexText:
string|null
Inherited from
ARIAMixin.ariaRowIndexText
ariaRowSpan
ariaRowSpan:
string|null
Inherited from
ARIAMixin.ariaRowSpan
ariaSelected
ariaSelected:
string|null
Inherited from
ARIAMixin.ariaSelected
ariaSetSize
ariaSetSize:
string|null
Inherited from
ARIAMixin.ariaSetSize
ariaSort
ariaSort:
string|null
Inherited from
ARIAMixin.ariaSort
ariaValueMax
ariaValueMax:
string|null
Inherited from
ARIAMixin.ariaValueMax
ariaValueMin
ariaValueMin:
string|null
Inherited from
ARIAMixin.ariaValueMin
ariaValueNow
ariaValueNow:
string|null
Inherited from
ARIAMixin.ariaValueNow
ariaValueText
ariaValueText:
string|null
Inherited from
ARIAMixin.ariaValueText
assignedSlot
readonlyassignedSlot:HTMLSlotElement|null
Inherited from
Slottable.assignedSlot
ATTRIBUTE_NODE
readonlyATTRIBUTE_NODE:2
Inherited from
Node.ATTRIBUTE_NODE
attributes
readonlyattributes:NamedNodeMap
The Element.attributes property returns a live collection of all attribute nodes registered to the specified node.
baseURI
readonlybaseURI:string
The read-only baseURI property of the Node interface returns the absolute base URL of the document containing the node.
Inherited from
Node.baseURI
CDATA_SECTION_NODE
readonlyCDATA_SECTION_NODE:4
node is a CDATASection node.
Inherited from
Node.CDATA_SECTION_NODE
childElementCount
readonlychildElementCount:number
Inherited from
ParentNode.childElementCount
childNodes
readonlychildNodes:NodeListOf<ChildNode>
The read-only childNodes property of the Node interface returns a live the first child node is assigned index 0.
Inherited from
Node.childNodes
children
readonlychildren:HTMLCollection
Returns the child elements.
Inherited from
ParentNode.children
className
className:
string
The className property of the of the specified element.
clientHeight
readonlyclientHeight: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.
clientLeft
readonlyclientLeft:number
The clientLeft read-only property of the Element interface returns the width of the left border of an element in pixels.
clientTop
readonlyclientTop:number
The clientTop read-only property of the Element interface returns the width of the top border of an element in pixels.
clientWidth
readonlyclientWidth: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.
COMMENT_NODE
readonlyCOMMENT_NODE:8
node is a Comment node.
Inherited from
Node.COMMENT_NODE
currentCSSZoom
readonlycurrentCSSZoom: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.
dataset
dataset:
DOMStringMap
DOCUMENT_FRAGMENT_NODE
readonlyDOCUMENT_FRAGMENT_NODE:11
node is a DocumentFragment node.
Inherited from
Node.DOCUMENT_FRAGMENT_NODE
DOCUMENT_NODE
readonlyDOCUMENT_NODE:9
node is a document.
Inherited from
Node.DOCUMENT_NODE
DOCUMENT_POSITION_CONTAINED_BY
readonlyDOCUMENT_POSITION_CONTAINED_BY:16
Set when other is a descendant of node.
Inherited from
Node.DOCUMENT_POSITION_CONTAINED_BY
DOCUMENT_POSITION_CONTAINS
readonlyDOCUMENT_POSITION_CONTAINS:8
Set when other is an ancestor of node.
Inherited from
Node.DOCUMENT_POSITION_CONTAINS
DOCUMENT_POSITION_DISCONNECTED
readonlyDOCUMENT_POSITION_DISCONNECTED:1
Set when node and other are not in the same tree.
Inherited from
Node.DOCUMENT_POSITION_DISCONNECTED
DOCUMENT_POSITION_FOLLOWING
readonlyDOCUMENT_POSITION_FOLLOWING:4
Set when other is following node.
Inherited from
Node.DOCUMENT_POSITION_FOLLOWING
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
readonlyDOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC:32
Inherited from
Node.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC
DOCUMENT_POSITION_PRECEDING
readonlyDOCUMENT_POSITION_PRECEDING:2
Set when other is preceding node.
Inherited from
Node.DOCUMENT_POSITION_PRECEDING
DOCUMENT_TYPE_NODE
readonlyDOCUMENT_TYPE_NODE:10
node is a doctype.
Inherited from
Node.DOCUMENT_TYPE_NODE
ELEMENT_NODE
readonlyELEMENT_NODE:1
node is an element.
Inherited from
Node.ELEMENT_NODE
ENTITY_NODE
readonlyENTITY_NODE:6
Inherited from
Node.ENTITY_NODE
ENTITY_REFERENCE_NODE
readonlyENTITY_REFERENCE_NODE:5
Inherited from
Node.ENTITY_REFERENCE_NODE
firstChild
readonlyfirstChild: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.
Inherited from
Node.firstChild
firstElementChild
readonlyfirstElementChild:Element|null
Returns the first child that is an element, and null otherwise.
Inherited from
ParentNode.firstElementChild
id
id:
string
The id property of the Element interface represents the element's identifier, reflecting the id global attribute.
innerHTML
innerHTML:
string
The innerHTML property of the Element interface gets or sets the HTML or XML markup contained within the element.
isConnected
readonlyisConnected: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.
Inherited from
Node.isConnected
lastChild
readonlylastChild: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.
Inherited from
Node.lastChild
lastElementChild
readonlylastElementChild:Element|null
Returns the last child that is an element, and null otherwise.
Inherited from
ParentNode.lastElementChild
localName
readonlylocalName:string
The Element.localName read-only property returns the local part of the qualified name of an element.
namespaceURI
readonlynamespaceURI: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.
nextElementSibling
readonlynextElementSibling:Element|null
Returns the first following sibling that is an element, and null otherwise.
Inherited from
NonDocumentTypeChildNode.nextElementSibling
nextSibling
readonlynextSibling: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.
Inherited from
Node.nextSibling
nodeName
readonlynodeName:string
The read-only nodeName property of Node returns the name of the current node as a string.
Inherited from
Node.nodeName
nodeType
readonlynodeType:number
The read-only nodeType property of a Node interface is an integer that identifies what the node is.
Inherited from
Node.nodeType
nodeValue
nodeValue:
string|null
The nodeValue property of the Node interface returns or sets the value of the current node.
Inherited from
Node.nodeValue
NOTATION_NODE
readonlyNOTATION_NODE:12
Inherited from
Node.NOTATION_NODE
onfullscreenchange
onfullscreenchange: (
this,ev) =>any|null
onfullscreenerror
onfullscreenerror: (
this,ev) =>any|null
outerHTML
outerHTML:
string
The outerHTML attribute of the Element DOM interface gets the serialized HTML fragment describing the element including its descendants.
ownerDocument
readonlyownerDocument:Document
The read-only ownerDocument property of the Node interface returns the top-level document object of the node.
Overrides
Node.ownerDocument
parentElement
readonlyparentElement: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.
Inherited from
Node.parentElement
parentNode
readonlyparentNode:ParentNode|null
The read-only parentNode property of the Node interface returns the parent of the specified node in the DOM tree.
Inherited from
Node.parentNode
prefix
readonlyprefix:string|null
The Element.prefix read-only property returns the namespace prefix of the specified element, or null if no prefix is specified.
previousElementSibling
readonlypreviousElementSibling:Element|null
Returns the first preceding sibling that is an element, and null otherwise.
Inherited from
NonDocumentTypeChildNode.previousElementSibling
previousSibling
readonlypreviousSibling: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.
Inherited from
Node.previousSibling
PROCESSING_INSTRUCTION_NODE
readonlyPROCESSING_INSTRUCTION_NODE:7
node is a ProcessingInstruction node.
Inherited from
Node.PROCESSING_INSTRUCTION_NODE
role
role:
string|null
Inherited from
ARIAMixin.role
scrollHeight
readonlyscrollHeight: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.
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.
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.
scrollWidth
readonlyscrollWidth: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.
shadowRoot
readonlyshadowRoot:ShadowRoot|null
The Element.shadowRoot read-only property represents the shadow root hosted by the element.
slot
slot:
string
The slot property of the Element interface returns the name of the shadow DOM slot the element is inserted in.
style
style:
CSSStyleDeclaration
tagName
readonlytagName:string
The tagName read-only property of the Element interface returns the tag name of the element on which it's called.
TEXT_NODE
readonlyTEXT_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.
Returns
DOMTokenList
Set Signature
set classList(
value):void
Parameters
| Parameter | Type |
|---|---|
value | string |
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.
Returns
DOMTokenList
Set Signature
set part(
value):void
Parameters
| Parameter | Type |
|---|---|
value | string |
Returns
void
textContent
Get Signature
get textContent():
string
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.
Parameters
| Parameter | Type |
|---|---|
value | string | 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.
Type Parameters
| Type Parameter |
|---|
K extends keyof ElementEventMap |
Parameters
| Parameter | Type |
|---|---|
type | K |
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.
Parameters
| Parameter | Type |
|---|---|
type | string |
listener | EventListenerOrEventListenerObject |
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.
Parameters
| Parameter | Type |
|---|---|
...nodes | (string | Node)[] |
Returns
void
Inherited from
ChildNode.after
animate()
animate(
keyframes,options?):Animation
Parameters
| Parameter | Type |
|---|---|
keyframes | Keyframe[] | 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.
Parameters
| Parameter | Type |
|---|---|
...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.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
node | T |
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.
Parameters
| Parameter | Type |
|---|---|
init | ShadowRootInit |
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.
Parameters
| Parameter | Type |
|---|---|
...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.
Parameters
| Parameter | Type |
|---|---|
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.
Parameters
| Parameter | Type |
|---|---|
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.
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selector | K |
Returns
HTMLElementTagNameMap[K] | null
Call Signature
closest<
K>(selector):SVGElementTagNameMap[K] |null
Type Parameters
| Type Parameter |
|---|
K extends keyof SVGElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selector | K |
Returns
SVGElementTagNameMap[K] | null
Call Signature
closest<
K>(selector):MathMLElementTagNameMap[K] |null
Type Parameters
| Type Parameter |
|---|
K extends keyof MathMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selector | K |
Returns
MathMLElementTagNameMap[K] | null
Call Signature
closest<
E>(selectors):E|null
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends Element | Element |
Parameters
| Parameter | Type |
|---|---|
selectors | string |
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.
Parameters
| Parameter | Type |
|---|---|
other | Node |
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.
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.
Parameters
| Parameter | Type |
|---|---|
other | Node | 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.
Parameters
| Parameter | Type |
|---|---|
event | Event |
Returns
boolean
Inherited from
Node.dispatchEvent
getAnimations()
getAnimations(
options?):Animation[]
Parameters
| Parameter | Type |
|---|---|
options? | GetAnimationsOptions |
Returns
Animation[]
Inherited from
Animatable.getAnimations
getAttribute()
getAttribute(
qualifiedName):string|null
The getAttribute() method of the element.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
Returns
string | null
getAttributeNames()
getAttributeNames():
string[]
The getAttributeNames() method of the array.
Returns
string[]
getAttributeNode()
getAttributeNode(
qualifiedName):Attr|null
Returns the specified attribute of the specified element, as an Attr node.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
Returns
Attr | null
getAttributeNodeNS()
getAttributeNodeNS(
namespace,localName):Attr|null
The getAttributeNodeNS() method of the Element interface returns the namespaced Attr node of an element.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
localName | string |
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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
localName | string |
Returns
string | null
getBoundingClientRect()
getBoundingClientRect():
DOMRect
The Element.getBoundingClientRect() method returns a position relative to the viewport.
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.
Returns
DOMRectList
getElementsByClassName()
getElementsByClassName(
classNames):HTMLCollectionOf<Element>
The Element method getElementsByClassName() returns a live specified class name or names.
Parameters
| Parameter | Type |
|---|---|
classNames | string |
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.
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
qualifiedName | K |
Returns
HTMLCollectionOf<HTMLElementTagNameMap[K]>
Call Signature
getElementsByTagName<
K>(qualifiedName):HTMLCollectionOf<SVGElementTagNameMap[K]>
Type Parameters
| Type Parameter |
|---|
K extends keyof SVGElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
qualifiedName | K |
Returns
HTMLCollectionOf<SVGElementTagNameMap[K]>
Call Signature
getElementsByTagName<
K>(qualifiedName):HTMLCollectionOf<MathMLElementTagNameMap[K]>
Type Parameters
| Type Parameter |
|---|
K extends keyof MathMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
qualifiedName | K |
Returns
HTMLCollectionOf<MathMLElementTagNameMap[K]>
Call Signature
getElementsByTagName<
K>(qualifiedName):HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementDeprecatedTagNameMap |
Parameters
| Parameter | Type |
|---|---|
qualifiedName | K |
Returns
HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Call Signature
getElementsByTagName(
qualifiedName):HTMLCollectionOf<Element>
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
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.
Parameters
| Parameter | Type |
|---|---|
namespaceURI | "http://www.w3.org/1999/xhtml" |
localName | string |
Returns
HTMLCollectionOf<HTMLElement>
Call Signature
getElementsByTagNameNS(
namespaceURI,localName):HTMLCollectionOf<SVGElement>
Parameters
| Parameter | Type |
|---|---|
namespaceURI | "http://www.w3.org/2000/svg" |
localName | string |
Returns
HTMLCollectionOf<SVGElement>
Call Signature
getElementsByTagNameNS(
namespaceURI,localName):HTMLCollectionOf<MathMLElement>
Parameters
| Parameter | Type |
|---|---|
namespaceURI | "http://www.w3.org/1998/Math/MathML" |
localName | string |
Returns
HTMLCollectionOf<MathMLElement>
Call Signature
getElementsByTagNameNS(
namespace,localName):HTMLCollectionOf<Element>
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
localName | string |
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.
Parameters
| Parameter | Type |
|---|---|
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.
Parameters
| Parameter | Type |
|---|---|
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.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
localName | string |
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.
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.
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.
Parameters
| Parameter | Type |
|---|---|
pointerId | number |
Returns
boolean
insertAdjacentElement()
insertAdjacentElement(
where,element):Element|null
The insertAdjacentElement() method of the relative to the element it is invoked upon.
Parameters
| Parameter | Type |
|---|---|
where | InsertPosition |
element | Element |
Returns
Element | null
insertAdjacentHTML()
insertAdjacentHTML(
position,string):void
The insertAdjacentHTML() method of the the resulting nodes into the DOM tree at a specified position.
Parameters
| Parameter | Type |
|---|---|
position | InsertPosition |
string | string |
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.
Parameters
| Parameter | Type |
|---|---|
where | InsertPosition |
data | string |
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.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
node | T |
child | Node | 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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
Returns
boolean
Inherited from
Node.isDefaultNamespace
isEqualNode()
isEqualNode(
otherNode):boolean
The isEqualNode() method of the Node interface tests whether two nodes are equal.
Parameters
| Parameter | Type |
|---|---|
otherNode | Node | 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.
Parameters
| Parameter | Type |
|---|---|
otherNode | Node | 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).
Parameters
| Parameter | Type |
|---|---|
prefix | string | 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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | 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.
Parameters
| Parameter | Type |
|---|---|
selectors | string |
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.
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.
Parameters
| Parameter | Type |
|---|---|
...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.
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
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
| Parameter | Type |
|---|---|
selectors | K |
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
| Parameter | Type |
|---|---|
selectors | K |
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
| Parameter | Type |
|---|---|
selectors | K |
Returns
HTMLElementDeprecatedTagNameMap[K] | null
Deprecated
Inherited from
ParentNode.querySelector
Call Signature
querySelector<
E>(selectors):E|null
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends Element | Element |
Parameters
| Parameter | Type |
|---|---|
selectors | string |
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.
Type Parameters
| Type Parameter |
|---|
K extends keyof HTMLElementTagNameMap |
Parameters
| Parameter | Type |
|---|---|
selectors | K |
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
| Parameter | Type |
|---|---|
selectors | K |
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
| Parameter | Type |
|---|---|
selectors | K |
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
| Parameter | Type |
|---|---|
selectors | K |
Returns
NodeListOf<HTMLElementDeprecatedTagNameMap[K]>
Deprecated
Inherited from
ParentNode.querySelectorAll
Call Signature
querySelectorAll<
E>(selectors):NodeListOf<E>
Type Parameters
| Type Parameter | Default type |
|---|---|
E extends Element | Element |
Parameters
| Parameter | Type |
|---|---|
selectors | string |
Returns
NodeListOf<E>
Inherited from
ParentNode.querySelectorAll
releasePointerCapture()
releasePointerCapture(
pointerId):void
The releasePointerCapture() method of the previously set for a specific (PointerEvent) pointer.
Parameters
| Parameter | Type |
|---|---|
pointerId | number |
Returns
void
remove()
remove():
void
Removes node.
Returns
void
Inherited from
ChildNode.remove
removeAttribute()
removeAttribute(
qualifiedName):void
The Element method removeAttribute() removes the attribute with the specified name from the element.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
Returns
void
removeAttributeNode()
removeAttributeNode(
attr):Attr
The removeAttributeNode() method of the Element interface removes the specified Attr node from the element.
Parameters
| Parameter | Type |
|---|---|
attr | Attr |
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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
localName | string |
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.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
child | T |
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.
Type Parameters
| Type Parameter |
|---|
K extends keyof ElementEventMap |
Parameters
| Parameter | Type |
|---|---|
type | K |
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.
Parameters
| Parameter | Type |
|---|---|
type | string |
listener | EventListenerOrEventListenerObject |
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.
Type Parameters
| Type Parameter |
|---|
T extends Node |
Parameters
| Parameter | Type |
|---|---|
node | Node |
child | T |
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.
Parameters
| Parameter | Type |
|---|---|
...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.
Parameters
| Parameter | Type |
|---|---|
...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.
Parameters
| Parameter | Type |
|---|---|
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.
Parameters
| Parameter | Type |
|---|---|
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.
Parameters
| Parameter | Type |
|---|---|
options? | ScrollToOptions |
Returns
void
Call Signature
scroll(
x,y):void
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
Returns
void
scrollBy()
Call Signature
scrollBy(
options?):void
The scrollBy() method of the Element interface scrolls an element by the given amount.
Parameters
| Parameter | Type |
|---|---|
options? | ScrollToOptions |
Returns
void
Call Signature
scrollBy(
x,y):void
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
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.
Parameters
| Parameter | Type |
|---|---|
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.
Parameters
| Parameter | Type |
|---|---|
options? | ScrollToOptions |
Returns
void
Call Signature
scrollTo(
x,y):void
Parameters
| Parameter | Type |
|---|---|
x | number |
y | number |
Returns
void
setAttribute()
setAttribute(
qualifiedName,value):void
The setAttribute() method of the Element interface sets the value of an attribute on the specified element.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
value | string |
Returns
void
setAttributeNode()
setAttributeNode(
attr):Attr|null
The setAttributeNode() method of the Element interface adds a new Attr node to the specified element.
Parameters
| Parameter | Type |
|---|---|
attr | Attr |
Returns
Attr | null
setAttributeNodeNS()
setAttributeNodeNS(
attr):Attr|null
The setAttributeNodeNS() method of the Element interface adds a new namespaced Attr node to an element.
Parameters
| Parameter | Type |
|---|---|
attr | Attr |
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.
Parameters
| Parameter | Type |
|---|---|
namespace | string | null |
qualifiedName | string |
value | string |
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.
Parameters
| Parameter | Type |
|---|---|
html | string |
Returns
void
setPointerCapture()
setPointerCapture(
pointerId):void
The setPointerCapture() method of the capture target of future pointer events.
Parameters
| Parameter | Type |
|---|---|
pointerId | number |
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.
Parameters
| Parameter | Type |
|---|---|
qualifiedName | string |
force? | boolean |
Returns
boolean
webkitMatchesSelector()
webkitMatchesSelector(
selectors):boolean
Parameters
| Parameter | Type |
|---|---|
selectors | string |
Returns
boolean
Deprecated
This is a legacy alias of matches.