API Docs

HSWindow

Type

Object representing a window. You should not instantiate these directly, but rather, use the methods in hs.window to create them for you.

Properties

application

HSApplication
The application that owns this window
Hammerspoon 2/Modules/hs.window/HSWindow.swift:34

pid

number
The process ID of the application that owns this window
Hammerspoon 2/Modules/hs.window/HSWindow.swift:42

id

number
The window's underlying ID. A value of 0 or -1 likely means no window ID could be determined.
Hammerspoon 2/Modules/hs.window/HSWindow.swift:51

isMinimized

boolean
Whether the window is minimized
Hammerspoon 2/Modules/hs.window/HSWindow.swift:61

isVisible

boolean
Whether the window is visible (not minimized or hidden)
Hammerspoon 2/Modules/hs.window/HSWindow.swift:69

isFocused

boolean
Whether the window is focused
Hammerspoon 2/Modules/hs.window/HSWindow.swift:77

isFullscreen

boolean
Whether the window is fullscreen
Hammerspoon 2/Modules/hs.window/HSWindow.swift:85

isStandard

boolean
Whether the window is standard (has a titlebar)
Hammerspoon 2/Modules/hs.window/HSWindow.swift:93

position

HSPoint
The window's position on screen {x: Int, y: Int}
Hammerspoon 2/Modules/hs.window/HSWindow.swift:103

size

HSSize
The window's size {w: Int, h: Int}
Hammerspoon 2/Modules/hs.window/HSWindow.swift:111

frame

HSRect
The window's frame {x: Int, y: Int, w: Int, h: Int}
Hammerspoon 2/Modules/hs.window/HSWindow.swift:119

screen

HSScreen
The screen that contains the largest portion of this window.
Hammerspoon 2/Modules/hs.window/HSWindow.swift:127

Methods

focus() -> boolean

Focus this window
Declaration
focus() -> boolean
Returns
boolean
true if successful
Example
const wins = hs.window.allWindows()
wins[0].focus()
Hammerspoon 2/Modules/hs.window/HSWindow.swift:138

minimize() -> boolean

Minimize this window
Declaration
minimize() -> boolean
Returns
boolean
true if successful
Example
const win = hs.window.focusedWindow()
win.minimize()
Hammerspoon 2/Modules/hs.window/HSWindow.swift:147

unminimize() -> boolean

Unminimize this window
Declaration
unminimize() -> boolean
Returns
boolean
true if successful
Example
const win = hs.window.allWindows()[0]
win.unminimize()
Hammerspoon 2/Modules/hs.window/HSWindow.swift:156

raise() -> boolean

Raise this window to the front
Declaration
raise() -> boolean
Returns
boolean
true if successful
Example
const win = hs.window.allWindows()[0]
win.raise()
Hammerspoon 2/Modules/hs.window/HSWindow.swift:165

toggleFullscreen() -> boolean

Toggle fullscreen mode
Declaration
toggleFullscreen() -> boolean
Returns
boolean
true if successful
Example
const win = hs.window.focusedWindow()
win.toggleFullscreen()
Hammerspoon 2/Modules/hs.window/HSWindow.swift:174

close() -> boolean

Close this window
Declaration
close() -> boolean
Returns
boolean
true if successful
Example
const win = hs.window.focusedWindow()
win.close()
Hammerspoon 2/Modules/hs.window/HSWindow.swift:183

centerOnScreen() -> None

Center the window on the screen
Declaration
centerOnScreen() -> None
Returns
None
Example
const win = hs.window.focusedWindow()
win.centerOnScreen()
Hammerspoon 2/Modules/hs.window/HSWindow.swift:192

axElement() -> HSAXElement

Get the underlying AXElement
Declaration
axElement() -> HSAXElement
Returns
HSAXElement
The accessibility element for this window
Example
const win = hs.window.focusedWindow()
const ax = win.axElement()
Hammerspoon 2/Modules/hs.window/HSWindow.swift:203