Window

package js.html

extends EventTarget

Available on js

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

Documentation Window by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See:

https://developer.mozilla.org/en-US/docs/Web/API/Window

Variables

read only closed:Bool

This property indicates whether the current window is closed or not.

read only console:Console

Returns a reference to the console object which provides access to the browser's debugging console.

read only content:Dynamic

Returns a reference to the content element in the current window. The obsolete variant with underscore is no longer available from Web content.

read only crypto:Crypto

Returns the browser crypto object.

read only devicePixelRatio:Float

Returns the ratio between physical pixels and device independent pixels in the current display.

read only document:HTMLDocument

Returns a reference to the document that the window contains.

read only frameElement:Element

Returns the element in which the window is embedded, or null if the window is not embedded.

read only frames:Window

Returns an array of the subframes in the current window.

fullScreen:Bool

This property indicates whether the window is displayed in full screen or not.

read only history:History

Returns a reference to the history object.

read only indexedDB:Factory

innerHeight:Dynamic

Gets the height of the content area of the browser window including, if rendered, the horizontal scrollbar.

innerWidth:Dynamic

Gets the width of the content area of the browser window including, if rendered, the vertical scrollbar.

read only length:Int

Returns the number of frames in the window. See also window.frames.

read only localStorage:Storage

Returns a reference to the local storage object used to store data that may only be accessed by the origin that created it.

read only location:Location

Gets/sets the location, or current URL, of the window object.

read only locationbar:BarProp

Returns the locationbar object, whose visibility can be toggled in the window.

read only menubar:BarProp

Returns the menubar object, whose visibility can be toggled in the window.

name:String

Gets/sets the name of the window.

read only navigator:Navigator

Returns a reference to the navigator object.

onabort:Function

onabsolutedeviceorientation:Function

onafterprint:Function

onbeforeprint:Function

onblur:Function

oncanplay:Function

oncanplaythrough:Function

onchange:Function

onclick:Function

oncontextmenu:Function

ondblclick:Function

ondevicelight:Function

ondevicemotion:Function

ondeviceorientation:Function

ondeviceproximity:Function

ondrag:Function

ondragend:Function

ondragenter:Function

ondragleave:Function

ondragover:Function

ondragstart:Function

ondrop:Function

ondurationchange:Function

onemptied:Function

onended:Function

onfocus:Function

onfullscreenchange:Function

onfullscreenerror:Function

ongotpointercapture:Function

onhashchange:Function

oninput:Function

oninvalid:Function

onkeydown:Function

onkeypress:Function

onkeyup:Function

onlanguagechange:Function

onload:Function

onloadeddata:Function

onloadedmetadata:Function

onloadstart:Function

onlostpointercapture:Function

onmessage:Function

onmousedown:Function

onmouseenter:Function

onmouseleave:Function

onmousemove:Function

onmouseout:Function

onmouseover:Function

onmouseup:Function

onoffline:Function

ononline:Function

onorientationchange:Function

onpagehide:Function

onpageshow:Function

onpause:Function

onplay:Function

onplaying:Function

onpointercancel:Function

onpointerdown:Function

onpointerenter:Function

onpointerleave:Function

onpointerlockchange:Function

onpointerlockerror:Function

onpointermove:Function

onpointerout:Function

onpointerover:Function

onpointerup:Function

onpopstate:Function

onprogress:Function

onratechange:Function

onreset:Function

onresize:Function

onscroll:Function

onseeked:Function

onseeking:Function

onselect:Function

onshow:Function

onstalled:Function

onstorage:Function

onsubmit:Function

onsuspend:Function

ontimeupdate:Function

ontouchcancel:Function

ontouchend:Function

ontouchmove:Function

ontouchstart:Function

onunload:Function

onuserproximity:Function

onvolumechange:Function

onwaiting:Function

onwheel:Function

opener:Dynamic

Returns a reference to the window that opened this current window.

read only orientation:Int

Returns the orientation in degrees (in 90 degree increments) of the viewport relative to the device's natural orientation.

outerHeight:Dynamic

Gets the height of the outside of the browser window.

outerWidth:Dynamic

Gets the width of the outside of the browser window.

read only pageXOffset:Int

read only pageYOffset:Int

read only parent:Window

Returns a reference to the parent of the current window or subframe.

read only performance:Performance

Provides a hosting area for performance related attributes.

read only personalbar:BarProp

Returns the personalbar object, whose visibility can be toggled in the window.

read only screen:Screen

Returns a reference to the screen object associated with the window.

screenX:Dynamic

Returns the horizontal distance of the left border of the user's browser from the left side of the screen.

screenY:Dynamic

Returns the vertical distance of the top border of the user's browser from the top side of the screen.

read only scrollMaxX:Int

The maximum offset that the window can be scrolled to horizontally, that is the document width minus the viewport width.

read only scrollMaxY:Int

The maximum offset that the window can be scrolled to vertically (i.e., the document height minus the viewport height).

read only scrollX:Int

Returns the number of pixels that the document has already been scrolled horizontally.

read only scrollY:Int

Returns the number of pixels that the document has already been scrolled vertically.

read only scrollbars:BarProp

Returns the scrollbars object, whose visibility can be toggled in the window.

read only self:Window

Returns an object reference to the window object itself.

read only sessionStorage:Storage

Returns a storage object for storing data within a single page session.

read only speechSynthesis:SpeechSynthesis

Returns a SpeechSynthesis object, which is the entry point into using Web Speech API speech synthesis functionality.

status:String

Gets/sets the text in the statusbar at the bottom of the browser.

read only statusbar:BarProp

Returns the statusbar object, whose visibility can be toggled in the window.

read only toolbar:BarProp

Returns the toolbar object, whose visibility can be toggled in the window.

read only top:Window

Returns a reference to the topmost window in the window hierarchy. This property is read only.

read only window:Window

Returns a reference to the current window.

onbeforeunload:Event ‑> String

onerror:EitherType<Event, String> ‑> String ‑> Int ‑> Int ‑> Dynamic ‑> Bool

Methods

alert (message:String):Void

alert ():Void

Throws:

null	DOMError

atob (atob:String):String

Throws:

null	DOMError

blur ():Void

Throws:

null	DOMError

btoa (btoa:String):String

Throws:

null	DOMError

cancelAnimationFrame (handle:Int):Void

Throws:

null	DOMError

captureEvents ():Void

Registers the window to capture all events of the specified type.

clearInterval (handle:Int = 0):Void

clearTimeout (handle:Int = 0):Void

close ():Void

Throws:

null	DOMError

confirm (message:String = ""):Bool

Throws:

null	DOMError

createImageBitmap (aImage:EitherType<ImageElement, EitherType<VideoElement, EitherType<CanvasElement, EitherType<Blob, EitherType<ImageData, EitherType<CanvasRenderingContext2D, ImageBitmap>>>>>>, aSx:Int, aSy:Int, aSw:Int, aSh:Int):Promise<ImageBitmap>

createImageBitmap (aImage:EitherType<ImageElement, EitherType<VideoElement, EitherType<CanvasElement, EitherType<Blob, EitherType<ImageData, EitherType<CanvasRenderingContext2D, ImageBitmap>>>>>>):Promise<ImageBitmap>

Throws:

null	DOMError

dump (str:String):Void

Writes a message to the console.

fetch (input:EitherType<Request, String>, ?init:RequestInit):Promise<Response>

Throws:

null	DOMError

find (str:String = "", caseSensitive:Bool = false, backwards:Bool = false, wrapAround:Bool = false, wholeWord:Bool = false, searchInFrames:Bool = false, showDialog:Bool = false):Bool

Throws:

null	DOMError

focus ():Void

Throws:

null	DOMError

getComputedStyle (elt:Element, pseudoElt:String = ""):CSSStyleDeclaration

Throws:

null	DOMError

getDefaultComputedStyle (elt:Element, pseudoElt:String = ""):CSSStyleDeclaration

Throws:

null	DOMError

getSelection ():Selection

Throws:

null	DOMError

matchMedia (query:String):MediaQueryList

Throws:

null	DOMError

moveBy (x:Int, y:Int):Void

Throws:

null	DOMError

moveTo (x:Int, y:Int):Void

Throws:

null	DOMError

open (url:String = "", target:String = "", features:String = ""):Window

Throws:

null	DOMError

postMessage (message:Dynamic, targetOrigin:String, ?transfer:Array<Dynamic>):Void

Throws:

null	DOMError

print ():Void

Throws:

null	DOMError

prompt (message:String = "", default_:String = ""):String

Throws:

null	DOMError

releaseEvents ():Void

Releases the window from trapping events of a specific type.

requestAnimationFrame (callback:Float ‑> Void):Int

Throws:

null	DOMError

resizeBy (x:Int, y:Int):Void

Throws:

null	DOMError

resizeTo (x:Int, y:Int):Void

Throws:

null	DOMError

scroll (?options:ScrollToOptions):Void

scroll (x:Float, y:Float):Void

scrollBy (?options:ScrollToOptions):Void

scrollBy (x:Float, y:Float):Void

scrollByLines (numLines:Int, ?options:ScrollOptions):Void

Scrolls the document by the given number of lines.

scrollByPages (numPages:Int, ?options:ScrollOptions):Void

Scrolls the current document by the specified number of pages.

scrollTo (?options:ScrollToOptions):Void

scrollTo (x:Float, y:Float):Void

setInterval (handler:String, ?timeout:Int, unused:Rest<Dynamic>):Int

setInterval (handler:Function, ?timeout:Int, arguments:Rest<Dynamic>):Int

Throws:

null	DOMError

setResizable (resizable:Bool):Void

Toggles a user's ability to resize a window.

setTimeout (handler:String, timeout:Int = 0, unused:Rest<Dynamic>):Int

setTimeout (handler:Function, timeout:Int = 0, arguments:Rest<Dynamic>):Int

Throws:

null	DOMError

sizeToContent ():Void

Throws:

null	DOMError

stop ():Void

Throws:

null	DOMError

updateCommands (action:String, ?sel:Selection, reason:Int = 0):Void

Updates the state of commands of the current chrome window (UI).