Class: Window

Extends

• EventEmitter

Classes

Window

Members

bottom number

bottom coordinate of window

closed boolean readonly

is window closed?

content HTMLElement readonly

This is the content DOM element. Use this to add content to the Window.

height number

height of window

right number

right coordinate of window

title string

change title

width number

width of window

win HTMLElement readonly

This is the top-level DOM element

x number

left coordinate

y number

top coordinate

Methods

attachToScreen (direction, location)

Window.js:816

attaches window to a side of the screen

Name	Type	Description
direction	'horizontal' | 'vertical'
location	'left' | 'right' | 'top' | 'bottom'

blur ()

Window.js:85

blur the window

center (win)

Window.js:399

centers window in middle of other window or document.body

Name	Type	Description
win	Window	optional

close ()

Window.js:98

closes the window (can be reopened with open)

emit (event)Boolean inherited overrides

index.js:166

Calls each of the listeners registered for a given event.

Name	Type	Description
event	String | Symbol	The event name.

Returns:

Type	Description
Boolean	`true` if the event had listeners, else `false`.

eventNames ()Array inherited overrides

index.js:104

Return an array listing the events for which the emitter has registered listeners.

Returns:

Type	Description
Array

focus ()

Window.js:72

focus the window

isClosed ()boolean

Window.js:848

Returns:

Type	Description
boolean

isModal (ignoreClosed)boolean

Window.js:842

Name	Type	Description
ignoreClosed	boolean	optional

Returns:

Type	Description
boolean

listenerCount (event)Number inherited overrides

index.js:150

Return the number of listeners listening to a given event.

Name	Type	Description
event	String | Symbol	The event name.

Returns:

Type	Description
Number	The number of listeners.

listeners (event)Array inherited overrides

index.js:129

Return the listeners registered for a given event.

Name	Type	Description
event	String | Symbol	The event name.

Returns:

Type	Description
Array	The registered listeners.

load (data)

Window.js:322

return the state of the window

Name	Type	Description
data	object	from save()

maximize ()

Window.js:248

maximize the window

move (x, y)

Window.js:215

move window

Name	Type	Description
x	number
y	number

once (event, fn, context)EventEmitter inherited overrides

index.js:240

Add a one-time listener for a given event.

Name	Type	Default	Description
event	String | Symbol		The event name.
fn	function		The listener function.
context	*	this	optional The context to invoke the listener with.

Returns:

Type	Description
EventEmitter	`this`.

on (event, fn, context)EventEmitter inherited overrides

index.js:227

Add a listener for a given event.

Name	Type	Default	Description
event	String | Symbol		The event name.
fn	function		The listener function.
context	*	this	optional The context to invoke the listener with.

Returns:

Type	Description
EventEmitter	`this`.

open (noFocus)

Window.js:55

open the window

Name	Type	Description
noFocus	boolean	optional do not focus window when opened

removeAllListeners (event)EventEmitter inherited overrides

index.js:301

Remove all listeners, or those of the specified event.

Name	Type	Description
event	String | Symbol	optional The event name.

Returns:

Type	Description
EventEmitter	`this`.

removeListener (event, fn, context, once)EventEmitter inherited overrides

index.js:254

Remove the listeners of a given event.

Name	Type	Description
event	String | Symbol	The event name.
fn	function	Only remove the listeners that match this function.
context	*	Only remove the listeners that have this context.
once	Boolean	Only remove one-time listeners.

Returns:

Type	Description
EventEmitter	`this`.

resize (width, height)

Window.js:204

resize the window

Name	Type	Description
width	number
height	number

resizePlacement (bounds, keepInside)

Window.js:825

Name	Type	Description
bounds	Bounds
keepInside	boolean | 'horizontal' | 'vertical'

save ()object

Window.js:296

save the state of the window

Returns:

Type	Description
object	data

sendToBack ()

Window.js:279

sends window to back of window-manager

sendToFront ()

Window.js:287

send window to front of window-manager

Events

blur

Window.js:440

Fires when window loses focus

Type:

• Window

close

Window.js:445

Fires when window closes

Type:

• Window

focus

Window.js:435

Fires when window gains focus

Type:

• Window

maximize

Window.js:417

Fires when window is maximized

Type:

• Window

maximize-restore

Window.js:423

Fires when window is restored to normal after being maximized

Type:

• Window

move

Window.js:481

Fires during move

Type:

• Window

move-end

Window.js:475

Fires after move completes

Type:

• Window

move-start

Window.js:469

Fires when move starts

Type:

• Window

move-x

Window.js:499

Fires when x position of window is changed

Type:

• Window

move-y

Window.js:506

Fires when y position of window is changed

Type:

• Window

open

Window.js:429

Fires when window opens

Type:

• Window

resize

Window.js:463

Fires during resizing

Type:

• Window

resize-end

Window.js:457

Fires after resize completes

Type:

• Window

resize-height

Window.js:493

Fires when height is changed

Type:

• Window

resize-start

Window.js:451

Fires when resize starts

Type:

• Window

resize-width

Window.js:487

Fires when width is changed

Type:

• Window