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 optimisation 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 to Window.screenX.
y
Vertical position of the operating system window associated with window, equivalent to Window.screenY.
width
Width of outer bounds of the operating system window associated with window, equivalent to Window.outerWidth.
height
Height of the outer bounds of the operating system window associated with window, equivalent to Window.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 Status Comment
WebDriver
The definition of 'Get Window Rect' in that specification.
Candidate Recommendation Initial definition

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support No1 No2557 No1 No3
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support No1 No1 No2 No No1 No3 No4

1. To enable Chromium support, include {"goog:chromeOptions": {"w3c": true}} in the capabiliites when running the command.

2. The vendor-supported implementation for Edge is non-spec-conforming and incompatible.

3. The vendor-supported implementation for Safari is non spec-conforming and incompatible.

4. The vendor-supported implementation for Samsung Internet is non-spec-conforming and incompatible.

See also

 

Document Tags and Contributors

Contributors to this page: fscholz, ato
Last updated by: fscholz,