Window extension type

The Window interface represents a window containing a document; the document property points to the DOM document loaded in that window.

A window for a given document can be obtained using the document.defaultView property.

A global variable, window, representing the window in which the script is running, is exposed to JavaScript code.

The Window interface is home to a variety of functions, namespaces, objects, and constructors which are not necessarily directly associated with the concept of a user interface window. However, the Window interface is a suitable place to include these items that need to be globally available. Many of these are documented in the JavaScript Reference and the DOM Reference.

In a tabbed browser, each tab is represented by its own Window object; the global window seen by JavaScript code running within a given tab always represents the tab in which the code is running. That said, even in a tabbed browser, some properties and methods still apply to the overall window that contains the tab, such as Window.resizeTo and Window.innerHeight. Generally, anything that can't reasonably pertain to a tab pertains to the window instead.

on

• JSObject

Implemented types

• EventTarget
• JSObject

Properties

caches → CacheStorage

no setter

clientInformation → Navigator

no setter

closed → bool

no setter

crossOriginIsolated → bool

no setter

crypto → Crypto

no setter

customElements → CustomElementRegistry

no setter

devicePixelRatio → num

no setter

document → Document

no setter

event → Event?

no setter

external → External

no setter

frameElement → Element?

no setter

frames → Window

no setter

hashCode → int

The hash code for this object.

no setter, inherited

history → History

no setter

indexedDB → IDBFactory

no setter

innerHeight → int

no setter

innerWidth → int

no setter

isSecureContext → bool

no setter

length → int

no setter

localStorage → Storage

no setter

location → Location

no setter

locationbar → BarProp

no setter

menubar → BarProp

no setter

name ↔ String

getter/setter pair

navigation → Navigation

no setter

navigator → Navigator

no setter

onabort ↔ EventHandler?

getter/setter pair

onafterprint ↔ EventHandler?

getter/setter pair

onanimationcancel ↔ EventHandler?

getter/setter pair

onanimationend ↔ EventHandler?

getter/setter pair

onanimationiteration ↔ EventHandler?

getter/setter pair

onanimationstart ↔ EventHandler?

getter/setter pair

onauxclick ↔ EventHandler?

getter/setter pair

onbeforeinput ↔ EventHandler?

getter/setter pair

onbeforematch ↔ EventHandler?

getter/setter pair

onbeforeprint ↔ EventHandler?

getter/setter pair

onbeforetoggle ↔ EventHandler?

getter/setter pair

onbeforeunload ↔ OnBeforeUnloadEventHandler?

getter/setter pair

onblur ↔ EventHandler?

getter/setter pair

oncancel ↔ EventHandler?

getter/setter pair

oncanplay ↔ EventHandler?

getter/setter pair

oncanplaythrough ↔ EventHandler?

getter/setter pair

onchange ↔ EventHandler?

getter/setter pair

onclick ↔ EventHandler?

getter/setter pair

onclose ↔ EventHandler?

getter/setter pair

oncontextlost ↔ EventHandler?

getter/setter pair

oncontextmenu ↔ EventHandler?

getter/setter pair

oncontextrestored ↔ EventHandler?

getter/setter pair

oncopy ↔ EventHandler?

getter/setter pair

oncuechange ↔ EventHandler?

getter/setter pair

oncut ↔ EventHandler?

getter/setter pair

ondblclick ↔ EventHandler?

getter/setter pair

ondevicemotion ↔ EventHandler?

getter/setter pair

ondeviceorientation ↔ EventHandler?

getter/setter pair

ondeviceorientationabsolute ↔ EventHandler?

getter/setter pair

ondrag ↔ EventHandler?

getter/setter pair

ondragend ↔ EventHandler?

getter/setter pair

ondragenter ↔ EventHandler?

getter/setter pair

ondragleave ↔ EventHandler?

getter/setter pair

ondragover ↔ EventHandler?

getter/setter pair

ondragstart ↔ EventHandler?

getter/setter pair

ondrop ↔ EventHandler?

getter/setter pair

ondurationchange ↔ EventHandler?

getter/setter pair

onemptied ↔ EventHandler?

getter/setter pair

onended ↔ EventHandler?

getter/setter pair

onerror ↔ OnErrorEventHandler?

getter/setter pair

onfocus ↔ EventHandler?

getter/setter pair

onformdata ↔ EventHandler?

getter/setter pair

ongamepadconnected ↔ EventHandler?

getter/setter pair

ongamepaddisconnected ↔ EventHandler?

getter/setter pair

ongotpointercapture ↔ EventHandler?

getter/setter pair

onhashchange ↔ EventHandler?

getter/setter pair

oninput ↔ EventHandler?

getter/setter pair

oninvalid ↔ EventHandler?

getter/setter pair

onkeydown ↔ EventHandler?

getter/setter pair

onkeypress ↔ EventHandler?

getter/setter pair

onkeyup ↔ EventHandler?

getter/setter pair

onlanguagechange ↔ EventHandler?

getter/setter pair

onload ↔ EventHandler?

getter/setter pair

onloadeddata ↔ EventHandler?

getter/setter pair

onloadedmetadata ↔ EventHandler?

getter/setter pair

onloadstart ↔ EventHandler?

getter/setter pair

onlostpointercapture ↔ EventHandler?

getter/setter pair

onmessage ↔ EventHandler?

getter/setter pair

onmessageerror ↔ EventHandler?

getter/setter pair

onmousedown ↔ EventHandler?

getter/setter pair

onmouseenter ↔ EventHandler?

getter/setter pair

onmouseleave ↔ EventHandler?

getter/setter pair

onmousemove ↔ EventHandler?

getter/setter pair

onmouseout ↔ EventHandler?

getter/setter pair

onmouseover ↔ EventHandler?

getter/setter pair

onmouseup ↔ EventHandler?

getter/setter pair

onoffline ↔ EventHandler?

getter/setter pair

ononline ↔ EventHandler?

getter/setter pair

onpagehide ↔ EventHandler?

getter/setter pair

onpagereveal ↔ EventHandler?

getter/setter pair

onpageshow ↔ EventHandler?

getter/setter pair

onpaste ↔ EventHandler?

getter/setter pair

onpause ↔ EventHandler?

getter/setter pair

onplay ↔ EventHandler?

getter/setter pair

onplaying ↔ EventHandler?

getter/setter pair

onpointercancel ↔ EventHandler?

getter/setter pair

onpointerdown ↔ EventHandler?

getter/setter pair

onpointerenter ↔ EventHandler?

getter/setter pair

onpointerleave ↔ EventHandler?

getter/setter pair

onpointermove ↔ EventHandler?

getter/setter pair

onpointerout ↔ EventHandler?

getter/setter pair

onpointerover ↔ EventHandler?

getter/setter pair

onpointerrawupdate ↔ EventHandler?

getter/setter pair

onpointerup ↔ EventHandler?

getter/setter pair

onpopstate ↔ EventHandler?

getter/setter pair

onprogress ↔ EventHandler?

getter/setter pair

onratechange ↔ EventHandler?

getter/setter pair

onrejectionhandled ↔ EventHandler?

getter/setter pair

onreset ↔ EventHandler?

getter/setter pair

onresize ↔ EventHandler?

getter/setter pair

onscroll ↔ EventHandler?

getter/setter pair

onscrollend ↔ EventHandler?

getter/setter pair

onsecuritypolicyviolation ↔ EventHandler?

getter/setter pair

onseeked ↔ EventHandler?

getter/setter pair

onseeking ↔ EventHandler?

getter/setter pair

onselect ↔ EventHandler?

getter/setter pair

onselectionchange ↔ EventHandler?

getter/setter pair

onselectstart ↔ EventHandler?

getter/setter pair

onslotchange ↔ EventHandler?

getter/setter pair

onstalled ↔ EventHandler?

getter/setter pair

onstorage ↔ EventHandler?

getter/setter pair

onsubmit ↔ EventHandler?

getter/setter pair

onsuspend ↔ EventHandler?

getter/setter pair

ontimeupdate ↔ EventHandler?

getter/setter pair

ontoggle ↔ EventHandler?

getter/setter pair

ontouchcancel ↔ EventHandler?

getter/setter pair

ontouchend ↔ EventHandler?

getter/setter pair

ontouchmove ↔ EventHandler?

getter/setter pair

ontouchstart ↔ EventHandler?

getter/setter pair

ontransitioncancel ↔ EventHandler?

getter/setter pair

ontransitionend ↔ EventHandler?

getter/setter pair

ontransitionrun ↔ EventHandler?

getter/setter pair

ontransitionstart ↔ EventHandler?

getter/setter pair

onunhandledrejection ↔ EventHandler?

getter/setter pair

onunload ↔ EventHandler?

getter/setter pair

onvolumechange ↔ EventHandler?

getter/setter pair

onwaiting ↔ EventHandler?

getter/setter pair

onwebkitanimationend ↔ EventHandler?

getter/setter pair

onwebkitanimationiteration ↔ EventHandler?

getter/setter pair

onwebkitanimationstart ↔ EventHandler?

getter/setter pair

onwebkittransitionend ↔ EventHandler?

getter/setter pair

onwheel ↔ EventHandler?

getter/setter pair

opener ↔ JSAny?

getter/setter pair

origin → String

no setter

originAgentCluster → bool

no setter

outerHeight → int

no setter

outerWidth → int

no setter

pageXOffset → num

no setter

pageYOffset → num

no setter

parent → Window?

no setter

performance → Performance

no setter

personalbar → BarProp

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

screen → Screen

no setter

screenLeft → int

no setter

screenTop → int

no setter

screenX → int

no setter

screenY → int

no setter

scrollbars → BarProp

no setter

scrollX → num

no setter

scrollY → num

no setter

self → Window

no setter

sessionStorage → Storage

no setter

speechSynthesis → SpeechSynthesis

no setter

status ↔ String

getter/setter pair

statusbar → BarProp

no setter

toolbar → BarProp

no setter

top → Window?

no setter

trustedTypes → TrustedTypePolicyFactory

no setter

visualViewport → VisualViewport?

no setter

window → Window

no setter

Methods

addEventListener(String type, EventListener? callback, [JSAny options]) → void

The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

inherited

alert([String message]) → void

window.alert() instructs the browser to display a dialog with an optional message, and to wait until the user dismisses the dialog.

atob(String data) → String

blur() → void

The Window.blur() method does nothing.

btoa(String data) → String

cancelAnimationFrame(int handle) → void

The window.cancelAnimationFrame() method cancels an animation frame request previously scheduled through a call to window.requestAnimationFrame.

captureEvents() → void

The Window.captureEvents() method does nothing.

clearInterval([int id]) → void

clearTimeout([int id]) → void

close() → void

The Window.close() method closes the current window, or the window on which it was called.

confirm([String message]) → bool

window.confirm() instructs the browser to display a dialog with an optional message, and to wait until the user either confirms or cancels the dialog.

createImageBitmap(ImageBitmapSource image, [JSAny optionsOrSx, int sy, int sw, int sh, ImageBitmapOptions options]) → JSPromise<ImageBitmap>

dispatchEvent(Event event) → bool

The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

inherited

fetch(RequestInfo input, [RequestInit init]) → JSPromise<Response>

focus() → void

Makes a request to bring the window to the front. It may fail due to user settings and the window isn't guaranteed to be frontmost before this method returns.

getComputedStyle(Element elt, [String? pseudoElt]) → CSSStyleDeclaration

The Window.getComputedStyle() method returns an object containing the values of all CSS properties of an element, after applying active stylesheets and resolving any basic computation those values may contain.

getSelection() → Selection?

The Window.getSelection() method returns a Selection object representing the range of text selected by the user or the current position of the caret.

matchMedia(String query) → MediaQueryList

The Window interface's matchMedia() method returns a new MediaQueryList object that can then be used to determine if the document matches the media query string, as well as to monitor the document to detect when it matches (or stops matching) that media query.

moveBy(int x, int y) → void

The moveBy() method of the Window interface moves the current window by a specified amount.

moveTo(int x, int y) → void

The moveTo() method of the Window interface moves the current window to the specified coordinates.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

open([String url, String target, String features]) → Window?

The open() method of the Window interface loads a specified resource into a new or existing browsing context (that is, a tab, a window, or an iframe) under a specified name.

postMessage(JSAny? message, [JSAny optionsOrTargetOrigin, JSArray<JSObject> transfer]) → void

The window.postMessage() method safely enables cross-origin communication between Window objects; e.g., between a page and a pop-up that it spawned, or between a page and an iframe embedded within it.

print() → void

Opens the print dialog to print the current document.

prompt([String message, String default_]) → String?

window.prompt() instructs the browser to display a dialog with an optional message prompting the user to input some text, and to wait until the user either submits the text or cancels the dialog.

queueMicrotask(VoidFunction callback) → void

releaseEvents() → void

Releases the window from trapping events of a specific type.

removeEventListener(String type, EventListener? callback, [JSAny options]) → void

The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener from the target. The event listener to be removed is identified using a combination of the event type, the event listener function itself, and various optional options that may affect the matching process; see Matching event listeners for removal.

inherited

reportError(JSAny? e) → void

requestAnimationFrame(FrameRequestCallback callback) → int

The window.requestAnimationFrame() method tells the browser you wish to perform an animation. It requests the browser to call a user-supplied callback function before the next repaint.

resizeBy(int x, int y) → void

The Window.resizeBy() method resizes the current window by a specified amount.

resizeTo(int width, int height) → void

The Window.resizeTo() method dynamically resizes the window.

scroll([JSAny optionsOrX, num y]) → void

The Window.scroll() method scrolls the window to a particular place in the document.

scrollBy([JSAny optionsOrX, num y]) → void

The Window.scrollBy() method scrolls the document in the window by the given amount.

scrollTo([JSAny optionsOrX, num y]) → void

Window.scrollTo() scrolls to a particular set of coordinates in the document.

setInterval(TimerHandler handler, JSAny? arguments, [int timeout]) → int

setTimeout(TimerHandler handler, JSAny? arguments, [int timeout]) → int

stop() → void

The window.stop() stops further resource loading in the current browsing context, equivalent to the stop button in the browser.

structuredClone(JSAny? value, [StructuredSerializeOptions options]) → JSAny?

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited