Get Element Location in View
Determine an element's location on the screen once it has been scrolled into view (mainly an internal command and not supported by all clients)
Example Usage
// Not supported
# Not supported
// Javascript
// webdriver.io example
let location = driver.getLocationInView("~SomeAccessibilityId");
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml)
// wd example
let element = await driver.elementByAccessibilityId("SomeAccessibilityID");
let location = await element.getLocationInView();
# Not supported
[//]: # (DO NOT EDIT THIS FILE! This is an auto-generated file. Editing for this document happens in /commands-yml/commands/element/attributes/location-in-view.yml)
# Not supported
// Not supported
// Not supported
Support
Appium Server
| Platform | Driver | Platform Versions | Appium Version | Driver Version |
|---|---|---|---|---|
| iOS | XCUITest | 9.3+ | 1.6.0+ | All |
| UIAutomation | 8.0 to 9.3 | All | All | |
| Android | Espresso | ?+ | 1.9.0+ | All |
| UiAutomator2 | ?+ | 1.6.0+ | All | |
| UiAutomator | 4.2+ | All | All | |
| Mac | Mac | ?+ | 1.6.4+ | All |
| Windows | Windows | 10+ | 1.6.0+ | All |
Appium Clients
| Language | Support | Documentation |
|---|---|---|
| Java | All | |
| Python | All | |
| Javascript (WebdriverIO) | All | |
| Javascript (WD) | All | github.com |
| Ruby | All | |
| PHP | All | |
| C# | All |
HTTP API Specifications
Endpoint
GET /wd/hub/session/:session_id/elements/:element_id/location_in_view
URL Parameters
| name | description |
|---|---|
| session_id | ID of the session to route the command to |
| element_id | ID of the element to get the location-in-view of |
JSON Parameters
None
Response
| name | type | description |
|---|---|---|
| x | number |
X coordinate |
| y | number |
Y coordinate |