HTMLMapElement

The HTMLMapElement interface provides special properties and methods (beyond those of the regular object HTMLElement interface it also has available to it by inheritance) for manipulating the layout and presentation of map elements.

MDN Reference

Properties

Link copied to clipboard
Link copied to clipboard

The HTMLElement.accessKey property sets the keystroke which a user can press to jump to a given element.

Link copied to clipboard

The HTMLElement.accessKeyLabel read-only property returns a string containing the element's browser-assigned access key (if any); otherwise it returns an empty string.

Link copied to clipboard

The areas read-only property of the HTMLMapElement interface returns a collection of area elements associated with the map element.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The autocapitalize property of the HTMLElement interface represents the element's capitalization behavior for user input.

Link copied to clipboard

The autocorrect property of the HTMLElement interface controls whether or not autocorrection of editable text is enabled for spelling and/or punctuation errors.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

node is a CDATASection node.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Returns the child elements.

Link copied to clipboard

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

Link copied to clipboard

The className property of the of the specified element.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

node is a Comment node.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard
var dir: String

The HTMLElement.dir property indicates the text writing directionality of the content of the current element.

Link copied to clipboard

node is a DocumentFragment node.

Link copied to clipboard

node is a document.

Link copied to clipboard

Set when other is a descendant of node.

Link copied to clipboard

Set when other is an ancestor of node.

Link copied to clipboard

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

Link copied to clipboard

Set when other is following node.

Link copied to clipboard

Set when other is preceding node.

Link copied to clipboard

node is a doctype.

Link copied to clipboard

The draggable property of the HTMLElement interface gets and sets a Boolean primitive indicating if the element is draggable.

Link copied to clipboard

node is an element.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The HTMLElement property hidden reflects the value of the element's hidden attribute.

Link copied to clipboard

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

Link copied to clipboard

The HTMLElement property inert reflects the value of the element's inert attribute.

Link copied to clipboard

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

Link copied to clipboard

The innerText property of the HTMLElement interface represents the rendered text content of a node and its descendants.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

The lang property of the HTMLElement interface indicates the base language of an element's attribute values and text content, in the form of a MISSING: RFC(5646, 'BCP 47 language identifier tag')].

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The name property of the HTMLMapElement represents the unique name <map> element.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The offsetHeight read-only property of the HTMLElement interface returns the height of an element, including vertical padding and borders, as an integer.

Link copied to clipboard

The offsetLeft read-only property of the HTMLElement interface returns the number of pixels that the upper left corner of the current element is offset to the left within the HTMLElement.offsetParent node.

Link copied to clipboard

The HTMLElement.offsetParent read-only property returns a reference to the element which is the closest (nearest in the containment hierarchy) positioned ancestor element.

Link copied to clipboard

The offsetTop read-only property of the HTMLElement interface returns the distance from the outer border of the current element (including its margin) to the top padding edge of the HTMLelement.offsetParent, the closest positioned ancestor element.

Link copied to clipboard

The offsetWidth read-only property of the HTMLElement interface returns the layout width of an element as an integer.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Available only in secure contexts.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

The outerText property of the HTMLElement interface returns the same value as HTMLElement.innerText.

Link copied to clipboard
open override val ownerDocument: Document

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

The popover property of the HTMLElement interface gets and sets an element's popover state via JavaScript ('auto', 'hint', or 'manual'), and can be used for feature detection.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

node is a ProcessingInstruction node.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The spellcheck property of the HTMLElement interface represents a boolean value that controls the spell-checking hint.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

node is a Text node.

Link copied to clipboard

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

Link copied to clipboard

The HTMLElement.title property represents the title of the element: the text usually displayed in a 'tooltip' popup when the mouse is over the node.

Link copied to clipboard

The translate property of the HTMLElement interface indicates whether an element's attribute values and the values of its Text node children are to be translated when the page is localized, or whether to leave them unchanged.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

The writingSuggestions property of the HTMLElement interface is a string indicating if browser-provided writing suggestions should be enabled under the scope of the element or not.

Functions

Link copied to clipboard
open fun after(vararg nodes: String)

open fun after(vararg nodes: Node)

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

Link copied to clipboard
open fun animate(keyframes: ReadonlyArray<Keyframe>?, options: Double = definedExternally): Animation
open fun animate(keyframes: PropertyIndexedKeyframes?, options: Double = definedExternally): Animation
Link copied to clipboard
open fun append(vararg nodes: String)

open fun append(vararg nodes: Node)

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

Link copied to clipboard
fun <T : Node> appendChild(node: T): T

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

Link copied to clipboard
Link copied to clipboard

The HTMLElement.attachInternals() method returns an ElementInternals object.

Link copied to clipboard

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

Link copied to clipboard
open fun before(vararg nodes: String)

open fun before(vararg nodes: Node)

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

Link copied to clipboard
Link copied to clipboard
fun checkVisibility(options: CheckVisibilityOptions = definedExternally): Boolean

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

Link copied to clipboard
fun click()

The HTMLElement.click() method simulates a mouse click on an element.

Link copied to clipboard
fun cloneNode(subtree: Boolean = definedExternally): Node

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

Link copied to clipboard
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?

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
fun contains(other: Node?): 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.

Link copied to clipboard
Link copied to clipboard
open fun focus(options: FocusOptions = definedExternally)
Link copied to clipboard
Link copied to clipboard
fun getAttribute(qualifiedName: String): String?

The getAttribute() method of the element.

Link copied to clipboard

The getAttributeNames() method of the array.

Link copied to clipboard
fun getAttributeNode(qualifiedName: String): Attr?

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

Link copied to clipboard
fun getAttributeNodeNS(namespace: String?, localName: String): Attr?

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

Link copied to clipboard
fun getAttributeNS(namespace: String?, localName: String): String?

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
fun getHTML(options: GetHTMLOptions = definedExternally): String

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

Link copied to clipboard
fun getRootNode(options: GetRootNodeOptions = definedExternally): Node

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

Link copied to clipboard
fun hasAttribute(qualifiedName: String): Boolean

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

Link copied to clipboard
fun hasAttributeNS(namespace: String?, localName: String): 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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
fun hasPointerCapture(pointerId: Int): Boolean

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

Link copied to clipboard

The hidePopover() method of the HTMLElement interface hides a popover element (i.e., one that has a valid popover attribute) by removing it from the top layer and styling it with display: none.

Link copied to clipboard

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

Link copied to clipboard
fun insertAdjacentHTML(position: InsertPosition, string: String)

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

Link copied to clipboard

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.

Link copied to clipboard
fun <T : Node> insertBefore(node: T, child: Node?): T

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

Link copied to clipboard

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

Link copied to clipboard
fun isEqualNode(otherNode: Node?): Boolean

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

Link copied to clipboard
fun isSameNode(otherNode: Node?): Boolean

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

Link copied to clipboard

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

Link copied to clipboard
fun lookupPrefix(namespace: String?): String?

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

Link copied to clipboard
fun matches(selectors: String): Boolean

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

Link copied to clipboard
fun normalize()

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

Link copied to clipboard
open fun prepend(vararg nodes: String)

open fun prepend(vararg nodes: Node)

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

Link copied to clipboard
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.

Link copied to clipboard
open fun querySelectorAll(selectors: String): NodeList<Element>
open fun <T : SVGElement> querySelectorAll(selectors: SvgTagName<T>): NodeList<T>

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

Returns all element descendants of node that match selectors.

Link copied to clipboard
fun releasePointerCapture(pointerId: Int)

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

Link copied to clipboard
open fun remove()

Removes node.

Link copied to clipboard
fun removeAttribute(qualifiedName: String)

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

Link copied to clipboard

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

Link copied to clipboard
fun removeAttributeNS(namespace: String?, localName: String)

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.

Link copied to clipboard
fun <T : Node> removeChild(child: T): T

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

Link copied to clipboard
fun <T : Node> replaceChild(node: Node, child: T): T

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

Link copied to clipboard
open fun replaceChildren()
open fun replaceChildren(vararg nodes: String)

open fun replaceChildren(vararg nodes: Node)

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

Link copied to clipboard
open fun replaceWith(vararg nodes: String)

open fun replaceWith(vararg nodes: Node)

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

Link copied to clipboard
suspend fun requestFullscreen(options: FullscreenOptions = definedExternally)

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

Link copied to clipboard
fun requestFullscreenAsync(options: FullscreenOptions = definedExternally): Promise<Void>
Link copied to clipboard
suspend fun requestPointerLock(options: PointerLockOptions = definedExternally)

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

Link copied to clipboard
fun requestPointerLockAsync(options: PointerLockOptions = definedExternally): Promise<Void>
Link copied to clipboard
fun scroll(options: ScrollToOptions = definedExternally)

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

fun scroll(x: Double, y: Double)
Link copied to clipboard
fun scrollBy(options: ScrollToOptions = definedExternally)

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

fun scrollBy(x: Double, y: Double)
Link copied to clipboard
fun scrollIntoView(options: ScrollIntoViewOptions = definedExternally)

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.

Link copied to clipboard
fun scrollTo(options: ScrollToOptions = definedExternally)

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

fun scrollTo(x: Double, y: Double)
Link copied to clipboard
fun setAttribute(qualifiedName: String, value: String)

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
fun setAttributeNS(namespace: String?, qualifiedName: String, value: String)

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

Link copied to clipboard

The setHTMLUnsafe() method of the Element interface is used to parse a string of HTML into a DocumentFragment, which then replaces the element's subtree in the DOM.

Link copied to clipboard
fun setPointerCapture(pointerId: Int)

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

Link copied to clipboard

The showPopover() method of the HTMLElement interface shows a Popover_API element (i.e., one that has a valid popover attribute) by adding it to the top layer.

Link copied to clipboard
fun toggleAttribute(qualifiedName: String, force: Boolean = definedExternally): Boolean

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

Link copied to clipboard
fun togglePopover(options: Boolean = definedExternally): Boolean

The togglePopover() method of the HTMLElement interface toggles a Popover_API element (i.e., one that has a valid popover attribute) between the hidden and showing states.

Link copied to clipboard