Interface Window

A window containing a DOM document; the document property points to the DOM document loaded in that window.

MDN Reference

interface Window {
    caches: CacheStorage;
    clientInformation: Navigator;
    closed: boolean;
    crossOriginIsolated: boolean;
    crypto: Crypto;
    customElements: CustomElementRegistry;
    devicePixelRatio: number;
    document: Document;
    event: undefined | Event;
    external: External;
    frameElement: null | Element;
    frames: Window;
    history: History;
    indexedDB: IDBFactory;
    innerHeight: number;
    innerWidth: number;
    isSecureContext: boolean;
    length: number;
    localStorage: Storage;
    locationbar: BarProp;
    menubar: BarProp;
    name: string;
    navigation: Navigation;
    navigator: Navigator;
    onabort: null | ((this, ev) => any);
    onafterprint: 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);
    onbeforeprint: null | ((this, ev) => any);
    onbeforeunload: 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);
    ondevicemotion: null | ((this, ev) => any);
    ondeviceorientation: 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);
    ongamepadconnected: null | ((this, ev) => any);
    ongamepaddisconnected: null | ((this, ev) => any);
    ongotpointercapture: null | ((this, ev) => any);
    onhashchange: 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);
    onlanguagechange: 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);
    onmessage: null | ((this, ev) => any);
    onmessageerror: 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);
    onoffline: null | ((this, ev) => any);
    ononline: null | ((this, ev) => any);
    onorientationchange: null | ((this, ev) => any);
    onpagehide: null | ((this, ev) => any);
    onpageshow: null | ((this, ev) => any);
    onpaste: null | ((this, ev) => any);
    onpause: null | ((this, ev) => any);
    onplay: null | ((this, ev) => any);
    onplaying: null | ((this, ev) => any);
    onpointercancel: null | ((this, ev) => any);
    onpointerdown: null | ((this, ev) => any);
    onpointerenter: null | ((this, ev) => any);
    onpointerleave: null | ((this, ev) => any);
    onpointermove: null | ((this, ev) => any);
    onpointerout: null | ((this, ev) => any);
    onpointerover: null | ((this, ev) => any);
    onpointerup: null | ((this, ev) => any);
    onpopstate: null | ((this, ev) => any);
    onprogress: null | ((this, ev) => any);
    onratechange: null | ((this, ev) => any);
    onrejectionhandled: null | ((this, ev) => any);
    onreset: null | ((this, ev) => any);
    onresize: null | ((this, ev) => any);
    onscroll: null | ((this, ev) => any);
    onscrollend: 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);
    onstorage: 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);
    onunhandledrejection: null | ((this, ev) => any);
    onunload: 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);
    opener: any;
    orientation: number;
    origin: string;
    outerHeight: number;
    outerWidth: number;
    pageXOffset: number;
    pageYOffset: number;
    parent: Window;
    performance: Performance;
    personalbar: BarProp;
    screen: Screen;
    screenLeft: number;
    screenTop: number;
    screenX: number;
    screenY: number;
    scrollX: number;
    scrollY: number;
    scrollbars: BarProp;
    self: Window & typeof globalThis;
    sessionStorage: Storage;
    speechSynthesis: SpeechSynthesis;
    status: string;
    statusbar: BarProp;
    toolbar: BarProp;
    top: null | Window;
    visualViewport: null | VisualViewport;
    window: Window & typeof globalThis;
    location: Location;
    addEventListener<K>(type, listener, options?): void;
    addEventListener(type, listener, options?): void;
    alert(message?): void;
    atob(data): string;
    blur(): void;
    btoa(data): string;
    cancelAnimationFrame(handle): void;
    cancelIdleCallback(handle): void;
    captureEvents(): void;
    clearInterval(id): void;
    clearTimeout(id): void;
    close(): void;
    confirm(message?): boolean;
    createImageBitmap(image, options?): Promise<ImageBitmap>;
    createImageBitmap(image, sx, sy, sw, sh, options?): Promise<ImageBitmap>;
    dispatchEvent(event): boolean;
    fetch(input, init?): Promise<Response>;
    focus(): void;
    getComputedStyle(elt, pseudoElt?): CSSStyleDeclaration;
    getSelection(): null | Selection;
    matchMedia(query): MediaQueryList;
    moveBy(x, y): void;
    moveTo(x, y): void;
    open(url?, target?, features?): null | Window;
    postMessage(message, targetOrigin, transfer?): void;
    postMessage(message, options?): void;
    print(): void;
    prompt(message?, _default?): null | string;
    queueMicrotask(callback): void;
    releaseEvents(): void;
    removeEventListener<K>(type, listener, options?): void;
    removeEventListener(type, listener, options?): void;
    reportError(e): void;
    requestAnimationFrame(callback): number;
    requestIdleCallback(callback, options?): number;
    resizeBy(x, y): void;
    resizeTo(width, height): void;
    scroll(options?): void;
    scroll(x, y): void;
    scrollBy(options?): void;
    scrollBy(x, y): void;
    scrollTo(options?): void;
    scrollTo(x, y): void;
    setInterval(handler, timeout?, ...arguments): number;
    setTimeout(handler, timeout?, ...arguments): number;
    stop(): void;
    structuredClone<T>(value, options?): T;
    [index: number]: Window;
}

Hierarchy

  • EventTarget
  • AnimationFrameProvider
  • GlobalEventHandlers
  • WindowEventHandlers
  • WindowLocalStorage
  • WindowOrWorkerGlobalScope
  • WindowSessionStorage
    • Window

Indexable

[index: number]: Window

Properties

caches clientInformation closed crossOriginIsolated crypto customElements devicePixelRatio document event external frameElement frames history indexedDB innerHeight innerWidth isSecureContext length localStorage locationbar menubar name navigation navigator onabort onafterprint onanimationcancel onanimationend onanimationiteration onanimationstart onauxclick onbeforeinput onbeforeprint onbeforeunload onblur oncancel oncanplay oncanplaythrough onchange onclick onclose oncontextmenu oncopy oncuechange oncut ondblclick ondevicemotion ondeviceorientation ondrag ondragend ondragenter ondragleave ondragover ondragstart ondrop ondurationchange onemptied onended onerror onfocus onformdata ongamepadconnected ongamepaddisconnected ongotpointercapture onhashchange oninput oninvalid onkeydown onkeypress onkeyup onlanguagechange onload onloadeddata onloadedmetadata onloadstart onlostpointercapture onmessage onmessageerror onmousedown onmouseenter onmouseleave onmousemove onmouseout onmouseover onmouseup onoffline ononline onorientationchange onpagehide onpageshow onpaste onpause onplay onplaying onpointercancel onpointerdown onpointerenter onpointerleave onpointermove onpointerout onpointerover onpointerup onpopstate onprogress onratechange onrejectionhandled onreset onresize onscroll onscrollend onsecuritypolicyviolation onseeked onseeking onselect onselectionchange onselectstart onslotchange onstalled onstorage onsubmit onsuspend ontimeupdate ontoggle ontouchcancel? ontouchend? ontouchmove? ontouchstart? ontransitioncancel ontransitionend ontransitionrun ontransitionstart onunhandledrejection onunload onvolumechange onwaiting onwebkitanimationend onwebkitanimationiteration onwebkitanimationstart onwebkittransitionend onwheel opener orientation origin outerHeight outerWidth pageXOffset pageYOffset parent performance personalbar screen screenLeft screenTop screenX screenY scrollX scrollY scrollbars self sessionStorage speechSynthesis status statusbar toolbar top visualViewport window

Accessors

Methods

Properties

caches: CacheStorage

Available only in secure contexts.

MDN Reference

clientInformation: Navigator

Deprecated

This is a legacy alias of navigator.

MDN Reference

closed: boolean

Returns true if the window has been closed, false otherwise.

MDN Reference

crossOriginIsolated: boolean
crypto: Crypto
customElements: CustomElementRegistry

Defines a new custom element, mapping the given name to the given constructor as an autonomous custom element.

MDN Reference

devicePixelRatio: number
document: Document
event: undefined | Event

Deprecated

MDN Reference

external: External

Deprecated

MDN Reference

frameElement: null | Element
frames: Window
history: History
indexedDB: IDBFactory
innerHeight: number
innerWidth: number
isSecureContext: boolean
length: number
localStorage: Storage
locationbar: BarProp

Returns true if the location bar is visible; otherwise, returns false.

MDN Reference

menubar: BarProp

Returns true if the menu bar is visible; otherwise, returns false.

MDN Reference

name: string
navigation: Navigation
navigator: Navigator
onabort: null | ((this, ev) => any)

Fires when the user aborts the download.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: AnimationEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: InputEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: BeforeUnloadEvent

      Returns any

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

Fires when the object loses the input focus.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

      Returns any

Param: ev

The focus event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

Param: ev

The mouse event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

Param: ev

The mouse event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

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

Fires when the user double-clicks the object.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

Param: ev

The mouse event.

MDN Reference

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

Available only in secure contexts.

MDN Reference

Type declaration

    • (this, ev): any
    • Parameters

      • this: Window
      • ev: DeviceMotionEvent

      Returns any

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

Available only in secure contexts.

MDN Reference

Type declaration

    • (this, ev): any
    • Parameters

      • this: Window
      • ev: DeviceOrientationEvent

      Returns any

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

Fires on the source object continuously during a drag operation.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

Param: ev

The event.

MDN Reference

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

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

Param: ev

The event.

MDN Reference

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

Param: ev

The drag event.

MDN Reference

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

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

Param: ev

The drag event.

MDN Reference

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

Param: ev

The event.

MDN Reference

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: DragEvent

      Returns any

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

Occurs when the duration attribute is updated.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Occurs when the end of playback is reached.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event

MDN Reference

onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

Param: ev

The event.

MDN Reference

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

Fires when the object receives focus.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: FocusEvent

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: FormDataEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: GamepadEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: GamepadEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: HashChangeEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Fires when the user presses a key.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

      Returns any

Param: ev

The keyboard event

MDN Reference

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

Fires when the user presses an alphanumeric key.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

      Returns any

Param: ev

The event.

Deprecated

MDN Reference

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

Fires when the user releases a key.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: KeyboardEvent

      Returns any

Param: ev

The keyboard event

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

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

Fires immediately after the browser loads the object.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Occurs when Internet Explorer begins looking for media data.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: MessageEvent<any>

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: MessageEvent<any>

      Returns any

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

Param: ev

The mouse event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

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

Fires when the user moves the mouse over the object.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

Param: ev

The mouse event.

MDN Reference

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

Param: ev

The mouse event.

MDN Reference

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

Param: ev

The mouse event.

MDN Reference

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: MouseEvent

      Returns any

Param: ev

The mouse event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      Returns any

Deprecated

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: PageTransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: PageTransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ClipboardEvent

      Returns any

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

Occurs when playback is paused.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Occurs when the play method is requested.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Occurs when the audio or video has started playing.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: PointerEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: PopStateEvent

      Returns any

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

Occurs to indicate progress while downloading media data.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: ProgressEvent<EventTarget>

      Returns any

Param: ev

The event.

MDN Reference

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

Occurs when the playback rate is increased or decreased.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: PromiseRejectionEvent

      Returns any

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

Fires when the user resets a form.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: UIEvent

      Returns any

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: SecurityPolicyViolationEvent

      Returns any

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

Occurs when the seek operation ends.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Occurs when the current playback position is moved.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Fires when the current selection changes.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Occurs when the download has stopped.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: StorageEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: SubmitEvent

      Returns any

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

Occurs if the load operation has been intentionally halted.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Occurs to indicate the current playback position.

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TouchEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: TransitionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: PromiseRejectionEvent

      Returns any

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: WindowEventHandlers
      • ev: Event

      Returns any

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Param: ev

The event.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationend.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationiteration.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of onanimationstart.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: Event

      Returns any

Deprecated

This is a legacy alias of ontransitionend.

MDN Reference

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

Type declaration

    • (this, ev): any
    • Parameters

      • this: GlobalEventHandlers
      • ev: WheelEvent

      Returns any

opener: any
orientation: number

Deprecated

MDN Reference

origin: string
outerHeight: number
outerWidth: number
pageXOffset: number

Deprecated

This is a legacy alias of scrollX.

MDN Reference

pageYOffset: number

Deprecated

This is a legacy alias of scrollY.

MDN Reference

parent: Window

Refers to either the parent WindowProxy, or itself.

It can rarely be null e.g. for contentWindow of an iframe that is already removed from the parent.

MDN Reference

performance: Performance
personalbar: BarProp

Returns true if the personal bar is visible; otherwise, returns false.

MDN Reference

screen: Screen
screenLeft: number
screenTop: number
screenX: number
screenY: number
scrollX: number
scrollY: number
scrollbars: BarProp

Returns true if the scrollbars are visible; otherwise, returns false.

MDN Reference

self: Window & typeof globalThis
sessionStorage: Storage
speechSynthesis: SpeechSynthesis
status: string

Deprecated

MDN Reference

statusbar: BarProp

Returns true if the status bar is visible; otherwise, returns false.

MDN Reference

toolbar: BarProp

Returns true if the toolbar is visible; otherwise, returns false.

MDN Reference

top: null | Window
visualViewport: null | VisualViewport
window: Window & typeof globalThis

Accessors

  • get location(): Location
  • Returns Location

  • set location(href): void
  • Parameters

    • href: string | Location

    Returns void

Methods

  • Type Parameters

    • K extends keyof WindowEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any
        • Parameters

          • this: Window
          • ev: WindowEventMap[K]

          Returns any

    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    • Optional message: any

    Returns void

  • Parameters

    • data: string

    Returns string

  • Returns void

  • Parameters

    • data: string

    Returns string

  • Parameters

    • handle: number

    Returns void

  • Parameters

    • handle: number

    Returns void

  • Returns void

    Deprecated

    MDN Reference

  • Parameters

    • id: undefined | number

    Returns void

  • Parameters

    • id: undefined | number

    Returns void

  • Closes the window.

    MDN Reference

    Returns void

  • Parameters

    • Optional message: string

    Returns boolean

  • Parameters

    • image: ImageBitmapSource
    • Optional options: ImageBitmapOptions

    Returns Promise<ImageBitmap>

  • Parameters

    • image: ImageBitmapSource
    • sx: number
    • sy: number
    • sw: number
    • sh: number
    • Optional options: ImageBitmapOptions

    Returns Promise<ImageBitmap>

  • 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

    • event: Event

    Returns boolean

  • Parameters

    • input: URL | RequestInfo
    • Optional init: RequestInit

    Returns Promise<Response>

  • Moves the focus to the window's browsing context, if any.

    MDN Reference

    Returns void

  • Parameters

    • elt: Element
    • Optional pseudoElt: null | string

    Returns CSSStyleDeclaration

  • Returns null | Selection

  • Parameters

    • query: string

    Returns MediaQueryList

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optional url: string | URL
    • Optional target: string
    • Optional features: string

    Returns null | Window

  • Posts a message to the given window. Messages can be structured objects, e.g. nested objects and arrays, can contain JavaScript values (strings, numbers, Date objects, etc), and can contain certain data objects such as File Blob, FileList, and ArrayBuffer objects.

    Objects listed in the transfer member of options are transferred, not just cloned, meaning that they are no longer usable on the sending side.

    A target origin can be specified using the targetOrigin member of options. If not provided, it defaults to "/". This default restricts the message to same-origin targets only.

    If the origin of the target window doesn't match the given target origin, the message is discarded, to avoid information leakage. To send the message to the target regardless of origin, set the target origin to "*".

    Throws a "DataCloneError" DOMException if transfer array contains duplicate objects or if message could not be cloned.

    MDN Reference

    Parameters

    • message: any
    • targetOrigin: string
    • Optional transfer: Transferable[]

    Returns void

  • Parameters

    • message: any
    • Optional options: WindowPostMessageOptions

    Returns void

  • Returns void

  • Parameters

    • Optional message: string
    • Optional _default: string

    Returns null | string

  • Parameters

    • callback: VoidFunction

    Returns void

  • Returns void

    Deprecated

    MDN Reference

  • Type Parameters

    • K extends keyof WindowEventMap

    Parameters

    • type: K
    • listener: ((this, ev) => any)
        • (this, ev): any
        • Parameters

          • this: Window
          • ev: WindowEventMap[K]

          Returns any

    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

  • Parameters

    • e: any

    Returns void

  • Parameters

    • callback: FrameRequestCallback

    Returns number

  • Parameters

    • callback: IdleRequestCallback
    • Optional options: IdleRequestOptions

    Returns number

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • width: number
    • height: number

    Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optional options: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • handler: TimerHandler
    • Optional timeout: number
    • Rest ...arguments: any[]

    Returns number

  • Parameters

    • handler: TimerHandler
    • Optional timeout: number
    • Rest ...arguments: any[]

    Returns number

  • Cancels the document load.

    MDN Reference

    Returns void

  • Type Parameters

    • T = any

    Parameters

    • value: T
    • Optional options: StructuredSerializeOptions

    Returns T

Generated using TypeDoc