Interface Document

Any web page loaded in the browser and serves as an entry point into the web page's content, which is the DOM tree.

interface Document {
    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;
    URL: string;
    activeElement: null | Element;
    adoptedStyleSheets: CSSStyleSheet[];
    alinkColor: string;
    all: HTMLAllCollection;
    anchors: HTMLCollectionOf<HTMLAnchorElement>;
    applets: HTMLCollection;
    baseURI: string;
    bgColor: string;
    body: HTMLElement;
    characterSet: string;
    charset: string;
    childElementCount: number;
    childNodes: NodeListOf<ChildNode>;
    children: HTMLCollection;
    compatMode: string;
    contentType: string;
    cookie: string;
    currentScript: null | HTMLOrSVGScriptElement;
    defaultView: null | Window & typeof globalThis;
    designMode: string;
    dir: string;
    doctype: null | DocumentType;
    documentElement: HTMLElement;
    documentURI: string;
    domain: string;
    embeds: HTMLCollectionOf<HTMLEmbedElement>;
    fgColor: string;
    firstChild: null | ChildNode;
    firstElementChild: null | Element;
    fonts: FontFaceSet;
    forms: HTMLCollectionOf<HTMLFormElement>;
    fullscreen: boolean;
    fullscreenElement: null | Element;
    fullscreenEnabled: boolean;
    head: HTMLHeadElement;
    hidden: boolean;
    images: HTMLCollectionOf<HTMLImageElement>;
    implementation: DOMImplementation;
    inputEncoding: string;
    isConnected: boolean;
    lastChild: null | ChildNode;
    lastElementChild: null | Element;
    lastModified: string;
    linkColor: string;
    links: HTMLCollectionOf<HTMLAnchorElement | HTMLAreaElement>;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    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);
    onpointerlockchange: null | ((this, ev) => any);
    onpointerlockerror: 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);
    onreadystatechange: 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);
    onvisibilitychange: 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);
    ownerDocument: null;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    pictureInPictureElement: null | Element;
    pictureInPictureEnabled: boolean;
    plugins: HTMLCollectionOf<HTMLEmbedElement>;
    pointerLockElement: null | Element;
    previousSibling: null | ChildNode;
    readyState: DocumentReadyState;
    referrer: string;
    rootElement: null | SVGSVGElement;
    scripts: HTMLCollectionOf<HTMLScriptElement>;
    scrollingElement: null | Element;
    styleSheets: StyleSheetList;
    textContent: null | string;
    timeline: DocumentTimeline;
    title: string;
    visibilityState: DocumentVisibilityState;
    vlinkColor: string;
    location: Location;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    adoptNode<T>(node): T;
    append(...nodes): void;
    appendChild<T>(node): T;
    captureEvents(): void;
    caretRangeFromPoint(x, y): null | Range;
    clear(): void;
    cloneNode(deep?): Node;
    close(): void;
    compareDocumentPosition(other): number;
    contains(other): boolean;
    createAttribute(localName): Attr;
    createAttributeNS(namespace, qualifiedName): Attr;
    createCDATASection(data): CDATASection;
    createComment(data): Comment;
    createDocumentFragment(): DocumentFragment;
    createElement<K>(tagName, options?): HTMLElementTagNameMap[K];
    createElement<K>(tagName, options?): HTMLElementDeprecatedTagNameMap[K];
    createElement(tagName, options?): HTMLElement;
    createElementNS(namespaceURI, qualifiedName): HTMLElement;
    createElementNS<K>(namespaceURI, qualifiedName): SVGElementTagNameMap[K];
    createElementNS(namespaceURI, qualifiedName): SVGElement;
    createElementNS(namespaceURI, qualifiedName, options?): Element;
    createElementNS(namespace, qualifiedName, options?): Element;
    createEvent(eventInterface): AnimationEvent;
    createEvent(eventInterface): AnimationPlaybackEvent;
    createEvent(eventInterface): AudioProcessingEvent;
    createEvent(eventInterface): BeforeUnloadEvent;
    createEvent(eventInterface): BlobEvent;
    createEvent(eventInterface): ClipboardEvent;
    createEvent(eventInterface): CloseEvent;
    createEvent(eventInterface): CompositionEvent;
    createEvent(eventInterface): CustomEvent<any>;
    createEvent(eventInterface): DeviceMotionEvent;
    createEvent(eventInterface): DeviceOrientationEvent;
    createEvent(eventInterface): DragEvent;
    createEvent(eventInterface): ErrorEvent;
    createEvent(eventInterface): Event;
    createEvent(eventInterface): Event;
    createEvent(eventInterface): FocusEvent;
    createEvent(eventInterface): FontFaceSetLoadEvent;
    createEvent(eventInterface): FormDataEvent;
    createEvent(eventInterface): GamepadEvent;
    createEvent(eventInterface): HashChangeEvent;
    createEvent(eventInterface): IDBVersionChangeEvent;
    createEvent(eventInterface): InputEvent;
    createEvent(eventInterface): KeyboardEvent;
    createEvent(eventInterface): MediaEncryptedEvent;
    createEvent(eventInterface): MediaKeyMessageEvent;
    createEvent(eventInterface): MediaQueryListEvent;
    createEvent(eventInterface): MediaStreamTrackEvent;
    createEvent(eventInterface): MessageEvent<any>;
    createEvent(eventInterface): MouseEvent;
    createEvent(eventInterface): MouseEvent;
    createEvent(eventInterface): MutationEvent;
    createEvent(eventInterface): MutationEvent;
    createEvent(eventInterface): OfflineAudioCompletionEvent;
    createEvent(eventInterface): PageTransitionEvent;
    createEvent(eventInterface): PaymentMethodChangeEvent;
    createEvent(eventInterface): PaymentRequestUpdateEvent;
    createEvent(eventInterface): PictureInPictureEvent;
    createEvent(eventInterface): PointerEvent;
    createEvent(eventInterface): PopStateEvent;
    createEvent(eventInterface): ProgressEvent<EventTarget>;
    createEvent(eventInterface): PromiseRejectionEvent;
    createEvent(eventInterface): RTCDTMFToneChangeEvent;
    createEvent(eventInterface): RTCDataChannelEvent;
    createEvent(eventInterface): RTCErrorEvent;
    createEvent(eventInterface): RTCPeerConnectionIceErrorEvent;
    createEvent(eventInterface): RTCPeerConnectionIceEvent;
    createEvent(eventInterface): RTCTrackEvent;
    createEvent(eventInterface): SecurityPolicyViolationEvent;
    createEvent(eventInterface): SpeechSynthesisErrorEvent;
    createEvent(eventInterface): SpeechSynthesisEvent;
    createEvent(eventInterface): StorageEvent;
    createEvent(eventInterface): SubmitEvent;
    createEvent(eventInterface): TouchEvent;
    createEvent(eventInterface): TrackEvent;
    createEvent(eventInterface): TransitionEvent;
    createEvent(eventInterface): UIEvent;
    createEvent(eventInterface): UIEvent;
    createEvent(eventInterface): WebGLContextEvent;
    createEvent(eventInterface): WheelEvent;
    createEvent(eventInterface): Event;
    createExpression(expression, resolver?): XPathExpression;
    createNSResolver(nodeResolver): XPathNSResolver;
    createNodeIterator(root, whatToShow?, filter?): NodeIterator;
    createProcessingInstruction(target, data): ProcessingInstruction;
    createRange(): Range;
    createTextNode(data): Text;
    createTreeWalker(root, whatToShow?, filter?): TreeWalker;
    dispatchEvent(event): boolean;
    elementFromPoint(x, y): null | Element;
    elementsFromPoint(x, y): Element[];
    evaluate(expression, contextNode, resolver?, type?, result?): XPathResult;
    execCommand(commandId, showUI?, value?): boolean;
    exitFullscreen(): Promise<void>;
    exitPictureInPicture(): Promise<void>;
    exitPointerLock(): void;
    getAnimations(): Animation[];
    getElementById(elementId): null | HTMLElement;
    getElementsByClassName(classNames): HTMLCollectionOf<Element>;
    getElementsByName(elementName): NodeListOf<HTMLElement>;
    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;
    getSelection(): null | Selection;
    hasChildNodes(): boolean;
    hasFocus(): boolean;
    hasStorageAccess(): Promise<boolean>;
    importNode<T>(node, deep?): T;
    insertBefore<T>(node, child): T;
    isDefaultNamespace(namespace): boolean;
    isEqualNode(otherNode): boolean;
    isSameNode(otherNode): boolean;
    lookupNamespaceURI(prefix): null | string;
    lookupPrefix(namespace): null | string;
    normalize(): void;
    open(unused1?, unused2?): Document;
    open(url, name, features): null | Window;
    prepend(...nodes): void;
    queryCommandEnabled(commandId): boolean;
    queryCommandIndeterm(commandId): boolean;
    queryCommandState(commandId): boolean;
    queryCommandSupported(commandId): boolean;
    queryCommandValue(commandId): string;
    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>;
    releaseEvents(): void;
    removeChild<T>(child): T;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    replaceChild<T>(node, child): T;
    replaceChildren(...nodes): void;
    requestStorageAccess(): Promise<void>;
    write(...text): void;
    writeln(...text): void;
}

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 URL activeElement adoptedStyleSheets alinkColor all anchors applets baseURI bgColor body characterSet charset childElementCount childNodes children compatMode contentType cookie currentScript defaultView designMode dir doctype documentElement documentURI domain embeds fgColor firstChild firstElementChild fonts forms fullscreen fullscreenElement fullscreenEnabled head hidden images implementation inputEncoding isConnected lastChild lastElementChild lastModified linkColor links nextSibling nodeName nodeType nodeValue 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 onpointerlockchange onpointerlockerror onpointermove onpointerout onpointerover onpointerup onprogress onratechange onreadystatechange onreset onresize onscroll onsecuritypolicyviolation onseeked onseeking onselect onselectionchange onselectstart onslotchange onstalled onsubmit onsuspend ontimeupdate ontoggle ontouchcancel? ontouchend? ontouchmove? ontouchstart? ontransitioncancel ontransitionend ontransitionrun ontransitionstart onvisibilitychange onvolumechange onwaiting onwebkitanimationend onwebkitanimationiteration onwebkitanimationstart onwebkittransitionend onwheel ownerDocument parentElement parentNode pictureInPictureElement pictureInPictureEnabled plugins pointerLockElement previousSibling readyState referrer rootElement scripts scrollingElement styleSheets textContent timeline title visibilityState vlinkColor

Accessors

location

Methods

addEventListener adoptNode append appendChild captureEvents caretRangeFromPoint clear cloneNode close compareDocumentPosition contains createAttribute createAttributeNS createCDATASection createComment createDocumentFragment createElement createElementNS createEvent createExpression createNSResolver createNodeIterator createProcessingInstruction createRange createTextNode createTreeWalker dispatchEvent elementFromPoint elementsFromPoint evaluate execCommand exitFullscreen exitPictureInPicture exitPointerLock getAnimations getElementById getElementsByClassName getElementsByName getElementsByTagName getElementsByTagNameNS getRootNode getSelection hasChildNodes hasFocus hasStorageAccess importNode insertBefore isDefaultNamespace isEqualNode isSameNode lookupNamespaceURI lookupPrefix normalize open prepend queryCommandEnabled queryCommandIndeterm queryCommandState queryCommandSupported queryCommandValue querySelector querySelectorAll releaseEvents removeChild removeEventListener replaceChild replaceChildren requestStorageAccess write writeln

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.

Readonly URL

URL: string

Sets or gets the URL for the current document.

Readonly activeElement

activeElement: null | Element

Returns the deepest element in the document through which or to which key events are being routed. This is, roughly speaking, the focused element in the document.

For the purposes of this API, when a child browsing context is focused, its container is focused in the parent browsing context. For example, if the user moves the focus to a text control in an iframe, the iframe is the element returned by the activeElement API in the iframe's node document.

Similarly, when the focused element is in a different node tree than documentOrShadowRoot, the element returned will be the host that's located in the same node tree as documentOrShadowRoot if documentOrShadowRoot is a shadow-including inclusive ancestor of the focused element, and null if not.

adoptedStyleSheets

adoptedStyleSheets: CSSStyleSheet[]

alinkColor

alinkColor: string

Sets or gets the color of all active links in the document.

Deprecated

Readonly all

all: HTMLAllCollection

Returns a reference to the collection of elements contained by the object.

Deprecated

Readonly anchors

anchors: HTMLCollectionOf<HTMLAnchorElement>

Retrieves a collection of all a objects that have a name and/or id property. Objects in this collection are in HTML source order.

Deprecated

Readonly applets

applets: HTMLCollection

Retrieves a collection of all applet objects in the document.

Deprecated

Readonly baseURI

baseURI: string

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

bgColor

bgColor: string

Deprecated. Sets or retrieves a value that indicates the background color behind the object.

Deprecated

body

body: HTMLElement

Specifies the beginning and end of the document body.

Readonly characterSet

characterSet: string

Returns document's encoding.

Readonly charset

charset: string

Gets or sets the character set used to encode the object.

Deprecated

This is a legacy alias of characterSet.

Readonly childElementCount

childElementCount: number

Readonly childNodes

childNodes: NodeListOf<ChildNode>

Returns the children.

Readonly children

children: HTMLCollection

Returns the child elements.

Readonly compatMode

compatMode: string

Gets a value that indicates whether standards-compliant mode is switched on for the object.

Readonly contentType

contentType: string

Returns document's content type.

cookie

cookie: string

Returns the HTTP cookies that apply to the Document. If there are no cookies or cookies can't be applied to this resource, the empty string will be returned.

Can be set, to add a new cookie to the element's set of HTTP cookies.

If the contents are sandboxed into a unique origin (e.g. in an iframe with the sandbox attribute), a "SecurityError" DOMException will be thrown on getting and setting.

Readonly currentScript

currentScript: null | HTMLOrSVGScriptElement

Returns the script element, or the SVG script element, that is currently executing, as long as the element represents a classic script. In the case of reentrant script execution, returns the one that most recently started executing amongst those that have not yet finished executing.

Returns null if the Document is not currently executing a script or SVG script element (e.g., because the running script is an event handler, or a timeout), or if the currently executing script or SVG script element represents a module script.

Readonly defaultView

defaultView: null | Window & typeof globalThis

Returns the Window object of the active document.

designMode

designMode: string

Sets or gets a value that indicates whether the document can be edited.

dir

dir: string

Sets or retrieves a value that indicates the reading order of the object.

Readonly doctype

doctype: null | DocumentType

Gets an object representing the document type declaration associated with the current document.

Readonly documentElement

documentElement: HTMLElement

Gets a reference to the root node of the document.

Readonly documentURI

documentURI: string

Returns document's URL.

domain

domain: string

Sets or gets the security domain of the document.

Deprecated

Readonly embeds

embeds: HTMLCollectionOf<HTMLEmbedElement>

Retrieves a collection of all embed objects in the document.

fgColor

fgColor: string

Sets or gets the foreground (text) color of the document.

Deprecated

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.

Readonly fonts

fonts: FontFaceSet

Readonly forms

forms: HTMLCollectionOf<HTMLFormElement>

Retrieves a collection, in source order, of all form objects in the document.

Readonly fullscreen

fullscreen: boolean

Deprecated

Readonly fullscreenElement

fullscreenElement: null | Element

Returns document's fullscreen element.

Readonly fullscreenEnabled

fullscreenEnabled: boolean

Returns true if document has the ability to display elements fullscreen and fullscreen is supported, or false otherwise.

Readonly head

head: HTMLHeadElement

Returns the head element.

Readonly hidden

hidden: boolean

Readonly images

images: HTMLCollectionOf<HTMLImageElement>

Retrieves a collection, in source order, of img objects in the document.

Readonly implementation

implementation: DOMImplementation

Gets the implementation object of the current document.

Readonly inputEncoding

inputEncoding: string

Returns the character encoding used to create the webpage that is loaded into the document object.

Deprecated

This is a legacy alias of characterSet.

Readonly isConnected

isConnected: boolean

Returns true if node is connected and false otherwise.

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 lastModified

lastModified: string

Gets the date that the page was last modified, if the page supplies one.

linkColor

linkColor: string

Sets or gets the color of the document links.

Deprecated

Readonly links

links: HTMLCollectionOf<HTMLAnchorElement | HTMLAreaElement>

Retrieves a collection of all a objects that specify the href property and all area objects in the document.

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

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

    • (this, ev): any

    • Parameters

      Returns any

onfullscreenerror

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

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

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

onpointerlockchange

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

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

onpointerlockerror

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

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

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.

onreadystatechange

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

Fires when the state of the object has changed.

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

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

onvisibilitychange

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

Type declaration

    • (this, ev): any

    • Parameters

      Returns any

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

Readonly ownerDocument

ownerDocument: null

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 pictureInPictureElement

pictureInPictureElement: null | Element

Readonly pictureInPictureEnabled

pictureInPictureEnabled: boolean

Readonly plugins

plugins: HTMLCollectionOf<HTMLEmbedElement>

Return an HTMLCollection of the embed elements in the Document.

Readonly pointerLockElement

pointerLockElement: null | Element

Readonly previousSibling

previousSibling: null | ChildNode

Returns the previous sibling.

Readonly readyState

readyState: DocumentReadyState

Retrieves a value that indicates the current state of the object.

Readonly referrer

referrer: string

Gets the URL of the location that referred the user to the current page.

Readonly rootElement

rootElement: null | SVGSVGElement

Deprecated

Readonly scripts

scripts: HTMLCollectionOf<HTMLScriptElement>

Retrieves a collection of all script objects in the document.

Readonly scrollingElement

scrollingElement: null | Element

Readonly styleSheets

styleSheets: StyleSheetList

Retrieves a collection of styleSheet objects representing the style sheets that correspond to each instance of a link or style object in the document.

textContent

textContent: null | string

Readonly timeline

timeline: DocumentTimeline

title

title: string

Contains the title of the document.

Readonly visibilityState

visibilityState: DocumentVisibilityState

vlinkColor

vlinkColor: string

Sets or gets the color of the links that the user has visited.

Deprecated

Accessors

location

  • get location(): Location

  • Contains information about the current URL.

    Returns Location

  • set location(href): void

  • Parameters

    Returns void

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

adoptNode

  • adoptNode<T>(node): T

  • Moves node from another document and returns it.

    If node is a document, throws a "NotSupportedError" DOMException or, if node is a shadow root, throws a "HierarchyRequestError" DOMException.

    Type Parameters

    Parameters

    • node: T

    Returns T

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

  • appendChild<T>(node): T

  • Type Parameters

    Parameters

    • node: T

    Returns T

captureEvents

  • captureEvents(): void

  • Returns void

    Deprecated

caretRangeFromPoint

  • caretRangeFromPoint(x, y): null | Range

  • Parameters

    • x: number
    • y: number

    Returns null | Range

    Deprecated

clear

  • clear(): void

  • Returns void

    Deprecated

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

close

  • close(): void

  • Closes an output stream and forces the sent data to display.

    Returns void

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

createAttribute

  • createAttribute(localName): Attr

  • Creates an attribute object with a specified name.

    Parameters

    • localName: string

    Returns Attr

createAttributeNS

  • createAttributeNS(namespace, qualifiedName): Attr

  • Parameters

    • namespace: null | string
    • qualifiedName: string

    Returns Attr

createCDATASection

  • createCDATASection(data): CDATASection

  • Returns a CDATASection node whose data is data.

    Parameters

    • data: string

    Returns CDATASection

createComment

  • createComment(data): Comment

  • Creates a comment object with the specified data.

    Parameters

    • data: string

      Sets the comment object's data.

    Returns Comment

createDocumentFragment

createElement

createElementNS

  • createElementNS(namespaceURI, qualifiedName): HTMLElement

  • Returns an element with namespace namespace. Its namespace prefix will be everything before ":" (U+003E) in qualifiedName or null. Its local name will be everything after ":" (U+003E) in qualifiedName or qualifiedName.

    If localName does not match the Name production an "InvalidCharacterError" DOMException will be thrown.

    If one of the following conditions is true a "NamespaceError" DOMException will be thrown:

    localName does not match the QName production. Namespace prefix is not null and namespace is the empty string. Namespace prefix is "xml" and namespace is not the XML namespace. qualifiedName or namespace prefix is "xmlns" and namespace is not the XMLNS namespace. namespace is the XMLNS namespace and neither qualifiedName nor namespace prefix is "xmlns".

    When supplied, options's is can be used to create a customized built-in element.

    Parameters

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

    Returns HTMLElement

  • createElementNS<K>(namespaceURI, qualifiedName): SVGElementTagNameMap[K]

  • Type Parameters

    Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • qualifiedName: K

    Returns SVGElementTagNameMap[K]

  • createElementNS(namespaceURI, qualifiedName): SVGElement

  • Parameters

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

    Returns SVGElement

  • createElementNS(namespaceURI, qualifiedName, options?): Element

  • Parameters

    Returns Element

  • createElementNS(namespace, qualifiedName, options?): Element

  • Parameters

    Returns Element

createEvent

  • createEvent(eventInterface): AnimationEvent

  • Parameters

    • eventInterface: "AnimationEvent"

    Returns AnimationEvent

  • createEvent(eventInterface): AnimationPlaybackEvent

  • Parameters

    • eventInterface: "AnimationPlaybackEvent"

    Returns AnimationPlaybackEvent

  • createEvent(eventInterface): AudioProcessingEvent

  • Parameters

    • eventInterface: "AudioProcessingEvent"

    Returns AudioProcessingEvent

  • createEvent(eventInterface): BeforeUnloadEvent

  • Parameters

    • eventInterface: "BeforeUnloadEvent"

    Returns BeforeUnloadEvent

  • createEvent(eventInterface): BlobEvent

  • Parameters

    • eventInterface: "BlobEvent"

    Returns BlobEvent

  • createEvent(eventInterface): ClipboardEvent

  • Parameters

    • eventInterface: "ClipboardEvent"

    Returns ClipboardEvent

  • createEvent(eventInterface): CloseEvent

  • Parameters

    • eventInterface: "CloseEvent"

    Returns CloseEvent

  • createEvent(eventInterface): CompositionEvent

  • Parameters

    • eventInterface: "CompositionEvent"

    Returns CompositionEvent

  • createEvent(eventInterface): CustomEvent<any>

  • Parameters

    • eventInterface: "CustomEvent"

    Returns CustomEvent<any>

  • createEvent(eventInterface): DeviceMotionEvent

  • Parameters

    • eventInterface: "DeviceMotionEvent"

    Returns DeviceMotionEvent

  • createEvent(eventInterface): DeviceOrientationEvent

  • Parameters

    • eventInterface: "DeviceOrientationEvent"

    Returns DeviceOrientationEvent

  • createEvent(eventInterface): DragEvent

  • Parameters

    • eventInterface: "DragEvent"

    Returns DragEvent

  • createEvent(eventInterface): ErrorEvent

  • Parameters

    • eventInterface: "ErrorEvent"

    Returns ErrorEvent

  • createEvent(eventInterface): Event

  • Parameters

    • eventInterface: "Event"

    Returns Event

  • createEvent(eventInterface): Event

  • Parameters

    • eventInterface: "Events"

    Returns Event

  • createEvent(eventInterface): FocusEvent

  • Parameters

    • eventInterface: "FocusEvent"

    Returns FocusEvent

  • createEvent(eventInterface): FontFaceSetLoadEvent

  • Parameters

    • eventInterface: "FontFaceSetLoadEvent"

    Returns FontFaceSetLoadEvent

  • createEvent(eventInterface): FormDataEvent

  • Parameters

    • eventInterface: "FormDataEvent"

    Returns FormDataEvent

  • createEvent(eventInterface): GamepadEvent

  • Parameters

    • eventInterface: "GamepadEvent"

    Returns GamepadEvent

  • createEvent(eventInterface): HashChangeEvent

  • Parameters

    • eventInterface: "HashChangeEvent"

    Returns HashChangeEvent

  • createEvent(eventInterface): IDBVersionChangeEvent

  • Parameters

    • eventInterface: "IDBVersionChangeEvent"

    Returns IDBVersionChangeEvent

  • createEvent(eventInterface): InputEvent

  • Parameters

    • eventInterface: "InputEvent"

    Returns InputEvent

  • createEvent(eventInterface): KeyboardEvent

  • Parameters

    • eventInterface: "KeyboardEvent"

    Returns KeyboardEvent

  • createEvent(eventInterface): MediaEncryptedEvent

  • Parameters

    • eventInterface: "MediaEncryptedEvent"

    Returns MediaEncryptedEvent

  • createEvent(eventInterface): MediaKeyMessageEvent

  • Parameters

    • eventInterface: "MediaKeyMessageEvent"

    Returns MediaKeyMessageEvent

  • createEvent(eventInterface): MediaQueryListEvent

  • Parameters

    • eventInterface: "MediaQueryListEvent"

    Returns MediaQueryListEvent

  • createEvent(eventInterface): MediaStreamTrackEvent

  • Parameters

    • eventInterface: "MediaStreamTrackEvent"

    Returns MediaStreamTrackEvent

  • createEvent(eventInterface): MessageEvent<any>

  • Parameters

    • eventInterface: "MessageEvent"

    Returns MessageEvent<any>

  • createEvent(eventInterface): MouseEvent

  • Parameters

    • eventInterface: "MouseEvent"

    Returns MouseEvent

  • createEvent(eventInterface): MouseEvent

  • Parameters

    • eventInterface: "MouseEvents"

    Returns MouseEvent

  • createEvent(eventInterface): MutationEvent

  • Parameters

    • eventInterface: "MutationEvent"

    Returns MutationEvent

  • createEvent(eventInterface): MutationEvent

  • Parameters

    • eventInterface: "MutationEvents"

    Returns MutationEvent

  • createEvent(eventInterface): OfflineAudioCompletionEvent

  • Parameters

    • eventInterface: "OfflineAudioCompletionEvent"

    Returns OfflineAudioCompletionEvent

  • createEvent(eventInterface): PageTransitionEvent

  • Parameters

    • eventInterface: "PageTransitionEvent"

    Returns PageTransitionEvent

  • createEvent(eventInterface): PaymentMethodChangeEvent

  • Parameters

    • eventInterface: "PaymentMethodChangeEvent"

    Returns PaymentMethodChangeEvent

  • createEvent(eventInterface): PaymentRequestUpdateEvent

  • Parameters

    • eventInterface: "PaymentRequestUpdateEvent"

    Returns PaymentRequestUpdateEvent

  • createEvent(eventInterface): PictureInPictureEvent

  • Parameters

    • eventInterface: "PictureInPictureEvent"

    Returns PictureInPictureEvent

  • createEvent(eventInterface): PointerEvent

  • Parameters

    • eventInterface: "PointerEvent"

    Returns PointerEvent

  • createEvent(eventInterface): PopStateEvent

  • Parameters

    • eventInterface: "PopStateEvent"

    Returns PopStateEvent

  • createEvent(eventInterface): ProgressEvent<EventTarget>

  • Parameters

    • eventInterface: "ProgressEvent"

    Returns ProgressEvent<EventTarget>

  • createEvent(eventInterface): PromiseRejectionEvent

  • Parameters

    • eventInterface: "PromiseRejectionEvent"

    Returns PromiseRejectionEvent

  • createEvent(eventInterface): RTCDTMFToneChangeEvent

  • Parameters

    • eventInterface: "RTCDTMFToneChangeEvent"

    Returns RTCDTMFToneChangeEvent

  • createEvent(eventInterface): RTCDataChannelEvent

  • Parameters

    • eventInterface: "RTCDataChannelEvent"

    Returns RTCDataChannelEvent

  • createEvent(eventInterface): RTCErrorEvent

  • Parameters

    • eventInterface: "RTCErrorEvent"

    Returns RTCErrorEvent

  • createEvent(eventInterface): RTCPeerConnectionIceErrorEvent

  • Parameters

    • eventInterface: "RTCPeerConnectionIceErrorEvent"

    Returns RTCPeerConnectionIceErrorEvent

  • createEvent(eventInterface): RTCPeerConnectionIceEvent

  • Parameters

    • eventInterface: "RTCPeerConnectionIceEvent"

    Returns RTCPeerConnectionIceEvent

  • createEvent(eventInterface): RTCTrackEvent

  • Parameters

    • eventInterface: "RTCTrackEvent"

    Returns RTCTrackEvent

  • createEvent(eventInterface): SecurityPolicyViolationEvent

  • Parameters

    • eventInterface: "SecurityPolicyViolationEvent"

    Returns SecurityPolicyViolationEvent

  • createEvent(eventInterface): SpeechSynthesisErrorEvent

  • Parameters

    • eventInterface: "SpeechSynthesisErrorEvent"

    Returns SpeechSynthesisErrorEvent

  • createEvent(eventInterface): SpeechSynthesisEvent

  • Parameters

    • eventInterface: "SpeechSynthesisEvent"

    Returns SpeechSynthesisEvent

  • createEvent(eventInterface): StorageEvent

  • Parameters

    • eventInterface: "StorageEvent"

    Returns StorageEvent

  • createEvent(eventInterface): SubmitEvent

  • Parameters

    • eventInterface: "SubmitEvent"

    Returns SubmitEvent

  • createEvent(eventInterface): TouchEvent

  • Parameters

    • eventInterface: "TouchEvent"

    Returns TouchEvent

  • createEvent(eventInterface): TrackEvent

  • Parameters

    • eventInterface: "TrackEvent"

    Returns TrackEvent

  • createEvent(eventInterface): TransitionEvent

  • Parameters

    • eventInterface: "TransitionEvent"

    Returns TransitionEvent

  • createEvent(eventInterface): UIEvent

  • Parameters

    • eventInterface: "UIEvent"

    Returns UIEvent

  • createEvent(eventInterface): UIEvent

  • Parameters

    • eventInterface: "UIEvents"

    Returns UIEvent

  • createEvent(eventInterface): WebGLContextEvent

  • Parameters

    • eventInterface: "WebGLContextEvent"

    Returns WebGLContextEvent

  • createEvent(eventInterface): WheelEvent

  • Parameters

    • eventInterface: "WheelEvent"

    Returns WheelEvent

  • createEvent(eventInterface): Event

  • Parameters

    • eventInterface: string

    Returns Event

createExpression

createNSResolver

createNodeIterator

  • createNodeIterator(root, whatToShow?, filter?): NodeIterator

  • Creates a NodeIterator object that you can use to traverse filtered lists of nodes or elements in a document.

    Parameters

    • root: Node

      The root element or node to start traversing on.

    • Optional whatToShow: number

      The type of nodes or elements to appear in the node list

    • Optional filter: null | NodeFilter

      A custom NodeFilter function to use. For more information, see filter. Use null for no filter.

    Returns NodeIterator

createProcessingInstruction

  • createProcessingInstruction(target, data): ProcessingInstruction

  • Returns a ProcessingInstruction node whose target is target and data is data. If target does not match the Name production an "InvalidCharacterError" DOMException will be thrown. If data contains "?>" an "InvalidCharacterError" DOMException will be thrown.

    Parameters

    • target: string
    • data: string

    Returns ProcessingInstruction

createRange

  • createRange(): Range

  • Returns an empty range object that has both of its boundary points positioned at the beginning of the document.

    Returns Range

createTextNode

  • createTextNode(data): Text

  • Creates a text string from the specified value.

    Parameters

    • data: string

      String that specifies the nodeValue property of the text node.

    Returns Text

createTreeWalker

  • createTreeWalker(root, whatToShow?, filter?): TreeWalker

  • Creates a TreeWalker object that you can use to traverse filtered lists of nodes or elements in a document.

    Parameters

    • root: Node

      The root element or node to start traversing on.

    • Optional whatToShow: number

      The type of nodes or elements to appear in the node list. For more information, see whatToShow.

    • Optional filter: null | NodeFilter

      A custom NodeFilter function to use.

    Returns TreeWalker

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

    • event: Event

    Returns boolean

elementFromPoint

  • elementFromPoint(x, y): null | Element

  • Returns the element for the specified x coordinate and the specified y coordinate.

    Parameters

    • x: number

      The x-offset

    • y: number

      The y-offset

    Returns null | Element

elementsFromPoint

evaluate

execCommand

  • execCommand(commandId, showUI?, value?): boolean

  • Executes a command on the current document, current selection, or the given range.

    Parameters

    • commandId: string

      String that specifies the command to execute. This command can be any of the command identifiers that can be executed in script.

    • Optional showUI: boolean

      Display the user interface, defaults to false.

    • Optional value: string

      Value to assign.

    Returns boolean

    Deprecated

exitFullscreen

  • exitFullscreen(): Promise<void>

  • Stops document's fullscreen element from being displayed fullscreen and resolves promise when done.

    Returns Promise<void>

exitPictureInPicture

  • exitPictureInPicture(): Promise<void>

  • Returns Promise<void>

exitPointerLock

  • exitPointerLock(): void

  • Returns void

getAnimations

getElementById

  • getElementById(elementId): null | HTMLElement

  • Returns a reference to the first object with the specified value of the ID attribute.

    Parameters

    • elementId: string

      String that specifies the ID value.

    Returns null | HTMLElement

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>

getElementsByName

  • getElementsByName(elementName): NodeListOf<HTMLElement>

  • Gets a collection of objects based on the value of the NAME or ID attribute.

    Parameters

    • elementName: string

      Gets a collection of objects based on the value of the NAME or ID attribute.

    Returns NodeListOf<HTMLElement>

getElementsByTagName

  • getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Retrieves a collection of objects based on the specified element name.

    Type Parameters

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Type Parameters

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

getElementsByTagNameNS

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>

  • If namespace and localName are "*" returns a HTMLCollection of all descendant elements.

    If only namespace is "*" returns a HTMLCollection of all descendant elements whose local name is localName.

    If only localName is "*" returns a HTMLCollection of all descendant elements whose namespace is namespace.

    Otherwise, returns a HTMLCollection of all descendant elements whose namespace is namespace and local name is localName.

    Parameters

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

    Returns HTMLCollectionOf<HTMLElement>

  • getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>

  • Parameters

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

    Returns HTMLCollectionOf<SVGElement>

  • getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>

  • Parameters

    • namespace: null | string
    • localName: string

    Returns HTMLCollectionOf<Element>

getRootNode

getSelection

  • getSelection(): null | Selection

  • Returns an object representing the current selection of the document that is loaded into the object displaying a webpage.

    Returns null | Selection

hasChildNodes

  • hasChildNodes(): boolean

  • Returns whether node has children.

    Returns boolean

hasFocus

  • hasFocus(): boolean

  • Gets a value indicating whether the object currently has focus.

    Returns boolean

hasStorageAccess

  • hasStorageAccess(): Promise<boolean>

  • Returns Promise<boolean>

importNode

  • importNode<T>(node, deep?): T

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

    If node is a document or a shadow root, throws a "NotSupportedError" DOMException.

    Type Parameters

    Parameters

    • node: T
    • Optional deep: boolean

    Returns T

insertBefore

  • insertBefore<T>(node, child): T

  • Type Parameters

    Parameters

    • node: T
    • child: null | Node

    Returns T

isDefaultNamespace

  • isDefaultNamespace(namespace): boolean

  • Parameters

    • namespace: null | string

    Returns boolean

isEqualNode

  • isEqualNode(otherNode): boolean

  • Returns whether node and otherNode have the same properties.

    Parameters

    • otherNode: null | Node

    Returns boolean

isSameNode

  • isSameNode(otherNode): boolean

  • Parameters

    • otherNode: null | Node

    Returns boolean

lookupNamespaceURI

  • lookupNamespaceURI(prefix): null | string

  • Parameters

    • prefix: null | string

    Returns null | string

lookupPrefix

  • lookupPrefix(namespace): null | string

  • Parameters

    • namespace: null | string

    Returns null | string

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

open

  • open(unused1?, unused2?): Document

  • Opens a new window and loads a document specified by a given URL. Also, opens a new window that uses the url parameter and the name parameter to collect the output of the write method and the writeln method.

    Parameters

    • Optional unused1: string
    • Optional unused2: string

    Returns Document

  • open(url, name, features): null | Window

  • Parameters

    • url: string | URL
    • name: string
    • features: string

    Returns null | Window

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

queryCommandEnabled

  • queryCommandEnabled(commandId): boolean

  • Returns a Boolean value that indicates whether a specified command can be successfully executed using execCommand, given the current state of the document.

    Parameters

    • commandId: string

      Specifies a command identifier.

    Returns boolean

    Deprecated

queryCommandIndeterm

  • queryCommandIndeterm(commandId): boolean

  • Returns a Boolean value that indicates whether the specified command is in the indeterminate state.

    Parameters

    • commandId: string

      String that specifies a command identifier.

    Returns boolean

    Deprecated

queryCommandState

  • queryCommandState(commandId): boolean

  • Returns a Boolean value that indicates the current state of the command.

    Parameters

    • commandId: string

      String that specifies a command identifier.

    Returns boolean

    Deprecated

queryCommandSupported

  • queryCommandSupported(commandId): boolean

  • Returns a Boolean value that indicates whether the current command is supported on the current range.

    Parameters

    • commandId: string

      Specifies a command identifier.

    Returns boolean

    Deprecated

queryCommandValue

  • queryCommandValue(commandId): string

  • Returns the current value of the document, range, or current selection for the given command.

    Parameters

    • commandId: string

      String that specifies a command identifier.

    Returns string

    Deprecated

querySelector

querySelectorAll

releaseEvents

  • releaseEvents(): void

  • Returns void

    Deprecated

removeChild

  • removeChild<T>(child): T

  • Type Parameters

    Parameters

    • child: T

    Returns T

removeEventListener

replaceChild

  • replaceChild<T>(node, child): T

  • Type Parameters

    Parameters

    Returns T

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

requestStorageAccess

  • requestStorageAccess(): Promise<void>

  • Returns Promise<void>

write

  • write(...text): void

  • Writes one or more HTML expressions to a document in the specified window.

    Parameters

    • Rest ...text: string[]

    Returns void

writeln

  • writeln(...text): void

  • Writes one or more HTML expressions, followed by a carriage return, to a document in the specified window.

    Parameters

    • Rest ...text: string[]

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc