Options
All
  • Public
  • Public/Protected
  • All
Menu

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.

Hierarchy

  • Node
  • ARIAMixin
  • Animatable
  • ChildNode
  • InnerHTML
  • NonDocumentTypeChildNode
  • ParentNode
  • Slottable
    • Element

Index

Properties

Methods

Properties

ATTRIBUTE_NODE: number
CDATA_SECTION_NODE: number

node is a CDATASection node.

COMMENT_NODE: number

node is a Comment node.

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

DOCUMENT_NODE: number

node is a document.

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED: number

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

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number
DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

DOCUMENT_TYPE_NODE: number

node is a doctype.

ELEMENT_NODE: number

node is an element.

ENTITY_NODE: number
ENTITY_REFERENCE_NODE: number
NOTATION_NODE: number
PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

TEXT_NODE: number

node is a Text node.

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

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

childElementCount: number
childNodes: NodeListOf<ChildNode>

Returns the children.

children: HTMLCollection

Returns the child elements.

classList: DOMTokenList

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

className: string

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

clientHeight: number
clientLeft: number
clientTop: number
clientWidth: number
firstChild: null | ChildNode

Returns the first child.

firstElementChild: null | Element

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

id: string

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

innerHTML: string
isConnected: boolean

Returns true if node is connected and false otherwise.

lastChild: null | ChildNode

Returns the last child.

lastElementChild: null | Element

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

localName: string

Returns the local name.

namespaceURI: null | string

Returns the namespace.

nextElementSibling: null | Element

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

nextSibling: null | ChildNode

Returns the next sibling.

nodeName: string

Returns a string appropriate for the type of node.

nodeType: number

Returns the type of node.

nodeValue: null | string
onfullscreenchange: null | ((this: Element, ev: Event) => any)
onfullscreenerror: null | ((this: Element, ev: Event) => any)
outerHTML: string
ownerDocument: Document
parentElement: null | HTMLElement

Returns the parent element.

parentNode: null | ParentNode

Returns the parent.

part: DOMTokenList
prefix: null | string

Returns the namespace prefix.

previousElementSibling: null | Element

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

previousSibling: null | ChildNode

Returns the previous sibling.

scrollHeight: number
scrollLeft: number
scrollTop: number
scrollWidth: number
shadowRoot: null | ShadowRoot

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

slot: string

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

tagName: string

Returns the HTML-uppercased qualified name.

textContent: null | string

Methods

  • addEventListener<K>(type: K, listener: (this: Element, ev: ElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void
  • addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void
  • Type parameters

    • K: keyof ElementEventMap

    Parameters

    • type: K
    • listener: (this: Element, ev: ElementEventMap[K]) => any
        • (this: Element, ev: ElementEventMap[K]): any
        • Parameters

          • this: Element
          • ev: ElementEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • after(...nodes: (string | Node)[]): void
  • Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

  • animate(keyframes: null | Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions): Animation
  • Parameters

    • keyframes: null | Keyframe[] | PropertyIndexedKeyframes
    • Optional options: number | KeyframeAnimationOptions

    Returns Animation

  • append(...nodes: (string | Node)[]): void
  • Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

  • appendChild<T>(node: T): T
  • Type parameters

    • T: Node

    Parameters

    • node: T

    Returns T

  • attachShadow(init: ShadowRootInit): ShadowRoot
  • Creates a shadow root for element and returns it.

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

  • before(...nodes: (string | Node)[]): void
  • Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

  • cloneNode(deep?: boolean): Node
  • Returns a copy of node. If deep is true, the copy also includes the node's descendants.

    Parameters

    • Optional deep: boolean

    Returns Node

  • closest<K>(selector: K): null | HTMLElementTagNameMap[K]
  • closest<K>(selector: K): null | SVGElementTagNameMap[K]
  • closest<E>(selectors: string): null | E
  • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns null | HTMLElementTagNameMap[K]

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns null | SVGElementTagNameMap[K]

  • Type parameters

    Parameters

    • selectors: string

    Returns null | E

  • compareDocumentPosition(other: Node): number
  • Returns a bitmask indicating the position of other relative to node.

    Parameters

    • other: Node

    Returns number

  • contains(other: null | Node): boolean
  • Returns true if other is an inclusive descendant of node, and false otherwise.

    Parameters

    • other: null | Node

    Returns boolean

  • dispatchEvent(event: Event): boolean
  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    Returns boolean

  • getAnimations(options?: GetAnimationsOptions): Animation[]
  • Parameters

    • Optional options: GetAnimationsOptions

    Returns Animation[]

  • getAttribute(qualifiedName: string): null | string
  • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    Parameters

    • qualifiedName: string

    Returns null | string

  • getAttributeNS(namespace: null | string, localName: string): null | string
  • Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

    Parameters

    • namespace: null | string
    • localName: string

    Returns null | string

  • getAttributeNames(): string[]
  • Returns the qualified names of all element's attributes. Can contain duplicates.

    Returns string[]

  • getAttributeNode(qualifiedName: string): null | Attr
  • Parameters

    • qualifiedName: string

    Returns null | Attr

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

    • namespace: null | string
    • localName: string

    Returns null | Attr

  • getBoundingClientRect(): DOMRect
  • Returns DOMRect

  • getClientRects(): DOMRectList
  • Returns DOMRectList

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

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

  • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>
  • getElementsByTagName<K>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>
  • getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>
  • Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns 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(namespace: null | string, localName: string): HTMLCollectionOf<Element>
  • Parameters

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

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

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

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespace: null | string
    • localName: string

    Returns HTMLCollectionOf<Element>

  • getRootNode(options?: GetRootNodeOptions): Node
  • Returns node's root.

    Parameters

    • Optional options: GetRootNodeOptions

    Returns Node

  • hasAttribute(qualifiedName: string): boolean
  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    Parameters

    • qualifiedName: string

    Returns boolean

  • hasAttributeNS(namespace: null | string, localName: string): boolean
  • Returns true if element has an attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: null | string
    • localName: string

    Returns boolean

  • hasAttributes(): boolean
  • Returns true if element has attributes, and false otherwise.

    Returns boolean

  • hasChildNodes(): boolean
  • Returns whether node has children.

    Returns boolean

  • hasPointerCapture(pointerId: number): boolean
  • Parameters

    • pointerId: number

    Returns boolean

  • insertAdjacentElement(where: InsertPosition, element: Element): null | Element
  • Parameters

    • where: InsertPosition
    • element: Element

    Returns null | Element

  • insertAdjacentHTML(position: InsertPosition, text: string): void
  • Parameters

    • position: InsertPosition
    • text: string

    Returns void

  • insertAdjacentText(where: InsertPosition, data: string): void
  • Parameters

    • where: InsertPosition
    • data: string

    Returns void

  • insertBefore<T>(node: T, child: null | Node): T
  • Type parameters

    • T: Node

    Parameters

    • node: T
    • child: null | Node

    Returns T

  • isDefaultNamespace(namespace: null | string): boolean
  • Parameters

    • namespace: null | string

    Returns boolean

  • isEqualNode(otherNode: null | Node): boolean
  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: null | Node

    Returns boolean

  • isSameNode(otherNode: null | Node): boolean
  • Parameters

    • otherNode: null | Node

    Returns boolean

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

    • prefix: null | string

    Returns null | string

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

    • namespace: null | string

    Returns null | string

  • matches(selectors: string): boolean
  • Returns true if matching selectors against element's root yields element, and false otherwise.

    Parameters

    • selectors: string

    Returns boolean

  • normalize(): void
  • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

    Returns void

  • prepend(...nodes: (string | Node)[]): void
  • Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

  • querySelector<K>(selectors: K): null | HTMLElementTagNameMap[K]
  • querySelector<K>(selectors: K): null | SVGElementTagNameMap[K]
  • querySelector<E>(selectors: string): null | E
  • Returns the first element that is a descendant of node that matches selectors.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns null | HTMLElementTagNameMap[K]

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns null | SVGElementTagNameMap[K]

  • Type parameters

    Parameters

    • selectors: string

    Returns null | E

  • querySelectorAll<K>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>
  • querySelectorAll<K>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>
  • querySelectorAll<E>(selectors: string): NodeListOf<E>
  • Returns all element descendants of node that match selectors.

    Type parameters

    • K: keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type parameters

    • K: keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type parameters

    Parameters

    • selectors: string

    Returns NodeListOf<E>

  • releasePointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

  • remove(): void
  • Removes node.

    Returns void

  • removeAttribute(qualifiedName: string): void
  • Removes element's first attribute whose qualified name is qualifiedName.

    Parameters

    • qualifiedName: string

    Returns void

  • removeAttributeNS(namespace: null | string, localName: string): void
  • Removes element's attribute whose namespace is namespace and local name is localName.

    Parameters

    • namespace: null | string
    • localName: string

    Returns void

  • removeAttributeNode(attr: Attr): Attr
  • Parameters

    • attr: Attr

    Returns Attr

  • removeChild<T>(child: T): T
  • Type parameters

    • T: Node

    Parameters

    • child: T

    Returns 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
  • Type parameters

    • K: keyof ElementEventMap

    Parameters

    • type: K
    • listener: (this: Element, ev: ElementEventMap[K]) => any
        • (this: Element, ev: ElementEventMap[K]): any
        • Parameters

          • this: Element
          • ev: ElementEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

  • replaceChild<T>(node: Node, child: T): T
  • Type parameters

    • T: Node

    Parameters

    • node: Node
    • child: T

    Returns T

  • replaceChildren(...nodes: (string | Node)[]): void
  • Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

  • replaceWith(...nodes: (string | Node)[]): void
  • Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    Parameters

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

    Returns void

  • requestFullscreen(options?: FullscreenOptions): Promise<void>
  • Displays element fullscreen and resolves promise when done.

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

    Parameters

    • Optional options: FullscreenOptions

    Returns Promise<void>

  • requestPointerLock(): void
  • Returns void

  • scroll(options?: ScrollToOptions): void
  • scroll(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • scrollBy(options?: ScrollToOptions): void
  • scrollBy(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void
  • Parameters

    • Optional arg: boolean | ScrollIntoViewOptions

    Returns void

  • scrollTo(options?: ScrollToOptions): void
  • scrollTo(x: number, y: number): void
  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • setAttribute(qualifiedName: string, value: string): void
  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

  • setAttributeNS(namespace: null | string, qualifiedName: string, value: string): void
  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    Parameters

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

    Returns void

  • setAttributeNode(attr: Attr): null | Attr
  • Parameters

    • attr: Attr

    Returns null | Attr

  • setAttributeNodeNS(attr: Attr): null | Attr
  • Parameters

    • attr: Attr

    Returns null | Attr

  • setPointerCapture(pointerId: number): void
  • Parameters

    • pointerId: number

    Returns void

  • toggleAttribute(qualifiedName: string, force?: boolean): boolean
  • If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName.

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

    Parameters

    • qualifiedName: string
    • Optional force: boolean

    Returns boolean

  • webkitMatchesSelector(selectors: string): boolean
  • deprecated

    This is a legacy alias of matches.

    Parameters

    • selectors: string

    Returns boolean

Generated using TypeDoc