kotlin-browser/web.dom/Element

Element

open external class Element : Node, ARIAMixin, Animatable, ChildNode, NonDocumentTypeChildNode, ParentNode, Slottable(source)

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

MDN Reference

Inheritors

HTMLElement

MathMLElement

SVGElement

Properties

abortEvent

open val abortEvent: EventInstance<Event, Element, Element>

MDN Reference

ariaAtomic

open var ariaAtomic: String?

MDN Reference

ariaAutoComplete

open var ariaAutoComplete: String?

MDN Reference

ariaBrailleLabel

open var ariaBrailleLabel: String?

MDN Reference

ariaBrailleRoleDescription

open var ariaBrailleRoleDescription: String?

MDN Reference

ariaBusy

open var ariaBusy: String?

MDN Reference

ariaChecked

open var ariaChecked: String?

MDN Reference

ariaColCount

open var ariaColCount: String?

MDN Reference

ariaColIndex

open var ariaColIndex: String?

MDN Reference

ariaColIndexText

open var ariaColIndexText: String?

MDN Reference

ariaColSpan

open var ariaColSpan: String?

MDN Reference

ariaCurrent

open var ariaCurrent: String?

MDN Reference

ariaDescription

open var ariaDescription: String?

MDN Reference

ariaDisabled

open var ariaDisabled: String?

MDN Reference

ariaExpanded

open var ariaExpanded: String?

MDN Reference

ariaHasPopup

open var ariaHasPopup: String?

MDN Reference

ariaHidden

open var ariaHidden: String?

MDN Reference

ariaInvalid

open var ariaInvalid: String?

ariaKeyShortcuts

open var ariaKeyShortcuts: String?

MDN Reference

ariaLabel

open var ariaLabel: String?

MDN Reference

ariaLevel

open var ariaLevel: String?

MDN Reference

ariaLive

open var ariaLive: String?

MDN Reference

ariaModal

open var ariaModal: String?

MDN Reference

ariaMultiLine

open var ariaMultiLine: String?

MDN Reference

ariaMultiSelectable

open var ariaMultiSelectable: String?

MDN Reference

ariaOrientation

open var ariaOrientation: String?

MDN Reference

ariaPlaceholder

open var ariaPlaceholder: String?

MDN Reference

ariaPosInSet

open var ariaPosInSet: String?

MDN Reference

ariaPressed

open var ariaPressed: String?

MDN Reference

ariaReadOnly

open var ariaReadOnly: String?

MDN Reference

ariaRequired

open var ariaRequired: String?

MDN Reference

ariaRoleDescription

open var ariaRoleDescription: String?

MDN Reference

ariaRowCount

open var ariaRowCount: String?

MDN Reference

ariaRowIndex

open var ariaRowIndex: String?

MDN Reference

ariaRowIndexText

open var ariaRowIndexText: String?

MDN Reference

ariaRowSpan

open var ariaRowSpan: String?

MDN Reference

ariaSelected

open var ariaSelected: String?

MDN Reference

ariaSetSize

open var ariaSetSize: String?

MDN Reference

ariaSort

open var ariaSort: String?

MDN Reference

ariaValueMax

open var ariaValueMax: String?

MDN Reference

ariaValueMin

open var ariaValueMin: String?

MDN Reference

ariaValueNow

open var ariaValueNow: String?

MDN Reference

ariaValueText

open var ariaValueText: String?

MDN Reference

assignedSlot

open val assignedSlot: HTMLSlotElement?

MDN Reference

ATTRIBUTE_NODE

val ATTRIBUTE_NODE: NodeType

attributes

val attributes: NamedNodeMap

MDN Reference

auxClickEvent

open val auxClickEvent: EventInstance<MouseEvent, Element, Node>

MDN Reference

baseURI

val baseURI: String

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

beforeInputEvent

open val beforeInputEvent: EventInstance<InputEvent, Element, Node>

MDN Reference

blurEvent

open val blurEvent: EventInstance<FocusEvent, Element, Element>

MDN Reference

CDATA_SECTION_NODE

val CDATA_SECTION_NODE: NodeType

node is a CDATASection node.

childElementCount

open val childElementCount: Int

MDN Reference

childNodes

val childNodes: NodeListOf<ChildNode>

Returns the children.

children

open val children: HTMLCollection<*>

Returns the child elements.

classList

val classList: DOMTokenList

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

className

var className: String

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

clickEvent

open val clickEvent: EventInstance<MouseEvent, Element, Node>

MDN Reference

clientHeight

val clientHeight: Int

val clientLeft: Int

val clientTop: Int

val clientWidth: Int

val COMMENT_NODE: NodeType

node is a Comment node.

compositionEndEvent

open val compositionEndEvent: EventInstance<CompositionEvent, Element, Node>

MDN Reference

compositionStartEvent

open val compositionStartEvent: EventInstance<CompositionEvent, Element, Node>

MDN Reference

compositionUpdateEvent

open val compositionUpdateEvent: EventInstance<CompositionEvent, Element, Node>

MDN Reference

contextMenuEvent

open val contextMenuEvent: EventInstance<MouseEvent, Element, Node>

MDN Reference

currentCSSZoom

val currentCSSZoom: Double

MDN Reference

dblClickEvent

open val dblClickEvent: EventInstance<MouseEvent, Element, Node>

MDN Reference

DOCUMENT_FRAGMENT_NODE

val DOCUMENT_FRAGMENT_NODE: NodeType

node is a DocumentFragment node.

DOCUMENT_NODE

val DOCUMENT_NODE: NodeType

node is a document.

DOCUMENT_POSITION_CONTAINED_BY

val DOCUMENT_POSITION_CONTAINED_BY: NodeType

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS

val DOCUMENT_POSITION_CONTAINS: NodeType

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED

val DOCUMENT_POSITION_DISCONNECTED: NodeType

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

DOCUMENT_POSITION_FOLLOWING

val DOCUMENT_POSITION_FOLLOWING: NodeType

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

val DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: NodeType

DOCUMENT_POSITION_PRECEDING

val DOCUMENT_POSITION_PRECEDING: NodeType

Set when other is preceding node.

DOCUMENT_TYPE_NODE

val DOCUMENT_TYPE_NODE: NodeType

node is a doctype.

ELEMENT_NODE

val ELEMENT_NODE: NodeType

node is an element.

ENTITY_NODE

val ENTITY_NODE: NodeType

ENTITY_REFERENCE_NODE

val ENTITY_REFERENCE_NODE: NodeType

errorEvent

open val errorEvent: EventInstance<Event, Element, Element>

MDN Reference

firstChild

val firstChild: ChildNode?

Returns the first child.

firstElementChild

open val firstElementChild: Element?

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

focusEvent

open val focusEvent: EventInstance<FocusEvent, Element, Element>

MDN Reference

focusInEvent

open val focusInEvent: EventInstance<FocusEvent, Element, Node>

MDN Reference

focusOutEvent

open val focusOutEvent: EventInstance<FocusEvent, Element, Node>

MDN Reference

fullscreenChangeEvent

open val fullscreenChangeEvent: EventInstance<Event, Element, Node>

MDN Reference

fullscreenErrorEvent

open val fullscreenErrorEvent: EventInstance<Event, Element, Node>

MDN Reference

var id: String

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

innerHTML

var innerHTML: String

MDN Reference

inputEvent

open val inputEvent: EventInstance<InputEvent, Element, Node>

MDN Reference

isConnected

val isConnected: Boolean

Returns true if node is connected and false otherwise.

keyDownEvent

open val keyDownEvent: EventInstance<KeyboardEvent, Element, Node>

MDN Reference

keyPressEvent

open val keyPressEvent: EventInstance<KeyboardEvent, Element, Node>

MDN Reference

keyUpEvent

open val keyUpEvent: EventInstance<KeyboardEvent, Element, Node>

MDN Reference

lastChild

val lastChild: ChildNode?

Returns the last child.

lastElementChild

open val lastElementChild: Element?

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

loadEvent

open val loadEvent: EventInstance<Event, Element, Element>

MDN Reference

localName

val localName: String

Returns the local name.

mouseDownEvent

open val mouseDownEvent: EventInstance<MouseEvent, Element, Node>

MDN Reference

mouseEnterEvent

open val mouseEnterEvent: EventInstance<MouseEvent, Element, Element>

MDN Reference

mouseLeaveEvent

open val mouseLeaveEvent: EventInstance<MouseEvent, Element, Element>

MDN Reference

mouseMoveEvent

open val mouseMoveEvent: EventInstance<MouseEvent, Element, Node>

MDN Reference

mouseOutEvent

open val mouseOutEvent: EventInstance<MouseEvent, Element, Node>

MDN Reference

mouseOverEvent

open val mouseOverEvent: EventInstance<MouseEvent, Element, Node>

MDN Reference

mouseUpEvent

open val mouseUpEvent: EventInstance<MouseEvent, Element, Node>

MDN Reference

namespaceURI

val namespaceURI: String?

Returns the namespace.

nextElementSibling

open val nextElementSibling: Element?

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

nextSibling

val nextSibling: ChildNode?

Returns the next sibling.

nodeName

val nodeName: String

Returns a string appropriate for the type of node.

nodeType

val nodeType: NodeType

Returns the type of node.

nodeValue

var nodeValue: String?

MDN Reference

NOTATION_NODE

val NOTATION_NODE: NodeType

onfullscreenchange

var onfullscreenchange: EventHandler<Event, Element, Node>?

MDN Reference

onfullscreenerror

var onfullscreenerror: EventHandler<Event, Element, Node>?

MDN Reference

outerHTML

var outerHTML: String

MDN Reference

ownerDocument

open override val ownerDocument: Document

Returns the node document. Returns null for documents.

parentElement

val parentElement: HTMLElement?

Returns the parent element.

parentNode

val parentNode: ParentNode?

Returns the parent.

part

val part: DOMTokenList

MDN Reference

prefix

val prefix: String?

Returns the namespace prefix.

previousElementSibling

open val previousElementSibling: Element?

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

previousSibling

val previousSibling: ChildNode?

Returns the previous sibling.

PROCESSING_INSTRUCTION_NODE

val PROCESSING_INSTRUCTION_NODE: NodeType

node is a ProcessingInstruction node.

role

open var role: String?

scrollEndEvent

open val scrollEndEvent: EventInstance<Event, Element, Node>

MDN Reference

scrollEvent

open val scrollEvent: EventInstance<Event, Element, Node>

MDN Reference

scrollHeight

val scrollHeight: Int

MDN Reference

scrollLeft

var scrollLeft: Double

MDN Reference

scrollTop

var scrollTop: Double

val scrollWidth: Int

open val selectEvent: EventInstance<Event, Element, Node>

MDN Reference

shadowRoot

val shadowRoot: ShadowRoot?

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

slot

var slot: String

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

tagName

val tagName: String

Returns the HTML-uppercased qualified name.

TEXT_NODE

val TEXT_NODE: NodeType

node is a Text node.

textContent

var textContent: String?

MDN Reference

touchCancelEvent

open val touchCancelEvent: EventInstance<TouchEvent, Element, Node>

MDN Reference

touchEndEvent

open val touchEndEvent: EventInstance<TouchEvent, Element, Node>

MDN Reference

touchMoveEvent

open val touchMoveEvent: EventInstance<TouchEvent, Element, Node>

MDN Reference

touchStartEvent

open val touchStartEvent: EventInstance<TouchEvent, Element, Node>

MDN Reference

unloadEvent

open val unloadEvent: EventInstance<Event, Element, Element>

MDN Reference

wheelEvent

open val wheelEvent: EventInstance<WheelEvent, Element, Node>

MDN Reference

Functions

after

open fun after(vararg nodes: Any)

Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

animate

open fun animate(keyframes: ReadonlyArray<Keyframe>?, options: Double = definedExternally): Animation

MDN Reference

open fun animate(keyframes: ReadonlyArray<Keyframe>?, options: KeyframeAnimationOptions): Animation

open fun animate(keyframes: PropertyIndexedKeyframes?, options: Double = definedExternally): Animation

open fun animate(keyframes: PropertyIndexedKeyframes?, options: KeyframeAnimationOptions): Animation

append

open fun append(vararg nodes: Any)

Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes.

appendChild

fun <T : Node> appendChild(node: T): T

MDN Reference

appendText

fun Element.appendText(text: String): Element

attachShadow

fun attachShadow(init: ShadowRootInit): ShadowRoot

Creates a shadow root for element and returns it.

before

open fun before(vararg nodes: Any)

Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

checkVisibility

fun checkVisibility(options: CheckVisibilityOptions = definedExternally): Boolean

MDN Reference

cloneNode

fun cloneNode(deep: Boolean = definedExternally): Node

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

closest

fun closest(selector: String): Element?

fun <T : MathMLElement> closest(selector: MathMLTagName<T>): T?

fun <T : SVGElement> closest(selector: SvgTagName<T>): T?

fun <T : HTMLElement> closest(selector: HtmlTagName<T>): T?

Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

compareDocumentPosition

fun compareDocumentPosition(other: Node): Short

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

computedStyleMap

fun computedStyleMap(): StylePropertyMapReadOnly

MDN Reference

contains

fun contains(other: Node?): Boolean

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

dispatchEvent

fun dispatchEvent(event: Event): Boolean

getAnimations

open fun getAnimations(options: GetAnimationsOptions = definedExternally): ReadonlyArray<Animation>

MDN Reference

getAttribute

fun getAttribute(qualifiedName: String): String?

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

getAttributeNames

fun getAttributeNames(): ReadonlyArray<String>

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

getAttributeNode

fun getAttributeNode(qualifiedName: String): Attr?

MDN Reference

getAttributeNodeNS

fun getAttributeNodeNS(namespace: String?, localName: String): Attr?

MDN Reference

getAttributeNS

fun getAttributeNS(namespace: String?, localName: String): String?

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

getBoundingClientRect

fun getBoundingClientRect(): DOMRect

MDN Reference

getClientRects

fun getClientRects(): DOMRectList

MDN Reference

getElementsByClassName

fun 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.

getElementsByTagName

fun getElementsByTagName(qualifiedName: String): HTMLCollectionOf<Element>

fun <T : MathMLElement> getElementsByTagName(qualifiedName: MathMLTagName<T>): HTMLCollectionOf<T>

fun <T : SVGElement> getElementsByTagName(qualifiedName: SvgTagName<T>): HTMLCollectionOf<T>

fun <T : HTMLElement> getElementsByTagName(qualifiedName: HtmlTagName<T>): HTMLCollectionOf<T>

MDN Reference

getElementsByTagNameNS

fun getElementsByTagNameNS(namespace: String?, localName: String): HTMLCollectionOf<Element>

fun <T : MathMLElement> getElementsByTagNameNS(namespaceURI: MATHML_NAMESPACE, localName: MathMLTagName<T>): HTMLCollectionOf<T>

fun <T : SVGElement> getElementsByTagNameNS(namespaceURI: SVG_NAMESPACE, localName: SvgTagName<T>): HTMLCollectionOf<T>

getHTML

fun getHTML(options: GetHTMLOptions = definedExternally): String

MDN Reference

getRootNode

fun getRootNode(options: GetRootNodeOptions = definedExternally): Node

Returns node's root.

hasAttribute

fun hasAttribute(qualifiedName: String): Boolean

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

hasAttributeNS

fun hasAttributeNS(namespace: String?, localName: String): Boolean

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

hasAttributes

fun hasAttributes(): Boolean

Returns true if element has attributes, and false otherwise.

hasChildNodes

fun hasChildNodes(): Boolean

Returns whether node has children.

hasPointerCapture

fun hasPointerCapture(pointerId: Int): Boolean

MDN Reference

insertAdjacentElement

fun insertAdjacentElement(where: InsertPosition, element: Element): Element?

MDN Reference

insertAdjacentHTML

fun insertAdjacentHTML(position: InsertPosition, string: String)

MDN Reference

insertAdjacentText

fun insertAdjacentText(where: InsertPosition, data: String)

MDN Reference

insertBefore

fun <T : Node> insertBefore(node: T, child: Node?): T

MDN Reference

isDefaultNamespace

fun isDefaultNamespace(namespace: String?): Boolean

MDN Reference

isEqualNode

fun isEqualNode(otherNode: Node?): Boolean

Returns whether node and otherNode have the same properties.

isSameNode

fun isSameNode(otherNode: Node?): Boolean

MDN Reference

lookupNamespaceURI

fun lookupNamespaceURI(prefix: String?): String?

MDN Reference

lookupPrefix

fun lookupPrefix(namespace: String?): String?

MDN Reference

matches

fun matches(selectors: String): Boolean

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

normalize

fun normalize()

Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

prepend

open fun prepend(vararg nodes: Any)

Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes.

querySelector

open fun querySelector(selectors: String): Element?

open fun <T : MathMLElement> querySelector(selectors: MathMLTagName<T>): T?

open fun <T : SVGElement> querySelector(selectors: SvgTagName<T>): T?

open fun <T : HTMLElement> querySelector(selectors: HtmlTagName<T>): T?

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

querySelectorAll

open fun querySelectorAll(selectors: String): NodeListOf<Element>

open fun <T : MathMLElement> querySelectorAll(selectors: MathMLTagName<T>): NodeListOf<T>

open fun <T : SVGElement> querySelectorAll(selectors: SvgTagName<T>): NodeListOf<T>

open fun <T : HTMLElement> querySelectorAll(selectors: HtmlTagName<T>): NodeListOf<T>

Returns all element descendants of node that match selectors.

releasePointerCapture

fun releasePointerCapture(pointerId: Int)

MDN Reference

remove

open fun remove()

Removes node.

removeAttribute

fun removeAttribute(qualifiedName: String)

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

removeAttributeNode

fun removeAttributeNode(attr: Attr): Attr

MDN Reference

removeAttributeNS

fun removeAttributeNS(namespace: String?, localName: String)

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

removeChild

fun <T : Node> removeChild(child: T): T

MDN Reference

replaceChild

fun <T : Node> replaceChild(node: Node, child: T): T

MDN Reference

replaceChildren

open fun replaceChildren(vararg nodes: Any)

Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes.

replaceWith

open fun replaceWith(vararg nodes: Any)

Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes.

requestFullscreen

suspend fun requestFullscreen(options: FullscreenOptions = definedExternally)

Displays element fullscreen and resolves promise when done.

requestFullscreenAsync

fun requestFullscreenAsync(options: FullscreenOptions = definedExternally): Promise<Void>

requestPointerLock

suspend fun requestPointerLock(options: PointerLockOptions = definedExternally)

MDN Reference

requestPointerLockAsync

fun requestPointerLockAsync(options: PointerLockOptions = definedExternally): Promise<Void>

scroll

fun scroll(options: ScrollToOptions = definedExternally)

MDN Reference

fun scroll(x: Double, y: Double)

scrollBy

fun scrollBy(options: ScrollToOptions = definedExternally)

MDN Reference

fun scrollBy(x: Double, y: Double)

scrollIntoView

fun scrollIntoView(options: ScrollIntoViewOptions = definedExternally)

MDN Reference

scrollTo

fun scrollTo(options: ScrollToOptions = definedExternally)

MDN Reference

fun scrollTo(x: Double, y: Double)

setAttribute

fun setAttribute(qualifiedName: String, value: String)

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

setAttributeNode

fun setAttributeNode(attr: Attr): Attr?

MDN Reference

setAttributeNodeNS

fun setAttributeNodeNS(attr: Attr): Attr?

MDN Reference

setAttributeNS

fun setAttributeNS(namespace: String?, qualifiedName: String, value: String)

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

setHTMLUnsafe

fun setHTMLUnsafe(html: String)

MDN Reference

setPointerCapture

fun setPointerCapture(pointerId: Int)

MDN Reference

toggleAttribute

fun toggleAttribute(qualifiedName: String, force: Boolean = definedExternally): 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.