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.

MDN Reference

interface Document {
    $bindAttributes?: AttributeBindingsMap;
    $bindItemStart?: RangeBinding;
    $bindStart?: RangeBinding;
    $destroyListeners?: any[];
    ATTRIBUTE_NODE: 2;
    CDATA_SECTION_NODE: 4;
    COMMENT_NODE: 8;
    DOCUMENT_FRAGMENT_NODE: 11;
    DOCUMENT_NODE: 9;
    DOCUMENT_POSITION_CONTAINED_BY: 16;
    DOCUMENT_POSITION_CONTAINS: 8;
    DOCUMENT_POSITION_DISCONNECTED: 1;
    DOCUMENT_POSITION_FOLLOWING: 4;
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
    DOCUMENT_POSITION_PRECEDING: 2;
    DOCUMENT_TYPE_NODE: 10;
    ELEMENT_NODE: 1;
    ENTITY_NODE: 6;
    ENTITY_REFERENCE_NODE: 5;
    NOTATION_NODE: 12;
    PROCESSING_INSTRUCTION_NODE: 7;
    TEXT_NODE: 3;
    URL: string;
    activeElement: 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: HTMLOrSVGScriptElement;
    defaultView: Window & typeof globalThis;
    designMode: string;
    dir: string;
    doctype: DocumentType;
    documentElement: HTMLElement;
    documentURI: string;
    domain: string;
    embeds: HTMLCollectionOf<HTMLEmbedElement>;
    fgColor: string;
    firstChild: ChildNode;
    firstElementChild: Element;
    fonts: FontFaceSet;
    forms: HTMLCollectionOf<HTMLFormElement>;
    fullscreen: boolean;
    fullscreenElement: Element;
    fullscreenEnabled: boolean;
    head: HTMLHeadElement;
    hidden: boolean;
    images: HTMLCollectionOf<HTMLImageElement>;
    implementation: DOMImplementation;
    inputEncoding: string;
    isConnected: boolean;
    lastChild: ChildNode;
    lastElementChild: Element;
    lastModified: string;
    linkColor: string;
    links: HTMLCollectionOf<HTMLAnchorElement | HTMLAreaElement>;
    nextSibling: ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: string;
    onabort: Object;
    onanimationcancel: Object;
    onanimationend: Object;
    onanimationiteration: Object;
    onanimationstart: Object;
    onauxclick: Object;
    onbeforeinput: Object;
    onblur: Object;
    oncancel: Object;
    oncanplay: Object;
    oncanplaythrough: Object;
    onchange: Object;
    onclick: Object;
    onclose: Object;
    oncontextmenu: Object;
    oncopy: Object;
    oncuechange: Object;
    oncut: Object;
    ondblclick: Object;
    ondrag: Object;
    ondragend: Object;
    ondragenter: Object;
    ondragleave: Object;
    ondragover: Object;
    ondragstart: Object;
    ondrop: Object;
    ondurationchange: Object;
    onemptied: Object;
    onended: Object;
    onerror: OnErrorEventHandlerNonNull;
    onfocus: Object;
    onformdata: Object;
    onfullscreenchange: Object;
    onfullscreenerror: Object;
    ongotpointercapture: Object;
    oninput: Object;
    oninvalid: Object;
    onkeydown: Object;
    onkeypress: Object;
    onkeyup: Object;
    onload: Object;
    onloadeddata: Object;
    onloadedmetadata: Object;
    onloadstart: Object;
    onlostpointercapture: Object;
    onmousedown: Object;
    onmouseenter: Object;
    onmouseleave: Object;
    onmousemove: Object;
    onmouseout: Object;
    onmouseover: Object;
    onmouseup: Object;
    onpaste: Object;
    onpause: Object;
    onplay: Object;
    onplaying: Object;
    onpointercancel: Object;
    onpointerdown: Object;
    onpointerenter: Object;
    onpointerleave: Object;
    onpointerlockchange: Object;
    onpointerlockerror: Object;
    onpointermove: Object;
    onpointerout: Object;
    onpointerover: Object;
    onpointerup: Object;
    onprogress: Object;
    onratechange: Object;
    onreadystatechange: Object;
    onreset: Object;
    onresize: Object;
    onscroll: Object;
    onsecuritypolicyviolation: Object;
    onseeked: Object;
    onseeking: Object;
    onselect: Object;
    onselectionchange: Object;
    onselectstart: Object;
    onslotchange: Object;
    onstalled: Object;
    onsubmit: Object;
    onsuspend: Object;
    ontimeupdate: Object;
    ontoggle: Object;
    ontouchcancel?: Object;
    ontouchend?: Object;
    ontouchmove?: Object;
    ontouchstart?: Object;
    ontransitioncancel: Object;
    ontransitionend: Object;
    ontransitionrun: Object;
    ontransitionstart: Object;
    onvisibilitychange: Object;
    onvolumechange: Object;
    onwaiting: Object;
    onwebkitanimationend: Object;
    onwebkitanimationiteration: Object;
    onwebkitanimationstart: Object;
    onwebkittransitionend: Object;
    onwheel: Object;
    ownerDocument: null;
    parentElement: HTMLElement;
    parentNode: ParentNode;
    pictureInPictureElement: Element;
    pictureInPictureEnabled: boolean;
    plugins: HTMLCollectionOf<HTMLEmbedElement>;
    pointerLockElement: Element;
    previousSibling: ChildNode;
    readyState: DocumentReadyState;
    referrer: string;
    rootElement: SVGSVGElement;
    scripts: HTMLCollectionOf<HTMLScriptElement>;
    scrollingElement: Element;
    styleSheets: StyleSheetList;
    textContent: 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): 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<K>(namespaceURI, qualifiedName): MathMLElementTagNameMap[K];
    createElementNS(namespaceURI, qualifiedName): MathMLElement;
    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): MIDIConnectionEvent;
    createEvent(eventInterface): MIDIMessageEvent;
    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): Node;
    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): 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): HTMLElement;
    getElementsByClassName(classNames): HTMLCollectionOf<Element>;
    getElementsByName(elementName): NodeListOf<HTMLElement>;
    getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementTagNameMap[K]>;
    getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<SVGElementTagNameMap[K]>;
    getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<MathMLElementTagNameMap[K]>;
    getElementsByTagName<K>(qualifiedName): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;
    getElementsByTagName(qualifiedName): HTMLCollectionOf<Element>;
    getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<HTMLElement>;
    getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<SVGElement>;
    getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf<MathMLElement>;
    getElementsByTagNameNS(namespace, localName): HTMLCollectionOf<Element>;
    getRootNode(options?): Node;
    getSelection(): 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): string;
    lookupPrefix(namespace): string;
    normalize(): void;
    open(unused1?, unused2?): Document;
    open(url, name, features): Window;
    prepend(...nodes): void;
    queryCommandEnabled(commandId): boolean;
    queryCommandIndeterm(commandId): boolean;
    queryCommandState(commandId): boolean;
    queryCommandSupported(commandId): boolean;
    queryCommandValue(commandId): string;
    querySelector<K>(selectors): HTMLElementTagNameMap[K];
    querySelector<K>(selectors): SVGElementTagNameMap[K];
    querySelector<K>(selectors): MathMLElementTagNameMap[K];
    querySelector<K>(selectors): HTMLElementDeprecatedTagNameMap[K];
    querySelector<E>(selectors): E;
    querySelectorAll<K>(selectors): NodeListOf<HTMLElementTagNameMap[K]>;
    querySelectorAll<K>(selectors): NodeListOf<SVGElementTagNameMap[K]>;
    querySelectorAll<K>(selectors): NodeListOf<MathMLElementTagNameMap[K]>;
    querySelectorAll<K>(selectors): NodeListOf<HTMLElementDeprecatedTagNameMap[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

$bindAttributes? $bindItemStart? $bindStart? $destroyListeners? 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

Methods

Properties

$bindAttributes?: AttributeBindingsMap
$bindItemStart?: RangeBinding
$bindStart?: RangeBinding
$destroyListeners?: any[]
ATTRIBUTE_NODE: 2
CDATA_SECTION_NODE: 4

node is a CDATASection node.

COMMENT_NODE: 8

node is a Comment node.

DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

DOCUMENT_NODE: 9

node is a document.

DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

DOCUMENT_POSITION_DISCONNECTED: 1

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

DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32
DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

DOCUMENT_TYPE_NODE: 10

node is a doctype.

ELEMENT_NODE: 1

node is an element.

ENTITY_NODE: 6
ENTITY_REFERENCE_NODE: 5
NOTATION_NODE: 12
PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

TEXT_NODE: 3

node is a Text node.

URL: string

Sets or gets the URL for the current document.

MDN Reference

activeElement: 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.

MDN Reference

adoptedStyleSheets: CSSStyleSheet[]
alinkColor: string

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

Deprecated

MDN Reference

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

Deprecated

MDN Reference

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

MDN Reference

Retrieves a collection of all applet objects in the document.

Deprecated

MDN Reference

baseURI: string

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

MDN Reference

bgColor: string

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

Deprecated

MDN Reference

Specifies the beginning and end of the document body.

MDN Reference

characterSet: string

Returns document's encoding.

MDN Reference

charset: string

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

Deprecated

This is a legacy alias of characterSet.

MDN Reference

childElementCount: number
childNodes: NodeListOf<ChildNode>

Returns the children.

MDN Reference

children: HTMLCollection

Returns the child elements.

MDN Reference

compatMode: string

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

MDN Reference

contentType: string

Returns document's content type.

MDN Reference

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.

MDN Reference

currentScript: 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.

MDN Reference

defaultView: Window & typeof globalThis

Returns the Window object of the active document.

MDN Reference

designMode: string

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

MDN Reference

dir: string

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

MDN Reference

doctype: DocumentType

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

MDN Reference

documentElement: HTMLElement

Gets a reference to the root node of the document.

MDN Reference

documentURI: string

Returns document's URL.

MDN Reference

domain: string

Sets or gets the security domain of the document.

Deprecated

MDN Reference

Retrieves a collection of all embed objects in the document.

MDN Reference

fgColor: string

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

Deprecated

MDN Reference

firstChild: ChildNode

Returns the first child.

MDN Reference

firstElementChild: Element

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

MDN Reference

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

MDN Reference

fullscreen: boolean

Deprecated

MDN Reference

fullscreenElement: Element

Returns document's fullscreen element.

MDN Reference

fullscreenEnabled: boolean

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

MDN Reference

Returns the head element.

MDN Reference

hidden: boolean

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

MDN Reference

implementation: DOMImplementation

Gets the implementation object of the current document.

MDN Reference

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.

MDN Reference

isConnected: boolean

Returns true if node is connected and false otherwise.

MDN Reference

lastChild: ChildNode

Returns the last child.

MDN Reference

lastElementChild: Element

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

MDN Reference

lastModified: string

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

MDN Reference

linkColor: string

Sets or gets the color of the document links.

Deprecated

MDN Reference

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

MDN Reference

nextSibling: ChildNode

Returns the next sibling.

MDN Reference

nodeName: string

Returns a string appropriate for the type of node.

MDN Reference

nodeType: number

Returns the type of node.

MDN Reference

nodeValue: string
onabort: Object

Fires when the user aborts the download.

Param: ev

The event.

MDN Reference

onanimationcancel: Object
onanimationend: Object
onanimationiteration: Object
onanimationstart: Object
onauxclick: Object
onbeforeinput: Object
onblur: Object

Fires when the object loses the input focus.

Param: ev

The focus event.

MDN Reference

oncancel: Object
oncanplay: Object

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

Param: ev

The event.

MDN Reference

oncanplaythrough: Object
onchange: Object

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

Param: ev

The event.

MDN Reference

onclick: Object

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

Param: ev

The mouse event.

MDN Reference

onclose: Object
oncontextmenu: Object

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

Param: ev

The mouse event.

MDN Reference

oncopy: Object
oncuechange: Object
oncut: Object
ondblclick: Object

Fires when the user double-clicks the object.

Param: ev

The mouse event.

MDN Reference

ondrag: Object

Fires on the source object continuously during a drag operation.

Param: ev

The event.

MDN Reference

ondragend: Object

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

Param: ev

The event.

MDN Reference

ondragenter: Object

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

Param: ev

The drag event.

MDN Reference

ondragleave: Object

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

Param: ev

The drag event.

MDN Reference

ondragover: Object

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

Param: ev

The event.

MDN Reference

ondragstart: Object

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

Param: ev

The event.

MDN Reference

ondrop: Object
ondurationchange: Object

Occurs when the duration attribute is updated.

Param: ev

The event.

MDN Reference

onemptied: Object

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

Param: ev

The event.

MDN Reference

onended: Object

Occurs when the end of playback is reached.

Param: ev

The event

MDN Reference

Fires when an error occurs during object loading.

Param: ev

The event.

MDN Reference

onfocus: Object

Fires when the object receives focus.

Param: ev

The event.

MDN Reference

onformdata: Object
onfullscreenchange: Object
onfullscreenerror: Object
ongotpointercapture: Object
oninput: Object
oninvalid: Object
onkeydown: Object

Fires when the user presses a key.

Param: ev

The keyboard event

MDN Reference

onkeypress: Object

Fires when the user presses an alphanumeric key.

Param: ev

The event.

Deprecated

MDN Reference

onkeyup: Object

Fires when the user releases a key.

Param: ev

The keyboard event

MDN Reference

onload: Object

Fires immediately after the browser loads the object.

Param: ev

The event.

MDN Reference

onloadeddata: Object

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

Param: ev

The event.

MDN Reference

onloadedmetadata: Object

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

Param: ev

The event.

MDN Reference

onloadstart: Object

Occurs when Internet Explorer begins looking for media data.

Param: ev

The event.

MDN Reference

onlostpointercapture: Object
onmousedown: Object

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

Param: ev

The mouse event.

MDN Reference

onmouseenter: Object
onmouseleave: Object
onmousemove: Object

Fires when the user moves the mouse over the object.

Param: ev

The mouse event.

MDN Reference

onmouseout: Object

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

Param: ev

The mouse event.

MDN Reference

onmouseover: Object

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

Param: ev

The mouse event.

MDN Reference

onmouseup: Object

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

Param: ev

The mouse event.

MDN Reference

onpaste: Object
onpause: Object

Occurs when playback is paused.

Param: ev

The event.

MDN Reference

onplay: Object

Occurs when the play method is requested.

Param: ev

The event.

MDN Reference

onplaying: Object

Occurs when the audio or video has started playing.

Param: ev

The event.

MDN Reference

onpointercancel: Object
onpointerdown: Object
onpointerenter: Object
onpointerleave: Object
onpointerlockchange: Object
onpointerlockerror: Object
onpointermove: Object
onpointerout: Object
onpointerover: Object
onpointerup: Object
onprogress: Object

Occurs to indicate progress while downloading media data.

Param: ev

The event.

MDN Reference

onratechange: Object

Occurs when the playback rate is increased or decreased.

Param: ev

The event.

MDN Reference

onreadystatechange: Object

Fires when the state of the object has changed.

Param: ev

The event

MDN Reference

onreset: Object

Fires when the user resets a form.

Param: ev

The event.

MDN Reference

onresize: Object
onscroll: Object

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

Param: ev

The event.

MDN Reference

onsecuritypolicyviolation: Object
onseeked: Object

Occurs when the seek operation ends.

Param: ev

The event.

MDN Reference

onseeking: Object

Occurs when the current playback position is moved.

Param: ev

The event.

MDN Reference

onselect: Object

Fires when the current selection changes.

Param: ev

The event.

MDN Reference

onselectionchange: Object
onselectstart: Object
onslotchange: Object
onstalled: Object

Occurs when the download has stopped.

Param: ev

The event.

MDN Reference

onsubmit: Object
onsuspend: Object

Occurs if the load operation has been intentionally halted.

Param: ev

The event.

MDN Reference

ontimeupdate: Object

Occurs to indicate the current playback position.

Param: ev

The event.

MDN Reference

ontoggle: Object
ontouchcancel?: Object
ontouchend?: Object
ontouchmove?: Object
ontouchstart?: Object
ontransitioncancel: Object
ontransitionend: Object
ontransitionrun: Object
ontransitionstart: Object
onvisibilitychange: Object
onvolumechange: Object

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

Param: ev

The event.

MDN Reference

onwaiting: Object

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

Param: ev

The event.

MDN Reference

onwebkitanimationend: Object

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

onwebkitanimationiteration: Object

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

onwebkitanimationstart: Object

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

onwebkittransitionend: Object

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

onwheel: Object
ownerDocument: null

Returns the node document. Returns null for documents.

MDN Reference

parentElement: HTMLElement

Returns the parent element.

MDN Reference

parentNode: ParentNode

Returns the parent.

MDN Reference

pictureInPictureElement: Element
pictureInPictureEnabled: boolean

Return an HTMLCollection of the embed elements in the Document.

MDN Reference

pointerLockElement: Element
previousSibling: ChildNode

Returns the previous sibling.

MDN Reference

readyState: DocumentReadyState

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

MDN Reference

referrer: string

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

MDN Reference

rootElement: SVGSVGElement

Deprecated

MDN Reference

Retrieves a collection of all script objects in the document.

MDN Reference

scrollingElement: Element
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.

MDN Reference

textContent: string
title: string

Contains the title of the document.

MDN Reference

visibilityState: DocumentVisibilityState
vlinkColor: string

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

Deprecated

MDN Reference

Accessors

  • get location(): Location
  • Contains information about the current URL.

    MDN Reference

    Returns Location

  • set location(href): void
  • Parameters

    Returns void

Methods

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

    MDN Reference

    Type Parameters

    Parameters

    Returns void

  • Parameters

    Returns void

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

    MDN Reference

    Type Parameters

    Parameters

    • node: T

    Returns T

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

    MDN Reference

    Parameters

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

    Returns void

  • Returns void

    Deprecated

    MDN Reference

  • Parameters

    • x: number
    • y: number

    Returns Range

    Deprecated

  • Returns void

    Deprecated

    MDN Reference

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

    MDN Reference

    Parameters

    • Optional deep: boolean

    Returns Node

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

    MDN Reference

    Returns void

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

    MDN Reference

    Parameters

    Returns number

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

    MDN Reference

    Parameters

    Returns boolean

  • Creates an attribute object with a specified name.

    Parameters

    • localName: string

    Returns Attr

  • Parameters

    • namespace: string
    • qualifiedName: string

    Returns Attr

  • Returns a CDATASection node whose data is data.

    MDN Reference

    Parameters

    • data: string

    Returns CDATASection

  • Creates a comment object with the specified data.

    Parameters

    Returns Comment

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

    MDN Reference

    Parameters

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

    Returns HTMLElement

  • Type Parameters

    Parameters

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

    Returns SVGElementTagNameMap[K]

  • Parameters

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

    Returns SVGElement

  • Type Parameters

    Parameters

    • namespaceURI: "http://www.w3.org/1998/Math/MathML"
    • qualifiedName: K

    Returns MathMLElementTagNameMap[K]

  • Parameters

    • namespaceURI: "http://www.w3.org/1998/Math/MathML"
    • qualifiedName: string

    Returns MathMLElement

  • Parameters

    Returns Element

  • Parameters

    Returns Element

  • Parameters

    • eventInterface: "AnimationEvent"

    Returns AnimationEvent

  • Parameters

    • eventInterface: "AnimationPlaybackEvent"

    Returns AnimationPlaybackEvent

  • Parameters

    • eventInterface: "AudioProcessingEvent"

    Returns AudioProcessingEvent

  • Parameters

    • eventInterface: "BeforeUnloadEvent"

    Returns BeforeUnloadEvent

  • Parameters

    • eventInterface: "BlobEvent"

    Returns BlobEvent

  • Parameters

    • eventInterface: "ClipboardEvent"

    Returns ClipboardEvent

  • Parameters

    • eventInterface: "CloseEvent"

    Returns CloseEvent

  • Parameters

    • eventInterface: "CompositionEvent"

    Returns CompositionEvent

  • Parameters

    • eventInterface: "CustomEvent"

    Returns CustomEvent<any>

  • Parameters

    • eventInterface: "DeviceMotionEvent"

    Returns DeviceMotionEvent

  • Parameters

    • eventInterface: "DeviceOrientationEvent"

    Returns DeviceOrientationEvent

  • Parameters

    • eventInterface: "DragEvent"

    Returns DragEvent

  • Parameters

    • eventInterface: "ErrorEvent"

    Returns ErrorEvent

  • Parameters

    • eventInterface: "Event"

    Returns Event

  • Parameters

    • eventInterface: "Events"

    Returns Event

  • Parameters

    • eventInterface: "FocusEvent"

    Returns FocusEvent

  • Parameters

    • eventInterface: "FontFaceSetLoadEvent"

    Returns FontFaceSetLoadEvent

  • Parameters

    • eventInterface: "FormDataEvent"

    Returns FormDataEvent

  • Parameters

    • eventInterface: "GamepadEvent"

    Returns GamepadEvent

  • Parameters

    • eventInterface: "HashChangeEvent"

    Returns HashChangeEvent

  • Parameters

    • eventInterface: "IDBVersionChangeEvent"

    Returns IDBVersionChangeEvent

  • Parameters

    • eventInterface: "InputEvent"

    Returns InputEvent

  • Parameters

    • eventInterface: "KeyboardEvent"

    Returns KeyboardEvent

  • Parameters

    • eventInterface: "MIDIConnectionEvent"

    Returns MIDIConnectionEvent

  • Parameters

    • eventInterface: "MIDIMessageEvent"

    Returns MIDIMessageEvent

  • Parameters

    • eventInterface: "MediaEncryptedEvent"

    Returns MediaEncryptedEvent

  • Parameters

    • eventInterface: "MediaKeyMessageEvent"

    Returns MediaKeyMessageEvent

  • Parameters

    • eventInterface: "MediaQueryListEvent"

    Returns MediaQueryListEvent

  • Parameters

    • eventInterface: "MediaStreamTrackEvent"

    Returns MediaStreamTrackEvent

  • Parameters

    • eventInterface: "MessageEvent"

    Returns MessageEvent<any>

  • Parameters

    • eventInterface: "MouseEvent"

    Returns MouseEvent

  • Parameters

    • eventInterface: "MouseEvents"

    Returns MouseEvent

  • Parameters

    • eventInterface: "MutationEvent"

    Returns MutationEvent

  • Parameters

    • eventInterface: "MutationEvents"

    Returns MutationEvent

  • Parameters

    • eventInterface: "OfflineAudioCompletionEvent"

    Returns OfflineAudioCompletionEvent

  • Parameters

    • eventInterface: "PageTransitionEvent"

    Returns PageTransitionEvent

  • Parameters

    • eventInterface: "PaymentMethodChangeEvent"

    Returns PaymentMethodChangeEvent

  • Parameters

    • eventInterface: "PaymentRequestUpdateEvent"

    Returns PaymentRequestUpdateEvent

  • Parameters

    • eventInterface: "PictureInPictureEvent"

    Returns PictureInPictureEvent

  • Parameters

    • eventInterface: "PointerEvent"

    Returns PointerEvent

  • Parameters

    • eventInterface: "PopStateEvent"

    Returns PopStateEvent

  • Parameters

    • eventInterface: "ProgressEvent"

    Returns ProgressEvent<EventTarget>

  • Parameters

    • eventInterface: "PromiseRejectionEvent"

    Returns PromiseRejectionEvent

  • Parameters

    • eventInterface: "RTCDTMFToneChangeEvent"

    Returns RTCDTMFToneChangeEvent

  • Parameters

    • eventInterface: "RTCDataChannelEvent"

    Returns RTCDataChannelEvent

  • Parameters

    • eventInterface: "RTCErrorEvent"

    Returns RTCErrorEvent

  • Parameters

    • eventInterface: "RTCPeerConnectionIceErrorEvent"

    Returns RTCPeerConnectionIceErrorEvent

  • Parameters

    • eventInterface: "RTCPeerConnectionIceEvent"

    Returns RTCPeerConnectionIceEvent

  • Parameters

    • eventInterface: "RTCTrackEvent"

    Returns RTCTrackEvent

  • Parameters

    • eventInterface: "SecurityPolicyViolationEvent"

    Returns SecurityPolicyViolationEvent

  • Parameters

    • eventInterface: "SpeechSynthesisErrorEvent"

    Returns SpeechSynthesisErrorEvent

  • Parameters

    • eventInterface: "SpeechSynthesisEvent"

    Returns SpeechSynthesisEvent

  • Parameters

    • eventInterface: "StorageEvent"

    Returns StorageEvent

  • Parameters

    • eventInterface: "SubmitEvent"

    Returns SubmitEvent

  • Parameters

    • eventInterface: "TouchEvent"

    Returns TouchEvent

  • Parameters

    • eventInterface: "TrackEvent"

    Returns TrackEvent

  • Parameters

    • eventInterface: "TransitionEvent"

    Returns TransitionEvent

  • Parameters

    • eventInterface: "UIEvent"

    Returns UIEvent

  • Parameters

    • eventInterface: "UIEvents"

    Returns UIEvent

  • Parameters

    • eventInterface: "WebGLContextEvent"

    Returns WebGLContextEvent

  • Parameters

    • eventInterface: "WheelEvent"

    Returns WheelEvent

  • Parameters

    • eventInterface: string

    Returns Event

  • 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: NodeFilter

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

      MDN Reference

    Returns NodeIterator

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

    MDN Reference

    Parameters

    • target: string
    • data: string

    Returns ProcessingInstruction

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

    MDN Reference

    Returns Range

  • Creates a text string from the specified value.

    Parameters

    • data: string

      String that specifies the nodeValue property of the text node.

      MDN Reference

    Returns Text

  • 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: NodeFilter

      A custom NodeFilter function to use.

      MDN Reference

    Returns TreeWalker

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

    MDN Reference

    Parameters

    Returns boolean

  • 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 Element

  • 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

    MDN Reference

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

    MDN Reference

    Returns Promise<void>

  • Returns void

  • 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 HTMLElement

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

    MDN Reference

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

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

      MDN Reference

    Returns NodeListOf<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.

    MDN Reference

    Parameters

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

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

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

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/1998/Math/MathML"
    • localName: string

    Returns HTMLCollectionOf<MathMLElement>

  • Parameters

    • namespace: string
    • localName: string

    Returns HTMLCollectionOf<Element>

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

    MDN Reference

    Returns Selection

  • Returns whether node has children.

    MDN Reference

    Returns boolean

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

    MDN Reference

    Returns boolean

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

    MDN Reference

    Type Parameters

    Parameters

    • node: T
    • Optional deep: boolean

    Returns T

  • Returns whether node and otherNode have the same properties.

    MDN Reference

    Parameters

    Returns boolean

  • Parameters

    • namespace: string

    Returns string

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

    MDN Reference

    Returns void

  • 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

  • Parameters

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

    Returns Window

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

    MDN Reference

    Parameters

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

    Returns void

  • 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

    MDN Reference

  • 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

    MDN Reference

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

    Parameters

    • commandId: string

      String that specifies a command identifier.

    Returns boolean

    Deprecated

    MDN Reference

  • 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

    MDN Reference

  • 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

    MDN Reference

  • Returns void

    Deprecated

    MDN Reference

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

    MDN Reference

    Parameters

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

    Returns void

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

    Parameters

    • Rest ...text: string[]

    Returns 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