Interface HTMLPreElement

Exposes specific properties and methods (beyond those of the HTMLElement interface it also has available to it by inheritance) for manipulating a block of preformatted text (

).
interface HTMLPreElement {
    ATTRIBUTE_NODE: number;
    CDATA_SECTION_NODE: number;
    COMMENT_NODE: number;
    DOCUMENT_FRAGMENT_NODE: number;
    DOCUMENT_NODE: number;
    DOCUMENT_POSITION_CONTAINED_BY: number;
    DOCUMENT_POSITION_CONTAINS: number;
    DOCUMENT_POSITION_DISCONNECTED: number;
    DOCUMENT_POSITION_FOLLOWING: number;
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
    DOCUMENT_POSITION_PRECEDING: number;
    DOCUMENT_TYPE_NODE: number;
    ELEMENT_NODE: number;
    ENTITY_NODE: number;
    ENTITY_REFERENCE_NODE: number;
    NOTATION_NODE: number;
    PROCESSING_INSTRUCTION_NODE: number;
    TEXT_NODE: number;
    accessKey: string;
    accessKeyLabel: string;
    ariaAtomic: null | string;
    ariaAutoComplete: null | string;
    ariaBusy: null | string;
    ariaChecked: null | string;
    ariaColCount: null | string;
    ariaColIndex: null | string;
    ariaColIndexText: null | string;
    ariaColSpan: null | string;
    ariaCurrent: null | string;
    ariaDisabled: null | string;
    ariaExpanded: null | string;
    ariaHasPopup: null | string;
    ariaHidden: null | string;
    ariaInvalid: 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;
    ariaRowIndexText: 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;
    autocapitalize: string;
    autofocus: boolean;
    baseURI: string;
    childElementCount: number;
    childNodes: NodeListOf<ChildNode>;
    children: HTMLCollection;
    classList: DOMTokenList;
    className: string;
    clientHeight: number;
    clientLeft: number;
    clientTop: number;
    clientWidth: number;
    contentEditable: string;
    dataset: DOMStringMap;
    dir: string;
    draggable: boolean;
    enterKeyHint: string;
    firstChild: null | ChildNode;
    firstElementChild: null | Element;
    hidden: boolean;
    id: string;
    inert: boolean;
    innerHTML: string;
    innerText: string;
    inputMode: string;
    isConnected: boolean;
    isContentEditable: boolean;
    lang: string;
    lastChild: null | ChildNode;
    lastElementChild: null | Element;
    localName: string;
    namespaceURI: null | string;
    nextElementSibling: null | Element;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    nonce?: string;
    offsetHeight: number;
    offsetLeft: number;
    offsetParent: null | Element;
    offsetTop: number;
    offsetWidth: number;
    onabort: null | ((this, ev) => any);
    onanimationcancel: null | ((this, ev) => any);
    onanimationend: null | ((this, ev) => any);
    onanimationiteration: null | ((this, ev) => any);
    onanimationstart: null | ((this, ev) => any);
    onauxclick: null | ((this, ev) => any);
    onbeforeinput: null | ((this, ev) => any);
    onblur: null | ((this, ev) => any);
    oncancel: null | ((this, ev) => any);
    oncanplay: null | ((this, ev) => any);
    oncanplaythrough: null | ((this, ev) => any);
    onchange: null | ((this, ev) => any);
    onclick: null | ((this, ev) => any);
    onclose: null | ((this, ev) => any);
    oncontextmenu: null | ((this, ev) => any);
    oncopy: null | ((this, ev) => any);
    oncuechange: null | ((this, ev) => any);
    oncut: null | ((this, ev) => any);
    ondblclick: null | ((this, ev) => any);
    ondrag: null | ((this, ev) => any);
    ondragend: null | ((this, ev) => any);
    ondragenter: null | ((this, ev) => any);
    ondragleave: null | ((this, ev) => any);
    ondragover: null | ((this, ev) => any);
    ondragstart: null | ((this, ev) => any);
    ondrop: null | ((this, ev) => any);
    ondurationchange: null | ((this, ev) => any);
    onemptied: null | ((this, ev) => any);
    onended: null | ((this, ev) => any);
    onerror: OnErrorEventHandler;
    onfocus: null | ((this, ev) => any);
    onformdata: null | ((this, ev) => any);
    onfullscreenchange: null | ((this, ev) => any);
    onfullscreenerror: null | ((this, ev) => any);
    ongotpointercapture: null | ((this, ev) => any);
    oninput: null | ((this, ev) => any);
    oninvalid: null | ((this, ev) => any);
    onkeydown: null | ((this, ev) => any);
    onkeypress: null | ((this, ev) => any);
    onkeyup: null | ((this, ev) => any);
    onload: null | ((this, ev) => any);
    onloadeddata: null | ((this, ev) => any);
    onloadedmetadata: null | ((this, ev) => any);
    onloadstart: null | ((this, ev) => any);
    onlostpointercapture: null | ((this, ev) => any);
    onmousedown: null | ((this, ev) => any);
    onmouseenter: null | ((this, ev) => any);
    onmouseleave: null | ((this, ev) => any);
    onmousemove: null | ((this, ev) => any);
    onmouseout: null | ((this, ev) => any);
    onmouseover: null | ((this, ev) => any);
    onmouseup: null | ((this, ev) => any);
    onpaste: null | ((this, ev) => any);
    onpause: null | ((this, ev) => any);
    onplay: null | ((this, ev) => any);
    onplaying: null | ((this, ev) => any);
    onpointercancel: null | ((this, ev) => any);
    onpointerdown: null | ((this, ev) => any);
    onpointerenter: null | ((this, ev) => any);
    onpointerleave: null | ((this, ev) => any);
    onpointermove: null | ((this, ev) => any);
    onpointerout: null | ((this, ev) => any);
    onpointerover: null | ((this, ev) => any);
    onpointerup: null | ((this, ev) => any);
    onprogress: null | ((this, ev) => any);
    onratechange: null | ((this, ev) => any);
    onreset: null | ((this, ev) => any);
    onresize: null | ((this, ev) => any);
    onscroll: null | ((this, ev) => any);
    onsecuritypolicyviolation: null | ((this, ev) => any);
    onseeked: null | ((this, ev) => any);
    onseeking: null | ((this, ev) => any);
    onselect: null | ((this, ev) => any);
    onselectionchange: null | ((this, ev) => any);
    onselectstart: null | ((this, ev) => any);
    onslotchange: null | ((this, ev) => any);
    onstalled: null | ((this, ev) => any);
    onsubmit: null | ((this, ev) => any);
    onsuspend: null | ((this, ev) => any);
    ontimeupdate: null | ((this, ev) => any);
    ontoggle: null | ((this, ev) => any);
    ontouchcancel?: null | ((this, ev) => any);
    ontouchend?: null | ((this, ev) => any);
    ontouchmove?: null | ((this, ev) => any);
    ontouchstart?: null | ((this, ev) => any);
    ontransitioncancel: null | ((this, ev) => any);
    ontransitionend: null | ((this, ev) => any);
    ontransitionrun: null | ((this, ev) => any);
    ontransitionstart: null | ((this, ev) => any);
    onvolumechange: null | ((this, ev) => any);
    onwaiting: null | ((this, ev) => any);
    onwebkitanimationend: null | ((this, ev) => any);
    onwebkitanimationiteration: null | ((this, ev) => any);
    onwebkitanimationstart: null | ((this, ev) => any);
    onwebkittransitionend: null | ((this, ev) => any);
    onwheel: null | ((this, ev) => any);
    outerHTML: string;
    outerText: string;
    ownerDocument: Document;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    part: DOMTokenList;
    prefix: null | string;
    previousElementSibling: null | Element;
    previousSibling: null | ChildNode;
    role: null | string;
    scrollHeight: number;
    scrollLeft: number;
    scrollTop: number;
    scrollWidth: number;
    shadowRoot: null | ShadowRoot;
    slot: string;
    spellcheck: boolean;
    style: CSSStyleDeclaration;
    tabIndex: number;
    tagName: string;
    textContent: null | string;
    title: string;
    translate: boolean;
    width: number;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    after(...nodes): void;
    animate(keyframes, options?): Animation;
    append(...nodes): void;
    appendChild<T>(node): T;
    attachInternals(): ElementInternals;
    attachShadow(init): ShadowRoot;
    before(...nodes): void;
    blur(): void;
    click(): void;
    cloneNode(deep?): Node;
    closest<K>(selector): null | HTMLElementTagNameMap[K];
    closest<K>(selector): null | SVGElementTagNameMap[K];
    closest<E>(selectors): null | E;
    compareDocumentPosition(other): number;
    contains(other): boolean;
    dispatchEvent(event): boolean;
    focus(options?): void;
    getAnimations(options?): Animation[];
    getAttribute(qualifiedName): null | string;
    getAttributeNS(namespace, localName): null | string;
    getAttributeNames(): string[];
    getAttributeNode(qualifiedName): null | Attr;
    getAttributeNodeNS(namespace, localName): null | Attr;
    getBoundingClientRect(): DOMRect;
    getClientRects(): DOMRectList;
    getElementsByClassName(classNames): HTMLCollectionOf<Element>;
    getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>;
    getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>;
    getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>;
    getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>;
    getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>;
    getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>;
    getRootNode(options?): Node;
    hasAttribute(qualifiedName): boolean;
    hasAttributeNS(namespace, localName): boolean;
    hasAttributes(): boolean;
    hasChildNodes(): boolean;
    hasPointerCapture(pointerId): boolean;
    insertAdjacentElement(where, element): null | Element;
    insertAdjacentHTML(position, text): void;
    insertAdjacentText(where, data): void;
    insertBefore<T>(node, child): T;
    isDefaultNamespace(namespace): boolean;
    isEqualNode(otherNode): boolean;
    isSameNode(otherNode): boolean;
    lookupNamespaceURI(prefix): null | string;
    lookupPrefix(namespace): null | string;
    matches(selectors): boolean;
    normalize(): void;
    prepend(...nodes): void;
    querySelector<K>(selectors): null | HTMLElementTagNameMap[K];
    querySelector<K>(selectors): null | SVGElementTagNameMap[K];
    querySelector<E>(selectors): null | E;
    querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>;
    querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>;
    querySelectorAll<E>(selectors): NodeListOf<E>;
    releasePointerCapture(pointerId): void;
    remove(): void;
    removeAttribute(qualifiedName): void;
    removeAttributeNS(namespace, localName): void;
    removeAttributeNode(attr): Attr;
    removeChild<T>(child): T;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    replaceChild<T>(node, child): T;
    replaceChildren(...nodes): void;
    replaceWith(...nodes): void;
    requestFullscreen(options?): Promise<void>;
    requestPointerLock(): void;
    scroll(options?): void;
    scroll(x, y): void;
    scrollBy(options?): void;
    scrollBy(x, y): void;
    scrollIntoView(arg?): void;
    scrollTo(options?): void;
    scrollTo(x, y): void;
    setAttribute(qualifiedName, value): void;
    setAttributeNS(namespace, qualifiedName, value): void;
    setAttributeNode(attr): null | Attr;
    setAttributeNodeNS(attr): null | Attr;
    setPointerCapture(pointerId): void;
    toggleAttribute(qualifiedName, force?): boolean;
    webkitMatchesSelector(selectors): boolean;
}

Hierarchy (view full)

Properties

ATTRIBUTE_NODE CDATA_SECTION_NODE COMMENT_NODE DOCUMENT_FRAGMENT_NODE DOCUMENT_NODE DOCUMENT_POSITION_CONTAINED_BY DOCUMENT_POSITION_CONTAINS DOCUMENT_POSITION_DISCONNECTED DOCUMENT_POSITION_FOLLOWING DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC DOCUMENT_POSITION_PRECEDING DOCUMENT_TYPE_NODE ELEMENT_NODE ENTITY_NODE ENTITY_REFERENCE_NODE NOTATION_NODE PROCESSING_INSTRUCTION_NODE TEXT_NODE accessKey accessKeyLabel ariaAtomic ariaAutoComplete ariaBusy ariaChecked ariaColCount ariaColIndex ariaColIndexText ariaColSpan ariaCurrent ariaDisabled ariaExpanded ariaHasPopup ariaHidden ariaInvalid ariaKeyShortcuts ariaLabel ariaLevel ariaLive ariaModal ariaMultiLine ariaMultiSelectable ariaOrientation ariaPlaceholder ariaPosInSet ariaPressed ariaReadOnly ariaRequired ariaRoleDescription ariaRowCount ariaRowIndex ariaRowIndexText ariaRowSpan ariaSelected ariaSetSize ariaSort ariaValueMax ariaValueMin ariaValueNow ariaValueText assignedSlot attributes autocapitalize autofocus baseURI childElementCount childNodes children classList className clientHeight clientLeft clientTop clientWidth contentEditable dataset dir draggable enterKeyHint firstChild firstElementChild hidden id inert innerHTML innerText inputMode isConnected isContentEditable lang lastChild lastElementChild localName namespaceURI nextElementSibling nextSibling nodeName nodeType nodeValue nonce? offsetHeight offsetLeft offsetParent offsetTop offsetWidth onabort onanimationcancel onanimationend onanimationiteration onanimationstart onauxclick onbeforeinput onblur oncancel oncanplay oncanplaythrough onchange onclick onclose oncontextmenu oncopy oncuechange oncut ondblclick ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onfocus onformdata onfullscreenchange onfullscreenerror ongotpointercapture oninput oninvalid onkeydown onkeypress onkeyup onload onloadeddata onloadedmetadata onloadstart onlostpointercapture onmousedown onmouseenter onmouseleave onmousemove onmouseout onmouseover onmouseup onpaste onpause onplay onplaying onpointercancel onpointerdown onpointerenter onpointerleave onpointermove onpointerout onpointerover onpointerup onprogress onratechange onreset onresize onscroll onsecuritypolicyviolation onseeked onseeking onselect onselectionchange onselectstart onslotchange onstalled onsubmit onsuspend ontimeupdate ontoggle ontouchcancel? ontouchend? ontouchmove? ontouchstart? ontransitioncancel ontransitionend ontransitionrun ontransitionstart onvolumechange onwaiting onwebkitanimationend onwebkitanimationiteration onwebkitanimationstart onwebkittransitionend onwheel outerHTML outerText ownerDocument parentElement parentNode part prefix previousElementSibling previousSibling role scrollHeight scrollLeft scrollTop scrollWidth shadowRoot slot spellcheck style tabIndex tagName textContent title translate width

Methods

addEventListener after animate append appendChild attachInternals attachShadow before blur click cloneNode closest compareDocumentPosition contains dispatchEvent focus getAnimations getAttribute getAttributeNS getAttributeNames getAttributeNode getAttributeNodeNS getBoundingClientRect getClientRects getElementsByClassName getElementsByTagName getElementsByTagNameNS getRootNode hasAttribute hasAttributeNS hasAttributes hasChildNodes hasPointerCapture insertAdjacentElement insertAdjacentHTML insertAdjacentText insertBefore isDefaultNamespace isEqualNode isSameNode lookupNamespaceURI lookupPrefix matches normalize prepend querySelector querySelectorAll releasePointerCapture remove removeAttribute removeAttributeNS removeAttributeNode removeChild removeEventListener replaceChild replaceChildren replaceWith requestFullscreen requestPointerLock scroll scrollBy scrollIntoView scrollTo setAttribute setAttributeNS setAttributeNode setAttributeNodeNS setPointerCapture toggleAttribute webkitMatchesSelector

Properties

Readonly ATTRIBUTE_NODE

ATTRIBUTE_NODE: number

Readonly CDATA_SECTION_NODE

CDATA_SECTION_NODE: number

node is a CDATASection node.

Readonly COMMENT_NODE

COMMENT_NODE: number

node is a Comment node.

Readonly DOCUMENT_FRAGMENT_NODE

DOCUMENT_FRAGMENT_NODE: number

node is a DocumentFragment node.

Readonly DOCUMENT_NODE

DOCUMENT_NODE: number

node is a document.

Readonly DOCUMENT_POSITION_CONTAINED_BY

DOCUMENT_POSITION_CONTAINED_BY: number

Set when other is a descendant of node.

Readonly DOCUMENT_POSITION_CONTAINS

DOCUMENT_POSITION_CONTAINS: number

Set when other is an ancestor of node.

Readonly DOCUMENT_POSITION_DISCONNECTED

DOCUMENT_POSITION_DISCONNECTED: number

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

Readonly DOCUMENT_POSITION_FOLLOWING

DOCUMENT_POSITION_FOLLOWING: number

Set when other is following node.

Readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number

Readonly DOCUMENT_POSITION_PRECEDING

DOCUMENT_POSITION_PRECEDING: number

Set when other is preceding node.

Readonly DOCUMENT_TYPE_NODE

DOCUMENT_TYPE_NODE: number

node is a doctype.

Readonly ELEMENT_NODE

ELEMENT_NODE: number

node is an element.

Readonly ENTITY_NODE

ENTITY_NODE: number

Readonly ENTITY_REFERENCE_NODE

ENTITY_REFERENCE_NODE: number

Readonly NOTATION_NODE

NOTATION_NODE: number

Readonly PROCESSING_INSTRUCTION_NODE

PROCESSING_INSTRUCTION_NODE: number

node is a ProcessingInstruction node.

Readonly TEXT_NODE

TEXT_NODE: number

node is a Text node.

accessKey

accessKey: string

Readonly accessKeyLabel

accessKeyLabel: string

ariaAtomic

ariaAtomic: null | string

ariaAutoComplete

ariaAutoComplete: null | string

ariaBusy

ariaBusy: null | string

ariaChecked

ariaChecked: null | string

ariaColCount

ariaColCount: null | string

ariaColIndex

ariaColIndex: null | string

ariaColIndexText

ariaColIndexText: null | string

ariaColSpan

ariaColSpan: null | string

ariaCurrent

ariaCurrent: null | string

ariaDisabled

ariaDisabled: null | string

ariaExpanded

ariaExpanded: null | string

ariaHasPopup

ariaHasPopup: null | string

ariaHidden

ariaHidden: null | string

ariaInvalid

ariaInvalid: null | string

ariaKeyShortcuts

ariaKeyShortcuts: null | string

ariaLabel

ariaLabel: null | string

ariaLevel

ariaLevel: null | string

ariaLive

ariaLive: null | string

ariaModal

ariaModal: null | string

ariaMultiLine

ariaMultiLine: null | string

ariaMultiSelectable

ariaMultiSelectable: null | string

ariaOrientation

ariaOrientation: null | string

ariaPlaceholder

ariaPlaceholder: null | string

ariaPosInSet

ariaPosInSet: null | string

ariaPressed

ariaPressed: null | string

ariaReadOnly

ariaReadOnly: null | string

ariaRequired

ariaRequired: null | string

ariaRoleDescription

ariaRoleDescription: null | string

ariaRowCount

ariaRowCount: null | string

ariaRowIndex

ariaRowIndex: null | string

ariaRowIndexText

ariaRowIndexText: null | string

ariaRowSpan

ariaRowSpan: null | string

ariaSelected

ariaSelected: null | string

ariaSetSize

ariaSetSize: null | string

ariaSort

ariaSort: null | string

ariaValueMax

ariaValueMax: null | string

ariaValueMin

ariaValueMin: null | string

ariaValueNow

ariaValueNow: null | string

ariaValueText

ariaValueText: null | string

Readonly assignedSlot

assignedSlot: null | HTMLSlotElement

Readonly attributes

attributes: NamedNodeMap

autocapitalize

autocapitalize: string

autofocus

autofocus: boolean

Readonly baseURI

baseURI: string

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

Readonly childElementCount

childElementCount: number

Readonly childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

Readonly children

children: HTMLCollection

Returns the child elements.

Readonly classList

classList: DOMTokenList

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

className

className: string

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

Readonly clientHeight

clientHeight: number

Readonly clientLeft

clientLeft: number

Readonly clientTop

clientTop: number

Readonly clientWidth

clientWidth: number

contentEditable

contentEditable: string

Readonly dataset

dataset: DOMStringMap

dir

dir: string

draggable

draggable: boolean

enterKeyHint

enterKeyHint: string

Readonly firstChild

firstChild: null | ChildNode

Returns the first child.

Readonly firstElementChild

firstElementChild: null | Element

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

hidden

hidden: boolean

id

id: string

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

inert

inert: boolean

innerHTML

innerHTML: string

innerText

innerText: string

inputMode

inputMode: string

Readonly isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

Readonly isContentEditable

isContentEditable: boolean

lang

lang: string

Readonly lastChild

lastChild: null | ChildNode

Returns the last child.

Readonly lastElementChild

lastElementChild: null | Element

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

Readonly localName

localName: string

Returns the local name.

Readonly namespaceURI

namespaceURI: null | string

Returns the namespace.

Readonly nextElementSibling

nextElementSibling: null | Element

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

Readonly nextSibling

nextSibling: null | ChildNode

Returns the next sibling.

Readonly nodeName

nodeName: string

Returns a string appropriate for the type of node.

Readonly nodeType

nodeType: number

Returns the type of node.

nodeValue

nodeValue: null | string

Optional nonce

nonce?: string

Readonly offsetHeight

offsetHeight: number

Readonly offsetLeft

offsetLeft: number

Readonly offsetParent

offsetParent: null | Element

Readonly offsetTop

offsetTop: number

Readonly offsetWidth

offsetWidth: number

onabort

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

Fires when the user aborts the download.

Type declaration

Param: ev

The event.

onanimationcancel

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

Type declaration

onanimationend

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

Type declaration

onanimationiteration

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

Type declaration

onanimationstart

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

Type declaration

onauxclick

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

Type declaration

onbeforeinput

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

Type declaration

onblur

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

Fires when the object loses the input focus.

Type declaration

Param: ev

The focus event.

oncancel

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

Type declaration

oncanplay

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

Occurs when playback is possible, but would require further buffering.

Type declaration

Param: ev

The event.

oncanplaythrough

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

Type declaration

onchange

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

Fires when the contents of the object or selection have changed.

Type declaration

Param: ev

The event.

onclick

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

Fires when the user clicks the left mouse button on the object

Type declaration

Param: ev

The mouse event.

onclose

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

Type declaration

oncontextmenu

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

Fires when the user clicks the right mouse button in the client area, opening the context menu.

Type declaration

Param: ev

The mouse event.

oncopy

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

Type declaration

oncuechange

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

Type declaration

oncut

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

Type declaration

ondblclick

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

Fires when the user double-clicks the object.

Type declaration

Param: ev

The mouse event.

ondrag

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

Fires on the source object continuously during a drag operation.

Type declaration

Param: ev

The event.

ondragend

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

Fires on the source object when the user releases the mouse at the close of a drag operation.

Type declaration

Param: ev

The event.

ondragenter

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

Fires on the target element when the user drags the object to a valid drop target.

Type declaration

Param: ev

The drag event.

ondragleave

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

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

Type declaration

Param: ev

The drag event.

ondragover

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

Fires on the target element continuously while the user drags the object over a valid drop target.

Type declaration

Param: ev

The event.

ondragstart

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

Fires on the source object when the user starts to drag a text selection or selected object.

Type declaration

Param: ev

The event.

ondrop

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

Type declaration

ondurationchange

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

Occurs when the duration attribute is updated.

Type declaration

Param: ev

The event.

onemptied

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

Occurs when the media element is reset to its initial state.

Type declaration

Param: ev

The event.

onended

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

Occurs when the end of playback is reached.

Type declaration

Param: ev

The event

onerror

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

Param: ev

The event.

onfocus

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

Fires when the object receives focus.

Type declaration

Param: ev

The event.

onformdata

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

Type declaration

onfullscreenchange

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

Type declaration

onfullscreenerror

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

Type declaration

ongotpointercapture

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

Type declaration

oninput

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

Type declaration

oninvalid

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

Type declaration

onkeydown

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

Fires when the user presses a key.

Type declaration

Param: ev

The keyboard event

onkeypress

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

Fires when the user presses an alphanumeric key.

Type declaration

Param: ev

The event.

Deprecated

onkeyup

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

Fires when the user releases a key.

Type declaration

Param: ev

The keyboard event

onload

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

Fires immediately after the browser loads the object.

Type declaration

Param: ev

The event.

onloadeddata

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

Occurs when media data is loaded at the current playback position.

Type declaration

Param: ev

The event.

onloadedmetadata

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

Occurs when the duration and dimensions of the media have been determined.

Type declaration

Param: ev

The event.

onloadstart

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

Occurs when Internet Explorer begins looking for media data.

Type declaration

Param: ev

The event.

onlostpointercapture

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

Type declaration

onmousedown

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

Fires when the user clicks the object with either mouse button.

Type declaration

Param: ev

The mouse event.

onmouseenter

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

Type declaration

onmouseleave

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

Type declaration

onmousemove

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

Fires when the user moves the mouse over the object.

Type declaration

Param: ev

The mouse event.

onmouseout

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

Fires when the user moves the mouse pointer outside the boundaries of the object.

Type declaration

Param: ev

The mouse event.

onmouseover

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

Fires when the user moves the mouse pointer into the object.

Type declaration

Param: ev

The mouse event.

onmouseup

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

Fires when the user releases a mouse button while the mouse is over the object.

Type declaration

Param: ev

The mouse event.

onpaste

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

Type declaration

onpause

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

Occurs when playback is paused.

Type declaration

Param: ev

The event.

onplay

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

Occurs when the play method is requested.

Type declaration

Param: ev

The event.

onplaying

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

Occurs when the audio or video has started playing.

Type declaration

Param: ev

The event.

onpointercancel

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

Type declaration

onpointerdown

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

Type declaration

onpointerenter

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

Type declaration

onpointerleave

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

Type declaration

onpointermove

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

Type declaration

onpointerout

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

Type declaration

onpointerover

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

Type declaration

onpointerup

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

Type declaration

onprogress

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

Occurs to indicate progress while downloading media data.

Type declaration

Param: ev

The event.

onratechange

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

Occurs when the playback rate is increased or decreased.

Type declaration

Param: ev

The event.

onreset

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

Fires when the user resets a form.

Type declaration

Param: ev

The event.

onresize

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

Type declaration

onscroll

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

Fires when the user repositions the scroll box in the scroll bar on the object.

Type declaration

Param: ev

The event.

onsecuritypolicyviolation

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

Type declaration

onseeked

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

Occurs when the seek operation ends.

Type declaration

Param: ev

The event.

onseeking

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

Occurs when the current playback position is moved.

Type declaration

Param: ev

The event.

onselect

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

Fires when the current selection changes.

Type declaration

Param: ev

The event.

onselectionchange

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

Type declaration

onselectstart

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

Type declaration

onslotchange

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

Type declaration

onstalled

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

Occurs when the download has stopped.

Type declaration

Param: ev

The event.

onsubmit

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

Type declaration

onsuspend

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

Occurs if the load operation has been intentionally halted.

Type declaration

Param: ev

The event.

ontimeupdate

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

Occurs to indicate the current playback position.

Type declaration

Param: ev

The event.

ontoggle

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

Type declaration

Optional ontouchcancel

ontouchcancel?: null | ((this, ev) => any)

Type declaration

Optional ontouchend

ontouchend?: null | ((this, ev) => any)

Type declaration

Optional ontouchmove

ontouchmove?: null | ((this, ev) => any)

Type declaration

Optional ontouchstart

ontouchstart?: null | ((this, ev) => any)

Type declaration

ontransitioncancel

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

Type declaration

ontransitionend

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

Type declaration

ontransitionrun

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

Type declaration

ontransitionstart

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

Type declaration

onvolumechange

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

Occurs when the volume is changed, or playback is muted or unmuted.

Type declaration

Param: ev

The event.

onwaiting

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

Occurs when playback stops because the next frame of a video resource is not available.

Type declaration

Param: ev

The event.

onwebkitanimationend

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

Type declaration

Deprecated

This is a legacy alias of onanimationend.

onwebkitanimationiteration

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

Type declaration

Deprecated

This is a legacy alias of onanimationiteration.

onwebkitanimationstart

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

Type declaration

Deprecated

This is a legacy alias of onanimationstart.

onwebkittransitionend

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

Type declaration

Deprecated

This is a legacy alias of ontransitionend.

onwheel

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

Type declaration

outerHTML

outerHTML: string

outerText

outerText: string

Readonly ownerDocument

ownerDocument: Document

Returns the node document. Returns null for documents.

Readonly parentElement

parentElement: null | HTMLElement

Returns the parent element.

Readonly parentNode

parentNode: null | ParentNode

Returns the parent.

Readonly part

part: DOMTokenList

Readonly prefix

prefix: null | string

Returns the namespace prefix.

Readonly previousElementSibling

previousElementSibling: null | Element

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

Readonly previousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

role

role: null | string

Readonly scrollHeight

scrollHeight: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

Readonly scrollWidth

scrollWidth: number

Readonly shadowRoot

shadowRoot: null | ShadowRoot

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

slot

slot: string

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

spellcheck

spellcheck: boolean

Readonly style

style: CSSStyleDeclaration

tabIndex

tabIndex: number

Readonly tagName

tagName: string

Returns the HTML-uppercased qualified name.

textContent

textContent: null | string

title

title: string

translate

translate: boolean

width

width: number

Sets or gets a value that you can use to implement your own width functionality for the object.

Deprecated

Methods

addEventListener

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

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    Type Parameters

    Parameters

    Returns void

  • addEventListener(type, listener, options?): void

  • Parameters

    Returns void

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

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

    Returns void

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

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

    Returns void

appendChild

attachInternals

attachShadow

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

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

    Returns void

blur

click

cloneNode

  • cloneNode(deep?): 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

compareDocumentPosition

  • compareDocumentPosition(other): number

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

    Parameters

    Returns number

contains

  • contains(other): boolean

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

    Parameters

    Returns boolean

dispatchEvent

  • dispatchEvent(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

focus

getAnimations

getAttribute

  • getAttribute(qualifiedName): 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

  • getAttributeNS(namespace, localName): 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

  • getAttributeNames(): string[]

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

    Returns string[]

getAttributeNode

getAttributeNodeNS

getBoundingClientRect

getClientRects

getElementsByClassName

  • getElementsByClassName(classNames): 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

getElementsByTagNameNS

getRootNode

hasAttribute

  • hasAttribute(qualifiedName): boolean

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

    Parameters

    • qualifiedName: string

    Returns boolean

hasAttributeNS

  • hasAttributeNS(namespace, localName): 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

  • hasAttributes(): boolean

  • Returns true if element has attributes, and false otherwise.

    Returns boolean

hasChildNodes

hasPointerCapture

insertAdjacentElement

insertAdjacentHTML

insertAdjacentText

insertBefore

isDefaultNamespace

isEqualNode

  • isEqualNode(otherNode): boolean

  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: null | Node

    Returns boolean

isSameNode

lookupNamespaceURI

lookupPrefix

  • lookupPrefix(namespace): null | string

  • Parameters

    • namespace: null | string

    Returns null | string

matches

  • matches(selectors): boolean

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

    Parameters

    • selectors: string

    Returns boolean

normalize

  • 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

  • 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

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

    Returns void

querySelector

querySelectorAll

releasePointerCapture

remove

removeAttribute

  • removeAttribute(qualifiedName): void

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

    Parameters

    • qualifiedName: string

    Returns void

removeAttributeNS

  • removeAttributeNS(namespace, localName): void

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

    Parameters

    • namespace: null | string
    • localName: string

    Returns void

removeAttributeNode

removeChild

removeEventListener

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

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

    Returns void

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

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

    Returns void

requestFullscreen

  • requestFullscreen(options?): 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

    Returns Promise<void>

requestPointerLock

scroll

scrollBy

scrollIntoView

scrollTo

setAttribute

  • setAttribute(qualifiedName, value): void

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

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

setAttributeNS

  • setAttributeNS(namespace, qualifiedName, value): 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

setAttributeNodeNS

setPointerCapture

toggleAttribute

  • toggleAttribute(qualifiedName, force?): 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

  • webkitMatchesSelector(selectors): boolean

  • Parameters

    • selectors: string

    Returns boolean

    Deprecated

    This is a legacy alias of matches.

Settings

Member Visibility

Theme

On This Page