Get Window Rect
The Get Window Rect command of the WebDriver API returns the size and position of the given WebElement
. Many WebDriver clients present separate API methods for getting an element's location and dimensions, but as an optimization they both use this primitive.
The command operates on the currently selected window, and returns size and position of the operating system window. The returned WindowRect
can be used as input for the Set Window Rect command, which is for manipulating a window's position and dimensions.
Syntax
Method | URI template |
---|---|
GET |
/session/{session id}/window/rect |
URL parameters
session id
-
Identifier of the session.
Response
The response payload is a WindowRect
:
x
-
Horizontal position of the operating system window associated with
window
, equivalent toWindow.screenX
. y
-
Vertical position of the operating system window associated with
window
, equivalent toWindow.screenY
. width
-
Width of outer bounds of the operating system window associated with
window
, equivalent toWindow.outerWidth
. height
-
Height of the outer bounds of the operating system window associated with
window
, equivalent toWindow.outerHeight
.
Errors
- Invalid session ID
-
Session does not exist.
- Unexpected alert open
-
A user prompt, such as
window.alert
, blocks execution of command until it is dealt with.
Specifications
Specification |
---|
WebDriver # dfn-get-window-rect |
Browser compatibility
BCD tables only load in the browser
See also
- WebWindow
- Associated commands: