Get Element Location

Determine an element's location on the page or screen

Example Usage

// Java
List<MobileElement> element = (MobileElement) driver.findElementByAccessibilityId("SomeAccessibilityID");
Point location = element.getLocation();


# Python
location = self.driver.find_element_by_accessibility_id('SomeAccessibilityID').location


// Javascript
// webdriver.io example
let location = driver.getLocation("~SomeAccessibilityId");



// wd example
let element = await driver.elementByAccessibilityId("SomeAccessibilityID");
let location = await element.getLocation();


# Ruby
# ruby_lib example
find_element(:accessibility_id, 'SomeAccessibilityID').location


# ruby_lib_core example
@driver.find_element(:accessibility_id, 'SomeAccessibilityID').location


# PHP
$el = $this->byAccessibilityId('SomeAccessibilityID');
$location = $el->location();


// C#
// TODO C# sample

Description

The point (0, 0) refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with x and y properties

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 seleniumhq.github.io
Python All selenium-python.readthedocs.io
Javascript (WebdriverIO) All
Javascript (WD) All github.com
Ruby All www.rubydoc.info
PHP All github.com
C# All github.com

HTTP API Specifications

Endpoint

GET /wd/hub/session/:session_id/elements/:element_id/location

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 of

JSON Parameters

None

Response

name type description
x number X coordinate
y number Y coordinate

See Also